@contract-case/case-connector 0.7.3 → 0.7.5

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

@@ -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/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/src/connectors/case-boundary/internals/boundary/ConfigLogLevelConstants.d.ts

@@ -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/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/src/connectors/case-boundary/internals/boundary/ConfigLogLevelConstants.js

@@ -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/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/src/connectors/case-boundary/internals/boundary/ConfigPublishConstants.d.ts

@@ -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/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/src/connectors/case-boundary/internals/boundary/ConfigPublishConstants.js

@@ -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/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/src/connectors/case-boundary/internals/boundary/ILogPrinter.d.ts

@@ -0,0 +1,145 @@
+import { BoundaryResult } from './Result';
+/**
+ * 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/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,UAAU,CAAC;AAE1C;;;;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/src/connectors/case-boundary/internals/boundary/ILogPrinter.js

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

package/dist/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/src/connectors/case-boundary/internals/boundary/IRunTestCallback.d.ts

@@ -0,0 +1,41 @@
+import { BoundaryResult } from './Result';
+/**
+ * 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/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,UAAU,CAAC;AAE1C;;;;;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/src/connectors/case-boundary/internals/boundary/IRunTestCallback.js

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

package/dist/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/src/connectors/case-boundary/internals/boundary/ITriggerFunction.d.ts

@@ -0,0 +1,19 @@
+import { BoundaryResult } from './Result';
+/**
+ * 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.
+     *
+     * @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(config: Record<string, unknown>): Promise<BoundaryResult>;
+}
+//# sourceMappingURL=ITriggerFunction.d.ts.map

package/dist/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,UAAU,CAAC;AAE1C;;;;GAIG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;;;;;;;OAQG;IACH,OAAO,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,OAAO,CAAC,cAAc,CAAC,CAAC;CACnE"}

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

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

package/dist/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/src/connectors/case-boundary/internals/boundary/Result/BoundaryFailure.d.ts

@@ -0,0 +1,15 @@
+import { BoundaryResult } from './BoundaryResult';
+import { RESULT_FAILURE } from './BoundaryResultTypeConstants';
+/**
+ * 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;
+    constructor(kind: string, message: string, location: string);
+}
+//# sourceMappingURL=BoundaryFailure.d.ts.map

package/dist/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,kBAAkB,CAAC;AAClD,OAAO,EAAE,cAAc,EAAE,MAAM,+BAA+B,CAAC;AAE/D;;;;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;gBAEd,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM;CAO5D"}

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

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

package/dist/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,qDAAkD;AAClD,+EAA+D;AAE/D;;;;GAIG;AACH,MAAa,eAAgB,SAAQ,+BAAc;IAC/B,UAAU,CAAwB;IAE3C,IAAI,CAAS;IAEb,OAAO,CAAS;IAEhB,QAAQ,CAAS;IAE1B,YAAY,IAAY,EAAE,OAAe,EAAE,QAAgB;QACzD,KAAK,CAAC,4CAAc,CAAC,CAAC;QACtB,IAAI,CAAC,UAAU,GAAG,4CAAc,CAAC;QACjC,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;IAC3B,CAAC;CACF;AAhBD,0CAgBC"}

package/dist/src/connectors/case-boundary/internals/boundary/Result/BoundaryFailureKindConstants.d.ts

@@ -0,0 +1,32 @@
+/**
+ * Constants to use for determining what kind of failure you have
+ *
+ * @public
+ */
+export declare class BoundaryFailureKindConstants {
+    /**
+     * Something went wrong in ContractCase internals. Almost certainly a bug.
+     */
+    static readonly CASE_CORE_ERROR: string;
+    /**
+     * The user has configured ContractCase incorrectly
+     */
+    static readonly CASE_CONFIGURATION_ERROR: string;
+    /**
+     * The test's expectations were not met
+     */
+    static readonly CASE_FAILED_ASSERTION_ERROR: string;
+    /**
+     * The user-provided trigger failed when it was not expected to do so
+     */
+    static readonly CASE_TRIGGER_ERROR: string;
+    /**
+     * The user-provided verification function (testResponse or testErrorResponse) failed
+     */
+    static readonly CASE_VERIFY_RETURN_ERROR: string;
+    /**
+     * An error while contacting a contract broker
+     */
+    static readonly CASE_BROKER_ERROR: string;
+}
+//# sourceMappingURL=BoundaryFailureKindConstants.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"BoundaryFailureKindConstants.d.ts","sourceRoot":"","sources":["../../../../../../../src/connectors/case-boundary/internals/boundary/Result/BoundaryFailureKindConstants.ts"],"names":[],"mappings":"AASA;;;;GAIG;AACH,qBAAa,4BAA4B;IACvC;;OAEG;IACH,MAAM,CAAC,QAAQ,CAAC,eAAe,SAAsB;IAErD;;OAEG;IACH,MAAM,CAAC,QAAQ,CAAC,wBAAwB,SAA+B;IAEvE;;OAEG;IACH,MAAM,CAAC,QAAQ,CAAC,2BAA2B,SAAiC;IAE5E;;OAEG;IACH,MAAM,CAAC,QAAQ,CAAC,kBAAkB,SAAyB;IAE3D;;OAEG;IACH,MAAM,CAAC,QAAQ,CAAC,wBAAwB,SACF;IAEtC;;OAEG;IACH,MAAM,CAAC,QAAQ,CAAC,iBAAiB,SAAoB;CACtD"}

package/dist/src/connectors/case-boundary/internals/boundary/Result/BoundaryFailureKindConstants.js

@@ -0,0 +1,37 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BoundaryFailureKindConstants = void 0;
+const case_core_1 = require("@contract-case/case-core");
+/**
+ * Constants to use for determining what kind of failure you have
+ *
+ * @public
+ */
+class BoundaryFailureKindConstants {
+    /**
+     * Something went wrong in ContractCase internals. Almost certainly a bug.
+     */
+    static CASE_CORE_ERROR = case_core_1.CaseCoreError.name;
+    /**
+     * The user has configured ContractCase incorrectly
+     */
+    static CASE_CONFIGURATION_ERROR = case_core_1.CaseConfigurationError.name;
+    /**
+     * The test's expectations were not met
+     */
+    static CASE_FAILED_ASSERTION_ERROR = case_core_1.CaseFailedAssertionError.name;
+    /**
+     * The user-provided trigger failed when it was not expected to do so
+     */
+    static CASE_TRIGGER_ERROR = case_core_1.CaseTriggerError.name;
+    /**
+     * The user-provided verification function (testResponse or testErrorResponse) failed
+     */
+    static CASE_VERIFY_RETURN_ERROR = case_core_1.VerifyTriggerReturnObjectError.name;
+    /**
+     * An error while contacting a contract broker
+     */
+    static CASE_BROKER_ERROR = case_core_1.BrokerError.name;
+}
+exports.BoundaryFailureKindConstants = BoundaryFailureKindConstants;
+//# sourceMappingURL=BoundaryFailureKindConstants.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"BoundaryFailureKindConstants.js","sourceRoot":"","sources":["../../../../../../../src/connectors/case-boundary/internals/boundary/Result/BoundaryFailureKindConstants.ts"],"names":[],"mappings":";;;AAAA,wDAOkC;AAElC;;;;GAIG;AACH,MAAa,4BAA4B;IACvC;;OAEG;IACH,MAAM,CAAU,eAAe,GAAG,yBAAa,CAAC,IAAI,CAAC;IAErD;;OAEG;IACH,MAAM,CAAU,wBAAwB,GAAG,kCAAsB,CAAC,IAAI,CAAC;IAEvE;;OAEG;IACH,MAAM,CAAU,2BAA2B,GAAG,oCAAwB,CAAC,IAAI,CAAC;IAE5E;;OAEG;IACH,MAAM,CAAU,kBAAkB,GAAG,4BAAgB,CAAC,IAAI,CAAC;IAE3D;;OAEG;IACH,MAAM,CAAU,wBAAwB,GACtC,0CAA8B,CAAC,IAAI,CAAC;IAEtC;;OAEG;IACH,MAAM,CAAU,iBAAiB,GAAG,uBAAW,CAAC,IAAI,CAAC;;AA9BvD,oEA+BC"}

package/dist/src/connectors/case-boundary/internals/boundary/Result/BoundaryResult.d.ts

@@ -0,0 +1,15 @@
+import { RESULT_SUCCESS, RESULT_SUCCESS_HAS_MAP_PAYLOAD, RESULT_SUCCESS_HAS_ANY_PAYLOAD, RESULT_FAILURE } from './BoundaryResultTypeConstants';
+type BoundaryResultType = typeof RESULT_SUCCESS | typeof RESULT_SUCCESS_HAS_MAP_PAYLOAD | typeof RESULT_SUCCESS_HAS_ANY_PAYLOAD | typeof RESULT_FAILURE;
+/**
+ * Supertype for all methods that return results. Use one of `BoundarySuccess`,
+ * `BoundaryFailure`, or one of the specialised `BoundarySuccessWith*` return
+ * types as appropriate. See the documentation for the method you're implementing for more information.
+ *
+ * @public
+ */
+export declare abstract class BoundaryResult {
+    readonly resultType: BoundaryResultType;
+    constructor(result: BoundaryResultType);
+}
+export {};
+//# sourceMappingURL=BoundaryResult.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"BoundaryResult.d.ts","sourceRoot":"","sources":["../../../../../../../src/connectors/case-boundary/internals/boundary/Result/BoundaryResult.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,cAAc,EACd,8BAA8B,EAC9B,8BAA8B,EAC9B,cAAc,EACf,MAAM,+BAA+B,CAAC;AAEvC,KAAK,kBAAkB,GACnB,OAAO,cAAc,GACrB,OAAO,8BAA8B,GACrC,OAAO,8BAA8B,GACrC,OAAO,cAAc,CAAC;AAE1B;;;;;;GAMG;AACH,8BAAsB,cAAc;IAGlC,QAAQ,CAAC,UAAU,EAAE,kBAAkB,CAAC;gBAE5B,MAAM,EAAE,kBAAkB;CAGvC"}

package/dist/src/connectors/case-boundary/internals/boundary/Result/BoundaryResult.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BoundaryResult = void 0;
+/**
+ * Supertype for all methods that return results. Use one of `BoundarySuccess`,
+ * `BoundaryFailure`, or one of the specialised `BoundarySuccessWith*` return
+ * types as appropriate. See the documentation for the method you're implementing for more information.
+ *
+ * @public
+ */
+class BoundaryResult {
+    /* One of the constants from ResultTypeConstants indicating what the type of
+     * this result is */
+    resultType;
+    constructor(result) {
+        this.resultType = result;
+    }
+}
+exports.BoundaryResult = BoundaryResult;
+//# sourceMappingURL=BoundaryResult.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"BoundaryResult.js","sourceRoot":"","sources":["../../../../../../../src/connectors/case-boundary/internals/boundary/Result/BoundaryResult.ts"],"names":[],"mappings":";;;AAaA;;;;;;GAMG;AACH,MAAsB,cAAc;IAClC;wBACoB;IACX,UAAU,CAAqB;IAExC,YAAY,MAA0B;QACpC,IAAI,CAAC,UAAU,GAAG,MAAM,CAAC;IAC3B,CAAC;CACF;AARD,wCAQC"}

package/dist/src/connectors/case-boundary/internals/boundary/Result/BoundaryResultTypeConstants.d.ts

@@ -0,0 +1,35 @@
+/**
+ * This is a success type with no payload
+ * @internal
+ */
+export declare const RESULT_SUCCESS = "Success";
+/**
+ * This is a success type with a map payload
+ * @internal
+ */
+export declare const RESULT_SUCCESS_HAS_MAP_PAYLOAD = "SuccessMap";
+/**
+ * This is a success type with an arbitrary object payload
+ * @internal
+ */
+export declare const RESULT_SUCCESS_HAS_ANY_PAYLOAD = "SuccessAny";
+/**
+ * This is a failure
+ * @internal
+ */
+export declare const RESULT_FAILURE = "Failure";
+/**
+ * Use these constants to determine what type of result a BoundaryResult is.
+ * @public
+ */
+export declare class BoundaryResultTypeConstants {
+    /** This is a success type with no payload */
+    static readonly RESULT_SUCCESS = "Success";
+    /** This is a success type with a map payload */
+    static readonly RESULT_SUCCESS_HAS_MAP_PAYLOAD = "SuccessMap";
+    /** This is a success type with an arbitrary object payload */
+    static readonly RESULT_SUCCESS_HAS_ANY_PAYLOAD = "SuccessAny";
+    /** This is a failure */
+    static readonly RESULT_FAILURE = "Failure";
+}
+//# sourceMappingURL=BoundaryResultTypeConstants.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"BoundaryResultTypeConstants.d.ts","sourceRoot":"","sources":["../../../../../../../src/connectors/case-boundary/internals/boundary/Result/BoundaryResultTypeConstants.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,eAAO,MAAM,cAAc,YAAY,CAAC;AACxC;;;GAGG;AACH,eAAO,MAAM,8BAA8B,eAAe,CAAC;AAC3D;;;GAGG;AACH,eAAO,MAAM,8BAA8B,eAAe,CAAC;AAC3D;;;GAGG;AACH,eAAO,MAAM,cAAc,YAAY,CAAC;AAExC;;;GAGG;AACH,qBAAa,2BAA2B;IACtC,6CAA6C;IAC7C,MAAM,CAAC,QAAQ,CAAC,cAAc,aAAkB;IAEhD,gDAAgD;IAChD,MAAM,CAAC,QAAQ,CAAC,8BAA8B,gBACb;IAEjC,8DAA8D;IAC9D,MAAM,CAAC,QAAQ,CAAC,8BAA8B,gBACb;IAEjC,wBAAwB;IACxB,MAAM,CAAC,QAAQ,CAAC,cAAc,aAAkB;CACjD"}