@pact-foundation/pact
Version:
Pact for all things Javascript
145 lines • 6.75 kB
JavaScript
;
/**
* An Interaction is where you define the state of your interaction with a Provider.
* @module Interaction
*/
var __importDefault = (this && this.__importDefault) || function (mod) {
return (mod && mod.__esModule) ? mod : { "default": mod };
};
Object.defineProperty(exports, "__esModule", { value: true });
exports.interactionToInteractionObject = exports.Interaction = void 0;
var lodash_1 = require("lodash");
var ramda_1 = require("ramda");
var request_1 = require("../common/request");
var matchers_1 = require("./matchers");
var configurationError_1 = __importDefault(require("../errors/configurationError"));
/**
* Returns valid if object or matcher only contains string values
* @param query
*/
var throwIfQueryObjectInvalid = function (query) {
if ((0, matchers_1.isMatcher)(query)) {
return;
}
Object.values(query).forEach(function (value) {
if (!((0, matchers_1.isMatcher)(value) || Array.isArray(value) || typeof value === 'string')) {
throw new configurationError_1.default("Query must only contain strings.");
}
});
};
var Interaction = /** @class */ (function () {
function Interaction() {
this.state = {};
}
/**
* Gives a state the provider should be in for this interaction.
* @param {string} providerState - The state of the provider.
* @returns {Interaction} interaction
*/
Interaction.prototype.given = function (providerState) {
if (providerState) {
this.state.providerState = providerState;
}
return this;
};
/**
* A free style description of the interaction.
* @param {string} description - A description of the interaction.
* @returns {Interaction} interaction
*/
Interaction.prototype.uponReceiving = function (description) {
if ((0, lodash_1.isNil)(description)) {
throw new configurationError_1.default('You must provide a description for the interaction.');
}
this.state.description = description;
return this;
};
/**
* The request that represents this interaction triggered by the consumer.
* @param {Object} requestOpts
* @param {string} requestOpts.method - The HTTP method
* @param {string} requestOpts.path - The path of the URL
* @param {string} requestOpts.query - Any query string in the interaction
* @param {Object} requestOpts.headers - A key-value pair object of headers
* @param {Object} requestOpts.body - The body, in {@link String} format or {@link Object} format
* @returns {Interaction} interaction
*/
Interaction.prototype.withRequest = function (requestOpts) {
if ((0, lodash_1.isNil)(requestOpts.method)) {
throw new configurationError_1.default('You must provide an HTTP method.');
}
if ((0, lodash_1.keys)(request_1.HTTPMethods).indexOf(requestOpts.method.toString()) < 0) {
throw new configurationError_1.default("You must provide a valid HTTP method: ".concat((0, lodash_1.keys)(request_1.HTTPMethods).join(', '), "."));
}
if ((0, lodash_1.isNil)(requestOpts.path)) {
throw new configurationError_1.default('You must provide a path.');
}
if (typeof requestOpts.query === 'object') {
throwIfQueryObjectInvalid(requestOpts.query);
}
this.state.request = (0, ramda_1.reject)(lodash_1.isNil, requestOpts);
return this;
};
/**
* The response expected by the consumer.
* @param {Object} responseOpts
* @param {string} responseOpts.status - The HTTP status
* @param {string} responseOpts.headers
* @param {Object} responseOpts.body
* @returns {Interaction} interaction
*/
Interaction.prototype.willRespondWith = function (responseOpts) {
if ((0, lodash_1.isNil)(responseOpts.status) ||
responseOpts.status.toString().trim().length === 0) {
throw new configurationError_1.default('You must provide a status code.');
}
this.state.response = (0, ramda_1.reject)(lodash_1.isNil, {
body: responseOpts.body,
headers: responseOpts.headers || undefined,
status: responseOpts.status,
});
return this;
};
/**
* Returns the interaction object created.
* @returns {Object}
*/
Interaction.prototype.json = function () {
var _a, _b, _c, _d, _e, _f;
if ((0, lodash_1.isNil)(this.state.description)) {
throw new configurationError_1.default('You must provide a description for the Interaction');
}
if ((0, lodash_1.isNil)(this.state.request) ||
(0, lodash_1.isNil)((_b = (_a = this.state) === null || _a === void 0 ? void 0 : _a.request) === null || _b === void 0 ? void 0 : _b.method) ||
(0, lodash_1.isNil)((_d = (_c = this.state) === null || _c === void 0 ? void 0 : _c.request) === null || _d === void 0 ? void 0 : _d.path)) {
throw new configurationError_1.default('You must provide a request with at least a method and path for the Interaction');
}
if ((0, lodash_1.isNil)(this.state.response) || (0, lodash_1.isNil)((_f = (_e = this.state) === null || _e === void 0 ? void 0 : _e.response) === null || _f === void 0 ? void 0 : _f.status)) {
throw new configurationError_1.default('You must provide a response with a status for the Interaction');
}
return this.state;
};
return Interaction;
}());
exports.Interaction = Interaction;
var interactionToInteractionObject = function (interaction) {
var _a, _b, _c, _d, _e, _f, _g, _h;
return ({
state: interaction.providerState,
uponReceiving: interaction.description,
withRequest: {
method: (_a = interaction.request) === null || _a === void 0 ? void 0 : _a.method,
path: (_b = interaction.request) === null || _b === void 0 ? void 0 : _b.path,
query: (_c = interaction.request) === null || _c === void 0 ? void 0 : _c.query,
body: (_d = interaction.request) === null || _d === void 0 ? void 0 : _d.body,
headers: (_e = interaction.request) === null || _e === void 0 ? void 0 : _e.headers,
},
willRespondWith: {
status: (_f = interaction.response) === null || _f === void 0 ? void 0 : _f.status,
body: (_g = interaction.response) === null || _g === void 0 ? void 0 : _g.body,
headers: (_h = interaction.response) === null || _h === void 0 ? void 0 : _h.headers,
},
});
};
exports.interactionToInteractionObject = interactionToInteractionObject;
//# sourceMappingURL=interaction.js.map