@serenity-js/core 3.41.2 → 3.42.1

package/esm/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 [stage crew members](https://serenity-js.org/api/core/interface/StageCrewMember/) passed to [`SerenityConfig`](https://serenity-js.org/api/core/class/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/esm/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/esm/config/ClassDescription.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=ClassDescription.js.map

package/esm/config/ClassDescription.js.map

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

package/esm/config/SerenityConfig.d.ts

@@ -0,0 +1,75 @@
+import type { OutputStream } from '../adapter/index.js';
+import type { DiffFormatter } from '../errors/index.js';
+import type { Duration } from '../screenplay/index.js';
+import type { Cast, StageCrewMember, StageCrewMemberBuilder } from '../stage/index.js';
+import type { ClassDescription } from './ClassDescription.js';
+/**
+ * Describes the configuration object accepted by the [`configure`](https://serenity-js.org/api/core/function/configure/) function.
+ *
+ * ## Learn more
+ * - [`configure`](https://serenity-js.org/api/core/function/configure/)
+ * - [`Cast`](https://serenity-js.org/api/core/class/Cast/)
+ * - [`StageCrewMember`](https://serenity-js.org/api/core/interface/StageCrewMember/)
+ * - [`StageCrewMember`](https://serenity-js.org/api/core/interface/StageCrewMemberBuilder/)
+ * - [`ClassDescription`](https://serenity-js.org/api/core/#ClassDescription)
+ * - [`Stage.waitForNextCue`](https://serenity-js.org/api/core/class/Stage/#waitForNextCue)
+ *
+ * @group Serenity
+ */
+export declare abstract class SerenityConfig {
+    /**
+     * A [cast](https://serenity-js.org/api/core/class/Cast/) of [actors](https://serenity-js.org/api/core/class/Actor/) to be used when [`actorCalled`](https://serenity-js.org/api/core/function/actorCalled/)
+     * and [`actorInTheSpotlight`](https://serenity-js.org/api/core/function/actorInTheSpotlight/) functions are called.
+     */
+    actors?: Cast;
+    /**
+     * A list of [stage crew member builders](https://serenity-js.org/api/core/interface/StageCrewMemberBuilder/) or [stage crew members](https://serenity-js.org/api/core/interface/StageCrewMember/)
+     * to be notified of [Serenity/JS domain events](https://serenity-js.org/api/core-events/class/DomainEvent/) that occur during the scenario execution.
+     *
+     * Note that the `crew` can also be configured using [class descriptions](https://serenity-js.org/api/core/#ClassDescription).
+     * 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 [SceneFinishes](https://serenity-js.org/api/core-events/class/SceneFinishes/) and [SceneFinished](https://serenity-js.org/api/core-events/class/SceneFinished/) events
+     * that Serenity/JS should wait for any post-scenario
+     * async operations to complete. Those include generating the screenshots,
+     * saving reports to disk, [dismissing the actors](https://serenity-js.org/api/core/interface/Discardable/), 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 [`Wait.until`](https://serenity-js.org/api/core/class/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
+     * - [`Wait.until`](https://serenity-js.org/api/core/class/Wait/#until)
+     */
+    interactionTimeout?: Duration;
+    /**
+     * [`DiffFormatter`](https://serenity-js.org/api/core/interface/DiffFormatter/) that
+     * should be used by the [`ErrorFactory`](https://serenity-js.org/api/core/class/ErrorFactory/) and the ability
+     * to [`RaiseErrors`](https://serenity-js.org/api/core/class/RaiseErrors/)
+     * when generating diffs included in [`RuntimeError`](https://serenity-js.org/api/core/class/RuntimeError/) objects.
+     *
+     * By default, Serenity/JS uses [`NoOpDiffFormatter`](https://serenity-js.org/api/core/class/NoOpDiffFormatter/)
+     */
+    diffFormatter?: DiffFormatter;
+    /**
+     * An output stream to be injected into [stage crew member builders](https://serenity-js.org/api/core/interface/StageCrewMemberBuilder/)
+     *
+     * Defaults to [`process.stdout`](https://nodejs.org/api/process.html#process_process_stdout).
+     */
+    outputStream?: OutputStream;
+}
+//# sourceMappingURL=SerenityConfig.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"SerenityConfig.d.ts","sourceRoot":"","sources":["../../src/config/SerenityConfig.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC;AACxD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AACxD,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,wBAAwB,CAAC;AACvD,OAAO,KAAK,EAAE,IAAI,EAAE,eAAe,EAAE,sBAAsB,EAAE,MAAM,mBAAmB,CAAC;AACvF,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AAE9D;;;;;;;;;;;;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;;;;;;;OAOG;IACH,aAAa,CAAC,EAAE,aAAa,CAAC;IAE9B;;;;OAIG;IACH,YAAY,CAAC,EAAE,YAAY,CAAC;CAC/B"}

package/esm/config/SerenityConfig.js

@@ -0,0 +1,70 @@
+/**
+ * Describes the configuration object accepted by the [`configure`](https://serenity-js.org/api/core/function/configure/) function.
+ *
+ * ## Learn more
+ * - [`configure`](https://serenity-js.org/api/core/function/configure/)
+ * - [`Cast`](https://serenity-js.org/api/core/class/Cast/)
+ * - [`StageCrewMember`](https://serenity-js.org/api/core/interface/StageCrewMember/)
+ * - [`StageCrewMember`](https://serenity-js.org/api/core/interface/StageCrewMemberBuilder/)
+ * - [`ClassDescription`](https://serenity-js.org/api/core/#ClassDescription)
+ * - [`Stage.waitForNextCue`](https://serenity-js.org/api/core/class/Stage/#waitForNextCue)
+ *
+ * @group Serenity
+ */
+export class SerenityConfig {
+    /**
+     * A [cast](https://serenity-js.org/api/core/class/Cast/) of [actors](https://serenity-js.org/api/core/class/Actor/) to be used when [`actorCalled`](https://serenity-js.org/api/core/function/actorCalled/)
+     * and [`actorInTheSpotlight`](https://serenity-js.org/api/core/function/actorInTheSpotlight/) functions are called.
+     */
+    actors;
+    /**
+     * A list of [stage crew member builders](https://serenity-js.org/api/core/interface/StageCrewMemberBuilder/) or [stage crew members](https://serenity-js.org/api/core/interface/StageCrewMember/)
+     * to be notified of [Serenity/JS domain events](https://serenity-js.org/api/core-events/class/DomainEvent/) that occur during the scenario execution.
+     *
+     * Note that the `crew` can also be configured using [class descriptions](https://serenity-js.org/api/core/#ClassDescription).
+     * 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;
+    /**
+     * The maximum amount of time between [SceneFinishes](https://serenity-js.org/api/core-events/class/SceneFinishes/) and [SceneFinished](https://serenity-js.org/api/core-events/class/SceneFinished/) events
+     * that Serenity/JS should wait for any post-scenario
+     * async operations to complete. Those include generating the screenshots,
+     * saving reports to disk, [dismissing the actors](https://serenity-js.org/api/core/interface/Discardable/), 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;
+    /**
+     * The maximum default amount of time allowed for interactions such as [`Wait.until`](https://serenity-js.org/api/core/class/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
+     * - [`Wait.until`](https://serenity-js.org/api/core/class/Wait/#until)
+     */
+    interactionTimeout;
+    /**
+     * [`DiffFormatter`](https://serenity-js.org/api/core/interface/DiffFormatter/) that
+     * should be used by the [`ErrorFactory`](https://serenity-js.org/api/core/class/ErrorFactory/) and the ability
+     * to [`RaiseErrors`](https://serenity-js.org/api/core/class/RaiseErrors/)
+     * when generating diffs included in [`RuntimeError`](https://serenity-js.org/api/core/class/RuntimeError/) objects.
+     *
+     * By default, Serenity/JS uses [`NoOpDiffFormatter`](https://serenity-js.org/api/core/class/NoOpDiffFormatter/)
+     */
+    diffFormatter;
+    /**
+     * An output stream to be injected into [stage crew member builders](https://serenity-js.org/api/core/interface/StageCrewMemberBuilder/)
+     *
+     * Defaults to [`process.stdout`](https://nodejs.org/api/process.html#process_process_stdout).
+     */
+    outputStream;
+}
+//# sourceMappingURL=SerenityConfig.js.map

package/esm/config/SerenityConfig.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"SerenityConfig.js","sourceRoot":"","sources":["../../src/config/SerenityConfig.ts"],"names":[],"mappings":"AAMA;;;;;;;;;;;;GAYG;AACH,MAAM,OAAgB,cAAc;IAEhC;;;OAGG;IACH,MAAM,CAAQ;IAEd;;;;;;;OAOG;IACH,IAAI,CAAsE;IAE1E;;;;;;;;;;OAUG;IACH,UAAU,CAAY;IAEtB;;;;;;;;;;;OAWG;IACH,kBAAkB,CAAY;IAE9B;;;;;;;OAOG;IACH,aAAa,CAAiB;IAE9B;;;;OAIG;IACH,YAAY,CAAgB;CAC/B"}

package/esm/config/index.d.ts

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

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

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

package/esm/config/index.js

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

package/esm/config/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/config/index.ts"],"names":[],"mappings":"AAAA,cAAc,uBAAuB,CAAC;AACtC,cAAc,qBAAqB,CAAC"}

package/esm/errors/ErrorFactory.d.ts

@@ -0,0 +1,17 @@
+import type { DiffFormatter } from './diff/index.js';
+import type { ErrorOptions } from './ErrorOptions.js';
+import type { RuntimeError } from './model/index.js';
+/**
+ * Generates Serenity/JS [`RuntimeError`](https://serenity-js.org/api/core/class/RuntimeError/) objects based
+ * on the provided [configuration](https://serenity-js.org/api/core/interface/ErrorOptions/).
+ *
+ * @group Errors
+ */
+export declare class ErrorFactory {
+    private readonly formatter;
+    constructor(formatter?: DiffFormatter);
+    create<RE extends RuntimeError>(errorType: new (...args: any[]) => RE, options: ErrorOptions): RE;
+    private title;
+    private diffFrom;
+}
+//# sourceMappingURL=ErrorFactory.d.ts.map

package/esm/errors/ErrorFactory.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ErrorFactory.d.ts","sourceRoot":"","sources":["../../src/errors/ErrorFactory.ts"],"names":[],"mappings":"AASA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AACrD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AACtD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAC;AAErD;;;;;GAKG;AACH,qBAAa,YAAY;IAET,OAAO,CAAC,QAAQ,CAAC,SAAS;gBAAT,SAAS,GAAE,aAAuC;IAG/E,MAAM,CAAC,EAAE,SAAS,YAAY,EAAE,SAAS,EAAE,KAAK,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,YAAY,GAAG,EAAE;IAcjG,OAAO,CAAC,KAAK;IAIb,OAAO,CAAC,QAAQ;CAMnB"}

package/esm/errors/ErrorFactory.js

@@ -0,0 +1,244 @@
+import { types } from 'node:util';
+import { diffArrays, diffJson } from 'diff';
+import { equal } from 'tiny-types/lib/objects/equal.js';
+import { inspected, ValueInspector } from '../io/index.js';
+import { Unanswered } from '../screenplay/questions/Unanswered.js';
+import { AnsiDiffFormatter } from './diff/AnsiDiffFormatter.js';
+/**
+ * Generates Serenity/JS [`RuntimeError`](https://serenity-js.org/api/core/class/RuntimeError/) objects based
+ * on the provided [configuration](https://serenity-js.org/api/core/interface/ErrorOptions/).
+ *
+ * @group Errors
+ */
+export class ErrorFactory {
+    formatter;
+    constructor(formatter = new AnsiDiffFormatter()) {
+        this.formatter = formatter;
+    }
+    create(errorType, options) {
+        const message = [
+            this.title(options.message),
+            options.expectation && `\nExpectation: ${options.expectation}`,
+            options.diff && ('\n' + this.diffFrom(options.diff)),
+            options.location && (`    at ${options.location.path.value}:${options.location.line}:${options.location.column}`),
+        ].
+            filter(Boolean).
+            join('\n');
+        return new errorType(message, options?.cause);
+    }
+    title(value) {
+        return String(value).trim();
+    }
+    diffFrom(diff) {
+        return new Diff(diff.expected, diff.actual)
+            .lines()
+            .map(line => line.decorated(this.formatter))
+            .join('\n');
+    }
+}
+class DiffLine {
+    type;
+    value;
+    static markers = {
+        'expected': '- ',
+        'received': '+ ',
+        'unchanged': '  ',
+    };
+    static empty = () => new DiffLine('unchanged', '');
+    static unchanged = (line) => new DiffLine('unchanged', String(line));
+    static expected = (line) => new DiffLine('expected', String(line));
+    static received = (line) => new DiffLine('received', String(line));
+    static changed = (change, line) => {
+        if (change.removed) {
+            return this.expected(line);
+        }
+        if (change.added) {
+            return this.received(line);
+        }
+        return this.unchanged(line);
+    };
+    constructor(type, value) {
+        this.type = type;
+        this.value = value;
+    }
+    prependMarker() {
+        return this.prepend(this.marker());
+    }
+    appendMarker() {
+        return this.append(this.marker());
+    }
+    prepend(text) {
+        return new DiffLine(this.type, String(text) + this.value);
+    }
+    append(text) {
+        return new DiffLine(this.type, this.value + String(text));
+    }
+    decorated(decorator) {
+        return decorator[this.type](this.value);
+    }
+    marker() {
+        return DiffLine.markers[this.type];
+    }
+}
+class DiffValue {
+    value;
+    nameAndType;
+    summary;
+    changes;
+    desiredNameFieldLength;
+    constructor(name, value) {
+        this.value = value;
+        this.nameAndType = `${name} ${ValueInspector.typeOf(value)}`;
+        this.desiredNameFieldLength = this.nameAndType.length;
+        this.summary = this.summaryOf(value);
+    }
+    withDesiredFieldLength(columns) {
+        this.desiredNameFieldLength = columns;
+        return this;
+    }
+    hasSummary() {
+        return this.summary !== undefined;
+    }
+    type() {
+        return ValueInspector.typeOf(this.value);
+    }
+    isComplex() {
+        return (typeof this.value === 'object' || types.isProxy(this.value))
+            && !(this.value instanceof RegExp)
+            && !(this.value instanceof Unanswered);
+    }
+    isArray() {
+        return Array.isArray(this.value);
+    }
+    isComparableAsJson() {
+        if (!this.value || this.value instanceof Unanswered) {
+            return false;
+        }
+        return ValueInspector.isPlainObject(this.value)
+            || this.value['toJSON'];
+    }
+    toString() {
+        const labelWidth = this.desiredNameFieldLength - this.nameAndType.length;
+        return [
+            this.nameAndType,
+            this.summary && ': '.padEnd(labelWidth + 2),
+            this.summary,
+            this.changes && this.changes.padStart(labelWidth + 5),
+        ].
+            filter(Boolean).
+            join('');
+    }
+    summaryOf(value) {
+        if (value instanceof Date) {
+            return value.toISOString();
+        }
+        const isDefined = value !== undefined && value !== null;
+        if (isDefined && (ValueInspector.isPrimitive(value) || value instanceof RegExp)) {
+            return String(value);
+        }
+        return undefined;
+    }
+}
+class Diff {
+    diff;
+    constructor(expectedValue, actualValue) {
+        this.diff = this.diffFrom(expectedValue, actualValue);
+    }
+    diffFrom(expectedValue, actualValue) {
+        const { expected, actual } = this.aligned(new DiffValue('Expected', expectedValue), new DiffValue('Received', actualValue));
+        if (this.shouldRenderActualValueOnly(expected, actual)) {
+            return this.renderActualValue(expected, actual);
+        }
+        if (this.shouldRenderJsonDiff(expected, actual)) {
+            return this.renderJsonDiff(expected, actual);
+        }
+        if (this.shouldRenderArrayDiff(expected, actual)) {
+            return this.renderArrayDiff(expected, actual);
+        }
+        return [
+            DiffLine.expected(expected),
+            DiffLine.received(actual),
+            DiffLine.empty(),
+        ];
+    }
+    shouldRenderActualValueOnly(expected, actual) {
+        return actual.isComplex()
+            && !actual.hasSummary()
+            && expected.type() !== actual.type();
+    }
+    shouldRenderJsonDiff(expected, actual) {
+        return expected.isComparableAsJson()
+            && actual.isComparableAsJson()
+            && !expected.hasSummary()
+            && !actual.hasSummary();
+    }
+    shouldRenderArrayDiff(expected, actual) {
+        return expected.isArray()
+            && actual.isArray();
+    }
+    aligned(expected, actual) {
+        const maxFieldLength = Math.max(expected.desiredNameFieldLength, actual.desiredNameFieldLength);
+        return {
+            expected: expected.withDesiredFieldLength(maxFieldLength),
+            actual: actual.withDesiredFieldLength(maxFieldLength)
+        };
+    }
+    renderActualValue(expected, actual) {
+        const lines = inspected(actual.value)
+            .split('\n')
+            .map(DiffLine.unchanged);
+        return [
+            DiffLine.expected(expected),
+            DiffLine.received(actual),
+            DiffLine.empty(),
+            ...lines,
+            DiffLine.empty(),
+        ];
+    }
+    renderJsonDiff(expected, actual) {
+        const changes = diffJson(expected.value, actual.value);
+        const lines = changes.reduce((acc, change) => {
+            const changedLines = change.value.trimEnd().split('\n');
+            return acc.concat(changedLines.map(line => DiffLine.changed(change, line).prependMarker()));
+        }, []);
+        const { added, removed } = this.countOf(changes);
+        return [
+            DiffLine.expected(expected).append('  ').appendMarker().append(`${removed}`),
+            DiffLine.received(actual).append('  ').appendMarker().append(`${added}`),
+            DiffLine.empty(),
+            ...lines,
+            DiffLine.empty(),
+        ];
+    }
+    renderArrayDiff(expected, actual) {
+        const changes = diffArrays(expected.value, actual.value, { comparator: equal });
+        const lines = changes.reduce((acc, change) => {
+            const items = change.value;
+            return acc.concat(items.map(item => DiffLine.changed(change, inspected(item, { compact: true }))
+                .prepend('  ')
+                .prependMarker()));
+        }, []);
+        const { added, removed } = this.countOf(changes);
+        return [
+            DiffLine.expected(expected).append('  ').appendMarker().append(`${removed}`),
+            DiffLine.received(actual).append('  ').appendMarker().append(`${added}`),
+            DiffLine.empty(),
+            DiffLine.unchanged('  ['),
+            ...lines,
+            DiffLine.unchanged('  ]'),
+            DiffLine.empty(),
+        ];
+    }
+    countOf(changes) {
+        return changes.reduce(({ removed, added }, change) => {
+            return {
+                removed: removed + (change.removed ? change.count : 0),
+                added: added + (change.added ? change.count : 0),
+            };
+        }, { removed: 0, added: 0 });
+    }
+    lines() {
+        return this.diff;
+    }
+}
+//# sourceMappingURL=ErrorFactory.js.map

package/esm/errors/ErrorFactory.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ErrorFactory.js","sourceRoot":"","sources":["../../src/errors/ErrorFactory.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,WAAW,CAAC;AAGlC,OAAO,EAAE,UAAU,EAAE,QAAQ,EAAE,MAAM,MAAM,CAAC;AAC5C,OAAO,EAAE,KAAK,EAAE,MAAM,iCAAiC,CAAC;AAExD,OAAO,EAAE,SAAS,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAC3D,OAAO,EAAE,UAAU,EAAE,MAAM,uCAAuC,CAAC;AACnE,OAAO,EAAE,iBAAiB,EAAE,MAAM,6BAA6B,CAAC;AAKhE;;;;;GAKG;AACH,MAAM,OAAO,YAAY;IAEQ;IAA7B,YAA6B,YAA2B,IAAI,iBAAiB,EAAE;QAAlD,cAAS,GAAT,SAAS,CAAyC;IAC/E,CAAC;IAED,MAAM,CAA0B,SAAqC,EAAE,OAAqB;QAExF,MAAM,OAAO,GAAG;YACZ,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC;YAC3B,OAAO,CAAC,WAAW,IAAI,kBAAmB,OAAO,CAAC,WAAY,EAAE;YAChE,OAAO,CAAC,IAAI,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;YACpD,OAAO,CAAC,QAAQ,IAAI,CAAC,UAAW,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAM,IAAK,OAAO,CAAC,QAAQ,CAAC,IAAK,IAAK,OAAO,CAAC,QAAQ,CAAC,MAAO,EAAE,CAAC;SAC1H;YACD,MAAM,CAAC,OAAO,CAAC;YACf,IAAI,CAAC,IAAI,CAAC,CAAC;QAEX,OAAO,IAAI,SAAS,CAAC,OAAO,EAAE,OAAO,EAAE,KAAK,CAAkB,CAAC;IACnE,CAAC;IAEO,KAAK,CAAC,KAAa;QACvB,OAAO,MAAM,CAAC,KAAK,CAAC,CAAC,IAAI,EAAE,CAAC;IAChC,CAAC;IAEO,QAAQ,CAAC,IAA4C;QACzD,OAAO,IAAI,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,MAAM,CAAC;aACtC,KAAK,EAAE;aACP,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;aAC3C,IAAI,CAAC,IAAI,CAAC,CAAC;IACpB,CAAC;CACJ;AAID,MAAM,QAAQ;IAgCW;IACA;IAhCb,MAAM,CAAC,OAAO,GAA6B;QAC/C,UAAU,EAAG,IAAI;QACjB,UAAU,EAAG,IAAI;QACjB,WAAW,EAAE,IAAI;KACpB,CAAA;IAED,MAAM,CAAC,KAAK,GAAG,GAAG,EAAE,CAChB,IAAI,QAAQ,CAAC,WAAW,EAAE,EAAE,CAAC,CAAC;IAElC,MAAM,CAAC,SAAS,GAAG,CAAC,IAAS,EAAE,EAAE,CAC7B,IAAI,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC;IAE5C,MAAM,CAAC,QAAQ,GAAG,CAAC,IAAS,EAAE,EAAE,CAC5B,IAAI,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC;IAE3C,MAAM,CAAC,QAAQ,GAAG,CAAC,IAAS,EAAE,EAAE,CAC5B,IAAI,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC;IAE3C,MAAM,CAAC,OAAO,GAAG,CAAC,MAAiC,EAAE,IAAY,EAAE,EAAE;QACjE,IAAI,MAAM,CAAC,OAAO,EAAE,CAAC;YACjB,OAAO,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QAC/B,CAAC;QAED,IAAI,MAAM,CAAC,KAAK,EAAE,CAAC;YACf,OAAO,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QAC/B,CAAC;QAED,OAAO,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;IAChC,CAAC,CAAA;IAED,YACqB,IAAc,EACd,KAAa;QADb,SAAI,GAAJ,IAAI,CAAU;QACd,UAAK,GAAL,KAAK,CAAQ;IAElC,CAAC;IAED,aAAa;QACT,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC;IACvC,CAAC;IAED,YAAY;QACR,OAAO,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC;IACtC,CAAC;IAED,OAAO,CAAC,IAAS;QACb,OAAO,IAAI,QAAQ,CAAC,IAAI,CAAC,IAAI,EAAE,MAAM,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC;IAC9D,CAAC;IAED,MAAM,CAAC,IAAS;QACZ,OAAO,IAAI,QAAQ,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,KAAK,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC;IAC9D,CAAC;IAED,SAAS,CAAC,SAAwB;QAC9B,OAAO,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAC5C,CAAC;IAEO,MAAM;QACV,OAAO,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACvC,CAAC;;AAGL,MAAM,SAAS;IASS;IARZ,WAAW,CAAS;IACX,OAAO,CAAU;IAC1B,OAAO,CAAU;IAElB,sBAAsB,CAAS;IAEtC,YACI,IAAY,EACI,KAAc;QAAd,UAAK,GAAL,KAAK,CAAS;QAE9B,IAAI,CAAC,WAAW,GAAc,GAAI,IAAK,IAAK,cAAc,CAAC,MAAM,CAAC,KAAK,CAAE,EAAE,CAAC;QAC5E,IAAI,CAAC,sBAAsB,GAAG,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC;QACtD,IAAI,CAAC,OAAO,GAAkB,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;IACxD,CAAC;IAED,sBAAsB,CAAC,OAAe;QAClC,IAAI,CAAC,sBAAsB,GAAG,OAAO,CAAC;QACtC,OAAO,IAAI,CAAC;IAChB,CAAC;IAED,UAAU;QACN,OAAO,IAAI,CAAC,OAAO,KAAK,SAAS,CAAC;IACtC,CAAC;IAED,IAAI;QACA,OAAO,cAAc,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAC7C,CAAC;IAED,SAAS;QACL,OAAO,CAAC,OAAO,IAAI,CAAC,KAAK,KAAK,QAAQ,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;eAC7D,CAAE,CAAC,IAAI,CAAC,KAAK,YAAY,MAAM,CAAC;eAChC,CAAE,CAAC,IAAI,CAAC,KAAK,YAAY,UAAU,CAAC,CAAC;IAChD,CAAC;IAED,OAAO;QACH,OAAO,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IACrC,CAAC;IAED,kBAAkB;QACd,IAAI,CAAE,IAAI,CAAC,KAAK,IAAI,IAAI,CAAC,KAAK,YAAY,UAAU,EAAE,CAAC;YACnD,OAAO,KAAK,CAAC;QACjB,CAAC;QAED,OAAO,cAAc,CAAC,aAAa,CAAC,IAAI,CAAC,KAAK,CAAC;eACxC,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;IAChC,CAAC;IAED,QAAQ;QACJ,MAAM,UAAU,GAAG,IAAI,CAAC,sBAAsB,GAAG,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC;QAEzE,OAAO;YACH,IAAI,CAAC,WAAW;YAChB,IAAI,CAAC,OAAO,IAAI,IAAI,CAAC,MAAM,CAAC,UAAU,GAAG,CAAC,CAAC;YAC3C,IAAI,CAAC,OAAO;YACZ,IAAI,CAAC,OAAO,IAAI,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,UAAU,GAAG,CAAC,CAAC;SACxD;YACD,MAAM,CAAC,OAAO,CAAC;YACf,IAAI,CAAC,EAAE,CAAC,CAAC;IACb,CAAC;IAEO,SAAS,CAAC,KAAc;QAC5B,IAAI,KAAK,YAAY,IAAI,EAAE,CAAC;YACxB,OAAO,KAAK,CAAC,WAAW,EAAE,CAAC;QAC/B,CAAC;QAED,MAAM,SAAS,GAAG,KAAK,KAAK,SAAS,IAAI,KAAK,KAAK,IAAI,CAAC;QAExD,IAAI,SAAS,IAAI,CAAC,cAAc,CAAC,WAAW,CAAC,KAAK,CAAC,IAAI,KAAK,YAAY,MAAM,CAAC,EAAE,CAAC;YAC9E,OAAO,MAAM,CAAC,KAAK,CAAC,CAAC;QACzB,CAAC;QAED,OAAO,SAAS,CAAC;IACrB,CAAC;CACJ;AAED,MAAM,IAAI;IACW,IAAI,CAAa;IAElC,YACI,aAAsB,EACtB,WAAoB;QAEpB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,QAAQ,CAAC,aAAa,EAAE,WAAW,CAAC,CAAC;IAC1D,CAAC;IAEO,QAAQ,CAAC,aAAsB,EAAE,WAAoB;QACzD,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC,OAAO,CACrC,IAAI,SAAS,CAAC,UAAU,EAAE,aAAa,CAAC,EACxC,IAAI,SAAS,CAAC,UAAU,EAAE,WAAW,CAAC,CACzC,CAAC;QAEF,IAAI,IAAI,CAAC,2BAA2B,CAAC,QAAQ,EAAE,MAAM,CAAC,EAAE,CAAC;YACrD,OAAO,IAAI,CAAC,iBAAiB,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;QACpD,CAAC;QAED,IAAI,IAAI,CAAC,oBAAoB,CAAC,QAAQ,EAAE,MAAM,CAAC,EAAE,CAAC;YAC9C,OAAO,IAAI,CAAC,cAAc,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;QACjD,CAAC;QAED,IAAI,IAAI,CAAC,qBAAqB,CAAC,QAAQ,EAAE,MAAM,CAAC,EAAE,CAAC;YAC/C,OAAO,IAAI,CAAC,eAAe,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;QAClD,CAAC;QAED,OAAO;YACH,QAAQ,CAAC,QAAQ,CAAC,QAAQ,CAAC;YAC3B,QAAQ,CAAC,QAAQ,CAAC,MAAM,CAAC;YACzB,QAAQ,CAAC,KAAK,EAAE;SACnB,CAAA;IACL,CAAC;IAEO,2BAA2B,CAAC,QAAmB,EAAE,MAAiB;QACtE,OAAO,MAAM,CAAC,SAAS,EAAE;eAClB,CAAE,MAAM,CAAC,UAAU,EAAE;eACrB,QAAQ,CAAC,IAAI,EAAE,KAAK,MAAM,CAAC,IAAI,EAAE,CAAC;IAC7C,CAAC;IAEO,oBAAoB,CAAC,QAAmB,EAAE,MAAiB;QAC/D,OAAO,QAAQ,CAAC,kBAAkB,EAAE;eAC7B,MAAM,CAAC,kBAAkB,EAAE;eAC3B,CAAE,QAAQ,CAAC,UAAU,EAAE;eACvB,CAAE,MAAM,CAAC,UAAU,EAAE,CAAA;IAChC,CAAC;IAEO,qBAAqB,CAAC,QAAmB,EAAE,MAAiB;QAChE,OAAO,QAAQ,CAAC,OAAO,EAAE;eAClB,MAAM,CAAC,OAAO,EAAE,CAAC;IAC5B,CAAC;IAEO,OAAO,CAAC,QAAmB,EAAE,MAAiB;QAClD,MAAM,cAAc,GAAG,IAAI,CAAC,GAAG,CAC3B,QAAQ,CAAC,sBAAsB,EAC/B,MAAM,CAAC,sBAAsB,CAChC,CAAC;QAEF,OAAO;YACH,QAAQ,EAAE,QAAQ,CAAC,sBAAsB,CAAC,cAAc,CAAC;YACzD,MAAM,EAAI,MAAM,CAAC,sBAAsB,CAAC,cAAc,CAAC;SAC1D,CAAC;IACN,CAAC;IAEO,iBAAiB,CAAC,QAAmB,EAAE,MAAiB;QAE5D,MAAM,KAAK,GAAG,SAAS,CAAC,MAAM,CAAC,KAAK,CAAC;aAChC,KAAK,CAAC,IAAI,CAAC;aACX,GAAG,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC;QAE7B,OAAO;YACH,QAAQ,CAAC,QAAQ,CAAC,QAAQ,CAAC;YAC3B,QAAQ,CAAC,QAAQ,CAAC,MAAM,CAAC;YACzB,QAAQ,CAAC,KAAK,EAAE;YAChB,GAAG,KAAK;YACR,QAAQ,CAAC,KAAK,EAAE;SACnB,CAAC;IACN,CAAC;IAEO,cAAc,CAAC,QAAmB,EAAE,MAAiB;QACzD,MAAM,OAAO,GAAG,QAAQ,CAAC,QAAQ,CAAC,KAAe,EAAE,MAAM,CAAC,KAAe,CAAC,CAAC;QAE3E,MAAM,KAAK,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,MAAM,EAAE,EAAE;YACzC,MAAM,YAAY,GAAG,MAAM,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;YACxD,OAAO,GAAG,CAAC,MAAM,CACb,YAAY,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,QAAQ,CAAC,OAAO,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC,aAAa,EAAE,CAAC,CAC3E,CAAA;QACL,CAAC,EAAE,EAAE,CAAC,CAAC;QAEP,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QAEjD,OAAO;YACH,QAAQ,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,YAAY,EAAE,CAAC,MAAM,CAAC,GAAI,OAAQ,EAAE,CAAC;YAC9E,QAAQ,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,YAAY,EAAE,CAAC,MAAM,CAAC,GAAI,KAAM,EAAE,CAAC;YAC1E,QAAQ,CAAC,KAAK,EAAE;YAChB,GAAG,KAAK;YACR,QAAQ,CAAC,KAAK,EAAE;SACnB,CAAC;IACN,CAAC;IAEO,eAAe,CAAC,QAAmB,EAAE,MAAiB;QAC1D,MAAM,OAAO,GAAG,UAAU,CAAC,QAAQ,CAAC,KAAuB,EAAE,MAAM,CAAC,KAAuB,EAAE,EAAE,UAAU,EAAE,KAAK,EAAE,CAAE,CAAC;QAErH,MAAM,KAAK,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,MAAM,EAAE,EAAE;YACzC,MAAM,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC;YAC3B,OAAO,GAAG,CAAC,MAAM,CACb,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CACb,QAAQ,CAAC,OAAO,CAAC,MAAM,EAAE,SAAS,CAAC,IAAI,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC;iBACvD,OAAO,CAAC,IAAI,CAAC;iBACb,aAAa,EAAE,CACvB,CACJ,CAAC;QACN,CAAC,EAAE,EAAE,CAAC,CAAC;QAEP,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QAEjD,OAAO;YACH,QAAQ,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,YAAY,EAAE,CAAC,MAAM,CAAC,GAAI,OAAQ,EAAE,CAAC;YAC9E,QAAQ,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,YAAY,EAAE,CAAC,MAAM,CAAC,GAAI,KAAM,EAAE,CAAC;YAC1E,QAAQ,CAAC,KAAK,EAAE;YAChB,QAAQ,CAAC,SAAS,CAAC,KAAK,CAAC;YACzB,GAAG,KAAK;YACR,QAAQ,CAAC,SAAS,CAAC,KAAK,CAAC;YACzB,QAAQ,CAAC,KAAK,EAAE;SACnB,CAAA;IACL,CAAC;IAEO,OAAO,CAAC,OAA6C;QACzD,OAAO,OAAO,CAAC,MAAM,CAAC,CAAC,EAAE,OAAO,EAAE,KAAK,EAAE,EAAE,MAAM,EAAE,EAAE;YACjD,OAAO;gBACH,OAAO,EAAE,OAAO,GAAG,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;gBACtD,KAAK,EAAI,KAAK,GAAK,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;aACvD,CAAA;QACL,CAAC,EAAE,EAAE,OAAO,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,CAAC,CAAC;IACjC,CAAC;IAED,KAAK;QACD,OAAO,IAAI,CAAC,IAAI,CAAC;IACrB,CAAC;CACJ"}

package/esm/errors/ErrorOptions.d.ts

@@ -0,0 +1,16 @@
+import type { FileSystemLocation } from '../io/index.js';
+import type { ExpectationDetails } from '../screenplay/index.js';
+/**
+ * @group Errors
+ */
+export interface ErrorOptions {
+    message: string;
+    location?: FileSystemLocation;
+    expectation?: ExpectationDetails;
+    diff?: {
+        expected: unknown;
+        actual: unknown;
+    };
+    cause?: Error;
+}
+//# sourceMappingURL=ErrorOptions.d.ts.map

package/esm/errors/ErrorOptions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ErrorOptions.d.ts","sourceRoot":"","sources":["../../src/errors/ErrorOptions.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,gBAAgB,CAAC;AACzD,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,wBAAwB,CAAC;AAEjE;;GAEG;AACH,MAAM,WAAW,YAAY;IACzB,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,kBAAkB,CAAC;IAC9B,WAAW,CAAC,EAAE,kBAAkB,CAAC;IACjC,IAAI,CAAC,EAAE;QACH,QAAQ,EAAE,OAAO,CAAC;QAClB,MAAM,EAAE,OAAO,CAAC;KACnB,CAAC;IACF,KAAK,CAAC,EAAE,KAAK,CAAC;CACjB"}

package/esm/errors/ErrorOptions.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=ErrorOptions.js.map

package/esm/errors/ErrorOptions.js.map

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

package/esm/errors/ErrorSerialiser.d.ts

@@ -0,0 +1,14 @@
+import type { JSONObject } from 'tiny-types';
+/**
+ * @group Errors
+ */
+export declare class ErrorSerialiser {
+    private static readonly recognisedErrors;
+    static serialise(error: Error): string;
+    static registerErrorTypes(...types: Array<new (...args: any[]) => Error>): void;
+    static deserialise(serialised?: string | JSONObject): Error | undefined;
+    private static isSerialisable;
+    private static isDeserialisable;
+    static deserialiseFromStackTrace(stack: string): Error;
+}
+//# sourceMappingURL=ErrorSerialiser.d.ts.map

package/esm/errors/ErrorSerialiser.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ErrorSerialiser.d.ts","sourceRoot":"","sources":["../../src/errors/ErrorSerialiser.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAa,MAAM,YAAY,CAAC;AAGxD;;GAEG;AACH,qBAAa,eAAe;IACxB,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,gBAAgB,CAStC;IAEF,MAAM,CAAC,SAAS,CAAC,KAAK,EAAE,KAAK,GAAG,MAAM;IAiBtC,MAAM,CAAC,kBAAkB,CAAC,GAAG,KAAK,EAAE,KAAK,CAAC,KAAK,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,KAAK,CAAC,GAAG,IAAI;IAQ/E,MAAM,CAAC,WAAW,CAAC,UAAU,CAAC,EAAE,MAAM,GAAG,UAAU,GAAG,KAAK,GAAG,SAAS;IAwBvE,OAAO,CAAC,MAAM,CAAC,cAAc;IAK7B,OAAO,CAAC,MAAM,CAAC,gBAAgB;IAK/B,MAAM,CAAC,yBAAyB,CAAC,KAAK,EAAE,MAAM,GAAG,KAAK;CAWzD"}

package/esm/errors/ErrorSerialiser.js

@@ -0,0 +1,70 @@
+import { ensure, isDefined, isFunction } from 'tiny-types';
+/**
+ * @group Errors
+ */
+export class ErrorSerialiser {
+    static recognisedErrors = [
+        // Built-in JavaScript errors
+        Error,
+        EvalError,
+        RangeError,
+        ReferenceError,
+        SyntaxError,
+        TypeError,
+        URIError,
+    ];
+    static serialise(error) {
+        if (this.isSerialisable(error)) {
+            return JSON.stringify(error.toJSON(), undefined, 0);
+        }
+        const name = error && error.constructor && error.constructor.name
+            ? error.constructor.name
+            : error.name;
+        const serialisedError = Object.getOwnPropertyNames(error).reduce((serialised, key) => {
+            serialised[key] = error[key];
+            return serialised;
+        }, { name });
+        return JSON.stringify(serialisedError, undefined, 0);
+    }
+    static registerErrorTypes(...types) {
+        types.forEach(type => {
+            ErrorSerialiser.recognisedErrors.push(ensure(`Error type ${type}`, type, isDefined(), isFunction()));
+        });
+    }
+    static deserialise(serialised) {
+        if (serialised === null || serialised === undefined) {
+            return undefined;
+        }
+        const serialisedError = typeof serialised === 'string'
+            ? JSON.parse(serialised)
+            : serialised;
+        const constructor = ErrorSerialiser.recognisedErrors.find(errorType => errorType.name === serialisedError.name) || Error;
+        if (this.isDeserialisable(constructor)) {
+            return constructor.fromJSON(serialisedError);
+        }
+        const deserialised = Object.create(constructor.prototype);
+        for (const property in serialisedError) {
+            if (Object.prototype.hasOwnProperty.call(serialisedError, property)) {
+                deserialised[property] = serialisedError[property];
+            }
+        }
+        return deserialised;
+    }
+    static isSerialisable(value) {
+        return value
+            && typeof value.toJSON === 'function';
+    }
+    static isDeserialisable(type) {
+        return type
+            && typeof type.fromJSON === 'function';
+    }
+    static deserialiseFromStackTrace(stack) {
+        const stackTracePattern = /^([^\s:]*Error).*?(?::\s)?(.*?)\n(^ +at.*)$/ms;
+        if (!stackTracePattern.test(stack)) {
+            return new Error(String(stack));
+        }
+        const [, name, message, callStack_] = stack.match(stackTracePattern);
+        return ErrorSerialiser.deserialise({ name, message: message.trim(), stack });
+    }
+}
+//# sourceMappingURL=ErrorSerialiser.js.map