@serenity-js/core 3.4.1 → 3.5.0

package/src/screenplay/WithAnswerableProperties.ts

@@ -1,5 +1,5 @@
-import { Answerable } from './Answerable';
-import { Question } from './Question';
+import type { Answerable } from './Answerable';
+import type { Question } from './Question';
 
 /**
  * Describes a plain JavaScript object with {@apilink Answerable} properties.

package/src/screenplay/abilities/Ability.ts

@@ -1,5 +1,5 @@
-import { AbilityType } from './AbilityType';
-import { UsesAbilities } from './UsesAbilities';
+import type { AbilityType } from './AbilityType';
+import type { UsesAbilities } from './UsesAbilities';
 
 /**
  * **Abilities** enable {@apilink Actor|actors}

package/src/screenplay/abilities/AbilityType.ts

@@ -1,4 +1,4 @@
-import { Ability } from './Ability';
+import type { Ability } from './Ability';
 
 /**
  * An interface describing the static access method that every {@apilink Ability} class

package/src/screenplay/abilities/AnswerQuestions.ts

@@ -1,8 +1,8 @@
-import { Answerable } from '../Answerable';
+import type { Answerable } from '../Answerable';
 import { Question } from '../Question';
-import { AnswersQuestions } from '../questions';
+import type { AnswersQuestions } from '../questions';
 import { Ability } from './Ability';
-import { UsesAbilities } from './UsesAbilities';
+import type { UsesAbilities } from './UsesAbilities';
 
 /**
  * This {@apilink Ability} enables an {@apilink Actor} to resolve the value of a given {@apilink Answerable}.

package/src/screenplay/abilities/CanHaveAbilities.ts

@@ -1,5 +1,5 @@
-import { Ability } from './Ability';
-import { UsesAbilities } from './UsesAbilities';
+import type { Ability } from './Ability';
+import type { UsesAbilities } from './UsesAbilities';
 
 /**
  * Describes an {@apilink Actor} who can have an {@apilink Ability} to perform some {@apilink Activity}.

package/src/screenplay/abilities/PerformActivities.ts

@@ -1,7 +1,12 @@
 import { match } from 'tiny-types';
 
 import { AssertionError, ImplementationPendingError, TestCompromisedError } from '../../errors';
-import { EmitsDomainEvents, InteractionFinished, InteractionStarts, TaskFinished, TaskStarts } from '../../events';
+import type { EmitsDomainEvents} from '../../events';
+import { InteractionFinished, InteractionStarts, TaskFinished, TaskStarts } from '../../events';
+import type {
+    Outcome,
+    ProblemIndication
+} from '../../model';
 import {
     ActivityDetails,
     ExecutionCompromised,
@@ -9,12 +14,10 @@ import {
     ExecutionFailedWithError,
     ExecutionSuccessful,
     ImplementationPending,
-    Name,
-    Outcome,
-    ProblemIndication
+    Name
 } from '../../model';
-import { PerformsActivities } from '../activities/PerformsActivities';
-import { Activity } from '../Activity';
+import type { PerformsActivities } from '../activities/PerformsActivities';
+import type { Activity } from '../Activity';
 import { Interaction } from '../Interaction';
 import { Ability } from './index';
 

package/src/screenplay/abilities/UsesAbilities.ts

@@ -1,5 +1,5 @@
-import { Ability } from './Ability';
-import { AbilityType } from './AbilityType';
+import type { Ability } from './Ability';
+import type { AbilityType } from './AbilityType';
 
 /**
  * Describes an {@apilink Actor} who can use their {@apilink Ability|abilities} to perform an {@apilink Activity}

package/src/screenplay/activities/PerformsActivities.ts

@@ -1,4 +1,4 @@
-import { Activity } from '../Activity';
+import type { Activity } from '../Activity';
 
 /**
  * Describes an {@apilink Actor} who can perform a sequence of {@apilink Activity|Activities},

package/src/screenplay/artifacts/CollectsArtifacts.ts

@@ -1,4 +1,4 @@
-import { Artifact, Name } from '../../model';
+import type { Artifact, Name } from '../../model';
 
 /**
  * Describes an {@apilink Actor} who can collect {@apilink Artifact|Artifacts}, such as {@apilink Photo|Photos} or {@apilink JSONData},

package/src/screenplay/debugging/Debug.ts

@@ -2,13 +2,13 @@ import { ErrorSerialiser } from '../../errors';
 import { d } from '../../io';
 import { stringified } from '../../io/stringified';
 import { LogEntry, Name } from '../../model';
-import { UsesAbilities } from '../abilities';
-import { Answerable } from '../Answerable';
-import { Answered } from '../Answered';
-import { CollectsArtifacts } from '../artifacts';
+import type { UsesAbilities } from '../abilities';
+import type { Answerable } from '../Answerable';
+import type { Answered } from '../Answered';
+import type { CollectsArtifacts } from '../artifacts';
 import { Interaction } from '../Interaction';
-import { AnswersQuestions } from '../questions';
-import { DebuggingResult } from './DebuggingResult';
+import type { AnswersQuestions } from '../questions';
+import type { DebuggingResult } from './DebuggingResult';
 
 /**
  * Instructs the {@apilink Actor|actor} to evaluate and {@apilink Log|log} the provided {@apilink Answerable} values.

package/src/screenplay/debugging/Log.ts

@@ -1,11 +1,11 @@
 import { d } from '../../io';
 import { stringified } from '../../io/stringified';
 import { LogEntry, Name } from '../../model';
-import { UsesAbilities } from '../abilities';
-import { Answerable } from '../Answerable';
-import { CollectsArtifacts } from '../artifacts';
+import type { UsesAbilities } from '../abilities';
+import type { Answerable } from '../Answerable';
+import type { CollectsArtifacts } from '../artifacts';
 import { Interaction } from '../Interaction';
-import { AnswersQuestions } from '../questions';
+import type { AnswersQuestions } from '../questions';
 
 /**
  * Instructs the {@apilink Actor} to {@apilink CollectsArtifacts|collect} arbitrary static values and answers to {@apilink Answerable|Answerables},

package/src/screenplay/notes/ChainableSetter.ts

@@ -1,5 +1,5 @@
-import { Answerable } from '../Answerable';
-import { Interaction } from '../Interaction';
+import type { Answerable } from '../Answerable';
+import type { Interaction } from '../Interaction';
 
 /**
  * @group Notes

package/src/screenplay/notes/NotepadAdapter.ts

@@ -1,12 +1,13 @@
-import { JSONObject } from 'tiny-types';
+import type { JSONObject } from 'tiny-types';
 
 import { commaSeparated } from '../../io';
-import { UsesAbilities } from '../abilities';
-import { Answerable } from '../Answerable';
+import type { UsesAbilities } from '../abilities';
+import type { Answerable } from '../Answerable';
 import { Interaction } from '../Interaction';
-import { Question, QuestionAdapter } from '../Question';
-import { AnswersQuestions } from '../questions';
-import { ChainableSetter } from './ChainableSetter';
+import type { QuestionAdapter } from '../Question';
+import { Question } from '../Question';
+import type { AnswersQuestions } from '../questions';
+import type { ChainableSetter } from './ChainableSetter';
 import { TakeNotes } from './TakeNotes';
 
 /**

package/src/screenplay/notes/notes.ts

@@ -1,5 +1,5 @@
 import { Notepad } from './Notepad';
-import { NotepadAdapter } from './NotepadAdapter';
+import type { NotepadAdapter } from './NotepadAdapter';
 
 /**
  * Alias for {@apilink Notepad.notes}.

package/src/screenplay/questions/AnswersQuestions.ts

@@ -1,4 +1,4 @@
-import { Answerable } from '../Answerable';
+import type { Answerable } from '../Answerable';
 
 /**
  * Describes an {@apilink Actor} who can answer a {@apilink Question} about the system under test.

package/src/screenplay/questions/Check.ts

@@ -1,10 +1,10 @@
 import { d } from '../../io';
-import { PerformsActivities } from '../activities';
-import { Activity } from '../Activity';
-import { Answerable } from '../Answerable';
-import { AnswersQuestions } from '../questions';
+import type { PerformsActivities } from '../activities';
+import type { Activity } from '../Activity';
+import type { Answerable } from '../Answerable';
+import type { AnswersQuestions } from '../questions';
 import { Task } from '../Task';
-import { Expectation } from './Expectation';
+import type { Expectation } from './Expectation';
 import { ExpectationMet } from './expectations';
 
 /**

package/src/screenplay/questions/Expectation.ts

@@ -1,8 +1,9 @@
-import { JSONValue } from 'tiny-types';
+import type { JSONValue } from 'tiny-types';
 
 import { asyncMap, d } from '../../io';
-import { Answerable, AnswersQuestions, ExpectationDetails, ExpectationMet, ExpectationNotMet, Question, QuestionAdapter } from '../';
-import { ExpectationOutcome } from './expectations';
+import type { Answerable, AnswersQuestions, QuestionAdapter } from '../';
+import { ExpectationDetails, ExpectationMet, ExpectationNotMet, Question } from '../';
+import type { ExpectationOutcome } from './expectations';
 
 /**
  * @group Expectations

package/src/screenplay/questions/List.ts

@@ -1,14 +1,15 @@
 import { ListItemNotFoundError, LogicError } from '../../errors';
 import { d } from '../../io';
-import { UsesAbilities } from '../abilities';
-import { Actor } from '../Actor';
-import { Answerable } from '../Answerable';
-import { Question, QuestionAdapter } from '../Question';
-import { AnswersQuestions } from '../questions';
+import type { UsesAbilities } from '../abilities';
+import type { Actor } from '../Actor';
+import type { Answerable } from '../Answerable';
+import type { QuestionAdapter } from '../Question';
+import { Question } from '../Question';
+import type { AnswersQuestions } from '../questions';
 import { Task } from '../Task';
-import { Expectation } from './Expectation';
+import type { Expectation } from './Expectation';
 import { ExpectationMet } from './expectations';
-import { MetaQuestion } from './MetaQuestion';
+import type { MetaQuestion } from './MetaQuestion';
 
 /**
  * Serenity/JS Screenplay Pattern-style wrapper around {@apilink Array}

package/src/screenplay/questions/MetaQuestion.ts

@@ -1,5 +1,5 @@
-import { Answerable } from '../Answerable';
-import { Question } from '../Question';
+import type { Answerable } from '../Answerable';
+import type { Question } from '../Question';
 
 /**
  * A "meta question" is a {@apilink Question} about another {@apilink Answerable},

package/src/screenplay/questions/Unanswered.ts

@@ -1,4 +1,5 @@
-import { JSONValue, TinyType } from 'tiny-types';
+import type { JSONValue} from 'tiny-types';
+import { TinyType } from 'tiny-types';
 import * as util from 'util';   // eslint-disable-line unicorn/import-style
 
 /**

package/src/screenplay/questions/expectations/ExpectationDetails.ts

@@ -1,4 +1,5 @@
-import { ensure, isArray, isDefined, JSONObject, JSONValue, TinyType } from 'tiny-types';
+import type { JSONObject, JSONValue} from 'tiny-types';
+import { ensure, isArray, isDefined, TinyType } from 'tiny-types';
 
 import { inspected, typeOf } from '../../../io';
 import { Name } from '../../../model';

package/src/screenplay/questions/expectations/ExpectationOutcome.ts

@@ -1,6 +1,6 @@
 import { TinyType } from 'tiny-types';
 
-import { ExpectationDetails } from './ExpectationDetails';
+import type { ExpectationDetails } from './ExpectationDetails';
 
 /**
  * An outcome of an {@apilink Expectation},

package/src/screenplay/questions/q.ts

@@ -1,5 +1,6 @@
-import { Answerable } from '../Answerable';
-import { Question, QuestionAdapter } from '../Question';
+import type { Answerable } from '../Answerable';
+import type { QuestionAdapter } from '../Question';
+import { Question } from '../Question';
 
 /**
  * A Serenity/JS Screenplay Pattern-flavour

package/src/screenplay/time/TellsTime.ts

@@ -0,0 +1,19 @@
+import type { Timestamp } from './models';
+
+/**
+ * Describes an {@apilink Actor} or a supporting class capable of telling
+ * the current wall clock time.
+ *
+ * ## Learn more
+ * - {@apilink Actor}
+ * - {@apilink Serenity}
+ * - {@apilink Stage}
+ *
+ * @group Time
+ */
+export interface TellsTime {
+    /**
+     * Returns current wall clock time.
+     */
+    currentTime(): Timestamp;
+}

package/src/screenplay/time/abilities/ScheduleWork.ts

@@ -1,5 +1,7 @@
-import { Ability, Discardable } from '../../abilities';
-import { Clock, DelayedCallback, Duration, RepeatUntilLimits, Scheduler } from '../models';
+import type { Discardable } from '../../abilities';
+import { Ability } from '../../abilities';
+import type { Clock, DelayedCallback, Duration, RepeatUntilLimits} from '../models';
+import { Scheduler } from '../models';
 
 /**
  * An {@apilink Ability} that enables an {@apilink Actor} to schedule a callback function

package/src/screenplay/time/activities/Wait.ts

@@ -2,10 +2,11 @@ import { ensure, isGreaterThanOrEqualTo, isInRange } from 'tiny-types';
 
 import { AssertionError, ListItemNotFoundError, RaiseErrors, TimeoutExpiredError } from '../../../errors';
 import { d } from '../../../io';
-import { UsesAbilities } from '../../abilities';
-import { Answerable } from '../../Answerable';
+import type { UsesAbilities } from '../../abilities';
+import type { Answerable } from '../../Answerable';
 import { Interaction } from '../../Interaction';
-import { AnswersQuestions, Expectation, ExpectationMet, ExpectationOutcome } from '../../questions';
+import type { AnswersQuestions, Expectation, ExpectationOutcome } from '../../questions';
+import { ExpectationMet } from '../../questions';
 import { ScheduleWork } from '../abilities';
 import { Duration } from '../models';
 

package/src/screenplay/time/index.ts

@@ -1,3 +1,4 @@
 export * from './abilities';
 export * from './activities';
 export * from './models';
+export * from './TellsTime';

package/src/screenplay/time/models/DelayedCallback.ts

@@ -1,4 +1,4 @@
-import { Timestamp } from './Timestamp';
+import type { Timestamp } from './Timestamp';
 
 /**
  * @group Time

package/src/screenplay/time/models/Duration.ts

@@ -1,4 +1,5 @@
-import { ensure, isGreaterThanOrEqualTo, isInteger, JSONObject, TinyType } from 'tiny-types';
+import type { JSONObject} from 'tiny-types';
+import { ensure, isGreaterThanOrEqualTo, isInteger, TinyType } from 'tiny-types';
 
 /**
  * Represents a duration in milliseconds between two {@apilink Timestamp|timestamps}.

package/src/screenplay/time/models/RepeatUntilLimits.ts

@@ -1,4 +1,4 @@
-import { Duration } from './Duration';
+import type { Duration } from './Duration';
 
 /**
  * @group Time

package/src/screenplay/time/models/Scheduler.ts

@@ -1,9 +1,9 @@
 import { OperationInterruptedError, TimeoutExpiredError } from '../../../errors';
-import { Clock } from './Clock';
-import { DelayedCallback } from './DelayedCallback';
+import type { Clock } from './Clock';
+import type { DelayedCallback } from './DelayedCallback';
 import { Duration } from './Duration';
-import { RepeatUntilLimits } from './RepeatUntilLimits';
-import { Timestamp } from './Timestamp';
+import type { RepeatUntilLimits } from './RepeatUntilLimits';
+import type { Timestamp } from './Timestamp';
 
 /**
  * @group Time

package/src/stage/Cast.ts

@@ -1,4 +1,4 @@
-import { Actor } from '../screenplay';
+import type { Actor } from '../screenplay';
 
 /**
  * Serenity/JS uses the concept of a _**cast of actors**_ to centralise the process of configuring the {@apilink Actor|actors} and assigning their {@apilink Ability|abilities}.

package/src/stage/Extras.ts

@@ -1,5 +1,5 @@
-import { Actor } from '../screenplay';
-import { Cast } from './Cast';
+import type { Actor } from '../screenplay';
+import type { Cast } from './Cast';
 
 /**
  * Produces no-op actors with no special {@apilink Ability}

package/src/stage/ListensToDomainEvents.ts

@@ -1,4 +1,4 @@
-import { DomainEvent } from '../events';
+import type { DomainEvent } from '../events';
 
 /**
  * A {@apilink StageCrewMember} that can listen and react to {@apilink DomainEvent|DomainEvents}

package/src/stage/Stage.ts

@@ -1,21 +1,25 @@
 import { ensure, isDefined } from 'tiny-types';
 
-import { ConfigurationError, ErrorFactory, ErrorOptions, LogicError, RaiseErrors, RuntimeError } from '../errors';
+import type { ErrorFactory, ErrorOptions, RuntimeError } from '../errors';
+import { ConfigurationError, LogicError, RaiseErrors } from '../errors';
+import type {
+    DomainEvent,
+    EmitsDomainEvents} from '../events';
 import {
     AsyncOperationAttempted,
     AsyncOperationCompleted,
     AsyncOperationFailed,
-    DomainEvent,
-    EmitsDomainEvents,
     SceneFinishes,
     SceneStarts,
     TestRunFinishes
 } from '../events';
-import { ActivityDetails, CorrelationId, Description, Name } from '../model';
-import { Actor, Clock, Duration, ScheduleWork, Timestamp } from '../screenplay';
-import { ListensToDomainEvents } from '../stage';
-import { Cast } from './Cast';
-import { StageManager } from './StageManager';
+import type { ActivityDetails} from '../model';
+import { CorrelationId, Description, Name } from '../model';
+import type { Clock, Duration, Timestamp } from '../screenplay';
+import { Actor, ScheduleWork } from '../screenplay';
+import type { ListensToDomainEvents } from '../stage';
+import type { Cast } from './Cast';
+import type { StageManager } from './StageManager';
 
 /**
  * Stage is the place where {@apilink Actor|actors} perform.

package/src/stage/StageCrewMember.ts

@@ -1,5 +1,5 @@
-import { ListensToDomainEvents } from './ListensToDomainEvents';
-import { Stage } from './Stage';
+import type { ListensToDomainEvents } from './ListensToDomainEvents';
+import type { Stage } from './Stage';
 
 /**
  * You can think of the {@apilink StageCrewMember} as an in-memory microservice that reacts to {@apilink DomainEvent|domain events},

package/src/stage/StageCrewMemberBuilder.ts

@@ -1,5 +1,5 @@
-import { ListensToDomainEvents } from './ListensToDomainEvents';
-import { StageCrewMemberBuilderDependencies } from './StageCrewMemberBuilderDependencies';
+import type { ListensToDomainEvents } from './ListensToDomainEvents';
+import type { StageCrewMemberBuilderDependencies } from './StageCrewMemberBuilderDependencies';
 
 /**
  * Use a {@apilink StageCrewMemberBuilder} to configure complex {@apilink StageCrewMember} objects.

package/src/stage/StageCrewMemberBuilderDependencies.ts

@@ -1,5 +1,5 @@
-import { OutputStream } from '../adapter';
-import { Stage } from './Stage';
+import type { OutputStream } from '../adapter';
+import type { Stage } from './Stage';
 
 /**
  * Dependencies injected by {@apilink Serenity.configure} into {@apilink StageCrewMemberBuilder.build}

package/src/stage/StageManager.ts

@@ -1,12 +1,13 @@
-import { AsyncOperationAttempted, AsyncOperationCompleted, AsyncOperationFailed, DomainEvent } from '../events';
-import { CorrelationId, Description, Name } from '../model';
-import { Clock, Duration, Timestamp } from '../screenplay';
-import { ListensToDomainEvents } from '../stage';
+import type { DomainEvent } from '../events';
+import { AsyncOperationAttempted, AsyncOperationCompleted, AsyncOperationFailed } from '../events';
+import type { CorrelationId, Description, Name } from '../model';
+import type { Clock, Duration, TellsTime, Timestamp } from '../screenplay';
+import type { ListensToDomainEvents } from '../stage';
 
 /**
  * @group Stage
  */
-export class StageManager {
+export class StageManager implements TellsTime {
     private readonly subscribers: ListensToDomainEvents[] = [];
     private readonly wip: WIP;
 

package/src/stage/crew/artifact-archiver/ArtifactArchiver.ts

@@ -1,6 +1,8 @@
-import { WriteFileOptions } from 'fs';
+import type { WriteFileOptions } from 'fs';
 import { ensure, isDefined, isGreaterThan, isString, property } from 'tiny-types';
 
+import type {
+    DomainEvent} from '../../../events';
 import {
     ActivityRelatedArtifactArchived,
     ActivityRelatedArtifactGenerated,
@@ -8,13 +10,13 @@ import {
     ArtifactGenerated,
     AsyncOperationAttempted,
     AsyncOperationCompleted,
-    AsyncOperationFailed,
-    DomainEvent,
+    AsyncOperationFailed
 } from '../../../events';
 import { FileSystem, Path } from '../../../io';
-import { Artifact, ArtifactType, CorrelationId, Description, Name, Photo, TestReport } from '../../../model';
-import { Stage } from '../../Stage';
-import { StageCrewMember } from '../../StageCrewMember';
+import type { Artifact, ArtifactType} from '../../../model';
+import { CorrelationId, Description, Name, Photo, TestReport } from '../../../model';
+import type { Stage } from '../../Stage';
+import type { StageCrewMember } from '../../StageCrewMember';
 import { Hash } from './Hash';
 
 /**

package/src/stage/crew/stream-reporter/StreamReporter.ts

@@ -1,8 +1,8 @@
-import { Writable } from 'stream';
+import type { Writable } from 'stream';
 
-import { DomainEvent } from '../../../events';
-import { Stage } from '../../Stage';
-import { StageCrewMember } from '../../StageCrewMember';
+import type { DomainEvent } from '../../../events';
+import type { Stage } from '../../Stage';
+import type { StageCrewMember } from '../../StageCrewMember';
 
 /**
  * Serialises all the {@apilink DomainEvent} objects it receives and streams

package/src/stage/queues/DomainEventQueue.ts

@@ -1,7 +1,7 @@
 import { ensure, Predicate } from 'tiny-types';
 
-import { DomainEvent } from '../../events';
-import { CorrelationId } from '../../model';
+import type { DomainEvent } from '../../events';
+import type { CorrelationId } from '../../model';
 
 /**
  * @group Stage

package/src/stage/queues/DomainEventQueues.ts

@@ -1,7 +1,8 @@
 import { LogicError } from '../../errors';
-import { DomainEvent, SceneSequenceDetected, SceneStarts } from '../../events';
+import type { DomainEvent} from '../../events';
+import { SceneSequenceDetected, SceneStarts } from '../../events';
 import { d } from '../../io/format';
-import { CorrelationId, ScenarioDetails } from '../../model';
+import type { CorrelationId, ScenarioDetails } from '../../model';
 import { DomainEventQueue } from './DomainEventQueue';
 
 /**