@serenity-js/core 3.41.1 → 3.42.0

package/src/events/actor/index.ts

@@ -1,6 +1,6 @@
-export * from './ActorEntersStage';
-export * from './ActorSpotlighted';
-export * from './ActorStageExitAttempted';
-export * from './ActorStageExitCompleted';
-export * from './ActorStageExitFailed';
-export * from './ActorStageExitStarts';
+export * from './ActorEntersStage.js';
+export * from './ActorSpotlighted.js';
+export * from './ActorStageExitAttempted.js';
+export * from './ActorStageExitCompleted.js';
+export * from './ActorStageExitFailed.js';
+export * from './ActorStageExitStarts.js';

package/src/events/index.ts

@@ -1,35 +1,35 @@
-export * from './ActivityFinished';
-export * from './ActivityRelatedArtifactArchived';
-export * from './ActivityRelatedArtifactGenerated';
-export * from './ActivityStarts';
-export * from './actor';
-export * from './ArtifactArchived';
-export * from './ArtifactGenerated';
-export * from './AsyncOperationAborted';
-export * from './AsyncOperationAttempted';
-export * from './AsyncOperationCompleted';
-export * from './AsyncOperationFailed';
-export * from './BusinessRuleDetected';
-export * from './DomainEvent';
-export * from './EmitsDomainEvents';
-export * from './FeatureNarrativeDetected';
-export * from './InteractionFinished';
-export * from './InteractionStarts';
-export * from './RetryableSceneDetected';
-export * from './SceneBackgroundDetected';
-export * from './SceneDescriptionDetected';
-export * from './SceneFinished';
-export * from './SceneFinishes';
-export * from './SceneParametersDetected';
-export * from './SceneSequenceDetected';
-export * from './SceneStarts';
-export * from './SceneTagged';
-export * from './SceneTemplateDetected';
-export * from './TaskFinished';
-export * from './TaskStarts';
-export * from './TestRunFinished';
-export * from './TestRunFinishes';
-export * from './TestRunnerDetected';
-export * from './TestRunStarts';
-export * from './TestSuiteFinished';
-export * from './TestSuiteStarts';
+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';

package/src/index.ts

@@ -1,7 +1,7 @@
-export * from './config';
-export * from './errors';
-export * from './instance';
-export { d, f, format } from './io';
-export * from './screenplay';
-export * from './Serenity';
-export * from './stage';
+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';

package/src/instance.ts

@@ -1,17 +1,30 @@
-import type { SerenityConfig } from './config';
-import type { Actor} from './screenplay';
-import { Clock } from './screenplay';
-import { Serenity } from './Serenity';
-import type { Cast } from './stage';
+import type { SerenityConfig } from './config/index.js';
+import type { Actor} from './screenplay/index.js';
+import { Clock } from './screenplay/index.js';
+import { Serenity } from './Serenity.js';
+import type { Cast } from './stage/index.js';
 
-const clock = new Clock();
+// Use a global symbol to ensure the same Serenity instance is shared
+// across ESM and CJS module boundaries (dual-package hazard mitigation)
+const SERENITY_INSTANCE_KEY = Symbol.for('@serenity-js/core/serenity');
+
+function getOrCreateSerenity(): Serenity {
+    const globalRegistry = globalThis as { [key: symbol]: Serenity };
+    
+    if (!globalRegistry[SERENITY_INSTANCE_KEY]) {
+        const clock = new Clock();
+        globalRegistry[SERENITY_INSTANCE_KEY] = new Serenity(clock);
+    }
+    
+    return globalRegistry[SERENITY_INSTANCE_KEY];
+}
 
 /**
  * Serenity object is the root object of the Serenity/JS framework.
  *
  * @group Serenity
  */
-export const serenity = new Serenity(clock);
+export const serenity = getOrCreateSerenity();
 
 /**
  * Configures Serenity/JS. Every call to this function replaces the previous configuration provided,

package/src/io/FileFinder.ts

@@ -1,6 +1,6 @@
 import fg from 'fast-glob';
 
-import { Path } from './Path';
+import { Path } from './Path.js';
 
 export class FileFinder {
     constructor(private readonly cwd: Path) {

package/src/io/FileSystem.ts

@@ -1,9 +1,9 @@
 import type * as NodeFS from 'node:fs';
 import * as nodeOS from 'node:os';
 
-import * as gracefulFS from 'graceful-fs';
+import gracefulFS from 'graceful-fs';
 
-import { Path } from './Path';
+import { Path } from './Path.js';
 
 export class FileSystem {
 

package/src/io/FileSystemLocation.ts

@@ -1,7 +1,7 @@
 import type { JSONObject} from 'tiny-types';
 import { TinyType } from 'tiny-types';
 
-import { Path } from './Path';
+import { Path } from './Path.js';
 
 export class FileSystemLocation extends TinyType {
     static fromJSON(o: JSONObject): FileSystemLocation {

package/src/io/Path.ts

@@ -1,6 +1,9 @@
 import filenamify from 'filenamify';
 import { ensure, isDefined, isGreaterThan, property, TinyType } from 'tiny-types';
-import path, { sep } from 'upath';
+import upath from 'upath';
+
+const { sep } = upath;
+const path = upath;
 
 export class Path extends TinyType {
     private static readonly Separator = '/';

package/src/io/RequirementsHierarchy.ts

@@ -1,7 +1,7 @@
-import { ConfigurationError } from '../errors';
-import { CapabilityTag, FeatureTag, Tag, ThemeTag } from '../model';
-import type { FileSystem } from './FileSystem';
-import { Path } from './Path';
+import { ConfigurationError } from '../errors/index.js';
+import { CapabilityTag, FeatureTag, Tag, ThemeTag } from '../model/index.js';
+import type { FileSystem } from './FileSystem.js';
+import { Path } from './Path.js';
 
 export class RequirementsHierarchy {
 

package/src/io/format.ts

@@ -1,5 +1,5 @@
-import type { Answerable } from '../screenplay';
-import { stringified } from './stringified';
+import type { Answerable } from '../screenplay/index.js';
+import { stringified } from './stringified.js';
 
 /**
  * `format` is a factory function returning

package/src/io/index.ts

@@ -1,15 +1,16 @@
-export * from './asyncMap';
-export * from './commaSeparated';
-export * from './Config';
-export * from './FileFinder';
-export * from './FileSystem';
-export * from './FileSystemLocation';
-export * from './format';
-export * from './inspected';
-export * from './inspectedObject';
-export * from './loader';
-export * from './Path';
-export * from './reflection';
-export * from './RequirementsHierarchy';
-export * from './trimmed';
-export * from './Version';
+export * from './asyncMap.js';
+export * from './commaSeparated.js';
+export * from './Config.js';
+export * from './FileFinder.js';
+export * from './FileSystem.js';
+export * from './FileSystemLocation.js';
+export * from './format.js';
+export * from './inspected.js';
+export * from './inspectedObject.js';
+export * from './loader/index.js';
+export * from './Path.js';
+export * from './reflection/index.js';
+export * from './RequirementsHierarchy.js';
+export * from './stringified.js';
+export * from './trimmed.js';
+export * from './Version.js';

package/src/io/inspectedObject.ts

@@ -1,6 +1,6 @@
 import util from 'node:util';
 
-import { ValueInspector } from './reflection';
+import { ValueInspector } from './reflection/index.js';
 
 export function inspectedObject<T>(value: T, allowFields?: Array<keyof T>): (depth: number, options: util.InspectOptionsStylized, inspect: typeof util.inspect) => string {
     return function (depth: number, options: util.InspectOptionsStylized, inspect: typeof util.inspect = util.inspect): string {

package/src/io/loader/ClassDescriptionParser.ts

@@ -1,9 +1,9 @@
 import validate from 'validate-npm-package-name';
 
-import type { ClassDescription } from '../../config';
-import { ConfigurationError } from '../../errors';
-import { d } from '../format';
-import type { ClassDescriptor } from './ClassDescriptor';
+import type { ClassDescription } from '../../config/index.js';
+import { ConfigurationError } from '../../errors/index.js';
+import { d } from '../format.js';
+import type { ClassDescriptor } from './ClassDescriptor.js';
 
 export class ClassDescriptionParser {
     private static validClassNamePattern = /^[A-Za-z]\w+$/;

package/src/io/loader/ClassLoader.ts

@@ -1,8 +1,8 @@
-import type { ClassDescription } from '../../config';
-import { ConfigurationError } from '../../errors';
-import { d } from '../format';
-import type { ClassDescriptionParser } from './ClassDescriptionParser';
-import type { ModuleLoader } from './ModuleLoader';
+import type { ClassDescription } from '../../config/index.js';
+import { ConfigurationError } from '../../errors/index.js';
+import { d } from '../format.js';
+import type { ClassDescriptionParser } from './ClassDescriptionParser.js';
+import type { ModuleLoader } from './ModuleLoader.js';
 
 export class ClassLoader {
     constructor(

package/src/io/loader/ModuleLoader.ts

@@ -1,14 +1,29 @@
-
-const Module = require('module'); // No type definitions available
+import { createRequire } from 'node:module';
 import path from 'node:path';
+import { pathToFileURL } from 'node:url';
+
+import { Version } from '../Version.js';
 
-import { Version } from '../Version';
+// Get the Module object for internal resolution APIs
+const bootstrapRequire = createRequire(pathToFileURL(path.join(process.cwd(), 'package.json')).href);
+const Module = bootstrapRequire('module'); // No type definitions available
+
+/**
+ * Creates a require function for the given directory.
+ * Uses createRequire to create a require function anchored to the specified cwd.
+ */
+function createRequireForCwd(cwd: string): NodeRequire {
+    const contextFile = path.join(cwd, 'noop.js');
+    return createRequire(pathToFileURL(contextFile).href);
+}
 
 /**
  * Dynamically loads Node modules located relative to `cwd`.
  */
 export class ModuleLoader {
 
+    private readonly requireFn: NodeRequire;
+
     /**
      * @param {string} cwd
      *  Current working directory, relative to which Node modules should be resolved.
@@ -20,6 +35,8 @@ export class ModuleLoader {
         public readonly cwd: string,
         public readonly useRequireCache: boolean = true,
     ) {
+        // Create a require function anchored to the cwd
+        this.requireFn = createRequireForCwd(cwd);
     }
 
     /**
@@ -62,16 +79,16 @@ export class ModuleLoader {
      */
     require(moduleId: string): any {
         try {
-            return require(this.cachedIfNeeded(this.resolve(moduleId)));
+            return this.requireFn(this.cachedIfNeeded(this.resolve(moduleId)));
         }
         catch {
-            return require(this.cachedIfNeeded(moduleId));
+            return this.requireFn(this.cachedIfNeeded(moduleId));
         }
     }
 
     private cachedIfNeeded(moduleId: string): string {
         if (! this.useRequireCache) {
-            delete require.cache[moduleId];
+            delete this.requireFn.cache[moduleId];
         }
 
         return moduleId;

package/src/io/loader/index.ts

@@ -1,4 +1,4 @@
-export * from './ClassDescriptionParser';
-export * from './ClassDescriptor';
-export * from './ClassLoader';
-export * from './ModuleLoader';
+export * from './ClassDescriptionParser.js';
+export * from './ClassDescriptor.js';
+export * from './ClassLoader.js';
+export * from './ModuleLoader.js';

package/src/io/reflection/index.ts

@@ -1,2 +1,2 @@
-export * from './has';
-export * from './ValueInspector';
+export * from './has.js';
+export * from './ValueInspector.js';

package/src/io/stringified.ts

@@ -1,8 +1,8 @@
 import { inspect } from 'node:util';
 
-import type { Answerable } from '../screenplay/Answerable';
-import { Question } from '../screenplay/Question';
-import { ValueInspector } from './reflection/ValueInspector';
+import type { Answerable } from '../screenplay/Answerable.js';
+import { Question } from '../screenplay/Question.js';
+import { ValueInspector } from './reflection/ValueInspector.js';
 
 const indentationPrefix = '  ';
 

package/src/model/ActivityDetails.ts

@@ -1,8 +1,8 @@
 import type { JSONObject} from 'tiny-types';
 import { ensure, isDefined, TinyType } from 'tiny-types';
 
-import { FileSystemLocation } from '../io/FileSystemLocation';
-import { Name } from './Name';
+import { FileSystemLocation } from '../io/FileSystemLocation.js';
+import { Name } from './Name.js';
 
 export class ActivityDetails extends TinyType {
     static fromJSON(o: JSONObject): ActivityDetails {

package/src/model/Artifact.ts

@@ -1,8 +1,8 @@
 import type { JSONObject} from 'tiny-types';
 import { ensure, isDefined, isString, Predicate, TinyType } from 'tiny-types';
 
-import { LogicError } from '../errors';
-import * as artifacts from './artifacts';
+import { LogicError } from '../errors/index.js';
+import * as artifacts from './artifacts/index.js';
 
 export interface SerialisedArtifact extends JSONObject {
     type: string;

package/src/model/BusinessRule.ts

@@ -1,8 +1,8 @@
 import type { JSONObject} from 'tiny-types';
 import { ensure, isDefined, TinyType } from 'tiny-types';
 
-import { Description } from './Description';
-import { Name } from './Name';
+import { Description } from './Description.js';
+import { Name } from './Name.js';
 
 export class BusinessRule extends TinyType {
     static fromJSON(o: JSONObject): BusinessRule {

package/src/model/CorrelationIdFactory.ts

@@ -1,4 +1,4 @@
-import type { CorrelationId } from './CorrelationId';
+import type { CorrelationId } from './CorrelationId.js';
 
 export interface CorrelationIdFactory {
     /**

package/src/model/ScenarioDetails.ts

@@ -1,9 +1,9 @@
 import type { JSONObject} from 'tiny-types';
 import { ensure, isDefined, TinyType } from 'tiny-types';
 
-import { FileSystemLocation } from '../io';
-import { Category } from './Category';
-import { Name } from './Name';
+import { FileSystemLocation } from '../io/index.js';
+import { Category } from './Category.js';
+import { Name } from './Name.js';
 
 export class ScenarioDetails extends TinyType {
     static fromJSON(o: JSONObject): ScenarioDetails {

package/src/model/ScenarioParameters.ts

@@ -1,8 +1,8 @@
 import type { JSONObject} from 'tiny-types';
 import { ensure, isDefined, TinyType } from 'tiny-types';
 
-import { Description } from './Description';
-import { Name } from './Name';
+import { Description } from './Description.js';
+import { Name } from './Name.js';
 
 export class ScenarioParameters extends TinyType {
     public static fromJSON(o: JSONObject): ScenarioParameters {

package/src/model/TestSuiteDetails.ts

@@ -1,9 +1,9 @@
 import type { JSONObject} from 'tiny-types';
 import { TinyType } from 'tiny-types';
 
-import { FileSystemLocation } from '../io';
-import { CorrelationId } from './CorrelationId';
-import { Name } from './Name';
+import { FileSystemLocation } from '../io/index.js';
+import { CorrelationId } from './CorrelationId.js';
+import { Name } from './Name.js';
 
 export class TestSuiteDetails extends TinyType {
     static fromJSON(o: JSONObject): TestSuiteDetails {

package/src/model/artifacts/HTTPRequestResponse.ts

@@ -1,6 +1,6 @@
 import type { JSONObject } from 'tiny-types';
 
-import { JSONData } from './JSONData';
+import { JSONData } from './JSONData.js';
 
 /**
  * The value of the `HTTPRequestResponse` artifact describing an HTTP request/response pair.

package/src/model/artifacts/JSONData.ts

@@ -1,6 +1,6 @@
 import type { JSONValue } from 'tiny-types';
 
-import { Artifact } from '../Artifact';
+import { Artifact } from '../Artifact.js';
 
 export class JSONData extends Artifact {
     static fromJSON(value: JSONValue): JSONData {

package/src/model/artifacts/LogEntry.ts

@@ -1,4 +1,4 @@
-import { JSONData } from './JSONData';
+import { JSONData } from './JSONData.js';
 
 export class LogEntry extends JSONData {
     static fromJSON(value: { data: string }): LogEntry {

package/src/model/artifacts/Photo.ts

@@ -1,4 +1,4 @@
-import { Artifact } from '../Artifact';
+import { Artifact } from '../Artifact.js';
 
 /**
  * @public

package/src/model/artifacts/TestReport.ts

@@ -1,6 +1,6 @@
 import type { JSONObject } from 'tiny-types';
 
-import { Artifact } from '../Artifact';
+import { Artifact } from '../Artifact.js';
 
 export class TestReport extends Artifact {
 

package/src/model/artifacts/TextData.ts

@@ -1,4 +1,4 @@
-import { JSONData } from './JSONData';
+import { JSONData } from './JSONData.js';
 
 export class TextData extends JSONData {
     static fromJSON(value: { contentType: string, data: string }): TextData {

package/src/model/artifacts/index.ts

@@ -1,6 +1,6 @@
-export * from './HTTPRequestResponse';
-export * from './JSONData';
-export * from './LogEntry';
-export * from './Photo';
-export * from './TestReport';
-export * from './TextData';
+export * from './HTTPRequestResponse.js';
+export * from './JSONData.js';
+export * from './LogEntry.js';
+export * from './Photo.js';
+export * from './TestReport.js';
+export * from './TextData.js';

package/src/model/index.ts

@@ -1,16 +1,16 @@
 /* eslint-disable simple-import-sort/exports */
 
-export * from './ActivityDetails';
-export * from './artifacts';
-export * from './Artifact';
-export * from './BusinessRule';
-export * from './Category';
-export * from './CorrelationId';
-export * from './CorrelationIdFactory';
-export * from './Description';
-export * from './Name';
-export * from './outcomes';
-export * from './ScenarioDetails';
-export * from './ScenarioParameters';
-export * from './tags';
-export * from './TestSuiteDetails';
+export * from './ActivityDetails.js';
+export * from './artifacts/index.js';
+export * from './Artifact.js';
+export * from './BusinessRule.js';
+export * from './Category.js';
+export * from './CorrelationId.js';
+export * from './CorrelationIdFactory.js';
+export * from './Description.js';
+export * from './Name.js';
+export * from './outcomes.js';
+export * from './ScenarioDetails.js';
+export * from './ScenarioParameters.js';
+export * from './tags/index.js';
+export * from './TestSuiteDetails.js';

package/src/model/outcomes.ts

@@ -2,8 +2,8 @@
 import type { JSONObject} from 'tiny-types';
 import { match, TinyType } from 'tiny-types';
 
-import type { AssertionError} from '../errors';
-import { ErrorSerialiser } from '../errors';
+import type { AssertionError} from '../errors/index.js';
+import { ErrorSerialiser } from '../errors/index.js';
 
 export interface SerialisedOutcome extends JSONObject {
     code:    number;
@@ -11,6 +11,50 @@ export interface SerialisedOutcome extends JSONObject {
 }
 
 export abstract class Outcome extends TinyType {
+
+    /**
+     * Symbol used to brand Outcome instances for cross-module instanceof checks.
+     * This addresses the dual-package hazard where the same class loaded from
+     * both ESM and CJS creates distinct constructor functions.
+     */
+    private static readonly TYPE_BRAND = Symbol.for('@serenity-js/core/Outcome');
+
+    /**
+     * Custom instanceof check that works across module boundaries.
+     * This addresses the dual-package hazard where the same class loaded from
+     * both ESM and CJS creates distinct constructor functions.
+     *
+     * The check walks up the prototype chain of the instance and compares
+     * constructor names, which remain consistent across module boundaries.
+     */
+    static [Symbol.hasInstance](instance: unknown): boolean {
+        if (instance === null || typeof instance !== 'object') {
+            return false;
+        }
+
+        // First, verify this is an Outcome instance using the brand
+        if ((instance as any)[Outcome.TYPE_BRAND] !== true) {
+            return false;
+        }
+
+        // When checking against the base Outcome class, any branded instance qualifies
+        if (this.name === 'Outcome') {
+            return true;
+        }
+
+        // For subclass checks, walk the prototype chain and compare by name
+        // This works across ESM/CJS boundaries where constructor references differ
+        let proto = Object.getPrototypeOf(instance);
+        while (proto !== null) {
+            if (proto.constructor?.name === this.name) {
+                return true;
+            }
+            proto = Object.getPrototypeOf(proto);
+        }
+
+        return false;
+    }
+
     static fromJSON = (o: SerialisedOutcome) => match(o.code)
         .when(ExecutionCompromised.Code,                _ => ExecutionCompromised.fromJSON(o))
         .when(ExecutionFailedWithError.Code,            _ => ExecutionFailedWithError.fromJSON(o))
@@ -23,6 +67,8 @@ export abstract class Outcome extends TinyType {
 
     protected constructor(protected readonly code: number) {
         super();
+        // Brand the instance for cross-module instanceof checks
+        (this as any)[Outcome.TYPE_BRAND] = true;
     }
 
     isWorseThan(another: Outcome | { Code: number }): boolean {

package/src/model/tags/ArbitraryTag.ts

@@ -1,4 +1,4 @@
-import { Tag } from './Tag';
+import { Tag } from './Tag.js';
 
 /**
  * Tagged with an arbitrary tag that doesn't have any special interpretation

package/src/model/tags/BrowserTag.ts

@@ -1,6 +1,6 @@
 import type { JSONObject } from 'tiny-types';
 
-import { Tag } from './Tag';
+import { Tag } from './Tag.js';
 
 /**
  * @access public