@pact-foundation/pact 7.3.0 → 8.0.2

package/pact.js

@@ -1,203 +1,29 @@
 "use strict";
-var __assign = (this && this.__assign) || Object.assign || function(t) {
-    for (var s, i = 1, n = arguments.length; i < n; i++) {
-        s = arguments[i];
-        for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
-            t[p] = s[p];
-    }
-    return t;
-};
+/**
+ * Pact module meta package.
+ * @module Pact
+ */
 function __export(m) {
     for (var p in m) if (!exports.hasOwnProperty(p)) exports[p] = m[p];
 }
 Object.defineProperty(exports, "__esModule", { value: true });
-// TODO: Make this the main interface into the Pact package
-//       this will be a backwards-incompatible, breaking change
 /**
- * Pact module.
- * @module Pact
+ * Exposes {@link Pact}
+ * @memberof Pact
+ * @static
  */
-var pact_node_1 = require("@pact-foundation/pact-node");
-var clc = require("cli-color");
-var Matchers = require("./dsl/matchers");
-var path = require("path");
-var process = require("process");
-var interaction_1 = require("./dsl/interaction");
-var lodash_1 = require("lodash");
-var net_1 = require("./common/net");
-var logger_1 = require("./common/logger");
-var mockService_1 = require("./dsl/mockService");
+__export(require("./httpPact"));
 /**
- * Creates a new {@link PactProvider}.
+ * Exposes {@link MessageConsumerPact}
  * @memberof Pact
- * @name create
- * @param {PactOptions} opts
- * @return {@link PactProvider}
+ * @static
  */
-var Pact = /** @class */ (function () {
-    function Pact(config) {
-        this.opts = Pact.createOptionsWithDefaults(config);
-        if (lodash_1.isEmpty(this.opts.consumer)) {
-            throw new Error("You must specify a Consumer for this pact.");
-        }
-        if (lodash_1.isEmpty(this.opts.provider)) {
-            throw new Error("You must specify a Provider for this pact.");
-        }
-        logger_1.default.level(this.opts.logLevel);
-        pact_node_1.default.logLevel(this.opts.logLevel);
-        this.server = pact_node_1.default.createServer({
-            consumer: this.opts.consumer,
-            cors: this.opts.cors,
-            dir: this.opts.dir,
-            host: this.opts.host,
-            log: this.opts.log,
-            pactFileWriteMode: this.opts.pactfileWriteMode,
-            port: config.port,
-            provider: this.opts.provider,
-            spec: this.opts.spec,
-            ssl: this.opts.ssl,
-            sslcert: this.opts.sslcert,
-            sslkey: this.opts.sslkey,
-        });
-    }
-    Pact.createOptionsWithDefaults = function (opts) {
-        return __assign({}, Pact.defaults, opts);
-    };
-    /**
-     * Start the Mock Server.
-     * @returns {Promise}
-     */
-    Pact.prototype.setup = function () {
-        var _this = this;
-        return this.checkPort()
-            .then(function () { return _this.startServer(); })
-            .then(function (opts) {
-            _this.setupMockService();
-            return Promise.resolve(opts);
-        });
-    };
-    /**
-     * Add an interaction to the {@link MockService}.
-     * @memberof PactProvider
-     * @instance
-     * @param {Interaction} interactionObj
-     * @returns {Promise}
-     */
-    Pact.prototype.addInteraction = function (interactionObj) {
-        if (interactionObj instanceof interaction_1.Interaction) {
-            return this.mockService.addInteraction(interactionObj);
-        }
-        var interaction = new interaction_1.Interaction();
-        if (interactionObj.state) {
-            interaction.given(interactionObj.state);
-        }
-        interaction
-            .uponReceiving(interactionObj.uponReceiving)
-            .withRequest(interactionObj.withRequest)
-            .willRespondWith(interactionObj.willRespondWith);
-        return this.mockService.addInteraction(interaction);
-    };
-    /**
-     * Checks with the Mock Service if the expected interactions have been exercised.
-     * @memberof PactProvider
-     * @instance
-     * @returns {Promise}
-     */
-    Pact.prototype.verify = function () {
-        var _this = this;
-        return this.mockService.verify()
-            .then(function () { return _this.mockService.removeInteractions(); })
-            .catch(function (e) {
-            // Properly format the error
-            /* tslint:disable: no-console */
-            console.error("");
-            console.error(clc.red("Pact verification failed!"));
-            console.error(clc.red(e));
-            /* tslint:enable: */
-            return _this.mockService.removeInteractions().then(function () {
-                throw new Error("Pact verification failed - expected interactions did not match actual.");
-            });
-        });
-    };
-    /**
-     * Writes the Pact and clears any interactions left behind and shutdown the
-     * mock server
-     * @memberof PactProvider
-     * @instance
-     * @returns {Promise}
-     */
-    Pact.prototype.finalize = function () {
-        var _this = this;
-        if (this.finalized) {
-            logger_1.default.warn("finalize() has already been called, this is probably a logic error in your test setup. " +
-                "In the future this will be an error.");
-        }
-        this.finalized = true;
-        return this.mockService.writePact()
-            .then(function () { return logger_1.default.info("Pact File Written"); }, function (e) {
-            return Promise.reject(e);
-        })
-            .then(function () { return new Promise(function (resolve, reject) { return _this.server.delete().then(function () { return resolve(); }, function (e) { return reject(e); }); }); })
-            .catch(function (e) { return new Promise(function (resolve, reject) {
-            return _this.server.delete().finally(function () { return reject(e); });
-        }); });
-    };
-    /**
-     * Writes the pact file out to file. Should be called when all tests have been performed for a
-     * given Consumer <-> Provider pair. It will write out the Pact to the
-     * configured file.
-     * @memberof PactProvider
-     * @instance
-     * @returns {Promise}
-     */
-    Pact.prototype.writePact = function () {
-        return this.mockService.writePact();
-    };
-    /**
-     * Clear up any interactions in the Provider Mock Server.
-     * @memberof PactProvider
-     * @instance
-     * @returns {Promise}
-     */
-    Pact.prototype.removeInteractions = function () {
-        return this.mockService.removeInteractions();
-    };
-    Pact.prototype.checkPort = function () {
-        if (this.server && this.server.options.port) {
-            return net_1.isPortAvailable(this.server.options.port, this.opts.host);
-        }
-        return Promise.resolve();
-    };
-    Pact.prototype.setupMockService = function () {
-        logger_1.default.info("Setting up Pact with Consumer \"" + this.opts.consumer + "\" and Provider \"" + this.opts.provider + "\"\n    using mock service on Port: \"" + this.opts.port + "\"");
-        this.mockService = new mockService_1.MockService(undefined, undefined, this.opts.port, this.opts.host, this.opts.ssl, this.opts.pactfileWriteMode);
-    };
-    Pact.prototype.startServer = function () {
-        var _this = this;
-        return new Promise(function (resolve, reject) {
-            return _this.server.start()
-                .then(function () {
-                _this.opts.port = _this.server.options.port || _this.opts.port;
-                resolve(_this.opts);
-            }, function (e) { return reject(e); });
-        });
-    };
-    Pact.defaults = {
-        consumer: "",
-        cors: false,
-        dir: path.resolve(process.cwd(), "pacts"),
-        host: "127.0.0.1",
-        log: path.resolve(process.cwd(), "logs", "pact.log"),
-        logLevel: "info",
-        pactfileWriteMode: "overwrite",
-        provider: "",
-        spec: 2,
-        ssl: false,
-    };
-    return Pact;
-}());
-exports.Pact = Pact;
 __export(require("./messageConsumerPact"));
+/**
+ * Exposes {@link MessageProviderPact}
+ * @memberof Pact
+ * @static
+ */
 __export(require("./messageProviderPact"));
 /**
  * Exposes {@link Verifier}
@@ -211,6 +37,11 @@ __export(require("./dsl/verifier"));
  * @static
  */
 __export(require("./dsl/graphql"));
+/**
+ * Exposes {@link ApolloGraphQL}
+ * @memberof Pact
+ * @static
+ */
 __export(require("./dsl/apolloGraphql"));
 /**
  * Exposes {@link Matchers}
@@ -219,6 +50,7 @@ __export(require("./dsl/apolloGraphql"));
  * @memberof Pact
  * @static
  */
+var Matchers = require("./dsl/matchers");
 exports.Matchers = Matchers;
 /**
  * Exposes {@link Interaction}

package/pact.js.map

@@ -1 +1 @@
-{"version":3,"file":"pact.js","sourceRoot":"","sources":["../src/pact.ts"],"names":[],"mappings":";;;;;;;;;;;;;AAAA,2DAA2D;AAC3D,+DAA+D;AAC/D;;;GAGG;AACH,wDAAwD;AACxD,+BAAiC;AACjC,yCAA2C;AAC3C,2BAA6B;AAC7B,iCAAmC;AACnC,iDAAmE;AACnE,iCAAiC;AACjC,oCAA+C;AAC/C,0CAAqC;AAErC,iDAAgD;AAIhD;;;;;;GAMG;AACH;IAuBE,cAAY,MAAmB;QAC7B,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,yBAAyB,CAAC,MAAM,CAAC,CAAC;QAEnD,IAAI,gBAAO,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE;YAC/B,MAAM,IAAI,KAAK,CAAC,4CAA4C,CAAC,CAAC;SAC/D;QAED,IAAI,gBAAO,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE;YAC/B,MAAM,IAAI,KAAK,CAAC,4CAA4C,CAAC,CAAC;SAC/D;QAED,gBAAM,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,QAAqB,CAAC,CAAC;QAC9C,mBAAc,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAC5C,IAAI,CAAC,MAAM,GAAG,mBAAc,CAAC,YAAY,CAAC;YACxC,QAAQ,EAAE,IAAI,CAAC,IAAI,CAAC,QAAQ;YAC5B,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,IAAI;YACpB,GAAG,EAAE,IAAI,CAAC,IAAI,CAAC,GAAG;YAClB,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,IAAI;YACpB,GAAG,EAAE,IAAI,CAAC,IAAI,CAAC,GAAG;YAClB,iBAAiB,EAAE,IAAI,CAAC,IAAI,CAAC,iBAAiB;YAC9C,IAAI,EAAE,MAAM,CAAC,IAAI;YACjB,QAAQ,EAAE,IAAI,CAAC,IAAI,CAAC,QAAQ;YAC5B,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,IAAI;YACpB,GAAG,EAAE,IAAI,CAAC,IAAI,CAAC,GAAG;YAClB,OAAO,EAAE,IAAI,CAAC,IAAI,CAAC,OAAO;YAC1B,MAAM,EAAE,IAAI,CAAC,IAAI,CAAC,MAAM;SACzB,CAAC,CAAC;IACL,CAAC;IApCa,8BAAyB,GAAvC,UAAwC,IAAiB;QACvD,OAAO,aAAK,IAAI,CAAC,QAAQ,EAAK,IAAI,CAAyB,CAAC;IAC9D,CAAC;IAoCD;;;OAGG;IACI,oBAAK,GAAZ;QAAA,iBAOC;QANG,OAAO,IAAI,CAAC,SAAS,EAAE;aACtB,IAAI,CAAC,cAAM,OAAA,KAAI,CAAC,WAAW,EAAE,EAAlB,CAAkB,CAAC;aAC9B,IAAI,CAAC,UAAC,IAAI;YACT,KAAI,CAAC,gBAAgB,EAAE,CAAA;YACvB,OAAO,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAA;QAC9B,CAAC,CAAC,CAAA;IACN,CAAC;IAED;;;;;;OAMG;IACI,6BAAc,GAArB,UAAsB,cAA+C;QACnE,IAAI,cAAc,YAAY,yBAAW,EAAE;YACzC,OAAO,IAAI,CAAC,WAAW,CAAC,cAAc,CAAC,cAAc,CAAC,CAAC;SACxD;QACD,IAAM,WAAW,GAAG,IAAI,yBAAW,EAAE,CAAC;QACtC,IAAI,cAAc,CAAC,KAAK,EAAE;YACxB,WAAW,CAAC,KAAK,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC;SACzC;QAED,WAAW;aACR,aAAa,CAAC,cAAc,CAAC,aAAa,CAAC;aAC3C,WAAW,CAAC,cAAc,CAAC,WAAW,CAAC;aACvC,eAAe,CAAC,cAAc,CAAC,eAAe,CAAC,CAAC;QAEnD,OAAO,IAAI,CAAC,WAAW,CAAC,cAAc,CAAC,WAAW,CAAC,CAAC;IACtD,CAAC;IAED;;;;;OAKG;IACI,qBAAM,GAAb;QAAA,iBAgBC;QAfC,OAAO,IAAI,CAAC,WAAW,CAAC,MAAM,EAAE;aAC7B,IAAI,CAAC,cAAM,OAAA,KAAI,CAAC,WAAW,CAAC,kBAAkB,EAAE,EAArC,CAAqC,CAAC;aACjD,KAAK,CAAC,UAAC,CAAM;YAEZ,4BAA4B;YAC5B,gCAAgC;YAChC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;YAClB,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,2BAA2B,CAAC,CAAC,CAAC;YACpD,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;YAC1B,oBAAoB;YAEpB,OAAO,KAAI,CAAC,WAAW,CAAC,kBAAkB,EAAE,CAAC,IAAI,CAAC;gBAChD,MAAM,IAAI,KAAK,CAAC,wEAAwE,CAAC,CAAC;YAC5F,CAAC,CAAC,CAAA;QACJ,CAAC,CAAC,CAAA;IACN,CAAC;IAED;;;;;;OAMG;IACI,uBAAQ,GAAf;QAAA,iBAeC;QAdC,IAAI,IAAI,CAAC,SAAS,EAAE;YAClB,gBAAM,CAAC,IAAI,CAAC,yFAAyF;gBACnG,sCAAsC,CAAC,CAAC;SAC3C;QACD,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC;QAEtB,OAAO,IAAI,CAAC,WAAW,CAAC,SAAS,EAAE;aAChC,IAAI,CAAC,cAAM,OAAA,gBAAM,CAAC,IAAI,CAAC,mBAAmB,CAAC,EAAhC,CAAgC,EAAE,UAAC,CAAC;YAC9C,OAAO,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;QAC3B,CAAC,CAAC;aACD,IAAI,CAAC,cAAM,OAAA,IAAI,OAAO,CAAO,UAAC,OAAO,EAAE,MAAM,IAAK,OAAA,KAAI,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,IAAI,CAAC,cAAM,OAAA,OAAO,EAAE,EAAT,CAAS,EAAE,UAAC,CAAC,IAAK,OAAA,MAAM,CAAC,CAAC,CAAC,EAAT,CAAS,CAAC,EAA5D,CAA4D,CAAC,EAApG,CAAoG,CAAC;aAChH,KAAK,CAAC,UAAC,CAAQ,IAAK,OAAA,IAAI,OAAO,CAAO,UAAC,OAAO,EAAE,MAAM;YACrD,OAAO,KAAI,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,OAAO,CAAC,cAAM,OAAA,MAAM,CAAC,CAAC,CAAC,EAAT,CAAS,CAAC,CAAC;QACvD,CAAC,CAAC,EAFmB,CAEnB,CAAC,CAAC;IACR,CAAC;IAED;;;;;;;OAOG;IACI,wBAAS,GAAhB;QACE,OAAO,IAAI,CAAC,WAAW,CAAC,SAAS,EAAE,CAAC;IACtC,CAAC;IAED;;;;;OAKG;IACI,iCAAkB,GAAzB;QACE,OAAO,IAAI,CAAC,WAAW,CAAC,kBAAkB,EAAE,CAAC;IAC/C,CAAC;IAEO,wBAAS,GAAjB;QACE,IAAI,IAAI,CAAC,MAAM,IAAI,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI,EAAE;YAC3C,OAAO,qBAAe,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;SACjE;QACD,OAAO,OAAO,CAAC,OAAO,EAAE,CAAA;IAC1B,CAAC;IAEO,+BAAgB,GAAxB;QACE,gBAAM,CAAC,IAAI,CAAC,qCAAkC,IAAI,CAAC,IAAI,CAAC,QAAQ,0BAAmB,IAAI,CAAC,IAAI,CAAC,QAAQ,8CACtE,IAAI,CAAC,IAAI,CAAC,IAAI,OAAG,CAAC,CAAC;QAElD,IAAI,CAAC,WAAW,GAAG,IAAI,yBAAW,CAAC,SAAS,EAAE,SAAS,EAAE,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,IAAI,EACrF,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC;IAChD,CAAC;IAEO,0BAAW,GAAnB;QAAA,iBAUC;QATC,OAAO,IAAI,OAAO,CAChB,UAAC,OAAO,EAAE,MAAM;YACd,OAAA,KAAI,CAAC,MAAM,CAAC,KAAK,EAAE;iBAChB,IAAI,CACH;gBACE,KAAI,CAAC,IAAI,CAAC,IAAI,GAAG,KAAI,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI,IAAI,KAAI,CAAC,IAAI,CAAC,IAAI,CAAA;gBAC3D,OAAO,CAAC,KAAI,CAAC,IAAI,CAAC,CAAA;YACtB,CAAC,EACD,UAAC,CAAM,IAAK,OAAA,MAAM,CAAC,CAAC,CAAC,EAAT,CAAS,CAAC;QANxB,CAMwB,CAAC,CAAA;IAC/B,CAAC;IAvLa,aAAQ,GAAG;QACvB,QAAQ,EAAE,EAAE;QACZ,IAAI,EAAE,KAAK;QACX,GAAG,EAAE,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,OAAO,CAAC;QACzC,IAAI,EAAE,WAAW;QACjB,GAAG,EAAE,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,MAAM,EAAE,UAAU,CAAC;QACpD,QAAQ,EAAE,MAAM;QAChB,iBAAiB,EAAE,WAAW;QAC9B,QAAQ,EAAE,EAAE;QACZ,IAAI,EAAE,CAAC;QACP,GAAG,EAAE,KAAK;KACI,CAAC;IA6KnB,WAAC;CAAA,AAzLD,IAyLC;AAzLY,oBAAI;AA2LjB,2CAAsC;AACtC,2CAAsC;AAGtC;;;;GAIG;AACH,oCAA+B;AAE/B;;;;GAIG;AACH,mCAA8B;AAC9B,yCAAoC;AAEpC;;;;;;GAMG;AACW,QAAA,QAAQ,GAAG,QAAQ,CAAC;AAElC;;;;GAIG;AACH,uCAAkC;AAElC;;;;GAIG;AACH,uCAAkC"}
+{"version":3,"file":"pact.js","sourceRoot":"","sources":["../src/pact.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;;;AAEH;;;;GAIG;AACH,gCAA0B;AAE1B;;;;GAIG;AACH,2CAAqC;AAErC;;;;GAIG;AACH,2CAAqC;AASrC;;;;GAIG;AACH,oCAA8B;AAE9B;;;;GAIG;AACH,mCAA6B;AAC7B;;;;GAIG;AACH,yCAAmC;AAEnC;;;;;;GAMG;AACH,yCAA0C;AAC5B,QAAA,QAAQ,GAAG,QAAQ,CAAA;AAEjC;;;;GAIG;AACH,uCAAiC;AAEjC;;;;GAIG;AACH,uCAAiC"}