@ehuelsmann/chai-openapi-response-validator 0.15.0 → 0.16.0

package/README.md

@@ -1,15 +1,19 @@
 # Chai OpenAPI Response Validator
 
+> **Notice:** Support for responses from [`request`](https://github.com/request/request#deprecated) and [`request-promise`](https://github.com/request/request-promise#deprecated) has been removed because both upstream projects are deprecated.
+
 [![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)
+![build status](https://github.com/ehuelsmann/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)
+[![codecov](https://codecov.io/gh/ehuelsmann/OpenAPIValidators/branch/master/graph/badge.svg)](https://codecov.io/gh/ehuelsmann/OpenAPIValidators)
+[![included](https://badgen.net/npm/types/@ehuelsmann%2Fchai-openapi-response-validator)](https://github.com/ehuelsmann/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/ehuelsmann/OpenAPIValidators/blob/master/CONTRIBUTING.md)
 
 Use Chai to assert that HTTP responses satisfy an OpenAPI spec.
 
+**Note** This project is a fork from the [openapi-library](https://github.com/openapi-library) project because that project is not maintained at the moment. This project contains updates and security fixes, but ideally will be merged back into that project, as soon as it's maintained again.
+
 ## 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.
@@ -27,12 +31,12 @@ Features:
 - 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`
+- Supports responses from `axios`, `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.
+If you've come here to help contribute - thanks! Take a look at the [contributing](https://github.com/ehuelsmann/OpenAPIValidators/blob/master/CONTRIBUTING.md) docs to get started.
 
 ## Installation
 
@@ -50,7 +54,9 @@ yarn add --dev @ehuelsmann/chai-openapi-response-validator
 
 ## Importing
 
-ES6 / TypeScript
+This package ships with both **ESM** (preferred) and **CommonJS** builds, so it works in any environment.
+
+ESM / TypeScript
 
 ```typescript
 import chaiResponseValidator from '@ehuelsmann/chai-openapi-response-validator';

package/dist/index.d.mts

@@ -0,0 +1,21 @@
+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;
+        }
+    }
+}
+declare function export_default(filepathOrObject: string | OpenAPISpecObject): Chai.ChaiPlugin;
+
+export { export_default as default };

package/dist/index.d.ts

@@ -1,4 +1,5 @@
 import { OpenAPISpecObject } from '@ehuelsmann/openapi-validator';
+
 declare global {
     namespace Chai {
         interface Assertion {
@@ -15,5 +16,6 @@ declare global {
         }
     }
 }
-export default function (filepathOrObject: string | OpenAPISpecObject): Chai.ChaiPlugin;
-//# sourceMappingURL=index.d.ts.map
+declare function export_default(filepathOrObject: string | OpenAPISpecObject): Chai.ChaiPlugin;
+
+export { export_default as default };

package/dist/index.js

@@ -1,17 +1,206 @@
 "use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
 };
-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);
-    };
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// lib/index.ts
+var index_exports = {};
+__export(index_exports, {
+  default: () => index_default
+});
+module.exports = __toCommonJS(index_exports);
+var import_openapi_validator2 = require("@ehuelsmann/openapi-validator");
+
+// lib/assertions/satisfyApiSpec.ts
+var import_openapi_validator = require("@ehuelsmann/openapi-validator");
+
+// lib/utils.ts
+var import_util = require("util");
+var stringify = (obj) => (0, import_util.inspect)(obj, { showHidden: false, depth: null });
+var joinWithNewLines = (...lines) => lines.join("\n\n");
+
+// lib/assertions/satisfyApiSpec.ts
+function satisfyApiSpec_default(chai, openApiSpec) {
+  const { Assertion } = chai;
+  Assertion.addProperty("satisfyApiSpec", function() {
+    const actualResponse = (0, import_openapi_validator.makeResponse)(this._obj);
+    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 === import_openapi_validator.ErrorCode.ServerNotFound) {
+    return 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 === import_openapi_validator.ErrorCode.BasePathNotFound) {
+    return 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 === import_openapi_validator.ErrorCode.PathNotFound) {
+    const pathNotFoundErrorMessage = 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 joinWithNewLines(
+        pathNotFoundErrorMessage,
+        `'${requestPath}' matches basePath \`${openApiSpec.spec.basePath}\` but no <basePath/endpointPath> combinations`
+      );
+    }
+    if ("didUserDefineServers" in openApiSpec && openApiSpec.didUserDefineServers) {
+      return joinWithNewLines(
+        pathNotFoundErrorMessage,
+        `'${requestPath}' matches servers ${stringify(
+          openApiSpec.getMatchingServerUrls(requestPath)
+        )} but no <server/endpointPath> combinations`
+      );
+    }
+    return pathNotFoundErrorMessage;
+  }
+  const path = openApiSpec.findOpenApiPathMatchingRequest(req);
+  const endpoint = `${method} ${path}`;
+  if (validationError.code === import_openapi_validator.ErrorCode.MethodNotFound) {
+    const expectedPathItem = openApiSpec.findExpectedPathItem(req);
+    const expectedRequestOperations = Object.keys(expectedPathItem).map((operation) => operation.toUpperCase()).join(", ");
+    return 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 === import_openapi_validator.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 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}`
+    );
+  }
+  const responseDefinition = openApiSpec.findExpectedResponse(actualResponse);
+  return 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: ${stringify(
+      responseDefinition
+    )}`
+  );
+}
+function getExpectedResNotToSatisfyApiSpecMsg(actualResponse, openApiSpec) {
+  const { status, req } = actualResponse;
+  const responseDefinition = openApiSpec.findExpectedResponse(actualResponse);
+  const endpoint = `${req.method} ${openApiSpec.findOpenApiPathMatchingRequest(
+    req
+  )}`;
+  return 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: ${stringify(
+      responseDefinition
+    )}`
+  );
+}
+
+// lib/assertions/satisfySchemaInApiSpec.ts
+function satisfySchemaInApiSpec_default(chai, openApiSpec) {
+  const { Assertion, AssertionError } = chai;
+  Assertion.addMethod("satisfySchemaInApiSpec", function(schemaName) {
+    const actualObject = this._obj;
+    const schema = openApiSpec.getSchemaObject(schemaName);
+    if (!schema) {
+      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 joinWithNewLines(
+    `expected object to satisfy the '${schemaName}' schema defined in your API spec`,
+    `object did not satisfy it because: ${validationError}`,
+    `object was: ${stringify(received)}`,
+    `The '${schemaName}' schema in API spec: ${stringify(schema)}`
+  );
+}
+function getExpectReceivedNotToSatisfySchemaInApiSpecMsg(received, schemaName, schema) {
+  return joinWithNewLines(
+    `expected object not to satisfy the '${schemaName}' schema defined in your API spec`,
+    `object was: ${stringify(received)}`,
+    `The '${schemaName}' schema in API spec: ${stringify(schema)}`
+  );
+}
+
+// lib/index.ts
+function index_default(filepathOrObject) {
+  const openApiSpec = (0, import_openapi_validator2.makeApiSpec)(filepathOrObject);
+  return function(chai) {
+    satisfyApiSpec_default(chai, openApiSpec);
+    satisfySchemaInApiSpec_default(chai, openApiSpec);
+  };
 }
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +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"}
+{"version":3,"sources":["../lib/index.ts","../lib/assertions/satisfyApiSpec.ts","../lib/utils.ts","../lib/assertions/satisfySchemaInApiSpec.ts"],"sourcesContent":["import { makeApiSpec, OpenAPISpecObject } from '@ehuelsmann/openapi-validator';\nimport satisfyApiSpec from './assertions/satisfyApiSpec';\nimport satisfySchemaInApiSpec from './assertions/satisfySchemaInApiSpec';\n\ndeclare global {\n  // eslint-disable-next-line @typescript-eslint/no-namespace\n  namespace Chai {\n    interface Assertion {\n      /**\n       * Check the HTTP response object satisfies a response defined in your OpenAPI spec.\n       * [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)\n       */\n      satisfyApiSpec: Assertion;\n      /**\n       * Check the object satisfies a schema defined in your OpenAPI spec.\n       * [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)\n       */\n      satisfySchemaInApiSpec(schemaName: string): Assertion;\n    }\n  }\n}\n\nexport default function (\n  filepathOrObject: string | OpenAPISpecObject,\n): Chai.ChaiPlugin {\n  const openApiSpec = makeApiSpec(filepathOrObject);\n  return function (chai) {\n    satisfyApiSpec(chai, openApiSpec);\n    satisfySchemaInApiSpec(chai, openApiSpec);\n  };\n}\n","import {\n  ActualResponse,\n  ErrorCode,\n  makeResponse,\n  OpenApi2Spec,\n  OpenApi3Spec,\n  OpenApiSpec,\n  ValidationError,\n} from '@ehuelsmann/openapi-validator';\nimport { joinWithNewLines, stringify } from '../utils';\n\nexport default function (\n  chai: Chai.ChaiStatic,\n  openApiSpec: OpenApiSpec,\n): void {\n  const { Assertion } = chai;\n\n  Assertion.addProperty('satisfyApiSpec', function () {\n    const actualResponse = makeResponse(this._obj); // eslint-disable-line no-underscore-dangle\n\n    const validationError = openApiSpec.validateResponse(actualResponse);\n    const pass = !validationError;\n    this.assert(\n      pass,\n      pass\n        ? ''\n        : getExpectedResToSatisfyApiSpecMsg(\n            actualResponse,\n            openApiSpec,\n            validationError,\n          ),\n      pass\n        ? getExpectedResNotToSatisfyApiSpecMsg(actualResponse, openApiSpec)\n        : '',\n      null,\n    );\n  });\n}\n\nfunction getExpectedResToSatisfyApiSpecMsg(\n  actualResponse: ActualResponse,\n  openApiSpec: OpenApiSpec,\n  validationError: ValidationError,\n): string {\n  const hint = 'expected res to satisfy API spec';\n\n  const { status, req } = actualResponse;\n  const { method, path: requestPath } = req;\n  const unmatchedEndpoint = `${method} ${requestPath}`;\n\n  if (validationError.code === ErrorCode.ServerNotFound) {\n    return joinWithNewLines(\n      hint,\n      `expected res to satisfy a '${status}' response defined for endpoint '${unmatchedEndpoint}' in your API spec`,\n      `res had request path '${requestPath}', but your API spec has no matching servers`,\n      `Servers found in API spec: ${(openApiSpec as OpenApi3Spec)\n        .getServerUrls()\n        .join(', ')}`,\n    );\n  }\n\n  if (validationError.code === ErrorCode.BasePathNotFound) {\n    return joinWithNewLines(\n      hint,\n      `expected res to satisfy a '${status}' response defined for endpoint '${unmatchedEndpoint}' in your API spec`,\n      `res had request path '${requestPath}', but your API spec has basePath '${\n        (openApiSpec as OpenApi2Spec).spec.basePath\n      }'`,\n    );\n  }\n\n  if (validationError.code === ErrorCode.PathNotFound) {\n    const pathNotFoundErrorMessage = joinWithNewLines(\n      hint,\n      `expected res to satisfy a '${status}' response defined for endpoint '${unmatchedEndpoint}' in your API spec`,\n      `res had request path '${requestPath}', but your API spec has no matching path`,\n      `Paths found in API spec: ${openApiSpec.paths().join(', ')}`,\n    );\n\n    if (\n      'didUserDefineBasePath' in openApiSpec &&\n      openApiSpec.didUserDefineBasePath\n    ) {\n      return joinWithNewLines(\n        pathNotFoundErrorMessage,\n        `'${requestPath}' matches basePath \\`${openApiSpec.spec.basePath}\\` but no <basePath/endpointPath> combinations`,\n      );\n    }\n\n    if (\n      'didUserDefineServers' in openApiSpec &&\n      openApiSpec.didUserDefineServers\n    ) {\n      return joinWithNewLines(\n        pathNotFoundErrorMessage,\n        `'${requestPath}' matches servers ${stringify(\n          openApiSpec.getMatchingServerUrls(requestPath),\n        )} but no <server/endpointPath> combinations`,\n      );\n    }\n    return pathNotFoundErrorMessage;\n  }\n\n  const path = openApiSpec.findOpenApiPathMatchingRequest(req);\n  const endpoint = `${method} ${path}`;\n\n  if (validationError.code === ErrorCode.MethodNotFound) {\n    const expectedPathItem = openApiSpec.findExpectedPathItem(req);\n    const expectedRequestOperations = Object.keys(expectedPathItem)\n      .map((operation) => operation.toUpperCase())\n      .join(', ');\n    return joinWithNewLines(\n      hint,\n      `expected res to satisfy a '${status}' response defined for endpoint '${endpoint}' in your API spec`,\n      `res had request method '${method}', but your API spec has no '${method}' operation defined for path '${path}'`,\n      `Request operations found for path '${path}' in API spec: ${expectedRequestOperations}`,\n    );\n  }\n\n  if (validationError.code === ErrorCode.StatusNotFound) {\n    const expectedResponseOperation =\n      // eslint-disable-next-line @typescript-eslint/no-non-null-assertion\n      openApiSpec.findExpectedResponseOperation(req)!;\n    const expectedResponseStatuses = Object.keys(\n      expectedResponseOperation.responses,\n    ).join(', ');\n    return joinWithNewLines(\n      hint,\n      `expected res to satisfy a '${status}' response defined for endpoint '${endpoint}' in your API spec`,\n      `res had status '${status}', but your API spec has no '${status}' response defined for endpoint '${endpoint}'`,\n      `Response statuses found for endpoint '${endpoint}' in API spec: ${expectedResponseStatuses}`,\n    );\n  }\n\n  // validationError.code === ErrorCode.InvalidBody\n  const responseDefinition = openApiSpec.findExpectedResponse(actualResponse);\n  return joinWithNewLines(\n    hint,\n    `expected res to satisfy the '${status}' response defined for endpoint '${endpoint}' in your API spec`,\n    `res did not satisfy it because: ${validationError}`,\n    `res contained: ${actualResponse.toString()}`,\n    `The '${status}' response defined for endpoint '${endpoint}' in API spec: ${stringify(\n      responseDefinition,\n    )}`,\n  );\n}\n\nfunction getExpectedResNotToSatisfyApiSpecMsg(\n  actualResponse: ActualResponse,\n  openApiSpec: OpenApiSpec,\n): string {\n  const { status, req } = actualResponse;\n  const responseDefinition = openApiSpec.findExpectedResponse(actualResponse);\n  const endpoint = `${req.method} ${openApiSpec.findOpenApiPathMatchingRequest(\n    req,\n  )}`;\n\n  return joinWithNewLines(\n    `expected res not to satisfy API spec`,\n    `expected res not to satisfy the '${status}' response defined for endpoint '${endpoint}' in your API spec`,\n    `res contained: ${actualResponse.toString()}`,\n    `The '${status}' response defined for endpoint '${endpoint}' in API spec: ${stringify(\n      responseDefinition,\n    )}`,\n  );\n}\n","import { inspect } from 'util';\n\nexport const stringify = (obj: unknown): string =>\n  inspect(obj, { showHidden: false, depth: null });\n\nexport const joinWithNewLines = (...lines: string[]): string =>\n  lines.join('\\n\\n');\n","import type { OpenApiSpec, Schema, ValidationError } from '@ehuelsmann/openapi-validator';\nimport { stringify, joinWithNewLines } from '../utils';\n\nexport default function (\n  chai: Chai.ChaiStatic,\n  openApiSpec: OpenApiSpec,\n): void {\n  const { Assertion, AssertionError } = chai;\n\n  Assertion.addMethod('satisfySchemaInApiSpec', function (schemaName) {\n    const actualObject = this._obj; // eslint-disable-line no-underscore-dangle\n\n    const schema = openApiSpec.getSchemaObject(schemaName);\n    if (!schema) {\n      // alert users they are misusing this assertion\n      // eslint-disable-next-line @typescript-eslint/no-throw-literal\n      throw new AssertionError(\n        'The argument to satisfySchemaInApiSpec must match a schema in your API spec',\n      );\n    }\n\n    const validationError = openApiSpec.validateObject(actualObject, schema);\n    const pass = !validationError;\n    this.assert(\n      pass,\n      pass\n        ? ''\n        : getExpectReceivedToSatisfySchemaInApiSpecMsg(\n            actualObject,\n            schemaName,\n            schema,\n            validationError,\n          ),\n      getExpectReceivedNotToSatisfySchemaInApiSpecMsg(\n        actualObject,\n        schemaName,\n        schema,\n      ),\n      null,\n    );\n  });\n}\n\nfunction getExpectReceivedToSatisfySchemaInApiSpecMsg(\n  received: unknown,\n  schemaName: string,\n  schema: Schema,\n  validationError: ValidationError,\n) {\n  return joinWithNewLines(\n    `expected object to satisfy the '${schemaName}' schema defined in your API spec`,\n    `object did not satisfy it because: ${validationError}`,\n    `object was: ${stringify(received)}`,\n    `The '${schemaName}' schema in API spec: ${stringify(schema)}`,\n  );\n}\n\nfunction getExpectReceivedNotToSatisfySchemaInApiSpecMsg(\n  received: unknown,\n  schemaName: string,\n  schema: Schema,\n) {\n  return joinWithNewLines(\n    `expected object not to satisfy the '${schemaName}' schema defined in your API spec`,\n    `object was: ${stringify(received)}`,\n    `The '${schemaName}' schema in API spec: ${stringify(schema)}`,\n  );\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAAAA,4BAA+C;;;ACA/C,+BAQO;;;ACRP,kBAAwB;AAEjB,IAAM,YAAY,CAAC,YACxB,qBAAQ,KAAK,EAAE,YAAY,OAAO,OAAO,KAAK,CAAC;AAE1C,IAAM,mBAAmB,IAAI,UAClC,MAAM,KAAK,MAAM;;;ADKJ,SAAR,uBACL,MACA,aACM;AACN,QAAM,EAAE,UAAU,IAAI;AAEtB,YAAU,YAAY,kBAAkB,WAAY;AAClD,UAAM,qBAAiB,uCAAa,KAAK,IAAI;AAE7C,UAAM,kBAAkB,YAAY,iBAAiB,cAAc;AACnE,UAAM,OAAO,CAAC;AACd,SAAK;AAAA,MACH;AAAA,MACA,OACI,KACA;AAAA,QACE;AAAA,QACA;AAAA,QACA;AAAA,MACF;AAAA,MACJ,OACI,qCAAqC,gBAAgB,WAAW,IAChE;AAAA,MACJ;AAAA,IACF;AAAA,EACF,CAAC;AACH;AAEA,SAAS,kCACP,gBACA,aACA,iBACQ;AACR,QAAM,OAAO;AAEb,QAAM,EAAE,QAAQ,IAAI,IAAI;AACxB,QAAM,EAAE,QAAQ,MAAM,YAAY,IAAI;AACtC,QAAM,oBAAoB,GAAG,MAAM,IAAI,WAAW;AAElD,MAAI,gBAAgB,SAAS,mCAAU,gBAAgB;AACrD,WAAO;AAAA,MACL;AAAA,MACA,8BAA8B,MAAM,oCAAoC,iBAAiB;AAAA,MACzF,yBAAyB,WAAW;AAAA,MACpC,8BAA+B,YAC5B,cAAc,EACd,KAAK,IAAI,CAAC;AAAA,IACf;AAAA,EACF;AAEA,MAAI,gBAAgB,SAAS,mCAAU,kBAAkB;AACvD,WAAO;AAAA,MACL;AAAA,MACA,8BAA8B,MAAM,oCAAoC,iBAAiB;AAAA,MACzF,yBAAyB,WAAW,sCACjC,YAA6B,KAAK,QACrC;AAAA,IACF;AAAA,EACF;AAEA,MAAI,gBAAgB,SAAS,mCAAU,cAAc;AACnD,UAAM,2BAA2B;AAAA,MAC/B;AAAA,MACA,8BAA8B,MAAM,oCAAoC,iBAAiB;AAAA,MACzF,yBAAyB,WAAW;AAAA,MACpC,4BAA4B,YAAY,MAAM,EAAE,KAAK,IAAI,CAAC;AAAA,IAC5D;AAEA,QACE,2BAA2B,eAC3B,YAAY,uBACZ;AACA,aAAO;AAAA,QACL;AAAA,QACA,IAAI,WAAW,wBAAwB,YAAY,KAAK,QAAQ;AAAA,MAClE;AAAA,IACF;AAEA,QACE,0BAA0B,eAC1B,YAAY,sBACZ;AACA,aAAO;AAAA,QACL;AAAA,QACA,IAAI,WAAW,qBAAqB;AAAA,UAClC,YAAY,sBAAsB,WAAW;AAAA,QAC/C,CAAC;AAAA,MACH;AAAA,IACF;AACA,WAAO;AAAA,EACT;AAEA,QAAM,OAAO,YAAY,+BAA+B,GAAG;AAC3D,QAAM,WAAW,GAAG,MAAM,IAAI,IAAI;AAElC,MAAI,gBAAgB,SAAS,mCAAU,gBAAgB;AACrD,UAAM,mBAAmB,YAAY,qBAAqB,GAAG;AAC7D,UAAM,4BAA4B,OAAO,KAAK,gBAAgB,EAC3D,IAAI,CAAC,cAAc,UAAU,YAAY,CAAC,EAC1C,KAAK,IAAI;AACZ,WAAO;AAAA,MACL;AAAA,MACA,8BAA8B,MAAM,oCAAoC,QAAQ;AAAA,MAChF,2BAA2B,MAAM,gCAAgC,MAAM,iCAAiC,IAAI;AAAA,MAC5G,sCAAsC,IAAI,kBAAkB,yBAAyB;AAAA,IACvF;AAAA,EACF;AAEA,MAAI,gBAAgB,SAAS,mCAAU,gBAAgB;AACrD,UAAM;AAAA;AAAA,MAEJ,YAAY,8BAA8B,GAAG;AAAA;AAC/C,UAAM,2BAA2B,OAAO;AAAA,MACtC,0BAA0B;AAAA,IAC5B,EAAE,KAAK,IAAI;AACX,WAAO;AAAA,MACL;AAAA,MACA,8BAA8B,MAAM,oCAAoC,QAAQ;AAAA,MAChF,mBAAmB,MAAM,gCAAgC,MAAM,oCAAoC,QAAQ;AAAA,MAC3G,yCAAyC,QAAQ,kBAAkB,wBAAwB;AAAA,IAC7F;AAAA,EACF;AAGA,QAAM,qBAAqB,YAAY,qBAAqB,cAAc;AAC1E,SAAO;AAAA,IACL;AAAA,IACA,gCAAgC,MAAM,oCAAoC,QAAQ;AAAA,IAClF,mCAAmC,eAAe;AAAA,IAClD,kBAAkB,eAAe,SAAS,CAAC;AAAA,IAC3C,QAAQ,MAAM,oCAAoC,QAAQ,kBAAkB;AAAA,MAC1E;AAAA,IACF,CAAC;AAAA,EACH;AACF;AAEA,SAAS,qCACP,gBACA,aACQ;AACR,QAAM,EAAE,QAAQ,IAAI,IAAI;AACxB,QAAM,qBAAqB,YAAY,qBAAqB,cAAc;AAC1E,QAAM,WAAW,GAAG,IAAI,MAAM,IAAI,YAAY;AAAA,IAC5C;AAAA,EACF,CAAC;AAED,SAAO;AAAA,IACL;AAAA,IACA,oCAAoC,MAAM,oCAAoC,QAAQ;AAAA,IACtF,kBAAkB,eAAe,SAAS,CAAC;AAAA,IAC3C,QAAQ,MAAM,oCAAoC,QAAQ,kBAAkB;AAAA,MAC1E;AAAA,IACF,CAAC;AAAA,EACH;AACF;;;AElKe,SAAR,+BACL,MACA,aACM;AACN,QAAM,EAAE,WAAW,eAAe,IAAI;AAEtC,YAAU,UAAU,0BAA0B,SAAU,YAAY;AAClE,UAAM,eAAe,KAAK;AAE1B,UAAM,SAAS,YAAY,gBAAgB,UAAU;AACrD,QAAI,CAAC,QAAQ;AAGX,YAAM,IAAI;AAAA,QACR;AAAA,MACF;AAAA,IACF;AAEA,UAAM,kBAAkB,YAAY,eAAe,cAAc,MAAM;AACvE,UAAM,OAAO,CAAC;AACd,SAAK;AAAA,MACH;AAAA,MACA,OACI,KACA;AAAA,QACE;AAAA,QACA;AAAA,QACA;AAAA,QACA;AAAA,MACF;AAAA,MACJ;AAAA,QACE;AAAA,QACA;AAAA,QACA;AAAA,MACF;AAAA,MACA;AAAA,IACF;AAAA,EACF,CAAC;AACH;AAEA,SAAS,6CACP,UACA,YACA,QACA,iBACA;AACA,SAAO;AAAA,IACL,mCAAmC,UAAU;AAAA,IAC7C,sCAAsC,eAAe;AAAA,IACrD,eAAe,UAAU,QAAQ,CAAC;AAAA,IAClC,QAAQ,UAAU,yBAAyB,UAAU,MAAM,CAAC;AAAA,EAC9D;AACF;AAEA,SAAS,gDACP,UACA,YACA,QACA;AACA,SAAO;AAAA,IACL,uCAAuC,UAAU;AAAA,IACjD,eAAe,UAAU,QAAQ,CAAC;AAAA,IAClC,QAAQ,UAAU,yBAAyB,UAAU,MAAM,CAAC;AAAA,EAC9D;AACF;;;AH7Ce,SAAR,cACL,kBACiB;AACjB,QAAM,kBAAc,uCAAY,gBAAgB;AAChD,SAAO,SAAU,MAAM;AACrB,2BAAe,MAAM,WAAW;AAChC,mCAAuB,MAAM,WAAW;AAAA,EAC1C;AACF;","names":["import_openapi_validator"]}

package/dist/index.mjs

@@ -0,0 +1,188 @@
+// lib/index.ts
+import { makeApiSpec } from "@ehuelsmann/openapi-validator";
+
+// lib/assertions/satisfyApiSpec.ts
+import {
+  ErrorCode,
+  makeResponse
+} from "@ehuelsmann/openapi-validator";
+
+// lib/utils.ts
+import { inspect } from "util";
+var stringify = (obj) => inspect(obj, { showHidden: false, depth: null });
+var joinWithNewLines = (...lines) => lines.join("\n\n");
+
+// lib/assertions/satisfyApiSpec.ts
+function satisfyApiSpec_default(chai, openApiSpec) {
+  const { Assertion } = chai;
+  Assertion.addProperty("satisfyApiSpec", function() {
+    const actualResponse = makeResponse(this._obj);
+    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 === ErrorCode.ServerNotFound) {
+    return 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 === ErrorCode.BasePathNotFound) {
+    return 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 === ErrorCode.PathNotFound) {
+    const pathNotFoundErrorMessage = 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 joinWithNewLines(
+        pathNotFoundErrorMessage,
+        `'${requestPath}' matches basePath \`${openApiSpec.spec.basePath}\` but no <basePath/endpointPath> combinations`
+      );
+    }
+    if ("didUserDefineServers" in openApiSpec && openApiSpec.didUserDefineServers) {
+      return joinWithNewLines(
+        pathNotFoundErrorMessage,
+        `'${requestPath}' matches servers ${stringify(
+          openApiSpec.getMatchingServerUrls(requestPath)
+        )} but no <server/endpointPath> combinations`
+      );
+    }
+    return pathNotFoundErrorMessage;
+  }
+  const path = openApiSpec.findOpenApiPathMatchingRequest(req);
+  const endpoint = `${method} ${path}`;
+  if (validationError.code === ErrorCode.MethodNotFound) {
+    const expectedPathItem = openApiSpec.findExpectedPathItem(req);
+    const expectedRequestOperations = Object.keys(expectedPathItem).map((operation) => operation.toUpperCase()).join(", ");
+    return 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 === 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 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}`
+    );
+  }
+  const responseDefinition = openApiSpec.findExpectedResponse(actualResponse);
+  return 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: ${stringify(
+      responseDefinition
+    )}`
+  );
+}
+function getExpectedResNotToSatisfyApiSpecMsg(actualResponse, openApiSpec) {
+  const { status, req } = actualResponse;
+  const responseDefinition = openApiSpec.findExpectedResponse(actualResponse);
+  const endpoint = `${req.method} ${openApiSpec.findOpenApiPathMatchingRequest(
+    req
+  )}`;
+  return 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: ${stringify(
+      responseDefinition
+    )}`
+  );
+}
+
+// lib/assertions/satisfySchemaInApiSpec.ts
+function satisfySchemaInApiSpec_default(chai, openApiSpec) {
+  const { Assertion, AssertionError } = chai;
+  Assertion.addMethod("satisfySchemaInApiSpec", function(schemaName) {
+    const actualObject = this._obj;
+    const schema = openApiSpec.getSchemaObject(schemaName);
+    if (!schema) {
+      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 joinWithNewLines(
+    `expected object to satisfy the '${schemaName}' schema defined in your API spec`,
+    `object did not satisfy it because: ${validationError}`,
+    `object was: ${stringify(received)}`,
+    `The '${schemaName}' schema in API spec: ${stringify(schema)}`
+  );
+}
+function getExpectReceivedNotToSatisfySchemaInApiSpecMsg(received, schemaName, schema) {
+  return joinWithNewLines(
+    `expected object not to satisfy the '${schemaName}' schema defined in your API spec`,
+    `object was: ${stringify(received)}`,
+    `The '${schemaName}' schema in API spec: ${stringify(schema)}`
+  );
+}
+
+// lib/index.ts
+function index_default(filepathOrObject) {
+  const openApiSpec = makeApiSpec(filepathOrObject);
+  return function(chai) {
+    satisfyApiSpec_default(chai, openApiSpec);
+    satisfySchemaInApiSpec_default(chai, openApiSpec);
+  };
+}
+export {
+  index_default as default
+};
+//# sourceMappingURL=index.mjs.map

package/dist/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../lib/index.ts","../lib/assertions/satisfyApiSpec.ts","../lib/utils.ts","../lib/assertions/satisfySchemaInApiSpec.ts"],"sourcesContent":["import { makeApiSpec, OpenAPISpecObject } from '@ehuelsmann/openapi-validator';\nimport satisfyApiSpec from './assertions/satisfyApiSpec';\nimport satisfySchemaInApiSpec from './assertions/satisfySchemaInApiSpec';\n\ndeclare global {\n  // eslint-disable-next-line @typescript-eslint/no-namespace\n  namespace Chai {\n    interface Assertion {\n      /**\n       * Check the HTTP response object satisfies a response defined in your OpenAPI spec.\n       * [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)\n       */\n      satisfyApiSpec: Assertion;\n      /**\n       * Check the object satisfies a schema defined in your OpenAPI spec.\n       * [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)\n       */\n      satisfySchemaInApiSpec(schemaName: string): Assertion;\n    }\n  }\n}\n\nexport default function (\n  filepathOrObject: string | OpenAPISpecObject,\n): Chai.ChaiPlugin {\n  const openApiSpec = makeApiSpec(filepathOrObject);\n  return function (chai) {\n    satisfyApiSpec(chai, openApiSpec);\n    satisfySchemaInApiSpec(chai, openApiSpec);\n  };\n}\n","import {\n  ActualResponse,\n  ErrorCode,\n  makeResponse,\n  OpenApi2Spec,\n  OpenApi3Spec,\n  OpenApiSpec,\n  ValidationError,\n} from '@ehuelsmann/openapi-validator';\nimport { joinWithNewLines, stringify } from '../utils';\n\nexport default function (\n  chai: Chai.ChaiStatic,\n  openApiSpec: OpenApiSpec,\n): void {\n  const { Assertion } = chai;\n\n  Assertion.addProperty('satisfyApiSpec', function () {\n    const actualResponse = makeResponse(this._obj); // eslint-disable-line no-underscore-dangle\n\n    const validationError = openApiSpec.validateResponse(actualResponse);\n    const pass = !validationError;\n    this.assert(\n      pass,\n      pass\n        ? ''\n        : getExpectedResToSatisfyApiSpecMsg(\n            actualResponse,\n            openApiSpec,\n            validationError,\n          ),\n      pass\n        ? getExpectedResNotToSatisfyApiSpecMsg(actualResponse, openApiSpec)\n        : '',\n      null,\n    );\n  });\n}\n\nfunction getExpectedResToSatisfyApiSpecMsg(\n  actualResponse: ActualResponse,\n  openApiSpec: OpenApiSpec,\n  validationError: ValidationError,\n): string {\n  const hint = 'expected res to satisfy API spec';\n\n  const { status, req } = actualResponse;\n  const { method, path: requestPath } = req;\n  const unmatchedEndpoint = `${method} ${requestPath}`;\n\n  if (validationError.code === ErrorCode.ServerNotFound) {\n    return joinWithNewLines(\n      hint,\n      `expected res to satisfy a '${status}' response defined for endpoint '${unmatchedEndpoint}' in your API spec`,\n      `res had request path '${requestPath}', but your API spec has no matching servers`,\n      `Servers found in API spec: ${(openApiSpec as OpenApi3Spec)\n        .getServerUrls()\n        .join(', ')}`,\n    );\n  }\n\n  if (validationError.code === ErrorCode.BasePathNotFound) {\n    return joinWithNewLines(\n      hint,\n      `expected res to satisfy a '${status}' response defined for endpoint '${unmatchedEndpoint}' in your API spec`,\n      `res had request path '${requestPath}', but your API spec has basePath '${\n        (openApiSpec as OpenApi2Spec).spec.basePath\n      }'`,\n    );\n  }\n\n  if (validationError.code === ErrorCode.PathNotFound) {\n    const pathNotFoundErrorMessage = joinWithNewLines(\n      hint,\n      `expected res to satisfy a '${status}' response defined for endpoint '${unmatchedEndpoint}' in your API spec`,\n      `res had request path '${requestPath}', but your API spec has no matching path`,\n      `Paths found in API spec: ${openApiSpec.paths().join(', ')}`,\n    );\n\n    if (\n      'didUserDefineBasePath' in openApiSpec &&\n      openApiSpec.didUserDefineBasePath\n    ) {\n      return joinWithNewLines(\n        pathNotFoundErrorMessage,\n        `'${requestPath}' matches basePath \\`${openApiSpec.spec.basePath}\\` but no <basePath/endpointPath> combinations`,\n      );\n    }\n\n    if (\n      'didUserDefineServers' in openApiSpec &&\n      openApiSpec.didUserDefineServers\n    ) {\n      return joinWithNewLines(\n        pathNotFoundErrorMessage,\n        `'${requestPath}' matches servers ${stringify(\n          openApiSpec.getMatchingServerUrls(requestPath),\n        )} but no <server/endpointPath> combinations`,\n      );\n    }\n    return pathNotFoundErrorMessage;\n  }\n\n  const path = openApiSpec.findOpenApiPathMatchingRequest(req);\n  const endpoint = `${method} ${path}`;\n\n  if (validationError.code === ErrorCode.MethodNotFound) {\n    const expectedPathItem = openApiSpec.findExpectedPathItem(req);\n    const expectedRequestOperations = Object.keys(expectedPathItem)\n      .map((operation) => operation.toUpperCase())\n      .join(', ');\n    return joinWithNewLines(\n      hint,\n      `expected res to satisfy a '${status}' response defined for endpoint '${endpoint}' in your API spec`,\n      `res had request method '${method}', but your API spec has no '${method}' operation defined for path '${path}'`,\n      `Request operations found for path '${path}' in API spec: ${expectedRequestOperations}`,\n    );\n  }\n\n  if (validationError.code === ErrorCode.StatusNotFound) {\n    const expectedResponseOperation =\n      // eslint-disable-next-line @typescript-eslint/no-non-null-assertion\n      openApiSpec.findExpectedResponseOperation(req)!;\n    const expectedResponseStatuses = Object.keys(\n      expectedResponseOperation.responses,\n    ).join(', ');\n    return joinWithNewLines(\n      hint,\n      `expected res to satisfy a '${status}' response defined for endpoint '${endpoint}' in your API spec`,\n      `res had status '${status}', but your API spec has no '${status}' response defined for endpoint '${endpoint}'`,\n      `Response statuses found for endpoint '${endpoint}' in API spec: ${expectedResponseStatuses}`,\n    );\n  }\n\n  // validationError.code === ErrorCode.InvalidBody\n  const responseDefinition = openApiSpec.findExpectedResponse(actualResponse);\n  return joinWithNewLines(\n    hint,\n    `expected res to satisfy the '${status}' response defined for endpoint '${endpoint}' in your API spec`,\n    `res did not satisfy it because: ${validationError}`,\n    `res contained: ${actualResponse.toString()}`,\n    `The '${status}' response defined for endpoint '${endpoint}' in API spec: ${stringify(\n      responseDefinition,\n    )}`,\n  );\n}\n\nfunction getExpectedResNotToSatisfyApiSpecMsg(\n  actualResponse: ActualResponse,\n  openApiSpec: OpenApiSpec,\n): string {\n  const { status, req } = actualResponse;\n  const responseDefinition = openApiSpec.findExpectedResponse(actualResponse);\n  const endpoint = `${req.method} ${openApiSpec.findOpenApiPathMatchingRequest(\n    req,\n  )}`;\n\n  return joinWithNewLines(\n    `expected res not to satisfy API spec`,\n    `expected res not to satisfy the '${status}' response defined for endpoint '${endpoint}' in your API spec`,\n    `res contained: ${actualResponse.toString()}`,\n    `The '${status}' response defined for endpoint '${endpoint}' in API spec: ${stringify(\n      responseDefinition,\n    )}`,\n  );\n}\n","import { inspect } from 'util';\n\nexport const stringify = (obj: unknown): string =>\n  inspect(obj, { showHidden: false, depth: null });\n\nexport const joinWithNewLines = (...lines: string[]): string =>\n  lines.join('\\n\\n');\n","import type { OpenApiSpec, Schema, ValidationError } from '@ehuelsmann/openapi-validator';\nimport { stringify, joinWithNewLines } from '../utils';\n\nexport default function (\n  chai: Chai.ChaiStatic,\n  openApiSpec: OpenApiSpec,\n): void {\n  const { Assertion, AssertionError } = chai;\n\n  Assertion.addMethod('satisfySchemaInApiSpec', function (schemaName) {\n    const actualObject = this._obj; // eslint-disable-line no-underscore-dangle\n\n    const schema = openApiSpec.getSchemaObject(schemaName);\n    if (!schema) {\n      // alert users they are misusing this assertion\n      // eslint-disable-next-line @typescript-eslint/no-throw-literal\n      throw new AssertionError(\n        'The argument to satisfySchemaInApiSpec must match a schema in your API spec',\n      );\n    }\n\n    const validationError = openApiSpec.validateObject(actualObject, schema);\n    const pass = !validationError;\n    this.assert(\n      pass,\n      pass\n        ? ''\n        : getExpectReceivedToSatisfySchemaInApiSpecMsg(\n            actualObject,\n            schemaName,\n            schema,\n            validationError,\n          ),\n      getExpectReceivedNotToSatisfySchemaInApiSpecMsg(\n        actualObject,\n        schemaName,\n        schema,\n      ),\n      null,\n    );\n  });\n}\n\nfunction getExpectReceivedToSatisfySchemaInApiSpecMsg(\n  received: unknown,\n  schemaName: string,\n  schema: Schema,\n  validationError: ValidationError,\n) {\n  return joinWithNewLines(\n    `expected object to satisfy the '${schemaName}' schema defined in your API spec`,\n    `object did not satisfy it because: ${validationError}`,\n    `object was: ${stringify(received)}`,\n    `The '${schemaName}' schema in API spec: ${stringify(schema)}`,\n  );\n}\n\nfunction getExpectReceivedNotToSatisfySchemaInApiSpecMsg(\n  received: unknown,\n  schemaName: string,\n  schema: Schema,\n) {\n  return joinWithNewLines(\n    `expected object not to satisfy the '${schemaName}' schema defined in your API spec`,\n    `object was: ${stringify(received)}`,\n    `The '${schemaName}' schema in API spec: ${stringify(schema)}`,\n  );\n}\n"],"mappings":";AAAA,SAAS,mBAAsC;;;ACA/C;AAAA,EAEE;AAAA,EACA;AAAA,OAKK;;;ACRP,SAAS,eAAe;AAEjB,IAAM,YAAY,CAAC,QACxB,QAAQ,KAAK,EAAE,YAAY,OAAO,OAAO,KAAK,CAAC;AAE1C,IAAM,mBAAmB,IAAI,UAClC,MAAM,KAAK,MAAM;;;ADKJ,SAAR,uBACL,MACA,aACM;AACN,QAAM,EAAE,UAAU,IAAI;AAEtB,YAAU,YAAY,kBAAkB,WAAY;AAClD,UAAM,iBAAiB,aAAa,KAAK,IAAI;AAE7C,UAAM,kBAAkB,YAAY,iBAAiB,cAAc;AACnE,UAAM,OAAO,CAAC;AACd,SAAK;AAAA,MACH;AAAA,MACA,OACI,KACA;AAAA,QACE;AAAA,QACA;AAAA,QACA;AAAA,MACF;AAAA,MACJ,OACI,qCAAqC,gBAAgB,WAAW,IAChE;AAAA,MACJ;AAAA,IACF;AAAA,EACF,CAAC;AACH;AAEA,SAAS,kCACP,gBACA,aACA,iBACQ;AACR,QAAM,OAAO;AAEb,QAAM,EAAE,QAAQ,IAAI,IAAI;AACxB,QAAM,EAAE,QAAQ,MAAM,YAAY,IAAI;AACtC,QAAM,oBAAoB,GAAG,MAAM,IAAI,WAAW;AAElD,MAAI,gBAAgB,SAAS,UAAU,gBAAgB;AACrD,WAAO;AAAA,MACL;AAAA,MACA,8BAA8B,MAAM,oCAAoC,iBAAiB;AAAA,MACzF,yBAAyB,WAAW;AAAA,MACpC,8BAA+B,YAC5B,cAAc,EACd,KAAK,IAAI,CAAC;AAAA,IACf;AAAA,EACF;AAEA,MAAI,gBAAgB,SAAS,UAAU,kBAAkB;AACvD,WAAO;AAAA,MACL;AAAA,MACA,8BAA8B,MAAM,oCAAoC,iBAAiB;AAAA,MACzF,yBAAyB,WAAW,sCACjC,YAA6B,KAAK,QACrC;AAAA,IACF;AAAA,EACF;AAEA,MAAI,gBAAgB,SAAS,UAAU,cAAc;AACnD,UAAM,2BAA2B;AAAA,MAC/B;AAAA,MACA,8BAA8B,MAAM,oCAAoC,iBAAiB;AAAA,MACzF,yBAAyB,WAAW;AAAA,MACpC,4BAA4B,YAAY,MAAM,EAAE,KAAK,IAAI,CAAC;AAAA,IAC5D;AAEA,QACE,2BAA2B,eAC3B,YAAY,uBACZ;AACA,aAAO;AAAA,QACL;AAAA,QACA,IAAI,WAAW,wBAAwB,YAAY,KAAK,QAAQ;AAAA,MAClE;AAAA,IACF;AAEA,QACE,0BAA0B,eAC1B,YAAY,sBACZ;AACA,aAAO;AAAA,QACL;AAAA,QACA,IAAI,WAAW,qBAAqB;AAAA,UAClC,YAAY,sBAAsB,WAAW;AAAA,QAC/C,CAAC;AAAA,MACH;AAAA,IACF;AACA,WAAO;AAAA,EACT;AAEA,QAAM,OAAO,YAAY,+BAA+B,GAAG;AAC3D,QAAM,WAAW,GAAG,MAAM,IAAI,IAAI;AAElC,MAAI,gBAAgB,SAAS,UAAU,gBAAgB;AACrD,UAAM,mBAAmB,YAAY,qBAAqB,GAAG;AAC7D,UAAM,4BAA4B,OAAO,KAAK,gBAAgB,EAC3D,IAAI,CAAC,cAAc,UAAU,YAAY,CAAC,EAC1C,KAAK,IAAI;AACZ,WAAO;AAAA,MACL;AAAA,MACA,8BAA8B,MAAM,oCAAoC,QAAQ;AAAA,MAChF,2BAA2B,MAAM,gCAAgC,MAAM,iCAAiC,IAAI;AAAA,MAC5G,sCAAsC,IAAI,kBAAkB,yBAAyB;AAAA,IACvF;AAAA,EACF;AAEA,MAAI,gBAAgB,SAAS,UAAU,gBAAgB;AACrD,UAAM;AAAA;AAAA,MAEJ,YAAY,8BAA8B,GAAG;AAAA;AAC/C,UAAM,2BAA2B,OAAO;AAAA,MACtC,0BAA0B;AAAA,IAC5B,EAAE,KAAK,IAAI;AACX,WAAO;AAAA,MACL;AAAA,MACA,8BAA8B,MAAM,oCAAoC,QAAQ;AAAA,MAChF,mBAAmB,MAAM,gCAAgC,MAAM,oCAAoC,QAAQ;AAAA,MAC3G,yCAAyC,QAAQ,kBAAkB,wBAAwB;AAAA,IAC7F;AAAA,EACF;AAGA,QAAM,qBAAqB,YAAY,qBAAqB,cAAc;AAC1E,SAAO;AAAA,IACL;AAAA,IACA,gCAAgC,MAAM,oCAAoC,QAAQ;AAAA,IAClF,mCAAmC,eAAe;AAAA,IAClD,kBAAkB,eAAe,SAAS,CAAC;AAAA,IAC3C,QAAQ,MAAM,oCAAoC,QAAQ,kBAAkB;AAAA,MAC1E;AAAA,IACF,CAAC;AAAA,EACH;AACF;AAEA,SAAS,qCACP,gBACA,aACQ;AACR,QAAM,EAAE,QAAQ,IAAI,IAAI;AACxB,QAAM,qBAAqB,YAAY,qBAAqB,cAAc;AAC1E,QAAM,WAAW,GAAG,IAAI,MAAM,IAAI,YAAY;AAAA,IAC5C;AAAA,EACF,CAAC;AAED,SAAO;AAAA,IACL;AAAA,IACA,oCAAoC,MAAM,oCAAoC,QAAQ;AAAA,IACtF,kBAAkB,eAAe,SAAS,CAAC;AAAA,IAC3C,QAAQ,MAAM,oCAAoC,QAAQ,kBAAkB;AAAA,MAC1E;AAAA,IACF,CAAC;AAAA,EACH;AACF;;;AElKe,SAAR,+BACL,MACA,aACM;AACN,QAAM,EAAE,WAAW,eAAe,IAAI;AAEtC,YAAU,UAAU,0BAA0B,SAAU,YAAY;AAClE,UAAM,eAAe,KAAK;AAE1B,UAAM,SAAS,YAAY,gBAAgB,UAAU;AACrD,QAAI,CAAC,QAAQ;AAGX,YAAM,IAAI;AAAA,QACR;AAAA,MACF;AAAA,IACF;AAEA,UAAM,kBAAkB,YAAY,eAAe,cAAc,MAAM;AACvE,UAAM,OAAO,CAAC;AACd,SAAK;AAAA,MACH;AAAA,MACA,OACI,KACA;AAAA,QACE;AAAA,QACA;AAAA,QACA;AAAA,QACA;AAAA,MACF;AAAA,MACJ;AAAA,QACE;AAAA,QACA;AAAA,QACA;AAAA,MACF;AAAA,MACA;AAAA,IACF;AAAA,EACF,CAAC;AACH;AAEA,SAAS,6CACP,UACA,YACA,QACA,iBACA;AACA,SAAO;AAAA,IACL,mCAAmC,UAAU;AAAA,IAC7C,sCAAsC,eAAe;AAAA,IACrD,eAAe,UAAU,QAAQ,CAAC;AAAA,IAClC,QAAQ,UAAU,yBAAyB,UAAU,MAAM,CAAC;AAAA,EAC9D;AACF;AAEA,SAAS,gDACP,UACA,YACA,QACA;AACA,SAAO;AAAA,IACL,uCAAuC,UAAU;AAAA,IACjD,eAAe,UAAU,QAAQ,CAAC;AAAA,IAClC,QAAQ,UAAU,yBAAyB,UAAU,MAAM,CAAC;AAAA,EAC9D;AACF;;;AH7Ce,SAAR,cACL,kBACiB;AACjB,QAAM,cAAc,YAAY,gBAAgB;AAChD,SAAO,SAAU,MAAM;AACrB,2BAAe,MAAM,WAAW;AAChC,mCAAuB,MAAM,WAAW;AAAA,EAC1C;AACF;","names":[]}

package/package.json

@@ -1,9 +1,22 @@
 {
   "name": "@ehuelsmann/chai-openapi-response-validator",
-  "version": "0.15.0",
+  "version": "0.16.0",
   "description": "Use Chai to assert that HTTP responses satisfy an OpenAPI spec",
-  "main": "dist/index.js",
-  "types": "dist/index.d.ts",
+  "main": "./dist/index.js",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/index.d.mts",
+        "default": "./dist/index.mjs"
+      },
+      "require": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.js"
+      }
+    }
+  },
   "scripts": {
     "clean": "rimraf dist",
     "clean:openapi-validator": "cd ../openapi-validator && yarn clean",
@@ -11,15 +24,15 @@
     "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",
+    "build": "tsup",
+    "test": "mocha --require ts-node/register --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",
+  "repository": "https://github.com/ehuelsmann/OpenAPIValidators/tree/master/packages/chai-openapi-response-validator",
   "author": "OpenApiChai <openapichai@gmail.com>",
   "contributors": [
     "Jonny Spruce <jspruce94@gmail.com>",
@@ -35,9 +48,9 @@
     "validate"
   ],
   "bugs": {
-    "url": "https://github.com/openapi-library/OpenAPIValidators/issues"
+    "url": "https://github.com/ehuelsmann/OpenAPIValidators/issues"
   },
-  "homepage": "https://github.com/openapi-library/OpenAPIValidators/tree/master/packages/chai-openapi-response-validator#readme",
+  "homepage": "https://github.com/ehuelsmann/OpenAPIValidators/tree/master/packages/chai-openapi-response-validator#readme",
   "publishConfig": {
     "access": "public"
   },
@@ -46,8 +59,7 @@
   ],
   "devDependencies": {
     "@types/chai": "^4.2.15",
-    "@types/mocha": "^8.2.1",
-    "@types/request-promise": "^4.1.48",
+    "@types/mocha": "^10.0.10",
     "@types/supertest": "^7.2.0",
     "axios": "^1.15.0",
     "chai": "^6.2.2",
@@ -58,15 +70,14 @@
     "eslint-plugin-mocha": "^8.0.0",
     "express": "^5.2.1",
     "fs-extra": "^9.0.1",
-    "mocha": "^8.2.0",
+    "mocha": "^11.7.4",
     "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"
+    "ts-node": "^10.9.2",
+    "tsup": "^8.5.1"
   },
   "dependencies": {
-    "@ehuelsmann/openapi-validator": "^0.15.0"
+    "@ehuelsmann/openapi-validator": "^0.16.0"
   }
 }

package/dist/assertions/satisfyApiSpec.d.ts

@@ -1,3 +0,0 @@
-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

@@ -1 +0,0 @@
-{"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

@@ -1,70 +0,0 @@
-"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

@@ -1 +0,0 @@
-{"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

@@ -1,3 +0,0 @@
-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

@@ -1 +0,0 @@
-{"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

@@ -1,28 +0,0 @@
-"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

@@ -1 +0,0 @@
-{"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.map

@@ -1 +0,0 @@
-{"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/utils.d.ts

@@ -1,3 +0,0 @@
-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

@@ -1 +0,0 @@
-{"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

@@ -1,9 +0,0 @@
-"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

@@ -1 +0,0 @@
-{"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"}