@pact-foundation/pact 10.0.0-beta.9 → 10.0.2

package/src/dsl/interaction.spec.js

@@ -0,0 +1,214 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+// @ts-nocheck
+var chai_1 = __importDefault(require("chai"));
+var chai_as_promised_1 = __importDefault(require("chai-as-promised"));
+var request_1 = require("../common/request");
+var interaction_1 = require("./interaction");
+var matchers_1 = require("./matchers");
+chai_1.default.use(chai_as_promised_1.default);
+var expect = chai_1.default.expect;
+describe('Interaction', function () {
+    describe('#given', function () {
+        it('creates Interaction with provider state', function () {
+            var actual = new interaction_1.Interaction()
+                .uponReceiving('r')
+                .given('provider state');
+            expect(actual.state).to.eql({
+                description: 'r',
+                providerState: 'provider state',
+            });
+        });
+        describe('without provider state', function () {
+            it('creates Interaction when blank', function () {
+                var actual = new interaction_1.Interaction().uponReceiving('r').given('').state;
+                expect(actual).to.eql({ description: 'r' });
+            });
+            it('creates Interaction when nothing is passed', function () {
+                var actual = new interaction_1.Interaction().uponReceiving('r').state;
+                expect(actual).to.eql({ description: 'r' });
+            });
+        });
+    });
+    describe('#uponReceiving', function () {
+        var interaction = new interaction_1.Interaction();
+        it('throws error when no description provided', function () {
+            expect(interaction.uponReceiving).to.throw(Error, 'You must provide a description for the interaction.');
+        });
+        it('has a state with description', function () {
+            interaction.uponReceiving('an interaction description');
+            expect(interaction.state).to.eql({
+                description: 'an interaction description',
+            });
+        });
+    });
+    describe('#withRequest', function () {
+        var interaction = new interaction_1.Interaction();
+        it('throws error when method is not provided', function () {
+            expect(interaction.withRequest.bind(interaction, {})).to.throw(Error, 'You must provide an HTTP method.');
+        });
+        it('throws error when an invalid method is provided', function () {
+            expect(interaction.withRequest.bind(interaction, { method: 'FOO' })).to.throw(Error, 'You must provide a valid HTTP method: GET, POST, PUT, PATCH, DELETE, HEAD, OPTIONS, COPY, LOCK, MKCOL, MOVE, PROPFIND, PROPPATCH, UNLOCK, REPORT.');
+        });
+        it('throws error when method is not provided', function () {
+            expect(interaction.withRequest.bind(interaction, { path: '/' })).to.throw(Error, 'You must provide an HTTP method.');
+        });
+        it('throws error when path is not provided', function () {
+            expect(interaction.withRequest.bind(interaction, { method: request_1.HTTPMethods.GET })).to.throw(Error, 'You must provide a path.');
+        });
+        it('throws error when query object is not a string', function () {
+            expect(interaction.withRequest.bind(interaction, {
+                method: request_1.HTTPMethods.GET,
+                path: '/',
+                query: { string: false, query: 'false' },
+            })).to.throw(Error, 'Query must only contain strings.');
+        });
+        describe('with only mandatory params', function () {
+            var actual = new interaction_1.Interaction()
+                .uponReceiving('a request')
+                .withRequest({ method: request_1.HTTPMethods.GET, path: '/search' }).state;
+            it('has a state containing only the given keys', function () {
+                expect(actual).to.have.property('request');
+                expect(actual.request).to.have.keys('method', 'path');
+            });
+            it('request has no other keys', function () {
+                expect(actual.request).to.not.have.keys('query', 'headers', 'body');
+            });
+        });
+        describe('with all other parameters', function () {
+            var actual = new interaction_1.Interaction().uponReceiving('request').withRequest({
+                body: { id: 1, name: 'Test', due: 'tomorrow' },
+                headers: { 'Content-Type': 'application/json' },
+                method: request_1.HTTPMethods.GET,
+                path: '/search',
+                query: 'q=test',
+            }).state;
+            it('has a full state all available keys', function () {
+                expect(actual).to.have.property('request');
+                expect(actual.request).to.have.keys('method', 'path', 'query', 'headers', 'body');
+            });
+        });
+        describe('query type', function () {
+            var request = {
+                body: { id: 1, name: 'Test', due: 'tomorrow' },
+                headers: { 'Content-Type': 'application/json' },
+                method: request_1.HTTPMethods.GET,
+                path: '/search',
+                query: {},
+            };
+            it('is passed with matcher', function () {
+                request.query = (0, matchers_1.term)({
+                    generate: 'limit=50&status=finished&order=desc',
+                    matcher: '^limit=[0-9]+&status=(finished)&order=(desc|asc)$',
+                });
+                expect(new interaction_1.Interaction().uponReceiving('request').withRequest(request).state
+                    .request).to.have.any.keys('query');
+            });
+            it('is passed with matcher as the value', function () {
+                request.query = {
+                    'id[]': (0, matchers_1.eachLike)('1'),
+                };
+                expect(new interaction_1.Interaction().uponReceiving('request').withRequest(request).state
+                    .request).to.have.any.keys('query');
+            });
+            it('is passed with object', function () {
+                request.query = {
+                    id: '1',
+                };
+                expect(new interaction_1.Interaction().uponReceiving('request').withRequest(request).state
+                    .request).to.have.any.keys('query');
+            });
+            it('is passed with array', function () {
+                var _a;
+                request.query = {
+                    id: ['1', '2'],
+                };
+                expect((_a = new interaction_1.Interaction().uponReceiving('request').withRequest(request).state
+                    .request) === null || _a === void 0 ? void 0 : _a.query).to.deep.eq({ id: ['1', '2'] });
+            });
+        });
+        describe('request body', function () {
+            it('is included when an empty string is specified', function () {
+                var actual = new interaction_1.Interaction().uponReceiving('request').withRequest({
+                    body: '',
+                    method: request_1.HTTPMethods.GET,
+                    path: '/path',
+                }).state;
+                expect(actual.request).to.have.any.keys('body');
+            });
+            it('is not included when explicitly set to undefined', function () {
+                var actual = new interaction_1.Interaction().uponReceiving('request').withRequest({
+                    body: undefined,
+                    method: request_1.HTTPMethods.GET,
+                    path: '/path',
+                }).state;
+                expect(actual.request).not.to.have.any.keys('body');
+            });
+        });
+    });
+    describe('#willRespondWith', function () {
+        var interaction;
+        beforeEach(function () {
+            interaction = new interaction_1.Interaction();
+        });
+        it('throws error when status is not provided', function () {
+            expect(interaction.willRespondWith.bind(interaction, {})).to.throw(Error, 'You must provide a status code.');
+        });
+        it('throws error when status is blank', function () {
+            expect(interaction.willRespondWith.bind(interaction, { status: '' })).to.throw(Error, 'You must provide a status code.');
+        });
+        describe('with only mandatory params', function () {
+            var actual;
+            beforeEach(function () {
+                interaction.uponReceiving('request');
+                interaction.willRespondWith({ status: 200 });
+                actual = interaction.state;
+            });
+            it('has a state compacted with only present keys', function () {
+                expect(actual).to.have.property('response');
+                expect(actual.response).to.have.keys('status');
+            });
+            it('request has no other keys', function () {
+                expect(actual.response).to.not.have.keys('headers', 'body');
+            });
+        });
+        describe('with all other parameters', function () {
+            var actual;
+            beforeEach(function () {
+                interaction.uponReceiving('request');
+                interaction.willRespondWith({
+                    body: { id: 1, name: 'Test', due: 'tomorrow' },
+                    headers: { 'Content-Type': 'application/json' },
+                    status: 404,
+                });
+                actual = interaction.state;
+            });
+            it('has a full state all available keys', function () {
+                expect(actual).to.have.property('response');
+                expect(actual.response).to.have.keys('status', 'headers', 'body');
+            });
+        });
+        describe('response body', function () {
+            it('is included when an empty string is specified', function () {
+                interaction.uponReceiving('request').willRespondWith({
+                    body: '',
+                    status: 204,
+                });
+                var actual = interaction.state;
+                expect(actual.response).to.have.any.keys('body');
+            });
+            it('is not included when explicitly set to undefined', function () {
+                interaction.uponReceiving('request').willRespondWith({
+                    body: undefined,
+                    status: 204,
+                });
+                var actual = interaction.state;
+                expect(actual.response).not.to.have.any.keys('body');
+            });
+        });
+    });
+});
+//# sourceMappingURL=interaction.spec.js.map

package/src/dsl/interaction.spec.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"interaction.spec.js","sourceRoot":"","sources":["../../../src/dsl/interaction.spec.ts"],"names":[],"mappings":";;;;;AAAA,cAAc;AACd,8CAAwB;AACxB,sEAA8C;AAC9C,6CAAgD;AAChD,6CAA8D;AAC9D,uCAA4C;AAE5C,cAAI,CAAC,GAAG,CAAC,0BAAc,CAAC,CAAC;AACjB,IAAA,MAAM,GAAK,cAAI,OAAT,CAAU;AAExB,QAAQ,CAAC,aAAa,EAAE;IACtB,QAAQ,CAAC,QAAQ,EAAE;QACjB,EAAE,CAAC,yCAAyC,EAAE;YAC5C,IAAM,MAAM,GAAG,IAAI,yBAAW,EAAE;iBAC7B,aAAa,CAAC,GAAG,CAAC;iBAClB,KAAK,CAAC,gBAAgB,CAAC,CAAC;YAE3B,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC;gBAC1B,WAAW,EAAE,GAAG;gBAChB,aAAa,EAAE,gBAAgB;aAChC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,QAAQ,CAAC,wBAAwB,EAAE;YACjC,EAAE,CAAC,gCAAgC,EAAE;gBACnC,IAAM,MAAM,GAAG,IAAI,yBAAW,EAAE,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,KAAK,CAAC;gBACpE,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,WAAW,EAAE,GAAG,EAAE,CAAC,CAAC;YAC9C,CAAC,CAAC,CAAC;YACH,EAAE,CAAC,4CAA4C,EAAE;gBAC/C,IAAM,MAAM,GAAG,IAAI,yBAAW,EAAE,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC,KAAK,CAAC;gBAC1D,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,WAAW,EAAE,GAAG,EAAE,CAAC,CAAC;YAC9C,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,gBAAgB,EAAE;QACzB,IAAM,WAAW,GAAG,IAAI,yBAAW,EAAE,CAAC;QAEtC,EAAE,CAAC,2CAA2C,EAAE;YAC9C,MAAM,CAAC,WAAW,CAAC,aAAa,CAAC,CAAC,EAAE,CAAC,KAAK,CACxC,KAAK,EACL,qDAAqD,CACtD,CAAC;QACJ,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,8BAA8B,EAAE;YACjC,WAAW,CAAC,aAAa,CAAC,4BAA4B,CAAC,CAAC;YACxD,MAAM,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC;gBAC/B,WAAW,EAAE,4BAA4B;aAC1C,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,cAAc,EAAE;QACvB,IAAM,WAAW,GAAG,IAAI,yBAAW,EAAE,CAAC;QAEtC,EAAE,CAAC,0CAA0C,EAAE;YAC7C,MAAM,CAAC,WAAW,CAAC,WAAW,CAAC,IAAI,CAAC,WAAW,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,CAC5D,KAAK,EACL,kCAAkC,CACnC,CAAC;QACJ,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,iDAAiD,EAAE;YACpD,MAAM,CACJ,WAAW,CAAC,WAAW,CAAC,IAAI,CAAC,WAAW,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,CAC7D,CAAC,EAAE,CAAC,KAAK,CACR,KAAK,EACL,mJAAmJ,CACpJ,CAAC;QACJ,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,0CAA0C,EAAE;YAC7C,MAAM,CAAC,WAAW,CAAC,WAAW,CAAC,IAAI,CAAC,WAAW,EAAE,EAAE,IAAI,EAAE,GAAG,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,CACvE,KAAK,EACL,kCAAkC,CACnC,CAAC;QACJ,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,wCAAwC,EAAE;YAC3C,MAAM,CACJ,WAAW,CAAC,WAAW,CAAC,IAAI,CAAC,WAAW,EAAE,EAAE,MAAM,EAAE,qBAAW,CAAC,GAAG,EAAE,CAAC,CACvE,CAAC,EAAE,CAAC,KAAK,CAAC,KAAK,EAAE,0BAA0B,CAAC,CAAC;QAChD,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,gDAAgD,EAAE;YACnD,MAAM,CACJ,WAAW,CAAC,WAAW,CAAC,IAAI,CAAC,WAAW,EAAE;gBACxC,MAAM,EAAE,qBAAW,CAAC,GAAG;gBACvB,IAAI,EAAE,GAAG;gBACT,KAAK,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,KAAK,EAAE,OAAO,EAAE;aACzC,CAAC,CACH,CAAC,EAAE,CAAC,KAAK,CAAC,KAAK,EAAE,kCAAkC,CAAC,CAAC;QACxD,CAAC,CAAC,CAAC;QAEH,QAAQ,CAAC,4BAA4B,EAAE;YACrC,IAAM,MAAM,GAAG,IAAI,yBAAW,EAAE;iBAC7B,aAAa,CAAC,WAAW,CAAC;iBAC1B,WAAW,CAAC,EAAE,MAAM,EAAE,qBAAW,CAAC,GAAG,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC,CAAC,KAAK,CAAC;YAEnE,EAAE,CAAC,4CAA4C,EAAE;gBAC/C,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC;gBAC3C,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;YACxD,CAAC,CAAC,CAAC;YAEH,EAAE,CAAC,2BAA2B,EAAE;gBAC9B,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,SAAS,EAAE,MAAM,CAAC,CAAC;YACtE,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,QAAQ,CAAC,2BAA2B,EAAE;YACpC,IAAM,MAAM,GAAG,IAAI,yBAAW,EAAE,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC,WAAW,CAAC;gBACpE,IAAI,EAAE,EAAE,EAAE,EAAE,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,GAAG,EAAE,UAAU,EAAE;gBAC9C,OAAO,EAAE,EAAE,cAAc,EAAE,kBAAkB,EAAE;gBAC/C,MAAM,EAAE,qBAAW,CAAC,GAAG;gBACvB,IAAI,EAAE,SAAS;gBACf,KAAK,EAAE,QAAQ;aAChB,CAAC,CAAC,KAAK,CAAC;YAET,EAAE,CAAC,qCAAqC,EAAE;gBACxC,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC;gBAC3C,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,IAAI,CACjC,QAAQ,EACR,MAAM,EACN,OAAO,EACP,SAAS,EACT,MAAM,CACP,CAAC;YACJ,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,QAAQ,CAAC,YAAY,EAAE;YACrB,IAAM,OAAO,GAAG;gBACd,IAAI,EAAE,EAAE,EAAE,EAAE,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,GAAG,EAAE,UAAU,EAAE;gBAC9C,OAAO,EAAE,EAAE,cAAc,EAAE,kBAAkB,EAAE;gBAC/C,MAAM,EAAE,qBAAW,CAAC,GAAG;gBACvB,IAAI,EAAE,SAAS;gBACf,KAAK,EAAE,EAAE;aACV,CAAC;YAEF,EAAE,CAAC,wBAAwB,EAAE;gBAC3B,OAAO,CAAC,KAAK,GAAG,IAAA,eAAI,EAAC;oBACnB,QAAQ,EAAE,qCAAqC;oBAC/C,OAAO,EAAE,mDAAmD;iBAC7D,CAAC,CAAC;gBACH,MAAM,CACJ,IAAI,yBAAW,EAAE,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,KAAK;qBAClE,OAAO,CACX,CAAC,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;YAC9B,CAAC,CAAC,CAAC;YAEH,EAAE,CAAC,qCAAqC,EAAE;gBACxC,OAAO,CAAC,KAAK,GAAG;oBACd,MAAM,EAAE,IAAA,mBAAQ,EAAC,GAAG,CAAC;iBACtB,CAAC;gBACF,MAAM,CACJ,IAAI,yBAAW,EAAE,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,KAAK;qBAClE,OAAO,CACX,CAAC,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;YAC9B,CAAC,CAAC,CAAC;YAEH,EAAE,CAAC,uBAAuB,EAAE;gBAC1B,OAAO,CAAC,KAAK,GAAG;oBACd,EAAE,EAAE,GAAG;iBACR,CAAC;gBACF,MAAM,CACJ,IAAI,yBAAW,EAAE,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,KAAK;qBAClE,OAAO,CACX,CAAC,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;YAC9B,CAAC,CAAC,CAAC;YAEH,EAAE,CAAC,sBAAsB,EAAE;;gBACzB,OAAO,CAAC,KAAK,GAAG;oBACd,EAAE,EAAE,CAAC,GAAG,EAAE,GAAG,CAAC;iBACf,CAAC;gBACF,MAAM,CACJ,MAAA,IAAI,yBAAW,EAAE,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,KAAK;qBAClE,OAAO,0CAAE,KAAK,CAClB,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,GAAG,EAAE,GAAG,CAAC,EAAE,CAAC,CAAC;YACnC,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,QAAQ,CAAC,cAAc,EAAE;YACvB,EAAE,CAAC,+CAA+C,EAAE;gBAClD,IAAM,MAAM,GAAG,IAAI,yBAAW,EAAE,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC,WAAW,CAAC;oBACpE,IAAI,EAAE,EAAE;oBACR,MAAM,EAAE,qBAAW,CAAC,GAAG;oBACvB,IAAI,EAAE,OAAO;iBACd,CAAC,CAAC,KAAK,CAAC;gBAET,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;YAClD,CAAC,CAAC,CAAC;YAEH,EAAE,CAAC,kDAAkD,EAAE;gBACrD,IAAM,MAAM,GAAG,IAAI,yBAAW,EAAE,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC,WAAW,CAAC;oBACpE,IAAI,EAAE,SAAS;oBACf,MAAM,EAAE,qBAAW,CAAC,GAAG;oBACvB,IAAI,EAAE,OAAO;iBACd,CAAC,CAAC,KAAK,CAAC;gBAET,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;YACtD,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,kBAAkB,EAAE;QAC3B,IAAI,WAAwB,CAAC;QAE7B,UAAU,CAAC;YACT,WAAW,GAAG,IAAI,yBAAW,EAAE,CAAC;QAClC,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,0CAA0C,EAAE;YAC7C,MAAM,CAAC,WAAW,CAAC,eAAe,CAAC,IAAI,CAAC,WAAW,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,CAChE,KAAK,EACL,iCAAiC,CAClC,CAAC;QACJ,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,mCAAmC,EAAE;YACtC,MAAM,CACJ,WAAW,CAAC,eAAe,CAAC,IAAI,CAAC,WAAW,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC,CAC9D,CAAC,EAAE,CAAC,KAAK,CAAC,KAAK,EAAE,iCAAiC,CAAC,CAAC;QACvD,CAAC,CAAC,CAAC;QAEH,QAAQ,CAAC,4BAA4B,EAAE;YACrC,IAAI,MAAwB,CAAC;YAE7B,UAAU,CAAC;gBACT,WAAW,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC;gBACrC,WAAW,CAAC,eAAe,CAAC,EAAE,MAAM,EAAE,GAAG,EAAE,CAAC,CAAC;gBAC7C,MAAM,GAAG,WAAW,CAAC,KAAK,CAAC;YAC7B,CAAC,CAAC,CAAC;YAEH,EAAE,CAAC,8CAA8C,EAAE;gBACjD,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC;gBAC5C,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;YACjD,CAAC,CAAC,CAAC;YAEH,EAAE,CAAC,2BAA2B,EAAE;gBAC9B,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC;YAC9D,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,QAAQ,CAAC,2BAA2B,EAAE;YACpC,IAAI,MAAwB,CAAC;YAE7B,UAAU,CAAC;gBACT,WAAW,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC;gBACrC,WAAW,CAAC,eAAe,CAAC;oBAC1B,IAAI,EAAE,EAAE,EAAE,EAAE,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,GAAG,EAAE,UAAU,EAAE;oBAC9C,OAAO,EAAE,EAAE,cAAc,EAAE,kBAAkB,EAAE;oBAC/C,MAAM,EAAE,GAAG;iBACZ,CAAC,CAAC;gBACH,MAAM,GAAG,WAAW,CAAC,KAAK,CAAC;YAC7B,CAAC,CAAC,CAAC;YAEH,EAAE,CAAC,qCAAqC,EAAE;gBACxC,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC;gBAC5C,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,SAAS,EAAE,MAAM,CAAC,CAAC;YACpE,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,QAAQ,CAAC,eAAe,EAAE;YACxB,EAAE,CAAC,+CAA+C,EAAE;gBAClD,WAAW,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC,eAAe,CAAC;oBACnD,IAAI,EAAE,EAAE;oBACR,MAAM,EAAE,GAAG;iBACZ,CAAC,CAAC;gBAEH,IAAM,MAAM,GAAG,WAAW,CAAC,KAAK,CAAC;gBACjC,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;YACnD,CAAC,CAAC,CAAC;YAEH,EAAE,CAAC,kDAAkD,EAAE;gBACrD,WAAW,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC,eAAe,CAAC;oBACnD,IAAI,EAAE,SAAS;oBACf,MAAM,EAAE,GAAG;iBACZ,CAAC,CAAC;gBAEH,IAAM,MAAM,GAAG,WAAW,CAAC,KAAK,CAAC;gBACjC,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;YACvD,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/src/dsl/matchers.d.ts

@@ -0,0 +1,143 @@
+/** @module Matchers
+ *
+ * For specific matcher types (e.g. IpV6), the values generated are not random
+ * but are fixed, to prevent contract invalidation after each run of the consumer test.
+ */
+import { AnyJson } from '../common/jsonTypes';
+export declare const EMAIL_FORMAT = "^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+.[a-zA-Z]{2,}$";
+export declare const ISO8601_DATE_FORMAT = "^([\\+-]?\\d{4}(?!\\d{2}\\b))((-?)((0[1-9]|1[0-2])(\\3([12]\\d|0[1-9]|3[01]))?|W([0-4]\\d|5[0-2])(-?[1-7])?|(00[1-9]|0[1-9]\\d|[12]\\d{2}|3([0-5]\\d|6[1-6])))?)$";
+export declare const ISO8601_DATETIME_FORMAT = "^\\d{4}-[01]\\d-[0-3]\\dT[0-2]\\d:[0-5]\\d:[0-5]\\d([+-][0-2]\\d:[0-5]\\d|Z)$";
+export declare const ISO8601_DATETIME_WITH_MILLIS_FORMAT = "^\\d{4}-[01]\\d-[0-3]\\dT[0-2]\\d:[0-5]\\d:[0-5]\\d\\.\\d+([+-][0-2]\\d(:?[0-5]\\d)?|Z)$";
+export declare const ISO8601_TIME_FORMAT = "^(T\\d\\d:\\d\\d(:\\d\\d)?(\\.\\d+)?(([+-]\\d\\d:\\d\\d)|Z)?)?$";
+export declare const RFC1123_TIMESTAMP_FORMAT = "^(Mon|Tue|Wed|Thu|Fri|Sat|Sun),\\s\\d{2}\\s(Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec)\\s\\d{4}\\s\\d{2}:\\d{2}:\\d{2}\\s(\\+|-)\\d{4}$";
+export declare const UUID_V4_FORMAT = "^[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}$";
+export declare const IPV4_FORMAT = "^(\\d{1,3}\\.)+\\d{1,3}$";
+export declare const IPV6_FORMAT = "^(([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9]))$";
+export declare const HEX_FORMAT = "^[0-9a-fA-F]+$";
+export interface Matcher<T> {
+    value?: T;
+    'pact:matcher:type': string;
+    getValue(): T;
+}
+export interface ArrayMatcher<T> extends Matcher<T> {
+    'pact:matcher:type': string;
+    min?: number;
+    max?: number;
+}
+export declare function isMatcher(x: AnyTemplate): x is Matcher<AnyTemplate>;
+export declare type AnyTemplate = AnyJson | Matcher<AnyTemplate> | ArrayMatcher<AnyTemplate> | TemplateMap | ArrayTemplate;
+export declare type InterfaceToTemplate<O> = {
+    [K in keyof O]: AnyTemplate;
+};
+interface TemplateMap {
+    [key: string]: AnyTemplate;
+}
+declare type ArrayTemplate = Array<AnyTemplate>;
+/**
+ * Validates the given example against the regex.
+ *
+ * @param example Example to use in the matcher.
+ * @param matcher Regular expression to check.
+ */
+export declare function validateExample(example: string, matcher: string): boolean;
+/**
+ * The eachLike matcher
+ * @param {any} template
+ * @param {Object} opts
+ * @param {Number} opts.min
+ */
+export declare function eachLike<T>(template: T, opts?: {
+    min: number;
+}): ArrayMatcher<T[]>;
+/**
+ * The somethingLike matcher
+ * @param {any} value - the value to be somethingLike
+ */
+export declare function somethingLike<T>(value: T): Matcher<T>;
+export interface RegexMatcher<T> extends Matcher<T> {
+    regex: string;
+}
+/**
+ * The term matcher. Also aliased to 'regex' for discoverability.
+ * @param {Object} opts
+ * @param {string} opts.generate - a value to represent the matched String
+ * @param {string} opts.matcher - a Regex representing the value
+ */
+export declare function term(opts: {
+    generate: string;
+    matcher: string;
+}): RegexMatcher<string>;
+/**
+ * Email address matcher.
+ * @param {string} address - a email address to use as an example
+ */
+export declare function email(address?: string): Matcher<string>;
+/**
+ * UUID v4 matcher.
+ * @param {string} uuuid - a UUID to use as an example.
+ */
+export declare function uuid(id?: string): Matcher<string>;
+/**
+ * IPv4 matcher.
+ * @param {string} ip - an IPv4 address to use as an example. Defaults to `127.0.0.13`
+ */
+export declare function ipv4Address(ip?: string): Matcher<string>;
+/**
+ * IPv6 matcher.
+ * @param {string} ip - an IPv6 address to use as an example. Defaults to '::ffff:192.0.2.128'
+ */
+export declare function ipv6Address(ip?: string): Matcher<string>;
+/**
+ * ISO8601 DateTime matcher.
+ * @param {string} date - an ISO8601 Date and Time string
+ *                        e.g. 2015-08-06T16:53:10+01:00 are valid
+ */
+export declare function iso8601DateTime(date?: string): Matcher<string>;
+/**
+ * ISO8601 DateTime matcher with required millisecond precision
+ * @param {string} date - an ISO8601 Date and Time string, e.g. 2015-08-06T16:53:10.123+01:00
+ */
+export declare function iso8601DateTimeWithMillis(date?: string): Matcher<string>;
+/**
+ * ISO8601 Date matcher.
+ * @param {string} date - a basic yyyy-MM-dd date string e.g. 2000-09-31
+ */
+export declare function iso8601Date(date?: string): Matcher<string>;
+/**
+ *  ISO8601 Time Matcher, matches a pattern of the format "'T'HH:mm:ss".
+ * @param {string} date - a ISO8601 formatted time string e.g. T22:44:30.652Z
+ */
+export declare function iso8601Time(time?: string): Matcher<string>;
+/**
+ * RFC1123 Timestamp matcher "DAY, DD MON YYY hh:mm:ss"
+ *
+ * @param {string} date - an RFC1123 Date and Time string, e.g. Mon, 31 Oct 2016 15:21:41 -0400
+ */
+export declare function rfc1123Timestamp(timestamp?: string): Matcher<string>;
+/**
+ * Hexadecimal Matcher.
+ * @param {string} hex - a hex value.
+ */
+export declare function hexadecimal(hex?: string): Matcher<string>;
+/**
+ * Decimal Matcher.
+ * @param {float} float - a decimal value.
+ */
+export declare function decimal(float?: number): Matcher<number>;
+/**
+ * Integer Matcher.
+ * @param {integer} int - an int value.
+ */
+export declare function integer(int?: number): Matcher<number>;
+/**
+ * Boolean Matcher.
+ */
+export declare function boolean(value?: boolean): Matcher<boolean>;
+/**
+ * String Matcher.
+ */
+export declare function string(value?: string): Matcher<string>;
+export { somethingLike as like };
+export { term as regex };
+export declare function extractPayload(value: AnyTemplate): AnyJson;
+export declare function matcherValueOrString(obj: unknown): string;