@ehuelsmann/chai-openapi-response-validator 0.15.0

package/README.md

@@ -0,0 +1,379 @@
+# Chai OpenAPI Response Validator
+
+[![downloads](https://img.shields.io/npm/dm/@ehuelsmann%2Fchai-openapi-response-validator)](https://www.npmjs.com/package/@ehuelsmann/chai-openapi-response-validator)
+[![npm](https://img.shields.io/npm/v/@ehuelsmann%2Fchai-openapi-response-validator.svg)](https://www.npmjs.com/package/@ehuelsmann/chai-openapi-response-validator)
+![build status](https://github.com/openapi-library/OpenAPIValidators/actions/workflows/ci.yml/badge.svg)
+![style](https://img.shields.io/badge/code%20style-airbnb-ff5a5f.svg)
+[![codecov](https://codecov.io/gh/openapi-library/OpenAPIValidators/branch/master/graph/badge.svg)](https://codecov.io/gh/openapi-library/OpenAPIValidators)
+[![included](https://badgen.net/npm/types/@ehuelsmann%2Fchai-openapi-response-validator)](https://github.com/openapi-library/OpenAPIValidators/blob/master/packages/chai-openapi-response-validator/lib/index.ts)
+[![contributions welcome](https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat)](https://github.com/openapi-library/OpenAPIValidators/blob/master/CONTRIBUTING.md)
+
+Use Chai to assert that HTTP responses satisfy an OpenAPI spec.
+
+## Problem 😕
+
+If your server's behaviour doesn't match your API documentation, then you need to correct your server, your documentation, or both. The sooner you know the better.
+
+## Solution 😄
+
+This plugin lets you automatically test whether your server's behaviour and documentation match. It extends the [Chai Assertion Library](https://www.chaijs.com/) to support the [OpenAPI standard](https://swagger.io/docs/specification/about/) for documenting REST APIs. In your JavaScript tests, you can simply assert [`expect(responseObject).to.satisfyApiSpec`](#in-api-tests-validate-the-status-and-body-of-http-responses-against-your-openapi-spec)
+
+Features:
+
+- Validates the status and body of HTTP responses against your OpenAPI spec [(see example)](#in-api-tests-validate-the-status-and-body-of-http-responses-against-your-openapi-spec)
+- Validates objects against schemas defined in your OpenAPI spec [(see example)](#in-unit-tests-validate-objects-against-schemas-defined-in-your-OpenAPI-spec)
+- Load your OpenAPI spec just once in your tests (load from a filepath or object)
+- Supports OpenAPI [2](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md) and [3](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md)
+- Supports OpenAPI specs in YAML and JSON formats
+- Supports `$ref` in response definitions (i.e. `$ref: '#/definitions/ComponentType/ComponentName'`)
+- Informs you if your OpenAPI spec is invalid
+- Supports responses from `axios`, `request-promise`, `supertest`, `superagent`, and `chai-http`
+- Use in [Mocha](#usage) and other test runners
+
+## Contributing ✨
+
+If you've come here to help contribute - thanks! Take a look at the [contributing](https://github.com/openapi-library/OpenAPIValidators/blob/master/CONTRIBUTING.md) docs to get started.
+
+## Installation
+
+[npm](http://npmjs.org)
+
+```bash
+npm install --save-dev @ehuelsmann/chai-openapi-response-validator
+```
+
+[yarn](https://yarnpkg.com/)
+
+```bash
+yarn add --dev @ehuelsmann/chai-openapi-response-validator
+```
+
+## Importing
+
+ES6 / TypeScript
+
+```typescript
+import chaiResponseValidator from '@ehuelsmann/chai-openapi-response-validator';
+```
+
+CommonJS / JavaScript
+
+<!-- prettier-ignore -->
+```javascript
+const chaiResponseValidator = require('@ehuelsmann/chai-openapi-response-validator').default;
+```
+
+## Usage
+
+### In API tests, validate the status and body of HTTP responses against your OpenAPI spec:
+
+#### 1. Write a test:
+
+```javascript
+// Set up Chai
+import chai from 'chai';
+const expect = chai.expect;
+
+// Import this plugin
+import chaiResponseValidator from '@ehuelsmann/chai-openapi-response-validator';
+
+// Load an OpenAPI file (YAML or JSON) into this plugin
+chai.use(chaiResponseValidator('path/to/openapi.yml'));
+
+// Write your test (e.g. using Mocha)
+describe('GET /example/endpoint', () => {
+  it('should satisfy OpenAPI spec', async () => {
+    // Get an HTTP response from your server (e.g. using axios)
+    const res = await axios.get('http://localhost:3000/example/endpoint');
+
+    expect(res.status).to.equal(200);
+
+    // Assert that the HTTP response satisfies the OpenAPI spec
+    expect(res).to.satisfyApiSpec;
+  });
+});
+```
+
+#### 2. Write an OpenAPI Spec (and save to `path/to/openapi.yml`):
+
+```yaml
+openapi: 3.0.0
+info:
+  title: Example API
+  version: 1.0.0
+paths:
+  /example:
+    get:
+      responses:
+        200:
+          description: Response body should be an object with fields 'stringProperty' and 'integerProperty'
+          content:
+            application/json:
+              schema:
+                type: object
+                required:
+                  - stringProperty
+                  - integerProperty
+                properties:
+                  stringProperty:
+                    type: string
+                  integerProperty:
+                    type: integer
+```
+
+#### 3. Run your test to validate your server's response against your OpenAPI spec:
+
+##### The assertion passes if the response status and body satisfy `openapi.yml`:
+
+```javascript
+// Response includes:
+{
+  status: 200,
+  body: {
+    stringProperty: 'string',
+    integerProperty: 123,
+  },
+};
+```
+
+##### The assertion fails if the response body is invalid:
+
+```javascript
+// Response includes:
+{
+  status: 200,
+  body: {
+    stringProperty: 'string',
+    integerProperty: 'invalid (should be an integer)',
+  },
+};
+```
+
+###### Output from test failure:
+
+```javascript
+AssertionError: expected res to satisfy API spec
+
+expected res to satisfy the '200' response defined for endpoint 'GET /example/endpoint' in your API spec
+res did not satisfy it because: integerProperty should be integer
+
+res contained: {
+  body: {
+      stringProperty: 'string',
+      integerProperty: 'invalid (should be an integer)'
+    }
+  }
+}
+
+The '200' response defined for endpoint 'GET /example/endpoint' in API spec: {
+  '200': {
+    description: 'Response body should be a string',
+    content: {
+      'application/json': {
+        schema: {
+          type: 'string'
+        }
+      }
+    }
+  },
+}
+```
+
+### In unit tests, validate objects against schemas defined in your OpenAPI spec:
+
+#### 1. Write a test:
+
+```javascript
+// Set up Chai
+import chai from 'chai';
+const expect = chai.expect;
+
+// Import this plugin and the function you want to test
+import chaiResponseValidator from '@ehuelsmann/chai-openapi-response-validator';
+import { functionToTest } from 'path/to/your/code';
+
+// Load an OpenAPI file (YAML or JSON) into this plugin
+chai.use(chaiResponseValidator('path/to/openapi.yml'));
+
+// Write your test (e.g. using Mocha)
+describe('functionToTest()', () => {
+  it('should satisfy OpenAPI spec', async () => {
+    // Assert that the function returns a value satisfying a schema defined in your OpenAPI spec
+    expect(functionToTest()).to.satisfySchemaInApiSpec('ExampleSchemaObject');
+  });
+});
+```
+
+#### 2. Write an OpenAPI Spec (and save to `path/to/openapi.yml`):
+
+```yaml
+openapi: 3.0.0
+info:
+  title: Example API
+  version: 1.0.0
+paths:
+  /example:
+    get:
+      responses:
+        200:
+          description: Response body should be an ExampleSchemaObject
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ExampleSchemaObject'
+components:
+  schemas:
+    ExampleSchemaObject:
+      type: object
+      required:
+        - stringProperty
+        - integerProperty
+      properties:
+        stringProperty:
+          type: string
+        integerProperty:
+          type: integer
+```
+
+#### 3. Run your test to validate your object against your OpenAPI spec:
+
+##### The assertion passes if the object satisfies the schema `ExampleSchemaObject`:
+
+```javascript
+// object includes:
+{
+  stringProperty: 'string',
+  integerProperty: 123,
+};
+```
+
+##### The assertion fails if the object does not satisfy the schema `ExampleSchemaObject`:
+
+```javascript
+// object includes:
+{
+  stringProperty: 123,
+  integerProperty: 123,
+};
+```
+
+###### Output from test failure:
+
+```javascript
+AssertionError: expected object to satisfy schema 'ExampleSchemaObject' defined in API spec:
+object did not satisfy it because: stringProperty should be string
+
+object was: {
+    {
+      stringProperty: 123,
+      integerProperty: 123
+    }
+  }
+}
+
+The 'ExampleSchemaObject' schema in API spec: {
+  type: 'object',
+  required: [
+    'stringProperty'
+    'integerProperty'
+  ],
+  properties: {
+    stringProperty: {
+      type: 'string'
+    },
+    integerProperty: {
+      type: 'integer'
+    }
+  }
+}
+```
+
+### Loading your OpenAPI spec (3 different ways):
+
+#### 1. From an absolute filepath ([see above](#usage))
+
+#### 2. From an object:
+
+```javascript
+// Set up Chai
+import chai from 'chai';
+const expect = chai.expect;
+
+// Import this plugin
+import chaiResponseValidator from '@ehuelsmann/chai-openapi-response-validator';
+
+// Get an object representing your OpenAPI spec
+const openApiSpec = {
+  openapi: '3.0.0',
+  info: {
+    title: 'Example API',
+    version: '0.1.0',
+  },
+  paths: {
+    '/example/endpoint': {
+      get: {
+        responses: {
+          200: {
+            description: 'Response body should be a string',
+            content: {
+              'application/json': {
+                schema: {
+                  type: 'string',
+                },
+              },
+            },
+          },
+        },
+      },
+    },
+  },
+};
+
+// Load that OpenAPI object into this plugin
+chai.use(chaiResponseValidator(openApiSpec));
+
+// Write your test (e.g. using Mocha)
+describe('GET /example/endpoint', () => {
+  it('should satisfy OpenAPI spec', async () => {
+    // Get an HTTP response from your server (e.g. using axios)
+    const res = await axios.get('http://localhost:3000/example/endpoint');
+
+    expect(res.status).to.equal(200);
+
+    // Assert that the HTTP response satisfies the OpenAPI spec
+    expect(res).to.satisfyApiSpec;
+  });
+});
+```
+
+#### 3. From a web endpoint:
+
+```javascript
+// Set up Chai
+import chai from 'chai';
+const expect = chai.expect;
+
+// Import this plugin and an HTTP client (e.g. axios)
+import chaiResponseValidator from '@ehuelsmann/chai-openapi-response-validator';
+import axios from 'axios';
+
+// Write your test (e.g. using Mocha)
+describe('GET /example/endpoint', () => {
+  // Load your OpenAPI spec from a web endpoint
+  before(async () => {
+    const response = await axios.get('url/to/openapi/spec');
+    const openApiSpec = response.data; // e.g. { openapi: '3.0.0', <etc> };
+    chai.use(chaiResponseValidator(openApiSpec));
+  });
+
+  it('should satisfy OpenAPI spec', async () => {
+    // Get an HTTP response from your server (e.g. using axios)
+    const res = await axios.get('http://localhost:3000/example/endpoint');
+
+    expect(res.status).to.equal(200);
+
+    // Assert that the HTTP response satisfies the OpenAPI spec
+    expect(res).to.satisfyApiSpec;
+  });
+});
+```

package/dist/assertions/satisfyApiSpec.d.ts

@@ -0,0 +1,3 @@
+import { OpenApiSpec } from '@ehuelsmann/openapi-validator';
+export default function (chai: Chai.ChaiStatic, openApiSpec: OpenApiSpec): void;
+//# sourceMappingURL=satisfyApiSpec.d.ts.map

package/dist/assertions/satisfyApiSpec.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"satisfyApiSpec.d.ts","sourceRoot":"","sources":["../../lib/assertions/satisfyApiSpec.ts"],"names":[],"mappings":"AAAA,OAAO,EAML,WAAW,EAEZ,MAAM,+BAA+B,CAAC;AAGvC,MAAM,CAAC,OAAO,WACZ,IAAI,EAAE,IAAI,CAAC,UAAU,EACrB,WAAW,EAAE,WAAW,GACvB,IAAI,CAuBN"}

package/dist/assertions/satisfyApiSpec.js

@@ -0,0 +1,70 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = default_1;
+const openapi_validator_1 = require("@ehuelsmann/openapi-validator");
+const utils_1 = require("../utils");
+function default_1(chai, openApiSpec) {
+    const { Assertion } = chai;
+    Assertion.addProperty('satisfyApiSpec', function () {
+        const actualResponse = (0, openapi_validator_1.makeResponse)(this._obj); // eslint-disable-line no-underscore-dangle
+        const validationError = openApiSpec.validateResponse(actualResponse);
+        const pass = !validationError;
+        this.assert(pass, pass
+            ? ''
+            : getExpectedResToSatisfyApiSpecMsg(actualResponse, openApiSpec, validationError), pass
+            ? getExpectedResNotToSatisfyApiSpecMsg(actualResponse, openApiSpec)
+            : '', null);
+    });
+}
+function getExpectedResToSatisfyApiSpecMsg(actualResponse, openApiSpec, validationError) {
+    const hint = 'expected res to satisfy API spec';
+    const { status, req } = actualResponse;
+    const { method, path: requestPath } = req;
+    const unmatchedEndpoint = `${method} ${requestPath}`;
+    if (validationError.code === openapi_validator_1.ErrorCode.ServerNotFound) {
+        return (0, utils_1.joinWithNewLines)(hint, `expected res to satisfy a '${status}' response defined for endpoint '${unmatchedEndpoint}' in your API spec`, `res had request path '${requestPath}', but your API spec has no matching servers`, `Servers found in API spec: ${openApiSpec
+            .getServerUrls()
+            .join(', ')}`);
+    }
+    if (validationError.code === openapi_validator_1.ErrorCode.BasePathNotFound) {
+        return (0, utils_1.joinWithNewLines)(hint, `expected res to satisfy a '${status}' response defined for endpoint '${unmatchedEndpoint}' in your API spec`, `res had request path '${requestPath}', but your API spec has basePath '${openApiSpec.spec.basePath}'`);
+    }
+    if (validationError.code === openapi_validator_1.ErrorCode.PathNotFound) {
+        const pathNotFoundErrorMessage = (0, utils_1.joinWithNewLines)(hint, `expected res to satisfy a '${status}' response defined for endpoint '${unmatchedEndpoint}' in your API spec`, `res had request path '${requestPath}', but your API spec has no matching path`, `Paths found in API spec: ${openApiSpec.paths().join(', ')}`);
+        if ('didUserDefineBasePath' in openApiSpec &&
+            openApiSpec.didUserDefineBasePath) {
+            return (0, utils_1.joinWithNewLines)(pathNotFoundErrorMessage, `'${requestPath}' matches basePath \`${openApiSpec.spec.basePath}\` but no <basePath/endpointPath> combinations`);
+        }
+        if ('didUserDefineServers' in openApiSpec &&
+            openApiSpec.didUserDefineServers) {
+            return (0, utils_1.joinWithNewLines)(pathNotFoundErrorMessage, `'${requestPath}' matches servers ${(0, utils_1.stringify)(openApiSpec.getMatchingServerUrls(requestPath))} but no <server/endpointPath> combinations`);
+        }
+        return pathNotFoundErrorMessage;
+    }
+    const path = openApiSpec.findOpenApiPathMatchingRequest(req);
+    const endpoint = `${method} ${path}`;
+    if (validationError.code === openapi_validator_1.ErrorCode.MethodNotFound) {
+        const expectedPathItem = openApiSpec.findExpectedPathItem(req);
+        const expectedRequestOperations = Object.keys(expectedPathItem)
+            .map((operation) => operation.toUpperCase())
+            .join(', ');
+        return (0, utils_1.joinWithNewLines)(hint, `expected res to satisfy a '${status}' response defined for endpoint '${endpoint}' in your API spec`, `res had request method '${method}', but your API spec has no '${method}' operation defined for path '${path}'`, `Request operations found for path '${path}' in API spec: ${expectedRequestOperations}`);
+    }
+    if (validationError.code === openapi_validator_1.ErrorCode.StatusNotFound) {
+        const expectedResponseOperation = 
+        // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+        openApiSpec.findExpectedResponseOperation(req);
+        const expectedResponseStatuses = Object.keys(expectedResponseOperation.responses).join(', ');
+        return (0, utils_1.joinWithNewLines)(hint, `expected res to satisfy a '${status}' response defined for endpoint '${endpoint}' in your API spec`, `res had status '${status}', but your API spec has no '${status}' response defined for endpoint '${endpoint}'`, `Response statuses found for endpoint '${endpoint}' in API spec: ${expectedResponseStatuses}`);
+    }
+    // validationError.code === ErrorCode.InvalidBody
+    const responseDefinition = openApiSpec.findExpectedResponse(actualResponse);
+    return (0, utils_1.joinWithNewLines)(hint, `expected res to satisfy the '${status}' response defined for endpoint '${endpoint}' in your API spec`, `res did not satisfy it because: ${validationError}`, `res contained: ${actualResponse.toString()}`, `The '${status}' response defined for endpoint '${endpoint}' in API spec: ${(0, utils_1.stringify)(responseDefinition)}`);
+}
+function getExpectedResNotToSatisfyApiSpecMsg(actualResponse, openApiSpec) {
+    const { status, req } = actualResponse;
+    const responseDefinition = openApiSpec.findExpectedResponse(actualResponse);
+    const endpoint = `${req.method} ${openApiSpec.findOpenApiPathMatchingRequest(req)}`;
+    return (0, utils_1.joinWithNewLines)(`expected res not to satisfy API spec`, `expected res not to satisfy the '${status}' response defined for endpoint '${endpoint}' in your API spec`, `res contained: ${actualResponse.toString()}`, `The '${status}' response defined for endpoint '${endpoint}' in API spec: ${(0, utils_1.stringify)(responseDefinition)}`);
+}
+//# sourceMappingURL=satisfyApiSpec.js.map

package/dist/assertions/satisfyApiSpec.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"satisfyApiSpec.js","sourceRoot":"","sources":["../../lib/assertions/satisfyApiSpec.ts"],"names":[],"mappings":";;AAWA,4BA0BC;AArCD,qEAQuC;AACvC,oCAAuD;AAEvD,mBACE,IAAqB,EACrB,WAAwB;IAExB,MAAM,EAAE,SAAS,EAAE,GAAG,IAAI,CAAC;IAE3B,SAAS,CAAC,WAAW,CAAC,gBAAgB,EAAE;QACtC,MAAM,cAAc,GAAG,IAAA,gCAAY,EAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,2CAA2C;QAE3F,MAAM,eAAe,GAAG,WAAW,CAAC,gBAAgB,CAAC,cAAc,CAAC,CAAC;QACrE,MAAM,IAAI,GAAG,CAAC,eAAe,CAAC;QAC9B,IAAI,CAAC,MAAM,CACT,IAAI,EACJ,IAAI;YACF,CAAC,CAAC,EAAE;YACJ,CAAC,CAAC,iCAAiC,CAC/B,cAAc,EACd,WAAW,EACX,eAAe,CAChB,EACL,IAAI;YACF,CAAC,CAAC,oCAAoC,CAAC,cAAc,EAAE,WAAW,CAAC;YACnE,CAAC,CAAC,EAAE,EACN,IAAI,CACL,CAAC;IACJ,CAAC,CAAC,CAAC;AACL,CAAC;AAED,SAAS,iCAAiC,CACxC,cAA8B,EAC9B,WAAwB,EACxB,eAAgC;IAEhC,MAAM,IAAI,GAAG,kCAAkC,CAAC;IAEhD,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,GAAG,cAAc,CAAC;IACvC,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,WAAW,EAAE,GAAG,GAAG,CAAC;IAC1C,MAAM,iBAAiB,GAAG,GAAG,MAAM,IAAI,WAAW,EAAE,CAAC;IAErD,IAAI,eAAe,CAAC,IAAI,KAAK,6BAAS,CAAC,cAAc,EAAE,CAAC;QACtD,OAAO,IAAA,wBAAgB,EACrB,IAAI,EACJ,8BAA8B,MAAM,oCAAoC,iBAAiB,oBAAoB,EAC7G,yBAAyB,WAAW,8CAA8C,EAClF,8BAA+B,WAA4B;aACxD,aAAa,EAAE;aACf,IAAI,CAAC,IAAI,CAAC,EAAE,CAChB,CAAC;IACJ,CAAC;IAED,IAAI,eAAe,CAAC,IAAI,KAAK,6BAAS,CAAC,gBAAgB,EAAE,CAAC;QACxD,OAAO,IAAA,wBAAgB,EACrB,IAAI,EACJ,8BAA8B,MAAM,oCAAoC,iBAAiB,oBAAoB,EAC7G,yBAAyB,WAAW,sCACjC,WAA4B,CAAC,IAAI,CAAC,QACrC,GAAG,CACJ,CAAC;IACJ,CAAC;IAED,IAAI,eAAe,CAAC,IAAI,KAAK,6BAAS,CAAC,YAAY,EAAE,CAAC;QACpD,MAAM,wBAAwB,GAAG,IAAA,wBAAgB,EAC/C,IAAI,EACJ,8BAA8B,MAAM,oCAAoC,iBAAiB,oBAAoB,EAC7G,yBAAyB,WAAW,2CAA2C,EAC/E,4BAA4B,WAAW,CAAC,KAAK,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAC7D,CAAC;QAEF,IACE,uBAAuB,IAAI,WAAW;YACtC,WAAW,CAAC,qBAAqB,EACjC,CAAC;YACD,OAAO,IAAA,wBAAgB,EACrB,wBAAwB,EACxB,IAAI,WAAW,wBAAwB,WAAW,CAAC,IAAI,CAAC,QAAQ,gDAAgD,CACjH,CAAC;QACJ,CAAC;QAED,IACE,sBAAsB,IAAI,WAAW;YACrC,WAAW,CAAC,oBAAoB,EAChC,CAAC;YACD,OAAO,IAAA,wBAAgB,EACrB,wBAAwB,EACxB,IAAI,WAAW,qBAAqB,IAAA,iBAAS,EAC3C,WAAW,CAAC,qBAAqB,CAAC,WAAW,CAAC,CAC/C,4CAA4C,CAC9C,CAAC;QACJ,CAAC;QACD,OAAO,wBAAwB,CAAC;IAClC,CAAC;IAED,MAAM,IAAI,GAAG,WAAW,CAAC,8BAA8B,CAAC,GAAG,CAAC,CAAC;IAC7D,MAAM,QAAQ,GAAG,GAAG,MAAM,IAAI,IAAI,EAAE,CAAC;IAErC,IAAI,eAAe,CAAC,IAAI,KAAK,6BAAS,CAAC,cAAc,EAAE,CAAC;QACtD,MAAM,gBAAgB,GAAG,WAAW,CAAC,oBAAoB,CAAC,GAAG,CAAC,CAAC;QAC/D,MAAM,yBAAyB,GAAG,MAAM,CAAC,IAAI,CAAC,gBAAgB,CAAC;aAC5D,GAAG,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,SAAS,CAAC,WAAW,EAAE,CAAC;aAC3C,IAAI,CAAC,IAAI,CAAC,CAAC;QACd,OAAO,IAAA,wBAAgB,EACrB,IAAI,EACJ,8BAA8B,MAAM,oCAAoC,QAAQ,oBAAoB,EACpG,2BAA2B,MAAM,gCAAgC,MAAM,iCAAiC,IAAI,GAAG,EAC/G,sCAAsC,IAAI,kBAAkB,yBAAyB,EAAE,CACxF,CAAC;IACJ,CAAC;IAED,IAAI,eAAe,CAAC,IAAI,KAAK,6BAAS,CAAC,cAAc,EAAE,CAAC;QACtD,MAAM,yBAAyB;QAC7B,oEAAoE;QACpE,WAAW,CAAC,6BAA6B,CAAC,GAAG,CAAE,CAAC;QAClD,MAAM,wBAAwB,GAAG,MAAM,CAAC,IAAI,CAC1C,yBAAyB,CAAC,SAAS,CACpC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACb,OAAO,IAAA,wBAAgB,EACrB,IAAI,EACJ,8BAA8B,MAAM,oCAAoC,QAAQ,oBAAoB,EACpG,mBAAmB,MAAM,gCAAgC,MAAM,oCAAoC,QAAQ,GAAG,EAC9G,yCAAyC,QAAQ,kBAAkB,wBAAwB,EAAE,CAC9F,CAAC;IACJ,CAAC;IAED,iDAAiD;IACjD,MAAM,kBAAkB,GAAG,WAAW,CAAC,oBAAoB,CAAC,cAAc,CAAC,CAAC;IAC5E,OAAO,IAAA,wBAAgB,EACrB,IAAI,EACJ,gCAAgC,MAAM,oCAAoC,QAAQ,oBAAoB,EACtG,mCAAmC,eAAe,EAAE,EACpD,kBAAkB,cAAc,CAAC,QAAQ,EAAE,EAAE,EAC7C,QAAQ,MAAM,oCAAoC,QAAQ,kBAAkB,IAAA,iBAAS,EACnF,kBAAkB,CACnB,EAAE,CACJ,CAAC;AACJ,CAAC;AAED,SAAS,oCAAoC,CAC3C,cAA8B,EAC9B,WAAwB;IAExB,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,GAAG,cAAc,CAAC;IACvC,MAAM,kBAAkB,GAAG,WAAW,CAAC,oBAAoB,CAAC,cAAc,CAAC,CAAC;IAC5E,MAAM,QAAQ,GAAG,GAAG,GAAG,CAAC,MAAM,IAAI,WAAW,CAAC,8BAA8B,CAC1E,GAAG,CACJ,EAAE,CAAC;IAEJ,OAAO,IAAA,wBAAgB,EACrB,sCAAsC,EACtC,oCAAoC,MAAM,oCAAoC,QAAQ,oBAAoB,EAC1G,kBAAkB,cAAc,CAAC,QAAQ,EAAE,EAAE,EAC7C,QAAQ,MAAM,oCAAoC,QAAQ,kBAAkB,IAAA,iBAAS,EACnF,kBAAkB,CACnB,EAAE,CACJ,CAAC;AACJ,CAAC"}

package/dist/assertions/satisfySchemaInApiSpec.d.ts

@@ -0,0 +1,3 @@
+import type { OpenApiSpec } from '@ehuelsmann/openapi-validator';
+export default function (chai: Chai.ChaiStatic, openApiSpec: OpenApiSpec): void;
+//# sourceMappingURL=satisfySchemaInApiSpec.d.ts.map

package/dist/assertions/satisfySchemaInApiSpec.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"satisfySchemaInApiSpec.d.ts","sourceRoot":"","sources":["../../lib/assertions/satisfySchemaInApiSpec.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAA2B,MAAM,+BAA+B,CAAC;AAG1F,MAAM,CAAC,OAAO,WACZ,IAAI,EAAE,IAAI,CAAC,UAAU,EACrB,WAAW,EAAE,WAAW,GACvB,IAAI,CAmCN"}

package/dist/assertions/satisfySchemaInApiSpec.js

@@ -0,0 +1,28 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = default_1;
+const utils_1 = require("../utils");
+function default_1(chai, openApiSpec) {
+    const { Assertion, AssertionError } = chai;
+    Assertion.addMethod('satisfySchemaInApiSpec', function (schemaName) {
+        const actualObject = this._obj; // eslint-disable-line no-underscore-dangle
+        const schema = openApiSpec.getSchemaObject(schemaName);
+        if (!schema) {
+            // alert users they are misusing this assertion
+            // eslint-disable-next-line @typescript-eslint/no-throw-literal
+            throw new AssertionError('The argument to satisfySchemaInApiSpec must match a schema in your API spec');
+        }
+        const validationError = openApiSpec.validateObject(actualObject, schema);
+        const pass = !validationError;
+        this.assert(pass, pass
+            ? ''
+            : getExpectReceivedToSatisfySchemaInApiSpecMsg(actualObject, schemaName, schema, validationError), getExpectReceivedNotToSatisfySchemaInApiSpecMsg(actualObject, schemaName, schema), null);
+    });
+}
+function getExpectReceivedToSatisfySchemaInApiSpecMsg(received, schemaName, schema, validationError) {
+    return (0, utils_1.joinWithNewLines)(`expected object to satisfy the '${schemaName}' schema defined in your API spec`, `object did not satisfy it because: ${validationError}`, `object was: ${(0, utils_1.stringify)(received)}`, `The '${schemaName}' schema in API spec: ${(0, utils_1.stringify)(schema)}`);
+}
+function getExpectReceivedNotToSatisfySchemaInApiSpecMsg(received, schemaName, schema) {
+    return (0, utils_1.joinWithNewLines)(`expected object not to satisfy the '${schemaName}' schema defined in your API spec`, `object was: ${(0, utils_1.stringify)(received)}`, `The '${schemaName}' schema in API spec: ${(0, utils_1.stringify)(schema)}`);
+}
+//# sourceMappingURL=satisfySchemaInApiSpec.js.map

package/dist/assertions/satisfySchemaInApiSpec.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"satisfySchemaInApiSpec.js","sourceRoot":"","sources":["../../lib/assertions/satisfySchemaInApiSpec.ts"],"names":[],"mappings":";;AAGA,4BAsCC;AAxCD,oCAAuD;AAEvD,mBACE,IAAqB,EACrB,WAAwB;IAExB,MAAM,EAAE,SAAS,EAAE,cAAc,EAAE,GAAG,IAAI,CAAC;IAE3C,SAAS,CAAC,SAAS,CAAC,wBAAwB,EAAE,UAAU,UAAU;QAChE,MAAM,YAAY,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC,2CAA2C;QAE3E,MAAM,MAAM,GAAG,WAAW,CAAC,eAAe,CAAC,UAAU,CAAC,CAAC;QACvD,IAAI,CAAC,MAAM,EAAE,CAAC;YACZ,+CAA+C;YAC/C,+DAA+D;YAC/D,MAAM,IAAI,cAAc,CACtB,6EAA6E,CAC9E,CAAC;QACJ,CAAC;QAED,MAAM,eAAe,GAAG,WAAW,CAAC,cAAc,CAAC,YAAY,EAAE,MAAM,CAAC,CAAC;QACzE,MAAM,IAAI,GAAG,CAAC,eAAe,CAAC;QAC9B,IAAI,CAAC,MAAM,CACT,IAAI,EACJ,IAAI;YACF,CAAC,CAAC,EAAE;YACJ,CAAC,CAAC,4CAA4C,CAC1C,YAAY,EACZ,UAAU,EACV,MAAM,EACN,eAAe,CAChB,EACL,+CAA+C,CAC7C,YAAY,EACZ,UAAU,EACV,MAAM,CACP,EACD,IAAI,CACL,CAAC;IACJ,CAAC,CAAC,CAAC;AACL,CAAC;AAED,SAAS,4CAA4C,CACnD,QAAiB,EACjB,UAAkB,EAClB,MAAc,EACd,eAAgC;IAEhC,OAAO,IAAA,wBAAgB,EACrB,mCAAmC,UAAU,mCAAmC,EAChF,sCAAsC,eAAe,EAAE,EACvD,eAAe,IAAA,iBAAS,EAAC,QAAQ,CAAC,EAAE,EACpC,QAAQ,UAAU,yBAAyB,IAAA,iBAAS,EAAC,MAAM,CAAC,EAAE,CAC/D,CAAC;AACJ,CAAC;AAED,SAAS,+CAA+C,CACtD,QAAiB,EACjB,UAAkB,EAClB,MAAc;IAEd,OAAO,IAAA,wBAAgB,EACrB,uCAAuC,UAAU,mCAAmC,EACpF,eAAe,IAAA,iBAAS,EAAC,QAAQ,CAAC,EAAE,EACpC,QAAQ,UAAU,yBAAyB,IAAA,iBAAS,EAAC,MAAM,CAAC,EAAE,CAC/D,CAAC;AACJ,CAAC"}

package/dist/index.d.ts

@@ -0,0 +1,19 @@
+import { OpenAPISpecObject } from '@ehuelsmann/openapi-validator';
+declare global {
+    namespace Chai {
+        interface Assertion {
+            /**
+             * Check the HTTP response object satisfies a response defined in your OpenAPI spec.
+             * [See usage example](https://github.com/openapi-library/OpenAPIValidators/tree/master/packages/chai-openapi-response-validator#in-api-tests-validate-the-status-and-body-of-http-responses-against-your-openapi-spec)
+             */
+            satisfyApiSpec: Assertion;
+            /**
+             * Check the object satisfies a schema defined in your OpenAPI spec.
+             * [See usage example](https://github.com/openapi-library/OpenAPIValidators/tree/master/packages/chai-openapi-response-validator#in-unit-tests-validate-objects-against-schemas-defined-in-your-openapi-spec)
+             */
+            satisfySchemaInApiSpec(schemaName: string): Assertion;
+        }
+    }
+}
+export default function (filepathOrObject: string | OpenAPISpecObject): Chai.ChaiPlugin;
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../lib/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAe,iBAAiB,EAAE,MAAM,+BAA+B,CAAC;AAI/E,OAAO,CAAC,MAAM,CAAC;IAEb,UAAU,IAAI,CAAC;QACb,UAAU,SAAS;YACjB;;;eAGG;YACH,cAAc,EAAE,SAAS,CAAC;YAC1B;;;eAGG;YACH,sBAAsB,CAAC,UAAU,EAAE,MAAM,GAAG,SAAS,CAAC;SACvD;KACF;CACF;AAED,MAAM,CAAC,OAAO,WACZ,gBAAgB,EAAE,MAAM,GAAG,iBAAiB,GAC3C,IAAI,CAAC,UAAU,CAMjB"}

package/dist/index.js

@@ -0,0 +1,17 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = default_1;
+const openapi_validator_1 = require("@ehuelsmann/openapi-validator");
+const satisfyApiSpec_1 = __importDefault(require("./assertions/satisfyApiSpec"));
+const satisfySchemaInApiSpec_1 = __importDefault(require("./assertions/satisfySchemaInApiSpec"));
+function default_1(filepathOrObject) {
+    const openApiSpec = (0, openapi_validator_1.makeApiSpec)(filepathOrObject);
+    return function (chai) {
+        (0, satisfyApiSpec_1.default)(chai, openApiSpec);
+        (0, satisfySchemaInApiSpec_1.default)(chai, openApiSpec);
+    };
+}
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../lib/index.ts"],"names":[],"mappings":";;;;;AAsBA,4BAQC;AA9BD,qEAA+E;AAC/E,iFAAyD;AACzD,iGAAyE;AAoBzE,mBACE,gBAA4C;IAE5C,MAAM,WAAW,GAAG,IAAA,+BAAW,EAAC,gBAAgB,CAAC,CAAC;IAClD,OAAO,UAAU,IAAI;QACnB,IAAA,wBAAc,EAAC,IAAI,EAAE,WAAW,CAAC,CAAC;QAClC,IAAA,gCAAsB,EAAC,IAAI,EAAE,WAAW,CAAC,CAAC;IAC5C,CAAC,CAAC;AACJ,CAAC"}

package/dist/utils.d.ts

@@ -0,0 +1,3 @@
+export declare const stringify: (obj: unknown) => string;
+export declare const joinWithNewLines: (...lines: string[]) => string;
+//# sourceMappingURL=utils.d.ts.map

package/dist/utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../lib/utils.ts"],"names":[],"mappings":"AAEA,eAAO,MAAM,SAAS,GAAI,KAAK,OAAO,KAAG,MACS,CAAC;AAEnD,eAAO,MAAM,gBAAgB,GAAI,GAAG,OAAO,MAAM,EAAE,KAAG,MAClC,CAAC"}

package/dist/utils.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.joinWithNewLines = exports.stringify = void 0;
+const util_1 = require("util");
+const stringify = (obj) => (0, util_1.inspect)(obj, { showHidden: false, depth: null });
+exports.stringify = stringify;
+const joinWithNewLines = (...lines) => lines.join('\n\n');
+exports.joinWithNewLines = joinWithNewLines;
+//# sourceMappingURL=utils.js.map

package/dist/utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../lib/utils.ts"],"names":[],"mappings":";;;AAAA,+BAA+B;AAExB,MAAM,SAAS,GAAG,CAAC,GAAY,EAAU,EAAE,CAChD,IAAA,cAAO,EAAC,GAAG,EAAE,EAAE,UAAU,EAAE,KAAK,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;AADtC,QAAA,SAAS,aAC6B;AAE5C,MAAM,gBAAgB,GAAG,CAAC,GAAG,KAAe,EAAU,EAAE,CAC7D,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;AADR,QAAA,gBAAgB,oBACR"}

package/package.json

@@ -0,0 +1,72 @@
+{
+  "name": "@ehuelsmann/chai-openapi-response-validator",
+  "version": "0.15.0",
+  "description": "Use Chai to assert that HTTP responses satisfy an OpenAPI spec",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "scripts": {
+    "clean": "rimraf dist",
+    "clean:openapi-validator": "cd ../openapi-validator && yarn clean",
+    "build:openapi-validator": "cd ../openapi-validator && yarn build",
+    "format": "prettier --write ../../ --ignore-path ../../.prettierignore",
+    "lint": "tsc --noEmit --project tsconfig.eslint.json && eslint .",
+    "lint:fix": "yarn lint --fix",
+    "build": "tsc",
+    "test": "ts-mocha --extension ts --recursive",
+    "test:watch": "yarn test --watch",
+    "test:coverage": "yarn clean && yarn clean:openapi-validator && yarn build && yarn build:openapi-validator && nyc yarn test && nyc report --reporter=lcov && nyc check-coverage",
+    "test:coverage:browse": "yarn test:coverage; open ../coverage/lcov-report/index.html",
+    "test:ci": "yarn format && yarn lint && yarn test:coverage",
+    "prepack": "yarn build"
+  },
+  "repository": "https://github.com/openapi-library/OpenAPIValidators/tree/master/packages/chai-openapi-response-validator",
+  "author": "OpenApiChai <openapichai@gmail.com>",
+  "contributors": [
+    "Jonny Spruce <jspruce94@gmail.com>",
+    "rwalle61 <richard.lh.waller@gmail.com>"
+  ],
+  "license": "MIT",
+  "keywords": [
+    "chai",
+    "chai-plugin",
+    "http",
+    "response",
+    "openapi",
+    "validate"
+  ],
+  "bugs": {
+    "url": "https://github.com/openapi-library/OpenAPIValidators/issues"
+  },
+  "homepage": "https://github.com/openapi-library/OpenAPIValidators/tree/master/packages/chai-openapi-response-validator#readme",
+  "publishConfig": {
+    "access": "public"
+  },
+  "files": [
+    "dist"
+  ],
+  "devDependencies": {
+    "@types/chai": "^4.2.15",
+    "@types/mocha": "^8.2.1",
+    "@types/request-promise": "^4.1.48",
+    "@types/supertest": "^7.2.0",
+    "axios": "^1.15.0",
+    "chai": "^6.2.2",
+    "chai-http": "^5.1.2",
+    "eslint": "^7.11.0",
+    "eslint-plugin-chai-friendly": "^1.2.0",
+    "eslint-plugin-import": "^2.22.1",
+    "eslint-plugin-mocha": "^8.0.0",
+    "express": "^5.2.1",
+    "fs-extra": "^9.0.1",
+    "mocha": "^8.2.0",
+    "nyc": "15.1.0",
+    "request": "^2.88.2",
+    "request-promise": "^4.2.6",
+    "rimraf": "^3.0.2",
+    "supertest": "^7.2.2",
+    "ts-mocha": "^8.0.0"
+  },
+  "dependencies": {
+    "@ehuelsmann/openapi-validator": "^0.15.0"
+  }
+}