@contract-case/case-connector 0.21.0 → 0.23.0

package/dist/cjs/src/connectors/case-boundary/internals/BoundaryPluginLoader.cjs

@@ -0,0 +1,68 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BoundaryPluginLoader = void 0;
+const case_core_1 = require("@contract-case/case-core");
+const versionString_js_1 = require("../../../entities/versionString.cjs");
+const index_js_1 = require("./mappers/index.cjs");
+const index_js_2 = require("./index.cjs");
+/**
+ * A BoundaryPluginLoader allows loading plugins into the core
+ *
+ * @public
+ */
+class BoundaryPluginLoader {
+    loader;
+    constructorConfig;
+    logPrinter;
+    resultPrinter;
+    parentVersions;
+    /**
+     * @public
+     * Construct a BoundaryContractDefiner to allow defining contracts.
+     *
+     * @param config - A ContractCaseBoundaryConfig object for the configuration
+     * @param logPrinter - An ILogPrinter to enable printing logs
+     * @param resultPrinter - An IResultPrinter to enable printing results
+     * @param parentVersions - The names version(s) of the package(s) calling
+     * this, where each entry in the array contains a name and version, with the
+     * first entry in the array being the furthest package up the call stack.
+     */
+    constructor(config, logPrinter, resultPrinter, parentVersions) {
+        this.constructorConfig = config;
+        this.loader = undefined;
+        this.logPrinter = logPrinter;
+        this.resultPrinter = resultPrinter;
+        // If invoked directly, we need to include our version
+        if (!parentVersions.includes(versionString_js_1.versionString)) {
+            this.parentVersions = [...parentVersions, versionString_js_1.versionString];
+        }
+        else {
+            this.parentVersions = parentVersions;
+        }
+    }
+    initialiseLoader() {
+        if (this.loader === undefined) {
+            const { config } = (0, index_js_1.convertConfig)(this.constructorConfig);
+            this.loader = new case_core_1.PluginLoader(config, (0, index_js_1.wrapLogPrinter)(this.logPrinter, this.resultPrinter), [...this.parentVersions]);
+        }
+    }
+    async loadPlugins(moduleNames) {
+        this.initialiseLoader();
+        return Promise.all(moduleNames.map(
+        // webpack ignore is needed here so that the final bundle for host
+        // languages is able to import arbitrary libs, without webpack failing
+        (moduleName) => import(/* webpackIgnore: true */ moduleName)))
+            .then((plugins) => {
+            if (this.loader == null) {
+                throw new case_core_1.CaseCoreError('this.loader was not initialised during loadPlugins. This should never happen, as initialiseLoader() is meant to be called first');
+            }
+            this.loader.loadPlugins(plugins);
+        }, (e) => {
+            throw new case_core_1.CaseConfigurationError(`Unable to load plugin: ${e.message}`, 'DONT_ADD_LOCATION', 'UNDOCUMENTED');
+        })
+            .then(() => new index_js_2.BoundarySuccess())
+            .catch(index_js_1.jsErrorToFailure);
+    }
+}
+exports.BoundaryPluginLoader = BoundaryPluginLoader;
+//# sourceMappingURL=BoundaryPluginLoader.js.map

package/dist/cjs/src/connectors/case-boundary/internals/BoundaryPluginLoader.d.cts

@@ -0,0 +1,28 @@
+import { ContractCaseBoundaryConfig, ILogPrinter, IResultPrinter, BoundaryResult } from './boundary/index.cjs';
+/**
+ * A BoundaryPluginLoader allows loading plugins into the core
+ *
+ * @public
+ */
+export declare class BoundaryPluginLoader {
+    private loader;
+    private readonly constructorConfig;
+    private readonly logPrinter;
+    private readonly resultPrinter;
+    private readonly parentVersions;
+    /**
+     * @public
+     * Construct a BoundaryContractDefiner to allow defining contracts.
+     *
+     * @param config - A ContractCaseBoundaryConfig object for the configuration
+     * @param logPrinter - An ILogPrinter to enable printing logs
+     * @param resultPrinter - An IResultPrinter to enable printing results
+     * @param parentVersions - The names version(s) of the package(s) calling
+     * this, where each entry in the array contains a name and version, with the
+     * first entry in the array being the furthest package up the call stack.
+     */
+    constructor(config: ContractCaseBoundaryConfig, logPrinter: ILogPrinter, resultPrinter: IResultPrinter, parentVersions: string[]);
+    private initialiseLoader;
+    loadPlugins(moduleNames: string[]): Promise<BoundaryResult>;
+}
+//# sourceMappingURL=BoundaryPluginLoader.d.ts.map

package/dist/cjs/src/connectors/case-boundary/internals/BoundaryPluginLoader.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"BoundaryPluginLoader.d.ts","sourceRoot":"","sources":["../../../../../../src/connectors/case-boundary/internals/BoundaryPluginLoader.ts"],"names":[],"mappings":"AAMA,OAAO,EACL,0BAA0B,EAC1B,WAAW,EACX,cAAc,EACd,cAAc,EACf,MAAM,qBAAqB,CAAC;AAS7B;;;;GAIG;AACH,qBAAa,oBAAoB;IAC/B,OAAO,CAAC,MAAM,CAA2B;IAEzC,OAAO,CAAC,QAAQ,CAAC,iBAAiB,CAA6B;IAE/D,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAc;IAEzC,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAiB;IAE/C,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAW;IAE1C;;;;;;;;;;OAUG;gBAED,MAAM,EAAE,0BAA0B,EAClC,UAAU,EAAE,WAAW,EACvB,aAAa,EAAE,cAAc,EAC7B,cAAc,EAAE,MAAM,EAAE;IAc1B,OAAO,CAAC,gBAAgB;IAYlB,WAAW,CAAC,WAAW,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,cAAc,CAAC;CA6BlE"}

package/dist/cjs/src/connectors/case-boundary/internals/BoundaryPluginLoader.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"BoundaryPluginLoader.js","sourceRoot":"","sources":["../../../../../../src/connectors/case-boundary/internals/BoundaryPluginLoader.ts"],"names":[],"mappings":";;;AAAA,wDAIkC;AAQlC,yEAAmE;AACnE,iDAI4B;AAC5B,yCAA6C;AAE7C;;;;GAIG;AACH,MAAa,oBAAoB;IACvB,MAAM,CAA2B;IAExB,iBAAiB,CAA6B;IAE9C,UAAU,CAAc;IAExB,aAAa,CAAiB;IAE9B,cAAc,CAAW;IAE1C;;;;;;;;;;OAUG;IACH,YACE,MAAkC,EAClC,UAAuB,EACvB,aAA6B,EAC7B,cAAwB;QAExB,IAAI,CAAC,iBAAiB,GAAG,MAAM,CAAC;QAChC,IAAI,CAAC,MAAM,GAAG,SAAS,CAAC;QACxB,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;QAC7B,IAAI,CAAC,aAAa,GAAG,aAAa,CAAC;QACnC,sDAAsD;QACtD,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,gCAAa,CAAC,EAAE,CAAC;YAC5C,IAAI,CAAC,cAAc,GAAG,CAAC,GAAG,cAAc,EAAE,gCAAa,CAAC,CAAC;QAC3D,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,cAAc,GAAG,cAAc,CAAC;QACvC,CAAC;IACH,CAAC;IAEO,gBAAgB;QACtB,IAAI,IAAI,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;YAC9B,MAAM,EAAE,MAAM,EAAE,GAAG,IAAA,wBAAa,EAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC;YAEzD,IAAI,CAAC,MAAM,GAAG,IAAI,wBAAY,CAC5B,MAAM,EACN,IAAA,yBAAc,EAAC,IAAI,CAAC,UAAU,EAAE,IAAI,CAAC,aAAa,CAAC,EACnD,CAAC,GAAG,IAAI,CAAC,cAAc,CAAC,CACzB,CAAC;QACJ,CAAC;IACH,CAAC;IAED,KAAK,CAAC,WAAW,CAAC,WAAqB;QACrC,IAAI,CAAC,gBAAgB,EAAE,CAAC;QACxB,OAAO,OAAO,CAAC,GAAG,CAChB,WAAW,CAAC,GAAG;QACb,kEAAkE;QAClE,sEAAsE;QACtE,CAAC,UAAU,EAAE,EAAE,CAAC,MAAM,CAAC,yBAAyB,CAAC,UAAU,CAAC,CAC7D,CACF;aACE,IAAI,CACH,CAAC,OAAO,EAAE,EAAE;YACV,IAAI,IAAI,CAAC,MAAM,IAAI,IAAI,EAAE,CAAC;gBACxB,MAAM,IAAI,yBAAa,CACrB,iIAAiI,CAClI,CAAC;YACJ,CAAC;YACD,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;QACnC,CAAC,EACD,CAAC,CAAC,EAAE,EAAE;YACJ,MAAM,IAAI,kCAAsB,CAC9B,0BAA0B,CAAC,CAAC,OAAO,EAAE,EACrC,mBAAmB,EACnB,cAAc,CACf,CAAC;QACJ,CAAC,CACF;aACA,IAAI,CAAC,GAAG,EAAE,CAAC,IAAI,0BAAe,EAAE,CAAC;aACjC,KAAK,CAAC,2BAAgB,CAAC,CAAC;IAC7B,CAAC;CACF;AAjFD,oDAiFC"}

package/dist/cjs/src/connectors/case-boundary/internals/boundary/BoundaryCrashMessage.cjs

@@ -0,0 +1,41 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BoundaryCrashMessage = void 0;
+/**
+ * Contains constants for the crash messages
+ *
+ * @public
+ */
+class BoundaryCrashMessage {
+    static CRASH_MESSAGE_START = `
+---------------------------------------------------
+!!!!🚨🚨🚨🚨🚨 ContractCase Crashed 🚨🚨🚨🚨🚨!!!!
+---------------------------------------------------
+
+The ContractCase core has failed in an unexpected
+way. This is almost certainly a bug in ContractCase.
+
+The details are:
+`;
+    static CRASH_MESSAGE_END = `
+
+Please open a bug report here:
+https://github.com/case-contract-testing/case/issues/new
+
+It would be great if you could include:
+
+* What you were doing when it failed
+* The results of re-running with logLevel: "maintainerDebug"
+
+For bonus points and internet karma, a reproducible 
+code sample would be very helpful.
+
+Sorry about this.
+
+---------------------------------------------------
+!!!!🚨🚨🚨🚨🚨 ContractCase Crashed 🚨🚨🚨🚨🚨!!!!
+---------------------------------------------------
+`;
+}
+exports.BoundaryCrashMessage = BoundaryCrashMessage;
+//# sourceMappingURL=BoundaryCrashMessage.js.map

package/dist/cjs/src/connectors/case-boundary/internals/boundary/BoundaryCrashMessage.d.cts

@@ -0,0 +1,10 @@
+/**
+ * Contains constants for the crash messages
+ *
+ * @public
+ */
+export declare class BoundaryCrashMessage {
+    static readonly CRASH_MESSAGE_START = "\n---------------------------------------------------\n!!!!\uD83D\uDEA8\uD83D\uDEA8\uD83D\uDEA8\uD83D\uDEA8\uD83D\uDEA8 ContractCase Crashed \uD83D\uDEA8\uD83D\uDEA8\uD83D\uDEA8\uD83D\uDEA8\uD83D\uDEA8!!!!\n---------------------------------------------------\n\nThe ContractCase core has failed in an unexpected\nway. This is almost certainly a bug in ContractCase.\n\nThe details are:\n";
+    static readonly CRASH_MESSAGE_END = "\n\nPlease open a bug report here:\nhttps://github.com/case-contract-testing/case/issues/new\n\nIt would be great if you could include:\n\n* What you were doing when it failed\n* The results of re-running with logLevel: \"maintainerDebug\"\n\nFor bonus points and internet karma, a reproducible \ncode sample would be very helpful.\n\nSorry about this.\n\n---------------------------------------------------\n!!!!\uD83D\uDEA8\uD83D\uDEA8\uD83D\uDEA8\uD83D\uDEA8\uD83D\uDEA8 ContractCase Crashed \uD83D\uDEA8\uD83D\uDEA8\uD83D\uDEA8\uD83D\uDEA8\uD83D\uDEA8!!!!\n---------------------------------------------------\n";
+}
+//# sourceMappingURL=BoundaryCrashMessage.d.ts.map

package/dist/cjs/src/connectors/case-boundary/internals/boundary/BoundaryCrashMessage.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"BoundaryCrashMessage.d.ts","sourceRoot":"","sources":["../../../../../../../src/connectors/case-boundary/internals/boundary/BoundaryCrashMessage.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,qBAAa,oBAAoB;IAC/B,MAAM,CAAC,QAAQ,CAAC,mBAAmB,yYASnC;IAEA,MAAM,CAAC,QAAQ,CAAC,iBAAiB,4mBAkBjC;CACD"}

package/dist/cjs/src/connectors/case-boundary/internals/boundary/BoundaryCrashMessage.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"BoundaryCrashMessage.js","sourceRoot":"","sources":["../../../../../../../src/connectors/case-boundary/internals/boundary/BoundaryCrashMessage.ts"],"names":[],"mappings":";;;AAAA;;;;GAIG;AACH,MAAa,oBAAoB;IAC/B,MAAM,CAAU,mBAAmB,GAAG;;;;;;;;;CASvC,CAAC;IAEA,MAAM,CAAU,iBAAiB,GAAG;;;;;;;;;;;;;;;;;;CAkBrC,CAAC;;AA9BF,oDA+BC"}

package/dist/cjs/src/connectors/case-boundary/internals/boundary/ConfigLogLevelConstants.cjs

@@ -0,0 +1,36 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ConfigLogLevelConstants = void 0;
+/**
+ * Convenience class to hold the values for LogLevel so that DSL layers don't need to know the actual value
+ *
+ * @public
+ */
+class ConfigLogLevelConstants {
+    /**
+     * Print no logs (note, results may still be printed - see `printResults`)
+     */
+    static NONE = 'none';
+    /**
+     * Log when something has gone wrong during the execution of the test framework
+     */
+    static ERROR = 'error';
+    /**
+     * Log when it seems likely that there is a misconfiguration, or an error
+     */
+    static WARN = 'warn';
+    /**
+     * Log information to help users find out what is happening during their tests (and warnings, and errors)
+     */
+    static DEBUG = 'debug';
+    /**
+     * Log debugging information for ContractCase maintainers (and debug, warn and errors)
+     */
+    static MAINTAINER_DEBUG = 'maintainerDebug';
+    /**
+     * Log detailed debugging information for ContractCase maintainers (and debug, warn and errors)
+     */
+    static DEEP_MAINTAINER_DEBUG = 'deepMaintainerDebug';
+}
+exports.ConfigLogLevelConstants = ConfigLogLevelConstants;
+//# sourceMappingURL=ConfigLogLevelConstants.js.map

package/dist/cjs/src/connectors/case-boundary/internals/boundary/ConfigLogLevelConstants.d.cts

@@ -0,0 +1,32 @@
+/**
+ * Convenience class to hold the values for LogLevel so that DSL layers don't need to know the actual value
+ *
+ * @public
+ */
+export declare class ConfigLogLevelConstants {
+    /**
+     * Print no logs (note, results may still be printed - see `printResults`)
+     */
+    static readonly NONE = "none";
+    /**
+     * Log when something has gone wrong during the execution of the test framework
+     */
+    static readonly ERROR = "error";
+    /**
+     * Log when it seems likely that there is a misconfiguration, or an error
+     */
+    static readonly WARN = "warn";
+    /**
+     * Log information to help users find out what is happening during their tests (and warnings, and errors)
+     */
+    static readonly DEBUG = "debug";
+    /**
+     * Log debugging information for ContractCase maintainers (and debug, warn and errors)
+     */
+    static readonly MAINTAINER_DEBUG = "maintainerDebug";
+    /**
+     * Log detailed debugging information for ContractCase maintainers (and debug, warn and errors)
+     */
+    static readonly DEEP_MAINTAINER_DEBUG = "deepMaintainerDebug";
+}
+//# sourceMappingURL=ConfigLogLevelConstants.d.ts.map

package/dist/cjs/src/connectors/case-boundary/internals/boundary/ConfigLogLevelConstants.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ConfigLogLevelConstants.d.ts","sourceRoot":"","sources":["../../../../../../../src/connectors/case-boundary/internals/boundary/ConfigLogLevelConstants.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,qBAAa,uBAAuB;IAClC;;OAEG;IACH,MAAM,CAAC,QAAQ,CAAC,IAAI,UAAU;IAE9B;;OAEG;IACH,MAAM,CAAC,QAAQ,CAAC,KAAK,WAAW;IAEhC;;OAEG;IACH,MAAM,CAAC,QAAQ,CAAC,IAAI,UAAU;IAE9B;;OAEG;IACH,MAAM,CAAC,QAAQ,CAAC,KAAK,WAAW;IAEhC;;OAEG;IACH,MAAM,CAAC,QAAQ,CAAC,gBAAgB,qBAAqB;IAErD;;OAEG;IACH,MAAM,CAAC,QAAQ,CAAC,qBAAqB,yBAAyB;CAC/D"}

package/dist/cjs/src/connectors/case-boundary/internals/boundary/ConfigLogLevelConstants.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ConfigLogLevelConstants.js","sourceRoot":"","sources":["../../../../../../../src/connectors/case-boundary/internals/boundary/ConfigLogLevelConstants.ts"],"names":[],"mappings":";;;AAAA;;;;GAIG;AACH,MAAa,uBAAuB;IAClC;;OAEG;IACH,MAAM,CAAU,IAAI,GAAG,MAAM,CAAC;IAE9B;;OAEG;IACH,MAAM,CAAU,KAAK,GAAG,OAAO,CAAC;IAEhC;;OAEG;IACH,MAAM,CAAU,IAAI,GAAG,MAAM,CAAC;IAE9B;;OAEG;IACH,MAAM,CAAU,KAAK,GAAG,OAAO,CAAC;IAEhC;;OAEG;IACH,MAAM,CAAU,gBAAgB,GAAG,iBAAiB,CAAC;IAErD;;OAEG;IACH,MAAM,CAAU,qBAAqB,GAAG,qBAAqB,CAAC;;AA7BhE,0DA8BC"}

package/dist/cjs/src/connectors/case-boundary/internals/boundary/ConfigPublishConstants.cjs

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ConfigPublishConstants = void 0;
+/**
+ * Convenience class to hold the values for the publish setting so that clients don't need to know the strings
+ *
+ * @public
+ */
+class ConfigPublishConstants {
+    /**
+     * Only publish contracts and verification results when in in CI according to https://github.com/watson/ci-info#supported-ci-tools
+     */
+    static ONLY_IN_CI = 'ONLY_IN_CI';
+    /**
+     * Never publish contracts or verification results
+     */
+    static NEVER = 'NEVER';
+    /**
+     * Always publish contracts and verification results
+     */
+    static ALWAYS = 'ALWAYS';
+}
+exports.ConfigPublishConstants = ConfigPublishConstants;
+//# sourceMappingURL=ConfigPublishConstants.js.map

package/dist/cjs/src/connectors/case-boundary/internals/boundary/ConfigPublishConstants.d.cts

@@ -0,0 +1,20 @@
+/**
+ * Convenience class to hold the values for the publish setting so that clients don't need to know the strings
+ *
+ * @public
+ */
+export declare class ConfigPublishConstants {
+    /**
+     * Only publish contracts and verification results when in in CI according to https://github.com/watson/ci-info#supported-ci-tools
+     */
+    static readonly ONLY_IN_CI = "ONLY_IN_CI";
+    /**
+     * Never publish contracts or verification results
+     */
+    static readonly NEVER = "NEVER";
+    /**
+     * Always publish contracts and verification results
+     */
+    static readonly ALWAYS = "ALWAYS";
+}
+//# sourceMappingURL=ConfigPublishConstants.d.ts.map

package/dist/cjs/src/connectors/case-boundary/internals/boundary/ConfigPublishConstants.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ConfigPublishConstants.d.ts","sourceRoot":"","sources":["../../../../../../../src/connectors/case-boundary/internals/boundary/ConfigPublishConstants.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,qBAAa,sBAAsB;IACjC;;OAEG;IACH,MAAM,CAAC,QAAQ,CAAC,UAAU,gBAAgB;IAE1C;;OAEG;IACH,MAAM,CAAC,QAAQ,CAAC,KAAK,WAAW;IAEhC;;OAEG;IACH,MAAM,CAAC,QAAQ,CAAC,MAAM,YAAY;CACnC"}

package/dist/cjs/src/connectors/case-boundary/internals/boundary/ConfigPublishConstants.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ConfigPublishConstants.js","sourceRoot":"","sources":["../../../../../../../src/connectors/case-boundary/internals/boundary/ConfigPublishConstants.ts"],"names":[],"mappings":";;;AAAA;;;;GAIG;AACH,MAAa,sBAAsB;IACjC;;OAEG;IACH,MAAM,CAAU,UAAU,GAAG,YAAY,CAAC;IAE1C;;OAEG;IACH,MAAM,CAAU,KAAK,GAAG,OAAO,CAAC;IAEhC;;OAEG;IACH,MAAM,CAAU,MAAM,GAAG,QAAQ,CAAC;;AAdpC,wDAeC"}

package/dist/cjs/src/connectors/case-boundary/internals/boundary/ILogPrinter.cjs

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

package/dist/cjs/src/connectors/case-boundary/internals/boundary/ILogPrinter.d.cts

@@ -0,0 +1,145 @@
+import { BoundaryResult } from './Result/index.cjs';
+/**
+ * Data class to hold data to print a message error during matching
+ *
+ * @public
+ */
+export interface PrintableMatchError {
+    /**
+     * The red highlighted blob, eg "MATCHING ERROR" or "TRIGGER FUNCTION ERROR". Could be any string.
+     */
+    readonly kind: string;
+    /**
+     * A summary of the error. Could be any string.
+     */
+    readonly message: string;
+    /**
+     * The location the error happened, for printing at the top of the error message
+     */
+    readonly location: string;
+    /**
+     * The tag line for the location the error happened, for printing after the error message. This might have more information than the `location` above.
+     */
+    readonly locationTag: string;
+    /**
+     * The machine-readable type for the cause of this error, for printing after the error message to make it easy to search for.
+     */
+    readonly errorTypeTag: string;
+    /**
+     * A string representation of the expected data (may contain newlines)
+     */
+    readonly expected: string;
+    /**
+     * A string representation of the actual data received (may contain newlines)
+     */
+    readonly actual: string;
+}
+/**
+ * Data class to hold data to print a message error
+ *
+ * @public
+ */
+export interface PrintableMessageError {
+    /**
+     * The red highlighted blob, eg "MATCHING ERROR" or "TRIGGER FUNCTION ERROR". Could be any string.
+     */
+    readonly kind: string;
+    /**
+     * A summary of the error. Could be any string.
+     */
+    readonly message: string;
+    /**
+     * The location the error happened, for printing at the top of the error message
+     */
+    readonly location: string;
+    /**
+     * The tag line for the location the error happened, for printing after the error message. This might have more information than the `location` above.
+     */
+    readonly locationTag: string;
+    /**
+     * The machine-readable type for the cause of this error, for printing after the error message to make it easy to search for.
+     */
+    readonly errorTypeTag: string;
+}
+/**
+ * Data class to hold data for a test title print line
+ *
+ * @public
+ */
+export interface PrintableTestTitle {
+    /**
+     * Either 'success' to indicate success, or 'failure' to indicate failure
+     */
+    readonly kind: string;
+    /**
+     * An icon for the start of the line (usually a single character emoji, but could be any string)
+     */
+    readonly icon: string;
+    /**
+     * The title to print (will not include newlines)
+     */
+    readonly title: string;
+    /**
+     * Any additional text to print after the title (may include newlines)
+     */
+    readonly additionalText: string;
+}
+/**
+ * Interface for printing results
+ *
+ * @public
+ */
+export interface IResultPrinter {
+    /**
+     * Called by ContractCase to ask the DSL to print an individual match error line.
+     */
+    printMatchError(MatchErrorDescription: PrintableMatchError): Promise<BoundaryResult>;
+    /**
+     * Called by ContractCase to ask the DSL to print an error during testing that doesn't have an expected / actual value
+     */
+    printMessageError(messageErrorDetails: PrintableMessageError): Promise<BoundaryResult>;
+    /**
+     * Called by ContractCase to ask the DSL to print a test title or main execution details (eg for contract downloading).
+     */
+    printTestTitle(titleDetails: PrintableTestTitle): Promise<BoundaryResult>;
+}
+/**
+ * Implement this interface to give ContractCase a way to print logs in your
+ * target language. Most platforms will want to print to standard out, but some
+ * might need to log to a file or otherwise collate the logs.
+ *
+ * @public
+ */
+export interface ILogPrinter {
+    /**
+     * Called by ContractCase to ask the DSL to print a log line. You do not need
+     * to filter calls to this interface, it will only be called when it is
+     * appropriate to print.
+     *
+     * @param level - A `LogLevel` string, either `error`, `warn`, `debug`,
+     * `maintainerDebug` or `deepMaintainerDebug` Use this to programmatically
+     * decide any colour formatting.. (although `none` is a possible log level,
+     * this function will never be called with `none`).
+     * @param timestamp - The timestamp generated by ContractCase, ready for printing. No extra
+     * formatting is necessary
+     * @param version - The version string for the current ContractCase stack (at low log levels,
+     * this is just the core version)
+     * @param typeString - A rendered version of the LogLevel. Do not rely on this value programmatically, use the `level` parameter instead.
+     * @param location - A string that represents the location that this log came from
+     * @param message - The main message of this log line
+     * @param additional - Any additional output to print on extra lines (you may want to indent this when printing)
+     *
+     * @returns A `BoundaryResult` type indicating whether there were errors
+     * during printing. Either a BoundarySuccess for no errors, or BoundaryFailure
+     * (with error details) in the event of a failure.
+     */
+    log(level: string, timestamp: string, version: string, typeString: string, location: string, message: string, additional: string): Promise<BoundaryResult>;
+}
+/**
+ * A convenience interface that combines result printing and log printing
+ *
+ * @public
+ */
+export interface ICombinedPrinter extends IResultPrinter, ILogPrinter {
+}
+//# sourceMappingURL=ILogPrinter.d.ts.map

package/dist/cjs/src/connectors/case-boundary/internals/boundary/ILogPrinter.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ILogPrinter.d.ts","sourceRoot":"","sources":["../../../../../../../src/connectors/case-boundary/internals/boundary/ILogPrinter.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAC;AAEnD;;;;GAIG;AACH,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB;;OAEG;IACH,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB;;OAEG;IACH,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC1B;;OAEG;IACH,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;IAC7B;;OAEG;IACH,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAC;IAC9B;;OAEG;IACH,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC1B;;OAEG;IACH,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;CACzB;AAED;;;;GAIG;AACH,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB;;OAEG;IACH,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB;;OAEG;IACH,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC1B;;OAEG;IACH,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;IAC7B;;OAEG;IACH,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAC;CAC/B;AAED;;;;GAIG;AACH,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB;;OAEG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB;;OAEG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB;;OAEG;IACH,QAAQ,CAAC,cAAc,EAAE,MAAM,CAAC;CACjC;AAED;;;;GAIG;AACH,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,eAAe,CACb,qBAAqB,EAAE,mBAAmB,GACzC,OAAO,CAAC,cAAc,CAAC,CAAC;IAE3B;;OAEG;IACH,iBAAiB,CACf,mBAAmB,EAAE,qBAAqB,GACzC,OAAO,CAAC,cAAc,CAAC,CAAC;IAE3B;;OAEG;IACH,cAAc,CAAC,YAAY,EAAE,kBAAkB,GAAG,OAAO,CAAC,cAAc,CAAC,CAAC;CAC3E;AAED;;;;;;GAMG;AACH,MAAM,WAAW,WAAW;IAC1B;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,GAAG,CACD,KAAK,EAAE,MAAM,EACb,SAAS,EAAE,MAAM,EACjB,OAAO,EAAE,MAAM,EACf,UAAU,EAAE,MAAM,EAClB,QAAQ,EAAE,MAAM,EAChB,OAAO,EAAE,MAAM,EACf,UAAU,EAAE,MAAM,GACjB,OAAO,CAAC,cAAc,CAAC,CAAC;CAC5B;AACD;;;;GAIG;AACH,MAAM,WAAW,gBAAiB,SAAQ,cAAc,EAAE,WAAW;CAAG"}

package/dist/cjs/src/connectors/case-boundary/internals/boundary/ILogPrinter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ILogPrinter.js","sourceRoot":"","sources":["../../../../../../../src/connectors/case-boundary/internals/boundary/ILogPrinter.ts"],"names":[],"mappings":""}

package/dist/cjs/src/connectors/case-boundary/internals/boundary/IRunTestCallback.cjs

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

package/dist/cjs/src/connectors/case-boundary/internals/boundary/IRunTestCallback.d.cts

@@ -0,0 +1,41 @@
+import { BoundaryResult } from './Result/index.cjs';
+/**
+ * Interface to tell ContractCase to run the test indicated in a call to an
+ * IRunTestCallback
+ *
+ * @public
+ */
+export interface IInvokeCoreTest {
+    /**
+     * Call this to tell the ContractCase core to actually invoke the test.
+     *
+     * Note that during verification, a failed verification doesn't return an error
+     * Result, but failed configuration or core bugs will. This is the intended default
+     * behaviour - as a failed verification doesn't necessarily indicate a problem
+     * in the code that is being verified.
+     *
+     * @returns a promise that indicates the result of verifying this test (BoundaryResult)
+     */
+    verify(): Promise<BoundaryResult>;
+}
+/**
+ * This interface allows the DSL layer to invoke the test. If your test runner
+ * supports programmatically running different tests, then use this interface to
+ * tell a BoundaryContractVerifier how to call back to your DSL with a test name
+ *
+ * @public
+ */
+export interface IRunTestCallback {
+    /**
+     * Called once for each test in a Verification run. In an implementation, you
+     * should tell your test runner that it is running a test, and what the name
+     * of the test is.
+     *
+     * @param testName - The name of this test
+     * @param invoker - an IInvokeCoreTest to tell the ContractCase core that
+     * you'd like it to run the test.
+     * @returns a promise that indicates the result of calling the invoker (BoundaryResult)
+     */
+    runTest(testName: string, invoker: IInvokeCoreTest): Promise<BoundaryResult>;
+}
+//# sourceMappingURL=IRunTestCallback.d.ts.map

package/dist/cjs/src/connectors/case-boundary/internals/boundary/IRunTestCallback.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"IRunTestCallback.d.ts","sourceRoot":"","sources":["../../../../../../../src/connectors/case-boundary/internals/boundary/IRunTestCallback.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAC;AAEnD;;;;;GAKG;AACH,MAAM,WAAW,eAAe;IAC9B;;;;;;;;;OASG;IACH,MAAM,IAAI,OAAO,CAAC,cAAc,CAAC,CAAC;CACnC;AAED;;;;;;GAMG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;;;;;;;;OASG;IACH,OAAO,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,eAAe,GAAG,OAAO,CAAC,cAAc,CAAC,CAAC;CAC9E"}

package/dist/cjs/src/connectors/case-boundary/internals/boundary/IRunTestCallback.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IRunTestCallback.js","sourceRoot":"","sources":["../../../../../../../src/connectors/case-boundary/internals/boundary/IRunTestCallback.ts"],"names":[],"mappings":""}

package/dist/cjs/src/connectors/case-boundary/internals/boundary/ITriggerFunction.cjs

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

package/dist/cjs/src/connectors/case-boundary/internals/boundary/ITriggerFunction.d.cts

@@ -0,0 +1,32 @@
+import { BoundaryResult } from './Result/index.cjs';
+export type BoundaryCoreFunction = (...args: string[]) => Promise<BoundaryResult>;
+export type BoundarySetupInfo = {
+    stateVariables: Record<string, string>;
+    /**
+     * Functions defined or registered in the core,
+     * that can be called by host wrappers.
+     * These functions are never-fail - they always return a successful promise.
+     */
+    functions: Record<string, BoundaryCoreFunction>;
+    mock: Record<string, string>;
+};
+/**
+ * Interface called by ContractCase to invoke user's test code.
+ *
+ * @public
+ */
+export interface ITriggerFunction {
+    /**
+     * Trigger the user's test code and test the response from it.
+     *
+     * @param setup - The information about the setup for this test
+     *
+     * @returns BoundarySuccess when successful; BoundaryFailure with
+     * kind=BoundaryFailureKindConstants.CASE_TRIGGER_ERROR if the trigger fails;
+     * BoundaryFailure with
+     * kind=BoundaryFailureKindConstants.CASE_VERIFY_RETURN_ERROR if the
+     * verification function fails.
+     */
+    trigger(setup: BoundarySetupInfo): Promise<BoundaryResult>;
+}
+//# sourceMappingURL=ITriggerFunction.d.ts.map

package/dist/cjs/src/connectors/case-boundary/internals/boundary/ITriggerFunction.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ITriggerFunction.d.ts","sourceRoot":"","sources":["../../../../../../../src/connectors/case-boundary/internals/boundary/ITriggerFunction.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAC;AAEnD,MAAM,MAAM,oBAAoB,GAAG,CACjC,GAAG,IAAI,EAAE,MAAM,EAAE,KACd,OAAO,CAAC,cAAc,CAAC,CAAC;AAE7B,MAAM,MAAM,iBAAiB,GAAG;IAC9B,cAAc,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACvC;;;;OAIG;IACH,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,oBAAoB,CAAC,CAAC;IAChD,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CAC9B,CAAC;AAEF;;;;GAIG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;;;;;;;;;OAUG;IACH,OAAO,CAAC,KAAK,EAAE,iBAAiB,GAAG,OAAO,CAAC,cAAc,CAAC,CAAC;CAC5D"}

package/dist/cjs/src/connectors/case-boundary/internals/boundary/ITriggerFunction.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ITriggerFunction.js","sourceRoot":"","sources":["../../../../../../../src/connectors/case-boundary/internals/boundary/ITriggerFunction.ts"],"names":[],"mappings":""}

package/dist/cjs/src/connectors/case-boundary/internals/boundary/Result/BoundaryFailure.cjs

@@ -0,0 +1,29 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BoundaryFailure = void 0;
+const BoundaryResult_js_1 = require("./BoundaryResult.cjs");
+const BoundaryResultTypeConstants_js_1 = require("./BoundaryResultTypeConstants.cjs");
+/**
+ * This indicates a failure. Use `BoundaryFailureKindConstants` to determine what type of failure it is.
+ *
+ * @public
+ */
+class BoundaryFailure extends BoundaryResult_js_1.BoundaryResult {
+    resultType;
+    kind;
+    message;
+    location;
+    contractCaseErrorCode;
+    originalStackTrace;
+    constructor(kind, message, location, originalStackTrace, contractCaseErrorCode) {
+        super(BoundaryResultTypeConstants_js_1.RESULT_FAILURE);
+        this.resultType = BoundaryResultTypeConstants_js_1.RESULT_FAILURE;
+        this.kind = kind;
+        this.message = message;
+        this.location = location;
+        this.originalStackTrace = originalStackTrace;
+        this.contractCaseErrorCode = contractCaseErrorCode;
+    }
+}
+exports.BoundaryFailure = BoundaryFailure;
+//# sourceMappingURL=BoundaryFailure.js.map

package/dist/cjs/src/connectors/case-boundary/internals/boundary/Result/BoundaryFailure.d.cts

@@ -0,0 +1,17 @@
+import { BoundaryResult } from './BoundaryResult.cjs';
+import { RESULT_FAILURE } from './BoundaryResultTypeConstants.cjs';
+/**
+ * This indicates a failure. Use `BoundaryFailureKindConstants` to determine what type of failure it is.
+ *
+ * @public
+ */
+export declare class BoundaryFailure extends BoundaryResult {
+    readonly resultType: typeof RESULT_FAILURE;
+    readonly kind: string;
+    readonly message: string;
+    readonly location: string;
+    readonly contractCaseErrorCode: string;
+    readonly originalStackTrace: string;
+    constructor(kind: string, message: string, location: string, originalStackTrace: string, contractCaseErrorCode: string);
+}
+//# sourceMappingURL=BoundaryFailure.d.ts.map

package/dist/cjs/src/connectors/case-boundary/internals/boundary/Result/BoundaryFailure.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"BoundaryFailure.d.ts","sourceRoot":"","sources":["../../../../../../../../src/connectors/case-boundary/internals/boundary/Result/BoundaryFailure.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AACrD,OAAO,EAAE,cAAc,EAAE,MAAM,kCAAkC,CAAC;AAElE;;;;GAIG;AACH,qBAAa,eAAgB,SAAQ,cAAc;IACjD,SAAkB,UAAU,EAAE,OAAO,cAAc,CAAC;IAEpD,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IAEtB,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IAEzB,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAE1B,QAAQ,CAAC,qBAAqB,EAAE,MAAM,CAAC;IAEvC,QAAQ,CAAC,kBAAkB,EAAE,MAAM,CAAC;gBAGlC,IAAI,EAAE,MAAM,EACZ,OAAO,EAAE,MAAM,EACf,QAAQ,EAAE,MAAM,EAChB,kBAAkB,EAAE,MAAM,EAC1B,qBAAqB,EAAE,MAAM;CAUhC"}

package/dist/cjs/src/connectors/case-boundary/internals/boundary/Result/BoundaryFailure.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"BoundaryFailure.js","sourceRoot":"","sources":["../../../../../../../../src/connectors/case-boundary/internals/boundary/Result/BoundaryFailure.ts"],"names":[],"mappings":";;;AAAA,2DAAqD;AACrD,qFAAkE;AAElE;;;;GAIG;AACH,MAAa,eAAgB,SAAQ,kCAAc;IAC/B,UAAU,CAAwB;IAE3C,IAAI,CAAS;IAEb,OAAO,CAAS;IAEhB,QAAQ,CAAS;IAEjB,qBAAqB,CAAS;IAE9B,kBAAkB,CAAS;IAEpC,YACE,IAAY,EACZ,OAAe,EACf,QAAgB,EAChB,kBAA0B,EAC1B,qBAA6B;QAE7B,KAAK,CAAC,+CAAc,CAAC,CAAC;QACtB,IAAI,CAAC,UAAU,GAAG,+CAAc,CAAC;QACjC,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QACzB,IAAI,CAAC,kBAAkB,GAAG,kBAAkB,CAAC;QAC7C,IAAI,CAAC,qBAAqB,GAAG,qBAAqB,CAAC;IACrD,CAAC;CACF;AA5BD,0CA4BC"}