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

package/src/dsl/graphql.spec.js

@@ -0,0 +1,229 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+var chai_1 = __importDefault(require("chai"));
+var chai_as_promised_1 = __importDefault(require("chai-as-promised"));
+var graphql_1 = require("./graphql");
+var matchers_1 = require("./matchers");
+chai_1.default.use(chai_as_promised_1.default);
+var expect = chai_1.default.expect;
+describe('GraphQLInteraction', function () {
+    var interaction;
+    beforeEach(function () {
+        interaction = new graphql_1.GraphQLInteraction();
+    });
+    describe('#withOperation', function () {
+        describe('when given a valid operation', function () {
+            it('creates a GraphQL Interaction', function () {
+                interaction.uponReceiving('a request');
+                interaction.withRequest({
+                    path: '/graphql',
+                    method: 'POST',
+                });
+                interaction.withOperation('query');
+                interaction.withQuery('{ hello }');
+                interaction.willRespondWith({
+                    status: 200,
+                    body: { data: {} },
+                });
+                var json = interaction.json();
+                expect(json.request.body.operationName).to.eq('query');
+            });
+        });
+        describe('when given an invalid operation', function () {
+            it('fails with an error', function () {
+                expect(interaction.withOperation.bind('aoeu')).to.throw(Error);
+            });
+        });
+        describe('when given a null operation', function () {
+            it('creates a GrphQL Interaction', function () {
+                interaction.uponReceiving('a request');
+                interaction.withRequest({
+                    path: '/graphql',
+                    method: 'POST',
+                });
+                interaction.withOperation(null);
+                interaction.withQuery('{ hello }');
+                interaction.willRespondWith({
+                    status: 200,
+                    body: { data: {} },
+                });
+                var json = interaction.json();
+                expect(json.request.body.operationName).to.eq(null);
+            });
+        });
+    });
+    describe('#withVariables', function () {
+        describe('when given a set of variables', function () {
+            it('adds the variables to the payload', function () {
+                interaction.uponReceiving('a request');
+                interaction.withRequest({
+                    path: '/graphql',
+                    method: 'POST',
+                });
+                interaction.withOperation('query');
+                interaction.withQuery('{ hello }');
+                interaction.withVariables({
+                    foo: 'bar',
+                });
+                interaction.willRespondWith({
+                    status: 200,
+                    body: { data: {} },
+                });
+                var json = interaction.json();
+                expect(json.request.body.variables).to.deep.eq({ foo: 'bar' });
+            });
+        });
+        describe('when no variables are provided', function () {
+            it('does not add the variables property to the payload', function () {
+                interaction.uponReceiving('a request');
+                interaction.withRequest({
+                    path: '/graphql',
+                    method: 'POST',
+                });
+                interaction.withOperation('query');
+                interaction.withQuery('{ hello }');
+                interaction.willRespondWith({
+                    status: 200,
+                    body: { data: {} },
+                });
+                var json = interaction.json();
+                expect(json.request.body).to.not.have.property('variables');
+            });
+        });
+        describe('when an empty variables object is presented', function () {
+            it('adds the variables property to the payload', function () {
+                interaction.uponReceiving('a request');
+                interaction.withRequest({
+                    path: '/graphql',
+                    method: 'POST',
+                });
+                interaction.withOperation('query');
+                interaction.withQuery('{ hello }');
+                interaction.withVariables({});
+                interaction.willRespondWith({
+                    status: 200,
+                    body: { data: {} },
+                });
+                var json = interaction.json();
+                expect(json.request.body).to.have.property('variables');
+            });
+        });
+    });
+    describe('#withQuery', function () {
+        beforeEach(function () {
+            interaction.uponReceiving('a request');
+            interaction.withRequest({
+                path: '/graphql',
+                method: 'POST',
+            });
+            interaction.withOperation('query');
+            interaction.withQuery('{ hello }');
+            interaction.withVariables({
+                foo: 'bar',
+            });
+            interaction.willRespondWith({
+                status: 200,
+                body: { data: {} },
+            });
+        });
+        describe('when given an empty query', function () {
+            it('fails with an error', function () {
+                expect(function () { return interaction.withQuery(null); }).to.throw();
+            });
+        });
+        describe('when given an invalid query', function () {
+            it('fails with an error', function () {
+                expect(function () {
+                    return interaction.withQuery('{ not properly terminated');
+                }).to.throw(Error);
+            });
+        });
+        describe('when given a valid query', function () {
+            describe('without variables', function () {
+                it('adds regular expressions for the whitespace in the query', function () {
+                    interaction.uponReceiving('a request');
+                    interaction.withRequest({
+                        path: '/graphql',
+                        method: 'POST',
+                    });
+                    interaction.withOperation('query');
+                    interaction.withQuery('{ hello }');
+                    interaction.willRespondWith({
+                        status: 200,
+                        body: { data: {} },
+                    });
+                    var json = interaction.json();
+                    expect((0, matchers_1.isMatcher)(json.request.body.query)).to.eq(true);
+                    var r = new RegExp(json.request.body.query.regex, 'g');
+                    var lotsOfWhitespace = "{             hello\n\n        }";
+                    expect(r.test(lotsOfWhitespace)).to.eq(true);
+                });
+            });
+            describe('and variables', function () {
+                it('adds regular expressions for the whitespace in the query', function () {
+                    interaction.withQuery("{\n            Hello(id: $id) {\n              name\n            }\n          }");
+                    interaction.withVariables({
+                        name: 'bar',
+                    });
+                    var json = interaction.json();
+                    expect((0, matchers_1.isMatcher)(json.request.body.query)).to.eq(true);
+                    var r = new RegExp(json.request.body.query.regex, 'g');
+                    // eslint-disable-next-line no-useless-escape
+                    var lotsOfWhitespace = "{             Hello(id: $id) { name    } }";
+                    expect(r.test(lotsOfWhitespace)).to.eq(true);
+                });
+            });
+        });
+    });
+    describe('#json', function () {
+        context('when query is empty', function () {
+            it('fails with an error', function () {
+                expect(function () { return interaction.json(); }).to.throw();
+            });
+        });
+        context('when description is empty', function () {
+            it('fails with an error', function () {
+                interaction.withQuery('{ hello }');
+                return expect(function () { return interaction.json(); }).to.throw();
+            });
+        });
+        describe('when no operation is provided', function () {
+            it('does not be present in unmarshaled body', function () {
+                interaction.uponReceiving('a request');
+                interaction.withRequest({
+                    path: '/graphql',
+                    method: 'POST',
+                });
+                interaction.withQuery('{ hello }');
+                interaction.willRespondWith({
+                    status: 200,
+                    body: { data: {} },
+                });
+                var json = interaction.json();
+                expect(json.request.body).to.not.have.property('operationName');
+            });
+        });
+    });
+    context('when given a valid query', function () {
+        it('marshals the query to JSON', function () {
+            interaction.uponReceiving('a request');
+            interaction.withRequest({
+                path: '/graphql',
+                method: 'POST',
+            });
+            interaction.withOperation('query');
+            interaction.withQuery('{ hello }');
+            interaction.willRespondWith({
+                status: 200,
+                body: { data: {} },
+            });
+            var json = interaction.json();
+            expect((0, matchers_1.isMatcher)(json.request.body.query)).to.eq(true);
+            expect(json.request.body.query.getValue()).to.eq('{ hello }');
+        });
+    });
+});
+//# sourceMappingURL=graphql.spec.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"graphql.spec.js","sourceRoot":"","sources":["../../../src/dsl/graphql.spec.ts"],"names":[],"mappings":";;;;;AAAA,8CAAwB;AACxB,sEAA8C;AAC9C,qCAA+C;AAC/C,uCAAuC;AAEvC,cAAI,CAAC,GAAG,CAAC,0BAAc,CAAC,CAAC;AACjB,IAAA,MAAM,GAAK,cAAI,OAAT,CAAU;AAExB,QAAQ,CAAC,oBAAoB,EAAE;IAC7B,IAAI,WAA+B,CAAC;IAEpC,UAAU,CAAC;QACT,WAAW,GAAG,IAAI,4BAAkB,EAAE,CAAC;IACzC,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,gBAAgB,EAAE;QACzB,QAAQ,CAAC,8BAA8B,EAAE;YACvC,EAAE,CAAC,+BAA+B,EAAE;gBAClC,WAAW,CAAC,aAAa,CAAC,WAAW,CAAC,CAAC;gBACvC,WAAW,CAAC,WAAW,CAAC;oBACtB,IAAI,EAAE,UAAU;oBAChB,MAAM,EAAE,MAAM;iBACf,CAAC,CAAC;gBACH,WAAW,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC;gBACnC,WAAW,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC;gBACnC,WAAW,CAAC,eAAe,CAAC;oBAC1B,MAAM,EAAE,GAAG;oBACX,IAAI,EAAE,EAAE,IAAI,EAAE,EAAE,EAAE;iBACnB,CAAC,CAAC;gBAEH,IAAM,IAAI,GAAQ,WAAW,CAAC,IAAI,EAAE,CAAC;gBACrC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,OAAO,CAAC,CAAC;YACzD,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QACH,QAAQ,CAAC,iCAAiC,EAAE;YAC1C,EAAE,CAAC,qBAAqB,EAAE;gBACxB,MAAM,CAAC,WAAW,CAAC,aAAa,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;YACjE,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QACH,QAAQ,CAAC,6BAA6B,EAAE;YACtC,EAAE,CAAC,8BAA8B,EAAE;gBACjC,WAAW,CAAC,aAAa,CAAC,WAAW,CAAC,CAAC;gBACvC,WAAW,CAAC,WAAW,CAAC;oBACtB,IAAI,EAAE,UAAU;oBAChB,MAAM,EAAE,MAAM;iBACf,CAAC,CAAC;gBACH,WAAW,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;gBAChC,WAAW,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC;gBACnC,WAAW,CAAC,eAAe,CAAC;oBAC1B,MAAM,EAAE,GAAG;oBACX,IAAI,EAAE,EAAE,IAAI,EAAE,EAAE,EAAE;iBACnB,CAAC,CAAC;gBAEH,IAAM,IAAI,GAAQ,WAAW,CAAC,IAAI,EAAE,CAAC;gBACrC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC;YACtD,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,gBAAgB,EAAE;QACzB,QAAQ,CAAC,+BAA+B,EAAE;YACxC,EAAE,CAAC,mCAAmC,EAAE;gBACtC,WAAW,CAAC,aAAa,CAAC,WAAW,CAAC,CAAC;gBACvC,WAAW,CAAC,WAAW,CAAC;oBACtB,IAAI,EAAE,UAAU;oBAChB,MAAM,EAAE,MAAM;iBACf,CAAC,CAAC;gBACH,WAAW,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC;gBACnC,WAAW,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC;gBACnC,WAAW,CAAC,aAAa,CAAC;oBACxB,GAAG,EAAE,KAAK;iBACX,CAAC,CAAC;gBACH,WAAW,CAAC,eAAe,CAAC;oBAC1B,MAAM,EAAE,GAAG;oBACX,IAAI,EAAE,EAAE,IAAI,EAAE,EAAE,EAAE;iBACnB,CAAC,CAAC;gBAEH,IAAM,IAAI,GAAQ,WAAW,CAAC,IAAI,EAAE,CAAC;gBACrC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,GAAG,EAAE,KAAK,EAAE,CAAC,CAAC;YACjE,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QACH,QAAQ,CAAC,gCAAgC,EAAE;YACzC,EAAE,CAAC,oDAAoD,EAAE;gBACvD,WAAW,CAAC,aAAa,CAAC,WAAW,CAAC,CAAC;gBACvC,WAAW,CAAC,WAAW,CAAC;oBACtB,IAAI,EAAE,UAAU;oBAChB,MAAM,EAAE,MAAM;iBACf,CAAC,CAAC;gBACH,WAAW,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC;gBACnC,WAAW,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC;gBACnC,WAAW,CAAC,eAAe,CAAC;oBAC1B,MAAM,EAAE,GAAG;oBACX,IAAI,EAAE,EAAE,IAAI,EAAE,EAAE,EAAE;iBACnB,CAAC,CAAC;gBAEH,IAAM,IAAI,GAAQ,WAAW,CAAC,IAAI,EAAE,CAAC;gBACrC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC;YAC9D,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QACH,QAAQ,CAAC,6CAA6C,EAAE;YACtD,EAAE,CAAC,4CAA4C,EAAE;gBAC/C,WAAW,CAAC,aAAa,CAAC,WAAW,CAAC,CAAC;gBACvC,WAAW,CAAC,WAAW,CAAC;oBACtB,IAAI,EAAE,UAAU;oBAChB,MAAM,EAAE,MAAM;iBACf,CAAC,CAAC;gBACH,WAAW,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC;gBACnC,WAAW,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC;gBACnC,WAAW,CAAC,aAAa,CAAC,EAAE,CAAC,CAAC;gBAC9B,WAAW,CAAC,eAAe,CAAC;oBAC1B,MAAM,EAAE,GAAG;oBACX,IAAI,EAAE,EAAE,IAAI,EAAE,EAAE,EAAE;iBACnB,CAAC,CAAC;gBAEH,IAAM,IAAI,GAAQ,WAAW,CAAC,IAAI,EAAE,CAAC;gBACrC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC;YAC1D,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,YAAY,EAAE;QACrB,UAAU,CAAC;YACT,WAAW,CAAC,aAAa,CAAC,WAAW,CAAC,CAAC;YACvC,WAAW,CAAC,WAAW,CAAC;gBACtB,IAAI,EAAE,UAAU;gBAChB,MAAM,EAAE,MAAM;aACf,CAAC,CAAC;YACH,WAAW,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC;YACnC,WAAW,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC;YACnC,WAAW,CAAC,aAAa,CAAC;gBACxB,GAAG,EAAE,KAAK;aACX,CAAC,CAAC;YACH,WAAW,CAAC,eAAe,CAAC;gBAC1B,MAAM,EAAE,GAAG;gBACX,IAAI,EAAE,EAAE,IAAI,EAAE,EAAE,EAAE;aACnB,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,QAAQ,CAAC,2BAA2B,EAAE;YACpC,EAAE,CAAC,qBAAqB,EAAE;gBACxB,MAAM,CAAC,cAAM,OAAA,WAAW,CAAC,SAAS,CAAC,IAAW,CAAC,EAAlC,CAAkC,CAAC,CAAC,EAAE,CAAC,KAAK,EAAE,CAAC;YAC9D,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,QAAQ,CAAC,6BAA6B,EAAE;YACtC,EAAE,CAAC,qBAAqB,EAAE;gBACxB,MAAM,CAAC;oBACL,OAAA,WAAW,CAAC,SAAS,CAAC,2BAA2B,CAAC;gBAAlD,CAAkD,CACnD,CAAC,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;YACpB,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,QAAQ,CAAC,0BAA0B,EAAE;YACnC,QAAQ,CAAC,mBAAmB,EAAE;gBAC5B,EAAE,CAAC,0DAA0D,EAAE;oBAC7D,WAAW,CAAC,aAAa,CAAC,WAAW,CAAC,CAAC;oBACvC,WAAW,CAAC,WAAW,CAAC;wBACtB,IAAI,EAAE,UAAU;wBAChB,MAAM,EAAE,MAAM;qBACf,CAAC,CAAC;oBACH,WAAW,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC;oBACnC,WAAW,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC;oBACnC,WAAW,CAAC,eAAe,CAAC;wBAC1B,MAAM,EAAE,GAAG;wBACX,IAAI,EAAE,EAAE,IAAI,EAAE,EAAE,EAAE;qBACnB,CAAC,CAAC;oBAEH,IAAM,IAAI,GAAQ,WAAW,CAAC,IAAI,EAAE,CAAC;oBAErC,MAAM,CAAC,IAAA,oBAAS,EAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC;oBACvD,IAAM,CAAC,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;oBACzD,IAAM,gBAAgB,GAAG,kCAEzB,CAAC;oBACD,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC;gBAC/C,CAAC,CAAC,CAAC;YACL,CAAC,CAAC,CAAC;YAEH,QAAQ,CAAC,eAAe,EAAE;gBACxB,EAAE,CAAC,0DAA0D,EAAE;oBAC7D,WAAW,CAAC,SAAS,CAAC,iFAIpB,CAAC,CAAC;oBACJ,WAAW,CAAC,aAAa,CAAC;wBACxB,IAAI,EAAE,KAAK;qBACZ,CAAC,CAAC;oBACH,IAAM,IAAI,GAAQ,WAAW,CAAC,IAAI,EAAE,CAAC;oBAErC,MAAM,CAAC,IAAA,oBAAS,EAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC;oBACvD,IAAM,CAAC,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;oBACzD,6CAA6C;oBAC7C,IAAM,gBAAgB,GAAG,4CAA6C,CAAC;oBACvE,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC;gBAC/C,CAAC,CAAC,CAAC;YACL,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,OAAO,EAAE;QAChB,OAAO,CAAC,qBAAqB,EAAE;YAC7B,EAAE,CAAC,qBAAqB,EAAE;gBACxB,MAAM,CAAC,cAAM,OAAA,WAAW,CAAC,IAAI,EAAE,EAAlB,CAAkB,CAAC,CAAC,EAAE,CAAC,KAAK,EAAE,CAAC;YAC9C,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,OAAO,CAAC,2BAA2B,EAAE;YACnC,EAAE,CAAC,qBAAqB,EAAE;gBACxB,WAAW,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC;gBAEnC,OAAO,MAAM,CAAC,cAAM,OAAA,WAAW,CAAC,IAAI,EAAE,EAAlB,CAAkB,CAAC,CAAC,EAAE,CAAC,KAAK,EAAE,CAAC;YACrD,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,QAAQ,CAAC,+BAA+B,EAAE;YACxC,EAAE,CAAC,yCAAyC,EAAE;gBAC5C,WAAW,CAAC,aAAa,CAAC,WAAW,CAAC,CAAC;gBACvC,WAAW,CAAC,WAAW,CAAC;oBACtB,IAAI,EAAE,UAAU;oBAChB,MAAM,EAAE,MAAM;iBACf,CAAC,CAAC;gBACH,WAAW,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC;gBACnC,WAAW,CAAC,eAAe,CAAC;oBAC1B,MAAM,EAAE,GAAG;oBACX,IAAI,EAAE,EAAE,IAAI,EAAE,EAAE,EAAE;iBACnB,CAAC,CAAC;gBAEH,IAAM,IAAI,GAAQ,WAAW,CAAC,IAAI,EAAE,CAAC;gBACrC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,eAAe,CAAC,CAAC;YAClE,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,OAAO,CAAC,0BAA0B,EAAE;QAClC,EAAE,CAAC,4BAA4B,EAAE;YAC/B,WAAW,CAAC,aAAa,CAAC,WAAW,CAAC,CAAC;YACvC,WAAW,CAAC,WAAW,CAAC;gBACtB,IAAI,EAAE,UAAU;gBAChB,MAAM,EAAE,MAAM;aACf,CAAC,CAAC;YACH,WAAW,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC;YACnC,WAAW,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC;YACnC,WAAW,CAAC,eAAe,CAAC;gBAC1B,MAAM,EAAE,GAAG;gBACX,IAAI,EAAE,EAAE,IAAI,EAAE,EAAE,EAAE;aACnB,CAAC,CAAC;YAEH,IAAM,IAAI,GAAQ,WAAW,CAAC,IAAI,EAAE,CAAC;YACrC,MAAM,CAAC,IAAA,oBAAS,EAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC;YACvD,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,WAAW,CAAC,CAAC;QAChE,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/{dsl → src/dsl}/interaction.d.ts

@@ -2,27 +2,26 @@
  * An Interaction is where you define the state of your interaction with a Provider.
  * @module Interaction
  */
-import { HTTPMethod, methods } from "../common/request";
-import { MatcherResult } from "./matchers";
+import { HTTPMethods, HTTPMethod } from '../common/request';
+import { Matcher, AnyTemplate } from './matchers';
 interface QueryObject {
-    [name: string]: string | MatcherResult | string[];
+    [name: string]: string | Matcher<string> | string[];
 }
 export declare type Query = string | QueryObject;
+export declare type Headers = {
+    [header: string]: string | Matcher<string>;
+};
 export interface RequestOptions {
-    method: HTTPMethod | methods;
-    path: string | MatcherResult;
+    method: HTTPMethods | HTTPMethod;
+    path: string | Matcher<string>;
     query?: Query;
-    headers?: {
-        [name: string]: string | MatcherResult;
-    };
-    body?: any;
+    headers?: Headers;
+    body?: AnyTemplate;
 }
 export interface ResponseOptions {
-    status: number | MatcherResult;
-    headers?: {
-        [name: string]: string | MatcherResult;
-    };
-    body?: any;
+    status: number;
+    headers?: Headers;
+    body?: AnyTemplate;
 }
 export interface InteractionObject {
     state: string | undefined;
@@ -36,6 +35,12 @@ export interface InteractionState {
     request?: RequestOptions;
     response?: ResponseOptions;
 }
+export interface InteractionStateComplete {
+    providerState?: string;
+    description: string;
+    request: RequestOptions;
+    response: ResponseOptions;
+}
 export declare class Interaction {
     protected state: InteractionState;
     /**
@@ -67,17 +72,14 @@ export declare class Interaction {
      * @param {string} responseOpts.status - The HTTP status
      * @param {string} responseOpts.headers
      * @param {Object} responseOpts.body
+     * @returns {Interaction} interaction
      */
     willRespondWith(responseOpts: ResponseOptions): this;
     /**
      * Returns the interaction object created.
      * @returns {Object}
      */
-    json(): InteractionState;
-    /**
-     * Returns valid if object or matcher only contains string values
-     * @param query
-     */
-    private queryObjectIsValid;
+    json(): InteractionStateComplete;
 }
+export declare const interactionToInteractionObject: (interaction: InteractionStateComplete) => InteractionObject;
 export {};

package/src/dsl/interaction.js

@@ -0,0 +1,144 @@
+"use strict";
+/**
+ * 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 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 oject 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, lodash_1.omitBy)(requestOpts, lodash_1.isNil);
+        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, lodash_1.omitBy)({
+            body: responseOpts.body,
+            headers: responseOpts.headers || undefined,
+            status: responseOpts.status,
+        }, lodash_1.isNil);
+        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

package/src/dsl/interaction.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"interaction.js","sourceRoot":"","sources":["../../../src/dsl/interaction.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;;;;AAEH,iCAA6C;AAC7C,6CAA4D;AAC5D,uCAA6D;AAC7D,oFAA8D;AA8C9D;;;GAGG;AACH,IAAM,yBAAyB,GAAG,UAAC,KAAkB;IACnD,IAAI,IAAA,oBAAS,EAAC,KAAK,CAAC,EAAE;QACpB,OAAO;KACR;IAED,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,UAAC,KAAK;QACjC,IACE,CAAC,CAAC,IAAA,oBAAS,EAAC,KAAK,CAAC,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,OAAO,KAAK,KAAK,QAAQ,CAAC,EACxE;YACA,MAAM,IAAI,4BAAkB,CAAC,kCAAkC,CAAC,CAAC;SAClE;IACH,CAAC,CAAC,CAAC;AACL,CAAC,CAAC;AAEF;IAAA;QACY,UAAK,GAAqB,EAAE,CAAC;IAuHzC,CAAC;IArHC;;;;OAIG;IACI,2BAAK,GAAZ,UAAa,aAAqB;QAChC,IAAI,aAAa,EAAE;YACjB,IAAI,CAAC,KAAK,CAAC,aAAa,GAAG,aAAa,CAAC;SAC1C;QAED,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;OAIG;IACI,mCAAa,GAApB,UAAqB,WAAmB;QACtC,IAAI,IAAA,cAAK,EAAC,WAAW,CAAC,EAAE;YACtB,MAAM,IAAI,4BAAkB,CAC1B,qDAAqD,CACtD,CAAC;SACH;QACD,IAAI,CAAC,KAAK,CAAC,WAAW,GAAG,WAAW,CAAC;QAErC,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;;OASG;IACI,iCAAW,GAAlB,UAAmB,WAA2B;QAC5C,IAAI,IAAA,cAAK,EAAC,WAAW,CAAC,MAAM,CAAC,EAAE;YAC7B,MAAM,IAAI,4BAAkB,CAAC,kCAAkC,CAAC,CAAC;SAClE;QAED,IAAI,IAAA,aAAI,EAAC,qBAAW,CAAC,CAAC,OAAO,CAAC,WAAW,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC,GAAG,CAAC,EAAE;YAChE,MAAM,IAAI,4BAAkB,CAC1B,gDAAyC,IAAA,aAAI,EAAC,qBAAW,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,MAAG,CACzE,CAAC;SACH;QAED,IAAI,IAAA,cAAK,EAAC,WAAW,CAAC,IAAI,CAAC,EAAE;YAC3B,MAAM,IAAI,4BAAkB,CAAC,0BAA0B,CAAC,CAAC;SAC1D;QAED,IAAI,OAAO,WAAW,CAAC,KAAK,KAAK,QAAQ,EAAE;YACzC,yBAAyB,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC;SAC9C;QAED,IAAI,CAAC,KAAK,CAAC,OAAO,GAAG,IAAA,eAAM,EAAC,WAAW,EAAE,cAAK,CAAmB,CAAC;QAElE,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;OAOG;IACI,qCAAe,GAAtB,UAAuB,YAA6B;QAClD,IACE,IAAA,cAAK,EAAC,YAAY,CAAC,MAAM,CAAC;YAC1B,YAAY,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC,IAAI,EAAE,CAAC,MAAM,KAAK,CAAC,EAClD;YACA,MAAM,IAAI,4BAAkB,CAAC,iCAAiC,CAAC,CAAC;SACjE;QAED,IAAI,CAAC,KAAK,CAAC,QAAQ,GAAG,IAAA,eAAM,EAC1B;YACE,IAAI,EAAE,YAAY,CAAC,IAAI;YACvB,OAAO,EAAE,YAAY,CAAC,OAAO,IAAI,SAAS;YAC1C,MAAM,EAAE,YAAY,CAAC,MAAM;SAC5B,EACD,cAAK,CACa,CAAC;QACrB,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;OAGG;IACI,0BAAI,GAAX;;QACE,IAAI,IAAA,cAAK,EAAC,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,EAAE;YACjC,MAAM,IAAI,4BAAkB,CAC1B,oDAAoD,CACrD,CAAC;SACH;QACD,IACE,IAAA,cAAK,EAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC;YACzB,IAAA,cAAK,EAAC,MAAA,MAAA,IAAI,CAAC,KAAK,0CAAE,OAAO,0CAAE,MAAM,CAAC;YAClC,IAAA,cAAK,EAAC,MAAA,MAAA,IAAI,CAAC,KAAK,0CAAE,OAAO,0CAAE,IAAI,CAAC,EAChC;YACA,MAAM,IAAI,4BAAkB,CAC1B,gFAAgF,CACjF,CAAC;SACH;QACD,IAAI,IAAA,cAAK,EAAC,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,IAAA,cAAK,EAAC,MAAA,MAAA,IAAI,CAAC,KAAK,0CAAE,QAAQ,0CAAE,MAAM,CAAC,EAAE;YACrE,MAAM,IAAI,4BAAkB,CAC1B,+DAA+D,CAChE,CAAC;SACH;QAED,OAAO,IAAI,CAAC,KAAiC,CAAC;IAChD,CAAC;IACH,kBAAC;AAAD,CAAC,AAxHD,IAwHC;AAxHY,kCAAW;AA0HjB,IAAM,8BAA8B,GAAG,UAC5C,WAAqC;;IAErC,OAAO;QACL,KAAK,EAAE,WAAW,CAAC,aAAa;QAChC,aAAa,EAAE,WAAW,CAAC,WAAW;QACtC,WAAW,EAAE;YACX,MAAM,EAAE,MAAA,WAAW,CAAC,OAAO,0CAAE,MAAM;YACnC,IAAI,EAAE,MAAA,WAAW,CAAC,OAAO,0CAAE,IAAI;YAC/B,KAAK,EAAE,MAAA,WAAW,CAAC,OAAO,0CAAE,KAAK;YACjC,IAAI,EAAE,MAAA,WAAW,CAAC,OAAO,0CAAE,IAAI;YAC/B,OAAO,EAAE,MAAA,WAAW,CAAC,OAAO,0CAAE,OAAO;SACtC;QACD,eAAe,EAAE;YACf,MAAM,EAAE,MAAA,WAAW,CAAC,QAAQ,0CAAE,MAAM;YACpC,IAAI,EAAE,MAAA,WAAW,CAAC,QAAQ,0CAAE,IAAI;YAChC,OAAO,EAAE,MAAA,WAAW,CAAC,QAAQ,0CAAE,OAAO;SACvC;KACF,CAAC;AACJ,CAAC,CAAC;AAnBW,QAAA,8BAA8B,kCAmBzC"}