@ehuelsmann/jest-openapi 0.15.0 → 0.16.0

package/README.md

@@ -1,15 +1,19 @@
 # @ehuelsmann/jest-openapi
 
+> **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%2Fjest-openapi)](https://www.npmjs.com/package/@ehuelsmann/jest-openapi)
 [![npm](https://img.shields.io/npm/v/@ehuelsmann%2Fjest-openapi.svg)](https://www.npmjs.com/package/@ehuelsmann/jest-openapi)
-![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%2Fjest-openapi)](https://github.com/openapi-library/OpenAPIValidators/blob/master/packages/jest-openapi/src/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%2Fjest-openapi)](https://github.com/ehuelsmann/OpenAPIValidators/blob/master/packages/jest-openapi/src/index.ts)
+[![contributions welcome](https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat)](https://github.com/ehuelsmann/OpenAPIValidators/blob/master/CONTRIBUTING.md)
 
 Additional Jest matchers for asserting 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`
-- Use in [Jest](#usage), or use our [sister package](https://github.com/openapi-library/OpenAPIValidators/tree/master/packages/chai-openapi-response-validator#readme) for Mocha and other test runners that support Chai
+- Supports responses from `axios`, `supertest`, `superagent`, and `chai-http`
+- Use in [Jest](#usage), or use our [sister package](https://github.com/ehuelsmann/OpenAPIValidators/tree/master/packages/chai-openapi-response-validator#readme) for Mocha and other test runners that support Chai
 
 ## 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/jest-openapi
 
 ## Importing
 
-ES6 / TypeScript
+This package ships with both **ESM** (preferred) and **CommonJS** builds, so it works in any environment.
+
+ESM / TypeScript
 
 ```typescript
 import jestOpenAPI from '@ehuelsmann/jest-openapi';

package/dist/index.d.mts

@@ -0,0 +1,21 @@
+import { OpenAPISpecObject } from '@ehuelsmann/openapi-validator';
+
+declare global {
+    namespace jest {
+        interface Matchers<R> {
+            /**
+             * 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/jest-openapi#in-api-tests-validate-the-status-and-body-of-http-responses-against-your-openapi-spec)
+             */
+            toSatisfyApiSpec(): R;
+            /**
+             * Check the object satisfies a schema defined in your OpenAPI spec.
+             * [See usage example](https://github.com/openapi-library/OpenAPIValidators/tree/master/packages/jest-openapi#in-unit-tests-validate-objects-against-schemas-defined-in-your-openapi-spec)
+             */
+            toSatisfySchemaInApiSpec(schemaName: string): R;
+        }
+    }
+}
+declare function export_default(filepathOrObject: string | OpenAPISpecObject): void;
+
+export { export_default as default };

package/dist/index.d.ts

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

package/dist/index.js

@@ -1,35 +1,250 @@
 "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 toSatisfyApiSpec_1 = __importDefault(require("./matchers/toSatisfyApiSpec"));
-const toSatisfySchemaInApiSpec_1 = __importDefault(require("./matchers/toSatisfySchemaInApiSpec"));
-function default_1(filepathOrObject) {
-    const openApiSpec = (0, openapi_validator_1.makeApiSpec)(filepathOrObject);
-    const jestMatchers = {
-        toSatisfyApiSpec(received) {
-            return toSatisfyApiSpec_1.default.call(this, received, openApiSpec);
-        },
-        toSatisfySchemaInApiSpec(received, schemaName) {
-            return toSatisfySchemaInApiSpec_1.default.call(this, received, schemaName, openApiSpec);
-        },
-    };
-    const jestExpect = global.expect;
-    /* istanbul ignore next */
-    if (jestExpect !== undefined) {
-        jestExpect.extend(jestMatchers);
+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);
+
+// src/index.ts
+var index_exports = {};
+__export(index_exports, {
+  default: () => index_default
+});
+module.exports = __toCommonJS(index_exports);
+var import_openapi_validator2 = require("@ehuelsmann/openapi-validator");
+
+// src/matchers/toSatisfyApiSpec.ts
+var import_jest_matcher_utils = require("jest-matcher-utils");
+var import_openapi_validator = require("@ehuelsmann/openapi-validator");
+
+// src/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");
+
+// src/matchers/toSatisfyApiSpec.ts
+function toSatisfyApiSpec_default(received, openApiSpec) {
+  const actualResponse = (0, import_openapi_validator.makeResponse)(received);
+  const validationError = openApiSpec.validateResponse(actualResponse);
+  const pass = !validationError;
+  const matcherHintOptions = {
+    comment: "Matches 'received' to a response defined in your API spec, then validates 'received' against it",
+    ...this.isNot !== void 0 && { isNot: this.isNot },
+    ...this.promise !== void 0 && { promise: this.promise }
+  };
+  const hint = (0, import_jest_matcher_utils.matcherHint)(
+    "toSatisfyApiSpec",
+    void 0,
+    "",
+    matcherHintOptions
+  );
+  const message = pass ? () => getExpectReceivedNotToSatisfyApiSpecMsg(
+    actualResponse,
+    openApiSpec,
+    hint
+  ) : () => getExpectReceivedToSatisfyApiSpecMsg(
+    actualResponse,
+    openApiSpec,
+    validationError,
+    hint
+  );
+  return {
+    pass,
+    message
+  };
+}
+function getExpectReceivedToSatisfyApiSpecMsg(actualResponse, openApiSpec, validationError, hint) {
+  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 ${(0, import_jest_matcher_utils.RECEIVED_COLOR)("received")} to satisfy a '${status}' response defined for endpoint '${unmatchedEndpoint}' in your API spec`,
+      `${(0, import_jest_matcher_utils.RECEIVED_COLOR)("received")} had request path ${(0, import_jest_matcher_utils.RECEIVED_COLOR)(requestPath)}, but your API spec has no matching servers`,
+      `Servers found in API spec: ${(0, import_jest_matcher_utils.EXPECTED_COLOR)(openApiSpec.getServerUrls().join(", "))}`
+    );
+  }
+  if (validationError.code === import_openapi_validator.ErrorCode.BasePathNotFound) {
+    return joinWithNewLines(
+      hint,
+      `expected ${(0, import_jest_matcher_utils.RECEIVED_COLOR)("received")} to satisfy a '${status}' response defined for endpoint '${unmatchedEndpoint}' in your API spec`,
+      `${(0, import_jest_matcher_utils.RECEIVED_COLOR)("received")} had request path ${(0, import_jest_matcher_utils.RECEIVED_COLOR)(requestPath)}, but your API spec has basePath ${(0, import_jest_matcher_utils.EXPECTED_COLOR)(openApiSpec.spec.basePath)}`
+    );
+  }
+  if (validationError.code === import_openapi_validator.ErrorCode.PathNotFound) {
+    const pathNotFoundErrorMessage = joinWithNewLines(
+      hint,
+      `expected ${(0, import_jest_matcher_utils.RECEIVED_COLOR)("received")} to satisfy a '${status}' response defined for endpoint '${unmatchedEndpoint}' in your API spec`,
+      `${(0, import_jest_matcher_utils.RECEIVED_COLOR)("received")} had request path ${(0, import_jest_matcher_utils.RECEIVED_COLOR)(requestPath)}, but your API spec has no matching path`,
+      `Paths found in API spec: ${(0, import_jest_matcher_utils.EXPECTED_COLOR)(openApiSpec.paths().join(", "))}`
+    );
+    if ("didUserDefineBasePath" in openApiSpec && openApiSpec.didUserDefineBasePath) {
+      return joinWithNewLines(
+        pathNotFoundErrorMessage,
+        `'${requestPath}' matches basePath \`${openApiSpec.spec.basePath}\` but no <basePath/endpointPath> combinations`
+      );
     }
-    else {
-        // eslint-disable-next-line no-console
-        console.error([
-            "Unable to find Jest's global expect.",
-            'Please check you have configured jest-openapi correctly.',
-            'See https://github.com/openapi-library/OpenAPIValidators/tree/master/packages/jest-openapi#usage for help.',
-        ].join('\n'));
+    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 ${(0, import_jest_matcher_utils.RECEIVED_COLOR)("received")} to satisfy a '${status}' response defined for endpoint '${endpoint}' in your API spec`,
+      `${(0, import_jest_matcher_utils.RECEIVED_COLOR)("received")} had request method ${(0, import_jest_matcher_utils.RECEIVED_COLOR)(method)}, but your API spec has no ${(0, import_jest_matcher_utils.RECEIVED_COLOR)(method)} operation defined for path '${path}'`,
+      `Request operations found for path '${path}' in API spec: ${(0, import_jest_matcher_utils.EXPECTED_COLOR)(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 ${(0, import_jest_matcher_utils.RECEIVED_COLOR)("received")} to satisfy a '${status}' response defined for endpoint '${endpoint}' in your API spec`,
+      `${(0, import_jest_matcher_utils.RECEIVED_COLOR)("received")} had status ${(0, import_jest_matcher_utils.RECEIVED_COLOR)(status)}, but your API spec has no ${(0, import_jest_matcher_utils.RECEIVED_COLOR)(status)} response defined for endpoint '${endpoint}'`,
+      `Response statuses found for endpoint '${endpoint}' in API spec: ${(0, import_jest_matcher_utils.EXPECTED_COLOR)(expectedResponseStatuses)}`
+    );
+  }
+  const responseDefinition = openApiSpec.findExpectedResponse(actualResponse);
+  return joinWithNewLines(
+    hint,
+    `expected ${(0, import_jest_matcher_utils.RECEIVED_COLOR)("received")} to satisfy the '${status}' response defined for endpoint '${endpoint}' in your API spec`,
+    `${(0, import_jest_matcher_utils.RECEIVED_COLOR)("received")} did not satisfy it because: ${validationError}`,
+    `${(0, import_jest_matcher_utils.RECEIVED_COLOR)("received")} contained: ${(0, import_jest_matcher_utils.RECEIVED_COLOR)(actualResponse.toString())}`,
+    `The '${status}' response defined for endpoint '${endpoint}' in API spec: ${(0, import_jest_matcher_utils.EXPECTED_COLOR)(stringify(responseDefinition))}`
+  );
+}
+function getExpectReceivedNotToSatisfyApiSpecMsg(actualResponse, openApiSpec, hint) {
+  const { status, req } = actualResponse;
+  const responseDefinition = openApiSpec.findExpectedResponse(actualResponse);
+  const endpoint = `${req.method} ${openApiSpec.findOpenApiPathMatchingRequest(
+    req
+  )}`;
+  return joinWithNewLines(
+    hint,
+    `expected ${(0, import_jest_matcher_utils.RECEIVED_COLOR)("received")} not to satisfy the '${status}' response defined for endpoint '${endpoint}' in your API spec`,
+    `${(0, import_jest_matcher_utils.RECEIVED_COLOR)("received")} contained: ${(0, import_jest_matcher_utils.RECEIVED_COLOR)(actualResponse.toString())}`,
+    `The '${status}' response defined for endpoint '${endpoint}' in API spec: ${(0, import_jest_matcher_utils.EXPECTED_COLOR)(stringify(responseDefinition))}`
+  );
+}
+
+// src/matchers/toSatisfySchemaInApiSpec.ts
+var import_jest_matcher_utils2 = require("jest-matcher-utils");
+function toSatisfySchemaInApiSpec_default(received, schemaName, openApiSpec) {
+  const matcherHintOptions = {
+    comment: "Matches 'received' to a schema defined in your API spec, then validates 'received' against it",
+    ...this.isNot !== void 0 && { isNot: this.isNot },
+    ...this.promise !== void 0 && { promise: this.promise }
+  };
+  const hint = (0, import_jest_matcher_utils2.matcherHint)(
+    "toSatisfySchemaInApiSpec",
+    void 0,
+    "schemaName",
+    matcherHintOptions
+  );
+  const schema = openApiSpec.getSchemaObject(schemaName);
+  if (!schema) {
+    throw new Error(
+      (0, import_jest_matcher_utils2.matcherErrorMessage)(
+        hint,
+        `${(0, import_jest_matcher_utils2.EXPECTED_COLOR)("schemaName")} must match a schema in your API spec`,
+        (0, import_jest_matcher_utils2.printWithType)("schemaName", schemaName, import_jest_matcher_utils2.printExpected)
+      )
+    );
+  }
+  const validationError = openApiSpec.validateObject(received, schema);
+  const pass = !validationError;
+  const message = pass ? () => getExpectReceivedNotToSatisfySchemaInApiSpecMsg(
+    received,
+    schemaName,
+    schema,
+    hint
+  ) : () => getExpectReceivedToSatisfySchemaInApiSpecMsg(
+    received,
+    schemaName,
+    schema,
+    validationError,
+    hint
+  );
+  return {
+    pass,
+    message
+  };
+}
+function getExpectReceivedToSatisfySchemaInApiSpecMsg(received, schemaName, schema, validationError, hint) {
+  return joinWithNewLines(
+    hint,
+    `expected ${(0, import_jest_matcher_utils2.RECEIVED_COLOR)("received")} to satisfy the '${schemaName}' schema defined in your API spec`,
+    `${(0, import_jest_matcher_utils2.RECEIVED_COLOR)("received")} did not satisfy it because: ${validationError}`,
+    `${(0, import_jest_matcher_utils2.RECEIVED_COLOR)("received")} was: ${(0, import_jest_matcher_utils2.RECEIVED_COLOR)(stringify(received))}`,
+    `The '${schemaName}' schema in API spec: ${(0, import_jest_matcher_utils2.EXPECTED_COLOR)(stringify(schema))}`
+  );
+}
+function getExpectReceivedNotToSatisfySchemaInApiSpecMsg(received, schemaName, schema, hint) {
+  return joinWithNewLines(
+    hint,
+    `expected ${(0, import_jest_matcher_utils2.RECEIVED_COLOR)("received")} not to satisfy the '${schemaName}' schema defined in your API spec`,
+    `${(0, import_jest_matcher_utils2.RECEIVED_COLOR)("received")} was: ${(0, import_jest_matcher_utils2.RECEIVED_COLOR)(stringify(received))}`,
+    `The '${schemaName}' schema in API spec: ${(0, import_jest_matcher_utils2.EXPECTED_COLOR)(stringify(schema))}`
+  );
+}
+
+// src/index.ts
+function index_default(filepathOrObject) {
+  const openApiSpec = (0, import_openapi_validator2.makeApiSpec)(filepathOrObject);
+  const jestMatchers = {
+    toSatisfyApiSpec(received) {
+      return toSatisfyApiSpec_default.call(this, received, openApiSpec);
+    },
+    toSatisfySchemaInApiSpec(received, schemaName) {
+      return toSatisfySchemaInApiSpec_default.call(
+        this,
+        received,
+        schemaName,
+        openApiSpec
+      );
     }
-    /* istanbul ignore next */
+  };
+  const jestExpect = global.expect;
+  if (jestExpect !== void 0) {
+    jestExpect.extend(jestMatchers);
+  } else {
+    console.error(
+      [
+        "Unable to find Jest's global expect.",
+        "Please check you have configured jest-openapi correctly.",
+        "See https://github.com/openapi-library/OpenAPIValidators/tree/master/packages/jest-openapi#usage for help."
+      ].join("\n")
+    );
+  }
 }
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;AAsBA,4BAiCC;AAvDD,qEAA+E;AAC/E,mFAA2D;AAC3D,mGAA2E;AAoB3E,mBAAyB,gBAA4C;IACnE,MAAM,WAAW,GAAG,IAAA,+BAAW,EAAC,gBAAgB,CAAC,CAAC;IAElD,MAAM,YAAY,GAAyB;QACzC,gBAAgB,CAAC,QAAiB;YAChC,OAAO,0BAAgB,CAAC,IAAI,CAAC,IAAI,EAAE,QAAQ,EAAE,WAAW,CAAC,CAAC;QAC5D,CAAC;QACD,wBAAwB,CAAC,QAAiB,EAAE,UAAkB;YAC5D,OAAO,kCAAwB,CAAC,IAAI,CAClC,IAAI,EACJ,QAAQ,EACR,UAAU,EACV,WAAW,CACZ,CAAC;QACJ,CAAC;KACF,CAAC;IAEF,MAAM,UAAU,GAAI,MAAmC,CAAC,MAAM,CAAC;IAE/D,0BAA0B;IAC1B,IAAI,UAAU,KAAK,SAAS,EAAE,CAAC;QAC7B,UAAU,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC;IAClC,CAAC;SAAM,CAAC;QACN,sCAAsC;QACtC,OAAO,CAAC,KAAK,CACX;YACE,sCAAsC;YACtC,0DAA0D;YAC1D,4GAA4G;SAC7G,CAAC,IAAI,CAAC,IAAI,CAAC,CACb,CAAC;IACJ,CAAC;IACD,0BAA0B;AAC5B,CAAC"}
+{"version":3,"sources":["../src/index.ts","../src/matchers/toSatisfyApiSpec.ts","../src/utils.ts","../src/matchers/toSatisfySchemaInApiSpec.ts"],"sourcesContent":["import { makeApiSpec, OpenAPISpecObject } from '@ehuelsmann/openapi-validator';\nimport toSatisfyApiSpec from './matchers/toSatisfyApiSpec';\nimport toSatisfySchemaInApiSpec from './matchers/toSatisfySchemaInApiSpec';\n\ndeclare global {\n  // eslint-disable-next-line @typescript-eslint/no-namespace\n  namespace jest {\n    interface Matchers<R> {\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/jest-openapi#in-api-tests-validate-the-status-and-body-of-http-responses-against-your-openapi-spec)\n       */\n      toSatisfyApiSpec(): R;\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/jest-openapi#in-unit-tests-validate-objects-against-schemas-defined-in-your-openapi-spec)\n       */\n      toSatisfySchemaInApiSpec(schemaName: string): R;\n    }\n  }\n}\n\nexport default function (filepathOrObject: string | OpenAPISpecObject): void {\n  const openApiSpec = makeApiSpec(filepathOrObject);\n\n  const jestMatchers: jest.ExpectExtendMap = {\n    toSatisfyApiSpec(received: unknown) {\n      return toSatisfyApiSpec.call(this, received, openApiSpec);\n    },\n    toSatisfySchemaInApiSpec(received: unknown, schemaName: string) {\n      return toSatisfySchemaInApiSpec.call(\n        this,\n        received,\n        schemaName,\n        openApiSpec,\n      );\n    },\n  };\n\n  const jestExpect = (global as { expect?: jest.Expect }).expect;\n\n  /* istanbul ignore next */\n  if (jestExpect !== undefined) {\n    jestExpect.extend(jestMatchers);\n  } else {\n    // eslint-disable-next-line no-console\n    console.error(\n      [\n        \"Unable to find Jest's global expect.\",\n        'Please check you have configured jest-openapi correctly.',\n        'See https://github.com/openapi-library/OpenAPIValidators/tree/master/packages/jest-openapi#usage for help.',\n      ].join('\\n'),\n    );\n  }\n  /* istanbul ignore next */\n}\n","import {\n  EXPECTED_COLOR,\n  matcherHint,\n  MatcherHintOptions,\n  RECEIVED_COLOR,\n} from 'jest-matcher-utils';\nimport {\n  ActualResponse,\n  ErrorCode,\n  makeResponse,\n  OpenApi2Spec,\n  OpenApi3Spec,\n  OpenApiSpec,\n  RawResponse,\n  ValidationError,\n} from '@ehuelsmann/openapi-validator';\nimport { joinWithNewLines, stringify } from '../utils';\n\nexport default function (\n  this: jest.MatcherContext,\n  received: unknown,\n  openApiSpec: OpenApiSpec,\n): jest.CustomMatcherResult {\n  const actualResponse = makeResponse(received as RawResponse);\n\n  const validationError = openApiSpec.validateResponse(actualResponse);\n  const pass = !validationError;\n\n  const matcherHintOptions: MatcherHintOptions = {\n    comment:\n      \"Matches 'received' to a response defined in your API spec, then validates 'received' against it\",\n    ...(this.isNot !== undefined && { isNot: this.isNot }),\n    ...(this.promise !== undefined && { promise: this.promise }),\n  };\n  const hint = matcherHint(\n    'toSatisfyApiSpec',\n    undefined,\n    '',\n    matcherHintOptions,\n  );\n  const message = pass\n    ? () =>\n        getExpectReceivedNotToSatisfyApiSpecMsg(\n          actualResponse,\n          openApiSpec,\n          hint,\n        )\n    : () =>\n        getExpectReceivedToSatisfyApiSpecMsg(\n          actualResponse,\n          openApiSpec,\n          validationError,\n          hint,\n        );\n\n  return {\n    pass,\n    message,\n  };\n}\n\nfunction getExpectReceivedToSatisfyApiSpecMsg(\n  actualResponse: ActualResponse,\n  openApiSpec: OpenApiSpec,\n  validationError: ValidationError,\n  hint: string,\n): string {\n  const { status, req } = actualResponse;\n  const { method, path: requestPath } = req;\n  const unmatchedEndpoint = `${method} ${requestPath}`;\n\n  if (validationError.code === ErrorCode.ServerNotFound) {\n    // prettier-ignore\n    return joinWithNewLines(\n      hint,\n      `expected ${RECEIVED_COLOR('received')} to satisfy a '${status}' response defined for endpoint '${unmatchedEndpoint}' in your API spec`,\n      `${RECEIVED_COLOR('received')} had request path ${RECEIVED_COLOR(requestPath)}, but your API spec has no matching servers`,\n      `Servers found in API spec: ${EXPECTED_COLOR((openApiSpec as OpenApi3Spec).getServerUrls().join(', '))}`,\n    );\n  }\n\n  if (validationError.code === ErrorCode.BasePathNotFound) {\n    // prettier-ignore\n    return joinWithNewLines(\n      hint,\n      `expected ${RECEIVED_COLOR('received')} to satisfy a '${status}' response defined for endpoint '${unmatchedEndpoint}' in your API spec`,\n      `${RECEIVED_COLOR('received')} had request path ${RECEIVED_COLOR(requestPath)}, but your API spec has basePath ${EXPECTED_COLOR((openApiSpec as OpenApi2Spec).spec.basePath)}`,\n    );\n  }\n\n  if (validationError.code === ErrorCode.PathNotFound) {\n    // prettier-ignore\n    const pathNotFoundErrorMessage = joinWithNewLines(\n      hint,\n      `expected ${RECEIVED_COLOR('received')} to satisfy a '${status}' response defined for endpoint '${unmatchedEndpoint}' in your API spec`,\n      `${RECEIVED_COLOR('received')} had request path ${RECEIVED_COLOR(requestPath)}, but your API spec has no matching path`,\n      `Paths found in API spec: ${EXPECTED_COLOR(openApiSpec.paths().join(', '))}`,\n    );\n\n    if (\n      'didUserDefineBasePath' in openApiSpec &&\n      openApiSpec.didUserDefineBasePath\n    ) {\n      // prettier-ignore\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    // prettier-ignore\n    return joinWithNewLines(\n      hint,\n      `expected ${RECEIVED_COLOR('received')} to satisfy a '${status}' response defined for endpoint '${endpoint}' in your API spec`,\n      `${RECEIVED_COLOR('received')} had request method ${RECEIVED_COLOR(method)}, but your API spec has no ${RECEIVED_COLOR(method)} operation defined for path '${path}'`,\n      `Request operations found for path '${path}' in API spec: ${EXPECTED_COLOR(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    // prettier-ignore\n    return joinWithNewLines(\n      hint,\n      `expected ${RECEIVED_COLOR('received')} to satisfy a '${status}' response defined for endpoint '${endpoint}' in your API spec`,\n      `${RECEIVED_COLOR('received')} had status ${RECEIVED_COLOR(status)}, but your API spec has no ${RECEIVED_COLOR(status)} response defined for endpoint '${endpoint}'`,\n      `Response statuses found for endpoint '${endpoint}' in API spec: ${EXPECTED_COLOR(expectedResponseStatuses)}`,\n    );\n  }\n\n  // validationError.code === ErrorCode.InvalidBody\n  const responseDefinition = openApiSpec.findExpectedResponse(actualResponse);\n  // prettier-ignore\n  return joinWithNewLines(\n    hint,\n    `expected ${RECEIVED_COLOR('received')} to satisfy the '${status}' response defined for endpoint '${endpoint}' in your API spec`,\n    `${RECEIVED_COLOR('received')} did not satisfy it because: ${validationError}`,\n    `${RECEIVED_COLOR('received')} contained: ${RECEIVED_COLOR(actualResponse.toString())}`,\n    `The '${status}' response defined for endpoint '${endpoint}' in API spec: ${EXPECTED_COLOR(stringify(responseDefinition))}`,\n  );\n}\n\nfunction getExpectReceivedNotToSatisfyApiSpecMsg(\n  actualResponse: ActualResponse,\n  openApiSpec: OpenApiSpec,\n  hint: string,\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  // prettier-ignore\n  return joinWithNewLines(\n    hint,\n    `expected ${RECEIVED_COLOR('received')} not to satisfy the '${status}' response defined for endpoint '${endpoint}' in your API spec`,\n    `${RECEIVED_COLOR('received')} contained: ${RECEIVED_COLOR(actualResponse.toString())}`,\n    `The '${status}' response defined for endpoint '${endpoint}' in API spec: ${EXPECTED_COLOR(stringify(responseDefinition))}`,\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 {\n  EXPECTED_COLOR,\n  matcherErrorMessage,\n  matcherHint,\n  MatcherHintOptions,\n  printExpected,\n  printWithType,\n  RECEIVED_COLOR,\n} from 'jest-matcher-utils';\nimport type { OpenApiSpec, Schema, ValidationError } from '@ehuelsmann/openapi-validator';\nimport { joinWithNewLines, stringify } from '../utils';\n\nexport default function (\n  this: jest.MatcherContext,\n  received: unknown,\n  schemaName: string,\n  openApiSpec: OpenApiSpec,\n): jest.CustomMatcherResult {\n  const matcherHintOptions: MatcherHintOptions = {\n    comment:\n      \"Matches 'received' to a schema defined in your API spec, then validates 'received' against it\",\n    ...(this.isNot !== undefined && { isNot: this.isNot }),\n    ...(this.promise !== undefined && { promise: this.promise }),\n  };\n  const hint = matcherHint(\n    'toSatisfySchemaInApiSpec',\n    undefined,\n    'schemaName',\n    matcherHintOptions,\n  );\n\n  const schema = openApiSpec.getSchemaObject(schemaName);\n  if (!schema) {\n    // alert users they are misusing this assertion\n    throw new Error(\n      matcherErrorMessage(\n        hint,\n        `${EXPECTED_COLOR('schemaName')} must match a schema in your API spec`,\n        printWithType('schemaName', schemaName, printExpected),\n      ),\n    );\n  }\n\n  const validationError = openApiSpec.validateObject(received, schema);\n  const pass = !validationError;\n\n  const message = pass\n    ? () =>\n        getExpectReceivedNotToSatisfySchemaInApiSpecMsg(\n          received,\n          schemaName,\n          schema,\n          hint,\n        )\n    : () =>\n        getExpectReceivedToSatisfySchemaInApiSpecMsg(\n          received,\n          schemaName,\n          schema,\n          validationError,\n          hint,\n        );\n\n  return {\n    pass,\n    message,\n  };\n}\n\nfunction getExpectReceivedToSatisfySchemaInApiSpecMsg(\n  received: unknown,\n  schemaName: string,\n  schema: Schema,\n  validationError: ValidationError,\n  hint: string,\n): string {\n  // prettier-ignore\n  return joinWithNewLines(\n    hint,\n    `expected ${RECEIVED_COLOR('received')} to satisfy the '${schemaName}' schema defined in your API spec`,\n    `${RECEIVED_COLOR('received')} did not satisfy it because: ${validationError}`,\n    `${RECEIVED_COLOR('received')} was: ${RECEIVED_COLOR(stringify(received))}`,\n    `The '${schemaName}' schema in API spec: ${EXPECTED_COLOR(stringify(schema))}`,\n  );\n}\n\nfunction getExpectReceivedNotToSatisfySchemaInApiSpecMsg(\n  received: unknown,\n  schemaName: string,\n  schema: Schema,\n  hint: string,\n): string {\n  // prettier-ignore\n  return joinWithNewLines(\n    hint,\n    `expected ${RECEIVED_COLOR('received')} not to satisfy the '${schemaName}' schema defined in your API spec`,\n    `${RECEIVED_COLOR('received')} was: ${RECEIVED_COLOR(stringify(received))}`,\n    `The '${schemaName}' schema in API spec: ${EXPECTED_COLOR(stringify(schema))}`,\n  );\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAAAA,4BAA+C;;;ACA/C,gCAKO;AACP,+BASO;;;ACfP,kBAAwB;AAEjB,IAAM,YAAY,CAAC,YACxB,qBAAQ,KAAK,EAAE,YAAY,OAAO,OAAO,KAAK,CAAC;AAE1C,IAAM,mBAAmB,IAAI,UAClC,MAAM,KAAK,MAAM;;;ADYJ,SAAR,yBAEL,UACA,aAC0B;AAC1B,QAAM,qBAAiB,uCAAa,QAAuB;AAE3D,QAAM,kBAAkB,YAAY,iBAAiB,cAAc;AACnE,QAAM,OAAO,CAAC;AAEd,QAAM,qBAAyC;AAAA,IAC7C,SACE;AAAA,IACF,GAAI,KAAK,UAAU,UAAa,EAAE,OAAO,KAAK,MAAM;AAAA,IACpD,GAAI,KAAK,YAAY,UAAa,EAAE,SAAS,KAAK,QAAQ;AAAA,EAC5D;AACA,QAAM,WAAO;AAAA,IACX;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,EACF;AACA,QAAM,UAAU,OACZ,MACE;AAAA,IACE;AAAA,IACA;AAAA,IACA;AAAA,EACF,IACF,MACE;AAAA,IACE;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,EACF;AAEN,SAAO;AAAA,IACL;AAAA,IACA;AAAA,EACF;AACF;AAEA,SAAS,qCACP,gBACA,aACA,iBACA,MACQ;AACR,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;AAErD,WAAO;AAAA,MACL;AAAA,MACA,gBAAY,0CAAe,UAAU,CAAC,kBAAkB,MAAM,oCAAoC,iBAAiB;AAAA,MACnH,OAAG,0CAAe,UAAU,CAAC,yBAAqB,0CAAe,WAAW,CAAC;AAAA,MAC7E,kCAA8B,0CAAgB,YAA6B,cAAc,EAAE,KAAK,IAAI,CAAC,CAAC;AAAA,IACxG;AAAA,EACF;AAEA,MAAI,gBAAgB,SAAS,mCAAU,kBAAkB;AAEvD,WAAO;AAAA,MACL;AAAA,MACA,gBAAY,0CAAe,UAAU,CAAC,kBAAkB,MAAM,oCAAoC,iBAAiB;AAAA,MACnH,OAAG,0CAAe,UAAU,CAAC,yBAAqB,0CAAe,WAAW,CAAC,wCAAoC,0CAAgB,YAA6B,KAAK,QAAQ,CAAC;AAAA,IAC9K;AAAA,EACF;AAEA,MAAI,gBAAgB,SAAS,mCAAU,cAAc;AAEnD,UAAM,2BAA2B;AAAA,MAC/B;AAAA,MACA,gBAAY,0CAAe,UAAU,CAAC,kBAAkB,MAAM,oCAAoC,iBAAiB;AAAA,MACnH,OAAG,0CAAe,UAAU,CAAC,yBAAqB,0CAAe,WAAW,CAAC;AAAA,MAC7E,gCAA4B,0CAAe,YAAY,MAAM,EAAE,KAAK,IAAI,CAAC,CAAC;AAAA,IAC5E;AAEA,QACE,2BAA2B,eAC3B,YAAY,uBACZ;AAEA,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;AAEZ,WAAO;AAAA,MACL;AAAA,MACA,gBAAY,0CAAe,UAAU,CAAC,kBAAkB,MAAM,oCAAoC,QAAQ;AAAA,MAC1G,OAAG,0CAAe,UAAU,CAAC,2BAAuB,0CAAe,MAAM,CAAC,kCAA8B,0CAAe,MAAM,CAAC,gCAAgC,IAAI;AAAA,MAClK,sCAAsC,IAAI,sBAAkB,0CAAe,yBAAyB,CAAC;AAAA,IACvG;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;AAEX,WAAO;AAAA,MACL;AAAA,MACA,gBAAY,0CAAe,UAAU,CAAC,kBAAkB,MAAM,oCAAoC,QAAQ;AAAA,MAC1G,OAAG,0CAAe,UAAU,CAAC,mBAAe,0CAAe,MAAM,CAAC,kCAA8B,0CAAe,MAAM,CAAC,mCAAmC,QAAQ;AAAA,MACjK,yCAAyC,QAAQ,sBAAkB,0CAAe,wBAAwB,CAAC;AAAA,IAC7G;AAAA,EACF;AAGA,QAAM,qBAAqB,YAAY,qBAAqB,cAAc;AAE1E,SAAO;AAAA,IACL;AAAA,IACA,gBAAY,0CAAe,UAAU,CAAC,oBAAoB,MAAM,oCAAoC,QAAQ;AAAA,IAC5G,OAAG,0CAAe,UAAU,CAAC,gCAAgC,eAAe;AAAA,IAC5E,OAAG,0CAAe,UAAU,CAAC,mBAAe,0CAAe,eAAe,SAAS,CAAC,CAAC;AAAA,IACrF,QAAQ,MAAM,oCAAoC,QAAQ,sBAAkB,0CAAe,UAAU,kBAAkB,CAAC,CAAC;AAAA,EAC3H;AACF;AAEA,SAAS,wCACP,gBACA,aACA,MACQ;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;AAGD,SAAO;AAAA,IACL;AAAA,IACA,gBAAY,0CAAe,UAAU,CAAC,wBAAwB,MAAM,oCAAoC,QAAQ;AAAA,IAChH,OAAG,0CAAe,UAAU,CAAC,mBAAe,0CAAe,eAAe,SAAS,CAAC,CAAC;AAAA,IACrF,QAAQ,MAAM,oCAAoC,QAAQ,sBAAkB,0CAAe,UAAU,kBAAkB,CAAC,CAAC;AAAA,EAC3H;AACF;;;AE3LA,IAAAC,6BAQO;AAIQ,SAAR,iCAEL,UACA,YACA,aAC0B;AAC1B,QAAM,qBAAyC;AAAA,IAC7C,SACE;AAAA,IACF,GAAI,KAAK,UAAU,UAAa,EAAE,OAAO,KAAK,MAAM;AAAA,IACpD,GAAI,KAAK,YAAY,UAAa,EAAE,SAAS,KAAK,QAAQ;AAAA,EAC5D;AACA,QAAM,WAAO;AAAA,IACX;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,EACF;AAEA,QAAM,SAAS,YAAY,gBAAgB,UAAU;AACrD,MAAI,CAAC,QAAQ;AAEX,UAAM,IAAI;AAAA,UACR;AAAA,QACE;AAAA,QACA,OAAG,2CAAe,YAAY,CAAC;AAAA,YAC/B,0CAAc,cAAc,YAAY,wCAAa;AAAA,MACvD;AAAA,IACF;AAAA,EACF;AAEA,QAAM,kBAAkB,YAAY,eAAe,UAAU,MAAM;AACnE,QAAM,OAAO,CAAC;AAEd,QAAM,UAAU,OACZ,MACE;AAAA,IACE;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,EACF,IACF,MACE;AAAA,IACE;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,EACF;AAEN,SAAO;AAAA,IACL;AAAA,IACA;AAAA,EACF;AACF;AAEA,SAAS,6CACP,UACA,YACA,QACA,iBACA,MACQ;AAER,SAAO;AAAA,IACL;AAAA,IACA,gBAAY,2CAAe,UAAU,CAAC,oBAAoB,UAAU;AAAA,IACpE,OAAG,2CAAe,UAAU,CAAC,gCAAgC,eAAe;AAAA,IAC5E,OAAG,2CAAe,UAAU,CAAC,aAAS,2CAAe,UAAU,QAAQ,CAAC,CAAC;AAAA,IACzE,QAAQ,UAAU,6BAAyB,2CAAe,UAAU,MAAM,CAAC,CAAC;AAAA,EAC9E;AACF;AAEA,SAAS,gDACP,UACA,YACA,QACA,MACQ;AAER,SAAO;AAAA,IACL;AAAA,IACA,gBAAY,2CAAe,UAAU,CAAC,wBAAwB,UAAU;AAAA,IACxE,OAAG,2CAAe,UAAU,CAAC,aAAS,2CAAe,UAAU,QAAQ,CAAC,CAAC;AAAA,IACzE,QAAQ,UAAU,6BAAyB,2CAAe,UAAU,MAAM,CAAC,CAAC;AAAA,EAC9E;AACF;;;AH7Ee,SAAR,cAAkB,kBAAoD;AAC3E,QAAM,kBAAc,uCAAY,gBAAgB;AAEhD,QAAM,eAAqC;AAAA,IACzC,iBAAiB,UAAmB;AAClC,aAAO,yBAAiB,KAAK,MAAM,UAAU,WAAW;AAAA,IAC1D;AAAA,IACA,yBAAyB,UAAmB,YAAoB;AAC9D,aAAO,iCAAyB;AAAA,QAC9B;AAAA,QACA;AAAA,QACA;AAAA,QACA;AAAA,MACF;AAAA,IACF;AAAA,EACF;AAEA,QAAM,aAAc,OAAoC;AAGxD,MAAI,eAAe,QAAW;AAC5B,eAAW,OAAO,YAAY;AAAA,EAChC,OAAO;AAEL,YAAQ;AAAA,MACN;AAAA,QACE;AAAA,QACA;AAAA,QACA;AAAA,MACF,EAAE,KAAK,IAAI;AAAA,IACb;AAAA,EACF;AAEF;","names":["import_openapi_validator","import_jest_matcher_utils"]}

package/dist/index.mjs

@@ -0,0 +1,243 @@
+// src/index.ts
+import { makeApiSpec } from "@ehuelsmann/openapi-validator";
+
+// src/matchers/toSatisfyApiSpec.ts
+import {
+  EXPECTED_COLOR,
+  matcherHint,
+  RECEIVED_COLOR
+} from "jest-matcher-utils";
+import {
+  ErrorCode,
+  makeResponse
+} from "@ehuelsmann/openapi-validator";
+
+// src/utils.ts
+import { inspect } from "util";
+var stringify = (obj) => inspect(obj, { showHidden: false, depth: null });
+var joinWithNewLines = (...lines) => lines.join("\n\n");
+
+// src/matchers/toSatisfyApiSpec.ts
+function toSatisfyApiSpec_default(received, openApiSpec) {
+  const actualResponse = makeResponse(received);
+  const validationError = openApiSpec.validateResponse(actualResponse);
+  const pass = !validationError;
+  const matcherHintOptions = {
+    comment: "Matches 'received' to a response defined in your API spec, then validates 'received' against it",
+    ...this.isNot !== void 0 && { isNot: this.isNot },
+    ...this.promise !== void 0 && { promise: this.promise }
+  };
+  const hint = matcherHint(
+    "toSatisfyApiSpec",
+    void 0,
+    "",
+    matcherHintOptions
+  );
+  const message = pass ? () => getExpectReceivedNotToSatisfyApiSpecMsg(
+    actualResponse,
+    openApiSpec,
+    hint
+  ) : () => getExpectReceivedToSatisfyApiSpecMsg(
+    actualResponse,
+    openApiSpec,
+    validationError,
+    hint
+  );
+  return {
+    pass,
+    message
+  };
+}
+function getExpectReceivedToSatisfyApiSpecMsg(actualResponse, openApiSpec, validationError, hint) {
+  const { status, req } = actualResponse;
+  const { method, path: requestPath } = req;
+  const unmatchedEndpoint = `${method} ${requestPath}`;
+  if (validationError.code === ErrorCode.ServerNotFound) {
+    return joinWithNewLines(
+      hint,
+      `expected ${RECEIVED_COLOR("received")} to satisfy a '${status}' response defined for endpoint '${unmatchedEndpoint}' in your API spec`,
+      `${RECEIVED_COLOR("received")} had request path ${RECEIVED_COLOR(requestPath)}, but your API spec has no matching servers`,
+      `Servers found in API spec: ${EXPECTED_COLOR(openApiSpec.getServerUrls().join(", "))}`
+    );
+  }
+  if (validationError.code === ErrorCode.BasePathNotFound) {
+    return joinWithNewLines(
+      hint,
+      `expected ${RECEIVED_COLOR("received")} to satisfy a '${status}' response defined for endpoint '${unmatchedEndpoint}' in your API spec`,
+      `${RECEIVED_COLOR("received")} had request path ${RECEIVED_COLOR(requestPath)}, but your API spec has basePath ${EXPECTED_COLOR(openApiSpec.spec.basePath)}`
+    );
+  }
+  if (validationError.code === ErrorCode.PathNotFound) {
+    const pathNotFoundErrorMessage = joinWithNewLines(
+      hint,
+      `expected ${RECEIVED_COLOR("received")} to satisfy a '${status}' response defined for endpoint '${unmatchedEndpoint}' in your API spec`,
+      `${RECEIVED_COLOR("received")} had request path ${RECEIVED_COLOR(requestPath)}, but your API spec has no matching path`,
+      `Paths found in API spec: ${EXPECTED_COLOR(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 ${RECEIVED_COLOR("received")} to satisfy a '${status}' response defined for endpoint '${endpoint}' in your API spec`,
+      `${RECEIVED_COLOR("received")} had request method ${RECEIVED_COLOR(method)}, but your API spec has no ${RECEIVED_COLOR(method)} operation defined for path '${path}'`,
+      `Request operations found for path '${path}' in API spec: ${EXPECTED_COLOR(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 ${RECEIVED_COLOR("received")} to satisfy a '${status}' response defined for endpoint '${endpoint}' in your API spec`,
+      `${RECEIVED_COLOR("received")} had status ${RECEIVED_COLOR(status)}, but your API spec has no ${RECEIVED_COLOR(status)} response defined for endpoint '${endpoint}'`,
+      `Response statuses found for endpoint '${endpoint}' in API spec: ${EXPECTED_COLOR(expectedResponseStatuses)}`
+    );
+  }
+  const responseDefinition = openApiSpec.findExpectedResponse(actualResponse);
+  return joinWithNewLines(
+    hint,
+    `expected ${RECEIVED_COLOR("received")} to satisfy the '${status}' response defined for endpoint '${endpoint}' in your API spec`,
+    `${RECEIVED_COLOR("received")} did not satisfy it because: ${validationError}`,
+    `${RECEIVED_COLOR("received")} contained: ${RECEIVED_COLOR(actualResponse.toString())}`,
+    `The '${status}' response defined for endpoint '${endpoint}' in API spec: ${EXPECTED_COLOR(stringify(responseDefinition))}`
+  );
+}
+function getExpectReceivedNotToSatisfyApiSpecMsg(actualResponse, openApiSpec, hint) {
+  const { status, req } = actualResponse;
+  const responseDefinition = openApiSpec.findExpectedResponse(actualResponse);
+  const endpoint = `${req.method} ${openApiSpec.findOpenApiPathMatchingRequest(
+    req
+  )}`;
+  return joinWithNewLines(
+    hint,
+    `expected ${RECEIVED_COLOR("received")} not to satisfy the '${status}' response defined for endpoint '${endpoint}' in your API spec`,
+    `${RECEIVED_COLOR("received")} contained: ${RECEIVED_COLOR(actualResponse.toString())}`,
+    `The '${status}' response defined for endpoint '${endpoint}' in API spec: ${EXPECTED_COLOR(stringify(responseDefinition))}`
+  );
+}
+
+// src/matchers/toSatisfySchemaInApiSpec.ts
+import {
+  EXPECTED_COLOR as EXPECTED_COLOR2,
+  matcherErrorMessage,
+  matcherHint as matcherHint2,
+  printExpected,
+  printWithType,
+  RECEIVED_COLOR as RECEIVED_COLOR2
+} from "jest-matcher-utils";
+function toSatisfySchemaInApiSpec_default(received, schemaName, openApiSpec) {
+  const matcherHintOptions = {
+    comment: "Matches 'received' to a schema defined in your API spec, then validates 'received' against it",
+    ...this.isNot !== void 0 && { isNot: this.isNot },
+    ...this.promise !== void 0 && { promise: this.promise }
+  };
+  const hint = matcherHint2(
+    "toSatisfySchemaInApiSpec",
+    void 0,
+    "schemaName",
+    matcherHintOptions
+  );
+  const schema = openApiSpec.getSchemaObject(schemaName);
+  if (!schema) {
+    throw new Error(
+      matcherErrorMessage(
+        hint,
+        `${EXPECTED_COLOR2("schemaName")} must match a schema in your API spec`,
+        printWithType("schemaName", schemaName, printExpected)
+      )
+    );
+  }
+  const validationError = openApiSpec.validateObject(received, schema);
+  const pass = !validationError;
+  const message = pass ? () => getExpectReceivedNotToSatisfySchemaInApiSpecMsg(
+    received,
+    schemaName,
+    schema,
+    hint
+  ) : () => getExpectReceivedToSatisfySchemaInApiSpecMsg(
+    received,
+    schemaName,
+    schema,
+    validationError,
+    hint
+  );
+  return {
+    pass,
+    message
+  };
+}
+function getExpectReceivedToSatisfySchemaInApiSpecMsg(received, schemaName, schema, validationError, hint) {
+  return joinWithNewLines(
+    hint,
+    `expected ${RECEIVED_COLOR2("received")} to satisfy the '${schemaName}' schema defined in your API spec`,
+    `${RECEIVED_COLOR2("received")} did not satisfy it because: ${validationError}`,
+    `${RECEIVED_COLOR2("received")} was: ${RECEIVED_COLOR2(stringify(received))}`,
+    `The '${schemaName}' schema in API spec: ${EXPECTED_COLOR2(stringify(schema))}`
+  );
+}
+function getExpectReceivedNotToSatisfySchemaInApiSpecMsg(received, schemaName, schema, hint) {
+  return joinWithNewLines(
+    hint,
+    `expected ${RECEIVED_COLOR2("received")} not to satisfy the '${schemaName}' schema defined in your API spec`,
+    `${RECEIVED_COLOR2("received")} was: ${RECEIVED_COLOR2(stringify(received))}`,
+    `The '${schemaName}' schema in API spec: ${EXPECTED_COLOR2(stringify(schema))}`
+  );
+}
+
+// src/index.ts
+function index_default(filepathOrObject) {
+  const openApiSpec = makeApiSpec(filepathOrObject);
+  const jestMatchers = {
+    toSatisfyApiSpec(received) {
+      return toSatisfyApiSpec_default.call(this, received, openApiSpec);
+    },
+    toSatisfySchemaInApiSpec(received, schemaName) {
+      return toSatisfySchemaInApiSpec_default.call(
+        this,
+        received,
+        schemaName,
+        openApiSpec
+      );
+    }
+  };
+  const jestExpect = global.expect;
+  if (jestExpect !== void 0) {
+    jestExpect.extend(jestMatchers);
+  } else {
+    console.error(
+      [
+        "Unable to find Jest's global expect.",
+        "Please check you have configured jest-openapi correctly.",
+        "See https://github.com/openapi-library/OpenAPIValidators/tree/master/packages/jest-openapi#usage for help."
+      ].join("\n")
+    );
+  }
+}
+export {
+  index_default as default
+};
+//# sourceMappingURL=index.mjs.map

package/dist/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/index.ts","../src/matchers/toSatisfyApiSpec.ts","../src/utils.ts","../src/matchers/toSatisfySchemaInApiSpec.ts"],"sourcesContent":["import { makeApiSpec, OpenAPISpecObject } from '@ehuelsmann/openapi-validator';\nimport toSatisfyApiSpec from './matchers/toSatisfyApiSpec';\nimport toSatisfySchemaInApiSpec from './matchers/toSatisfySchemaInApiSpec';\n\ndeclare global {\n  // eslint-disable-next-line @typescript-eslint/no-namespace\n  namespace jest {\n    interface Matchers<R> {\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/jest-openapi#in-api-tests-validate-the-status-and-body-of-http-responses-against-your-openapi-spec)\n       */\n      toSatisfyApiSpec(): R;\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/jest-openapi#in-unit-tests-validate-objects-against-schemas-defined-in-your-openapi-spec)\n       */\n      toSatisfySchemaInApiSpec(schemaName: string): R;\n    }\n  }\n}\n\nexport default function (filepathOrObject: string | OpenAPISpecObject): void {\n  const openApiSpec = makeApiSpec(filepathOrObject);\n\n  const jestMatchers: jest.ExpectExtendMap = {\n    toSatisfyApiSpec(received: unknown) {\n      return toSatisfyApiSpec.call(this, received, openApiSpec);\n    },\n    toSatisfySchemaInApiSpec(received: unknown, schemaName: string) {\n      return toSatisfySchemaInApiSpec.call(\n        this,\n        received,\n        schemaName,\n        openApiSpec,\n      );\n    },\n  };\n\n  const jestExpect = (global as { expect?: jest.Expect }).expect;\n\n  /* istanbul ignore next */\n  if (jestExpect !== undefined) {\n    jestExpect.extend(jestMatchers);\n  } else {\n    // eslint-disable-next-line no-console\n    console.error(\n      [\n        \"Unable to find Jest's global expect.\",\n        'Please check you have configured jest-openapi correctly.',\n        'See https://github.com/openapi-library/OpenAPIValidators/tree/master/packages/jest-openapi#usage for help.',\n      ].join('\\n'),\n    );\n  }\n  /* istanbul ignore next */\n}\n","import {\n  EXPECTED_COLOR,\n  matcherHint,\n  MatcherHintOptions,\n  RECEIVED_COLOR,\n} from 'jest-matcher-utils';\nimport {\n  ActualResponse,\n  ErrorCode,\n  makeResponse,\n  OpenApi2Spec,\n  OpenApi3Spec,\n  OpenApiSpec,\n  RawResponse,\n  ValidationError,\n} from '@ehuelsmann/openapi-validator';\nimport { joinWithNewLines, stringify } from '../utils';\n\nexport default function (\n  this: jest.MatcherContext,\n  received: unknown,\n  openApiSpec: OpenApiSpec,\n): jest.CustomMatcherResult {\n  const actualResponse = makeResponse(received as RawResponse);\n\n  const validationError = openApiSpec.validateResponse(actualResponse);\n  const pass = !validationError;\n\n  const matcherHintOptions: MatcherHintOptions = {\n    comment:\n      \"Matches 'received' to a response defined in your API spec, then validates 'received' against it\",\n    ...(this.isNot !== undefined && { isNot: this.isNot }),\n    ...(this.promise !== undefined && { promise: this.promise }),\n  };\n  const hint = matcherHint(\n    'toSatisfyApiSpec',\n    undefined,\n    '',\n    matcherHintOptions,\n  );\n  const message = pass\n    ? () =>\n        getExpectReceivedNotToSatisfyApiSpecMsg(\n          actualResponse,\n          openApiSpec,\n          hint,\n        )\n    : () =>\n        getExpectReceivedToSatisfyApiSpecMsg(\n          actualResponse,\n          openApiSpec,\n          validationError,\n          hint,\n        );\n\n  return {\n    pass,\n    message,\n  };\n}\n\nfunction getExpectReceivedToSatisfyApiSpecMsg(\n  actualResponse: ActualResponse,\n  openApiSpec: OpenApiSpec,\n  validationError: ValidationError,\n  hint: string,\n): string {\n  const { status, req } = actualResponse;\n  const { method, path: requestPath } = req;\n  const unmatchedEndpoint = `${method} ${requestPath}`;\n\n  if (validationError.code === ErrorCode.ServerNotFound) {\n    // prettier-ignore\n    return joinWithNewLines(\n      hint,\n      `expected ${RECEIVED_COLOR('received')} to satisfy a '${status}' response defined for endpoint '${unmatchedEndpoint}' in your API spec`,\n      `${RECEIVED_COLOR('received')} had request path ${RECEIVED_COLOR(requestPath)}, but your API spec has no matching servers`,\n      `Servers found in API spec: ${EXPECTED_COLOR((openApiSpec as OpenApi3Spec).getServerUrls().join(', '))}`,\n    );\n  }\n\n  if (validationError.code === ErrorCode.BasePathNotFound) {\n    // prettier-ignore\n    return joinWithNewLines(\n      hint,\n      `expected ${RECEIVED_COLOR('received')} to satisfy a '${status}' response defined for endpoint '${unmatchedEndpoint}' in your API spec`,\n      `${RECEIVED_COLOR('received')} had request path ${RECEIVED_COLOR(requestPath)}, but your API spec has basePath ${EXPECTED_COLOR((openApiSpec as OpenApi2Spec).spec.basePath)}`,\n    );\n  }\n\n  if (validationError.code === ErrorCode.PathNotFound) {\n    // prettier-ignore\n    const pathNotFoundErrorMessage = joinWithNewLines(\n      hint,\n      `expected ${RECEIVED_COLOR('received')} to satisfy a '${status}' response defined for endpoint '${unmatchedEndpoint}' in your API spec`,\n      `${RECEIVED_COLOR('received')} had request path ${RECEIVED_COLOR(requestPath)}, but your API spec has no matching path`,\n      `Paths found in API spec: ${EXPECTED_COLOR(openApiSpec.paths().join(', '))}`,\n    );\n\n    if (\n      'didUserDefineBasePath' in openApiSpec &&\n      openApiSpec.didUserDefineBasePath\n    ) {\n      // prettier-ignore\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    // prettier-ignore\n    return joinWithNewLines(\n      hint,\n      `expected ${RECEIVED_COLOR('received')} to satisfy a '${status}' response defined for endpoint '${endpoint}' in your API spec`,\n      `${RECEIVED_COLOR('received')} had request method ${RECEIVED_COLOR(method)}, but your API spec has no ${RECEIVED_COLOR(method)} operation defined for path '${path}'`,\n      `Request operations found for path '${path}' in API spec: ${EXPECTED_COLOR(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    // prettier-ignore\n    return joinWithNewLines(\n      hint,\n      `expected ${RECEIVED_COLOR('received')} to satisfy a '${status}' response defined for endpoint '${endpoint}' in your API spec`,\n      `${RECEIVED_COLOR('received')} had status ${RECEIVED_COLOR(status)}, but your API spec has no ${RECEIVED_COLOR(status)} response defined for endpoint '${endpoint}'`,\n      `Response statuses found for endpoint '${endpoint}' in API spec: ${EXPECTED_COLOR(expectedResponseStatuses)}`,\n    );\n  }\n\n  // validationError.code === ErrorCode.InvalidBody\n  const responseDefinition = openApiSpec.findExpectedResponse(actualResponse);\n  // prettier-ignore\n  return joinWithNewLines(\n    hint,\n    `expected ${RECEIVED_COLOR('received')} to satisfy the '${status}' response defined for endpoint '${endpoint}' in your API spec`,\n    `${RECEIVED_COLOR('received')} did not satisfy it because: ${validationError}`,\n    `${RECEIVED_COLOR('received')} contained: ${RECEIVED_COLOR(actualResponse.toString())}`,\n    `The '${status}' response defined for endpoint '${endpoint}' in API spec: ${EXPECTED_COLOR(stringify(responseDefinition))}`,\n  );\n}\n\nfunction getExpectReceivedNotToSatisfyApiSpecMsg(\n  actualResponse: ActualResponse,\n  openApiSpec: OpenApiSpec,\n  hint: string,\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  // prettier-ignore\n  return joinWithNewLines(\n    hint,\n    `expected ${RECEIVED_COLOR('received')} not to satisfy the '${status}' response defined for endpoint '${endpoint}' in your API spec`,\n    `${RECEIVED_COLOR('received')} contained: ${RECEIVED_COLOR(actualResponse.toString())}`,\n    `The '${status}' response defined for endpoint '${endpoint}' in API spec: ${EXPECTED_COLOR(stringify(responseDefinition))}`,\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 {\n  EXPECTED_COLOR,\n  matcherErrorMessage,\n  matcherHint,\n  MatcherHintOptions,\n  printExpected,\n  printWithType,\n  RECEIVED_COLOR,\n} from 'jest-matcher-utils';\nimport type { OpenApiSpec, Schema, ValidationError } from '@ehuelsmann/openapi-validator';\nimport { joinWithNewLines, stringify } from '../utils';\n\nexport default function (\n  this: jest.MatcherContext,\n  received: unknown,\n  schemaName: string,\n  openApiSpec: OpenApiSpec,\n): jest.CustomMatcherResult {\n  const matcherHintOptions: MatcherHintOptions = {\n    comment:\n      \"Matches 'received' to a schema defined in your API spec, then validates 'received' against it\",\n    ...(this.isNot !== undefined && { isNot: this.isNot }),\n    ...(this.promise !== undefined && { promise: this.promise }),\n  };\n  const hint = matcherHint(\n    'toSatisfySchemaInApiSpec',\n    undefined,\n    'schemaName',\n    matcherHintOptions,\n  );\n\n  const schema = openApiSpec.getSchemaObject(schemaName);\n  if (!schema) {\n    // alert users they are misusing this assertion\n    throw new Error(\n      matcherErrorMessage(\n        hint,\n        `${EXPECTED_COLOR('schemaName')} must match a schema in your API spec`,\n        printWithType('schemaName', schemaName, printExpected),\n      ),\n    );\n  }\n\n  const validationError = openApiSpec.validateObject(received, schema);\n  const pass = !validationError;\n\n  const message = pass\n    ? () =>\n        getExpectReceivedNotToSatisfySchemaInApiSpecMsg(\n          received,\n          schemaName,\n          schema,\n          hint,\n        )\n    : () =>\n        getExpectReceivedToSatisfySchemaInApiSpecMsg(\n          received,\n          schemaName,\n          schema,\n          validationError,\n          hint,\n        );\n\n  return {\n    pass,\n    message,\n  };\n}\n\nfunction getExpectReceivedToSatisfySchemaInApiSpecMsg(\n  received: unknown,\n  schemaName: string,\n  schema: Schema,\n  validationError: ValidationError,\n  hint: string,\n): string {\n  // prettier-ignore\n  return joinWithNewLines(\n    hint,\n    `expected ${RECEIVED_COLOR('received')} to satisfy the '${schemaName}' schema defined in your API spec`,\n    `${RECEIVED_COLOR('received')} did not satisfy it because: ${validationError}`,\n    `${RECEIVED_COLOR('received')} was: ${RECEIVED_COLOR(stringify(received))}`,\n    `The '${schemaName}' schema in API spec: ${EXPECTED_COLOR(stringify(schema))}`,\n  );\n}\n\nfunction getExpectReceivedNotToSatisfySchemaInApiSpecMsg(\n  received: unknown,\n  schemaName: string,\n  schema: Schema,\n  hint: string,\n): string {\n  // prettier-ignore\n  return joinWithNewLines(\n    hint,\n    `expected ${RECEIVED_COLOR('received')} not to satisfy the '${schemaName}' schema defined in your API spec`,\n    `${RECEIVED_COLOR('received')} was: ${RECEIVED_COLOR(stringify(received))}`,\n    `The '${schemaName}' schema in API spec: ${EXPECTED_COLOR(stringify(schema))}`,\n  );\n}\n"],"mappings":";AAAA,SAAS,mBAAsC;;;ACA/C;AAAA,EACE;AAAA,EACA;AAAA,EAEA;AAAA,OACK;AACP;AAAA,EAEE;AAAA,EACA;AAAA,OAMK;;;ACfP,SAAS,eAAe;AAEjB,IAAM,YAAY,CAAC,QACxB,QAAQ,KAAK,EAAE,YAAY,OAAO,OAAO,KAAK,CAAC;AAE1C,IAAM,mBAAmB,IAAI,UAClC,MAAM,KAAK,MAAM;;;ADYJ,SAAR,yBAEL,UACA,aAC0B;AAC1B,QAAM,iBAAiB,aAAa,QAAuB;AAE3D,QAAM,kBAAkB,YAAY,iBAAiB,cAAc;AACnE,QAAM,OAAO,CAAC;AAEd,QAAM,qBAAyC;AAAA,IAC7C,SACE;AAAA,IACF,GAAI,KAAK,UAAU,UAAa,EAAE,OAAO,KAAK,MAAM;AAAA,IACpD,GAAI,KAAK,YAAY,UAAa,EAAE,SAAS,KAAK,QAAQ;AAAA,EAC5D;AACA,QAAM,OAAO;AAAA,IACX;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,EACF;AACA,QAAM,UAAU,OACZ,MACE;AAAA,IACE;AAAA,IACA;AAAA,IACA;AAAA,EACF,IACF,MACE;AAAA,IACE;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,EACF;AAEN,SAAO;AAAA,IACL;AAAA,IACA;AAAA,EACF;AACF;AAEA,SAAS,qCACP,gBACA,aACA,iBACA,MACQ;AACR,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;AAErD,WAAO;AAAA,MACL;AAAA,MACA,YAAY,eAAe,UAAU,CAAC,kBAAkB,MAAM,oCAAoC,iBAAiB;AAAA,MACnH,GAAG,eAAe,UAAU,CAAC,qBAAqB,eAAe,WAAW,CAAC;AAAA,MAC7E,8BAA8B,eAAgB,YAA6B,cAAc,EAAE,KAAK,IAAI,CAAC,CAAC;AAAA,IACxG;AAAA,EACF;AAEA,MAAI,gBAAgB,SAAS,UAAU,kBAAkB;AAEvD,WAAO;AAAA,MACL;AAAA,MACA,YAAY,eAAe,UAAU,CAAC,kBAAkB,MAAM,oCAAoC,iBAAiB;AAAA,MACnH,GAAG,eAAe,UAAU,CAAC,qBAAqB,eAAe,WAAW,CAAC,oCAAoC,eAAgB,YAA6B,KAAK,QAAQ,CAAC;AAAA,IAC9K;AAAA,EACF;AAEA,MAAI,gBAAgB,SAAS,UAAU,cAAc;AAEnD,UAAM,2BAA2B;AAAA,MAC/B;AAAA,MACA,YAAY,eAAe,UAAU,CAAC,kBAAkB,MAAM,oCAAoC,iBAAiB;AAAA,MACnH,GAAG,eAAe,UAAU,CAAC,qBAAqB,eAAe,WAAW,CAAC;AAAA,MAC7E,4BAA4B,eAAe,YAAY,MAAM,EAAE,KAAK,IAAI,CAAC,CAAC;AAAA,IAC5E;AAEA,QACE,2BAA2B,eAC3B,YAAY,uBACZ;AAEA,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;AAEZ,WAAO;AAAA,MACL;AAAA,MACA,YAAY,eAAe,UAAU,CAAC,kBAAkB,MAAM,oCAAoC,QAAQ;AAAA,MAC1G,GAAG,eAAe,UAAU,CAAC,uBAAuB,eAAe,MAAM,CAAC,8BAA8B,eAAe,MAAM,CAAC,gCAAgC,IAAI;AAAA,MAClK,sCAAsC,IAAI,kBAAkB,eAAe,yBAAyB,CAAC;AAAA,IACvG;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;AAEX,WAAO;AAAA,MACL;AAAA,MACA,YAAY,eAAe,UAAU,CAAC,kBAAkB,MAAM,oCAAoC,QAAQ;AAAA,MAC1G,GAAG,eAAe,UAAU,CAAC,eAAe,eAAe,MAAM,CAAC,8BAA8B,eAAe,MAAM,CAAC,mCAAmC,QAAQ;AAAA,MACjK,yCAAyC,QAAQ,kBAAkB,eAAe,wBAAwB,CAAC;AAAA,IAC7G;AAAA,EACF;AAGA,QAAM,qBAAqB,YAAY,qBAAqB,cAAc;AAE1E,SAAO;AAAA,IACL;AAAA,IACA,YAAY,eAAe,UAAU,CAAC,oBAAoB,MAAM,oCAAoC,QAAQ;AAAA,IAC5G,GAAG,eAAe,UAAU,CAAC,gCAAgC,eAAe;AAAA,IAC5E,GAAG,eAAe,UAAU,CAAC,eAAe,eAAe,eAAe,SAAS,CAAC,CAAC;AAAA,IACrF,QAAQ,MAAM,oCAAoC,QAAQ,kBAAkB,eAAe,UAAU,kBAAkB,CAAC,CAAC;AAAA,EAC3H;AACF;AAEA,SAAS,wCACP,gBACA,aACA,MACQ;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;AAGD,SAAO;AAAA,IACL;AAAA,IACA,YAAY,eAAe,UAAU,CAAC,wBAAwB,MAAM,oCAAoC,QAAQ;AAAA,IAChH,GAAG,eAAe,UAAU,CAAC,eAAe,eAAe,eAAe,SAAS,CAAC,CAAC;AAAA,IACrF,QAAQ,MAAM,oCAAoC,QAAQ,kBAAkB,eAAe,UAAU,kBAAkB,CAAC,CAAC;AAAA,EAC3H;AACF;;;AE3LA;AAAA,EACE,kBAAAA;AAAA,EACA;AAAA,EACA,eAAAC;AAAA,EAEA;AAAA,EACA;AAAA,EACA,kBAAAC;AAAA,OACK;AAIQ,SAAR,iCAEL,UACA,YACA,aAC0B;AAC1B,QAAM,qBAAyC;AAAA,IAC7C,SACE;AAAA,IACF,GAAI,KAAK,UAAU,UAAa,EAAE,OAAO,KAAK,MAAM;AAAA,IACpD,GAAI,KAAK,YAAY,UAAa,EAAE,SAAS,KAAK,QAAQ;AAAA,EAC5D;AACA,QAAM,OAAOC;AAAA,IACX;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,EACF;AAEA,QAAM,SAAS,YAAY,gBAAgB,UAAU;AACrD,MAAI,CAAC,QAAQ;AAEX,UAAM,IAAI;AAAA,MACR;AAAA,QACE;AAAA,QACA,GAAGC,gBAAe,YAAY,CAAC;AAAA,QAC/B,cAAc,cAAc,YAAY,aAAa;AAAA,MACvD;AAAA,IACF;AAAA,EACF;AAEA,QAAM,kBAAkB,YAAY,eAAe,UAAU,MAAM;AACnE,QAAM,OAAO,CAAC;AAEd,QAAM,UAAU,OACZ,MACE;AAAA,IACE;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,EACF,IACF,MACE;AAAA,IACE;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,EACF;AAEN,SAAO;AAAA,IACL;AAAA,IACA;AAAA,EACF;AACF;AAEA,SAAS,6CACP,UACA,YACA,QACA,iBACA,MACQ;AAER,SAAO;AAAA,IACL;AAAA,IACA,YAAYC,gBAAe,UAAU,CAAC,oBAAoB,UAAU;AAAA,IACpE,GAAGA,gBAAe,UAAU,CAAC,gCAAgC,eAAe;AAAA,IAC5E,GAAGA,gBAAe,UAAU,CAAC,SAASA,gBAAe,UAAU,QAAQ,CAAC,CAAC;AAAA,IACzE,QAAQ,UAAU,yBAAyBD,gBAAe,UAAU,MAAM,CAAC,CAAC;AAAA,EAC9E;AACF;AAEA,SAAS,gDACP,UACA,YACA,QACA,MACQ;AAER,SAAO;AAAA,IACL;AAAA,IACA,YAAYC,gBAAe,UAAU,CAAC,wBAAwB,UAAU;AAAA,IACxE,GAAGA,gBAAe,UAAU,CAAC,SAASA,gBAAe,UAAU,QAAQ,CAAC,CAAC;AAAA,IACzE,QAAQ,UAAU,yBAAyBD,gBAAe,UAAU,MAAM,CAAC,CAAC;AAAA,EAC9E;AACF;;;AH7Ee,SAAR,cAAkB,kBAAoD;AAC3E,QAAM,cAAc,YAAY,gBAAgB;AAEhD,QAAM,eAAqC;AAAA,IACzC,iBAAiB,UAAmB;AAClC,aAAO,yBAAiB,KAAK,MAAM,UAAU,WAAW;AAAA,IAC1D;AAAA,IACA,yBAAyB,UAAmB,YAAoB;AAC9D,aAAO,iCAAyB;AAAA,QAC9B;AAAA,QACA;AAAA,QACA;AAAA,QACA;AAAA,MACF;AAAA,IACF;AAAA,EACF;AAEA,QAAM,aAAc,OAAoC;AAGxD,MAAI,eAAe,QAAW;AAC5B,eAAW,OAAO,YAAY;AAAA,EAChC,OAAO;AAEL,YAAQ;AAAA,MACN;AAAA,QACE;AAAA,QACA;AAAA,QACA;AAAA,MACF,EAAE,KAAK,IAAI;AAAA,IACb;AAAA,EACF;AAEF;","names":["EXPECTED_COLOR","matcherHint","RECEIVED_COLOR","matcherHint","EXPECTED_COLOR","RECEIVED_COLOR"]}

package/package.json

@@ -1,16 +1,29 @@
 {
   "name": "@ehuelsmann/jest-openapi",
-  "version": "0.15.0",
+  "version": "0.16.0",
   "description": "Jest matchers for asserting 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",
     "format": "prettier --write ../../ --ignore-path ../../.prettierignore",
     "lint": "tsc --noEmit --project tsconfig.eslint.json && eslint .",
     "lint:fix": "yarn lint --fix",
-    "build": "tsc",
+    "build": "tsup",
     "test": "jest",
     "test:watch": "jest --watch",
     "test:coverage": "yarn clean && yarn clean:openapi-validator && jest --coverage",
@@ -18,7 +31,7 @@
     "test:ci": "yarn format && yarn lint && yarn test:coverage",
     "prepack": "yarn build"
   },
-  "repository": "https://github.com/openapi-library/OpenAPIValidators/tree/master/packages/jest-openapi",
+  "repository": "https://github.com/ehuelsmann/OpenAPIValidators/tree/master/packages/jest-openapi",
   "author": "rwalle61 <richard.lh.waller@gmail.com>",
   "contributors": [
     "Jonny Spruce <jspruce94@gmail.com>"
@@ -33,9 +46,9 @@
     "assertions"
   ],
   "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/jest-openapi#readme",
+  "homepage": "https://github.com/ehuelsmann/OpenAPIValidators/tree/master/packages/jest-openapi#readme",
   "publishConfig": {
     "access": "public"
   },
@@ -44,7 +57,6 @@
   ],
   "devDependencies": {
     "@types/jest": "^30.0.0",
-    "@types/request-promise": "^4.1.48",
     "@types/supertest": "^7.2.0",
     "axios": "^1.15.0",
     "eslint": "^7.11.0",
@@ -52,13 +64,13 @@
     "express": "^5.2.1",
     "fs-extra": "^9.0.1",
     "jest": "^30.3.0",
-    "request-promise": "^4.2.6",
     "supertest": "^7.2.2",
     "ts-jest": "^29.0.0",
-    "ts-node": "^9.1.1"
+    "ts-node": "^9.1.1",
+    "tsup": "^8.5.1"
   },
   "dependencies": {
-    "jest-matcher-utils": "^29.0.0",
-    "@ehuelsmann/openapi-validator": "^0.15.0"
+    "@ehuelsmann/openapi-validator": "^0.16.0",
+    "jest-matcher-utils": "^29.0.0"
   }
 }

package/dist/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/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,QAAQ,CAAC,CAAC;YAClB;;;eAGG;YACH,gBAAgB,IAAI,CAAC,CAAC;YACtB;;;eAGG;YACH,wBAAwB,CAAC,UAAU,EAAE,MAAM,GAAG,CAAC,CAAC;SACjD;KACF;CACF;AAED,MAAM,CAAC,OAAO,WAAW,gBAAgB,EAAE,MAAM,GAAG,iBAAiB,GAAG,IAAI,CAiC3E"}

package/dist/matchers/toSatisfyApiSpec.d.ts

@@ -1,3 +0,0 @@
-import { OpenApiSpec } from '@ehuelsmann/openapi-validator';
-export default function (this: jest.MatcherContext, received: unknown, openApiSpec: OpenApiSpec): jest.CustomMatcherResult;
-//# sourceMappingURL=toSatisfyApiSpec.d.ts.map

package/dist/matchers/toSatisfyApiSpec.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"toSatisfyApiSpec.d.ts","sourceRoot":"","sources":["../../src/matchers/toSatisfyApiSpec.ts"],"names":[],"mappings":"AAMA,OAAO,EAML,WAAW,EAGZ,MAAM,+BAA+B,CAAC;AAGvC,MAAM,CAAC,OAAO,WACZ,IAAI,EAAE,IAAI,CAAC,cAAc,EACzB,QAAQ,EAAE,OAAO,EACjB,WAAW,EAAE,WAAW,GACvB,IAAI,CAAC,mBAAmB,CAqC1B"}

package/dist/matchers/toSatisfyApiSpec.js

@@ -1,81 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.default = default_1;
-const jest_matcher_utils_1 = require("jest-matcher-utils");
-const openapi_validator_1 = require("@ehuelsmann/openapi-validator");
-const utils_1 = require("../utils");
-function default_1(received, openApiSpec) {
-    const actualResponse = (0, openapi_validator_1.makeResponse)(received);
-    const validationError = openApiSpec.validateResponse(actualResponse);
-    const pass = !validationError;
-    const matcherHintOptions = {
-        comment: "Matches 'received' to a response defined in your API spec, then validates 'received' against it",
-        ...(this.isNot !== undefined && { isNot: this.isNot }),
-        ...(this.promise !== undefined && { promise: this.promise }),
-    };
-    const hint = (0, jest_matcher_utils_1.matcherHint)('toSatisfyApiSpec', undefined, '', matcherHintOptions);
-    const message = pass
-        ? () => getExpectReceivedNotToSatisfyApiSpecMsg(actualResponse, openApiSpec, hint)
-        : () => getExpectReceivedToSatisfyApiSpecMsg(actualResponse, openApiSpec, validationError, hint);
-    return {
-        pass,
-        message,
-    };
-}
-function getExpectReceivedToSatisfyApiSpecMsg(actualResponse, openApiSpec, validationError, hint) {
-    const { status, req } = actualResponse;
-    const { method, path: requestPath } = req;
-    const unmatchedEndpoint = `${method} ${requestPath}`;
-    if (validationError.code === openapi_validator_1.ErrorCode.ServerNotFound) {
-        // prettier-ignore
-        return (0, utils_1.joinWithNewLines)(hint, `expected ${(0, jest_matcher_utils_1.RECEIVED_COLOR)('received')} to satisfy a '${status}' response defined for endpoint '${unmatchedEndpoint}' in your API spec`, `${(0, jest_matcher_utils_1.RECEIVED_COLOR)('received')} had request path ${(0, jest_matcher_utils_1.RECEIVED_COLOR)(requestPath)}, but your API spec has no matching servers`, `Servers found in API spec: ${(0, jest_matcher_utils_1.EXPECTED_COLOR)(openApiSpec.getServerUrls().join(', '))}`);
-    }
-    if (validationError.code === openapi_validator_1.ErrorCode.BasePathNotFound) {
-        // prettier-ignore
-        return (0, utils_1.joinWithNewLines)(hint, `expected ${(0, jest_matcher_utils_1.RECEIVED_COLOR)('received')} to satisfy a '${status}' response defined for endpoint '${unmatchedEndpoint}' in your API spec`, `${(0, jest_matcher_utils_1.RECEIVED_COLOR)('received')} had request path ${(0, jest_matcher_utils_1.RECEIVED_COLOR)(requestPath)}, but your API spec has basePath ${(0, jest_matcher_utils_1.EXPECTED_COLOR)(openApiSpec.spec.basePath)}`);
-    }
-    if (validationError.code === openapi_validator_1.ErrorCode.PathNotFound) {
-        // prettier-ignore
-        const pathNotFoundErrorMessage = (0, utils_1.joinWithNewLines)(hint, `expected ${(0, jest_matcher_utils_1.RECEIVED_COLOR)('received')} to satisfy a '${status}' response defined for endpoint '${unmatchedEndpoint}' in your API spec`, `${(0, jest_matcher_utils_1.RECEIVED_COLOR)('received')} had request path ${(0, jest_matcher_utils_1.RECEIVED_COLOR)(requestPath)}, but your API spec has no matching path`, `Paths found in API spec: ${(0, jest_matcher_utils_1.EXPECTED_COLOR)(openApiSpec.paths().join(', '))}`);
-        if ('didUserDefineBasePath' in openApiSpec &&
-            openApiSpec.didUserDefineBasePath) {
-            // prettier-ignore
-            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(', ');
-        // prettier-ignore
-        return (0, utils_1.joinWithNewLines)(hint, `expected ${(0, jest_matcher_utils_1.RECEIVED_COLOR)('received')} to satisfy a '${status}' response defined for endpoint '${endpoint}' in your API spec`, `${(0, jest_matcher_utils_1.RECEIVED_COLOR)('received')} had request method ${(0, jest_matcher_utils_1.RECEIVED_COLOR)(method)}, but your API spec has no ${(0, jest_matcher_utils_1.RECEIVED_COLOR)(method)} operation defined for path '${path}'`, `Request operations found for path '${path}' in API spec: ${(0, jest_matcher_utils_1.EXPECTED_COLOR)(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(', ');
-        // prettier-ignore
-        return (0, utils_1.joinWithNewLines)(hint, `expected ${(0, jest_matcher_utils_1.RECEIVED_COLOR)('received')} to satisfy a '${status}' response defined for endpoint '${endpoint}' in your API spec`, `${(0, jest_matcher_utils_1.RECEIVED_COLOR)('received')} had status ${(0, jest_matcher_utils_1.RECEIVED_COLOR)(status)}, but your API spec has no ${(0, jest_matcher_utils_1.RECEIVED_COLOR)(status)} response defined for endpoint '${endpoint}'`, `Response statuses found for endpoint '${endpoint}' in API spec: ${(0, jest_matcher_utils_1.EXPECTED_COLOR)(expectedResponseStatuses)}`);
-    }
-    // validationError.code === ErrorCode.InvalidBody
-    const responseDefinition = openApiSpec.findExpectedResponse(actualResponse);
-    // prettier-ignore
-    return (0, utils_1.joinWithNewLines)(hint, `expected ${(0, jest_matcher_utils_1.RECEIVED_COLOR)('received')} to satisfy the '${status}' response defined for endpoint '${endpoint}' in your API spec`, `${(0, jest_matcher_utils_1.RECEIVED_COLOR)('received')} did not satisfy it because: ${validationError}`, `${(0, jest_matcher_utils_1.RECEIVED_COLOR)('received')} contained: ${(0, jest_matcher_utils_1.RECEIVED_COLOR)(actualResponse.toString())}`, `The '${status}' response defined for endpoint '${endpoint}' in API spec: ${(0, jest_matcher_utils_1.EXPECTED_COLOR)((0, utils_1.stringify)(responseDefinition))}`);
-}
-function getExpectReceivedNotToSatisfyApiSpecMsg(actualResponse, openApiSpec, hint) {
-    const { status, req } = actualResponse;
-    const responseDefinition = openApiSpec.findExpectedResponse(actualResponse);
-    const endpoint = `${req.method} ${openApiSpec.findOpenApiPathMatchingRequest(req)}`;
-    // prettier-ignore
-    return (0, utils_1.joinWithNewLines)(hint, `expected ${(0, jest_matcher_utils_1.RECEIVED_COLOR)('received')} not to satisfy the '${status}' response defined for endpoint '${endpoint}' in your API spec`, `${(0, jest_matcher_utils_1.RECEIVED_COLOR)('received')} contained: ${(0, jest_matcher_utils_1.RECEIVED_COLOR)(actualResponse.toString())}`, `The '${status}' response defined for endpoint '${endpoint}' in API spec: ${(0, jest_matcher_utils_1.EXPECTED_COLOR)((0, utils_1.stringify)(responseDefinition))}`);
-}
-//# sourceMappingURL=toSatisfyApiSpec.js.map

package/dist/matchers/toSatisfyApiSpec.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"toSatisfyApiSpec.js","sourceRoot":"","sources":["../../src/matchers/toSatisfyApiSpec.ts"],"names":[],"mappings":";;AAkBA,4BAyCC;AA3DD,2DAK4B;AAC5B,qEASuC;AACvC,oCAAuD;AAEvD,mBAEE,QAAiB,EACjB,WAAwB;IAExB,MAAM,cAAc,GAAG,IAAA,gCAAY,EAAC,QAAuB,CAAC,CAAC;IAE7D,MAAM,eAAe,GAAG,WAAW,CAAC,gBAAgB,CAAC,cAAc,CAAC,CAAC;IACrE,MAAM,IAAI,GAAG,CAAC,eAAe,CAAC;IAE9B,MAAM,kBAAkB,GAAuB;QAC7C,OAAO,EACL,iGAAiG;QACnG,GAAG,CAAC,IAAI,CAAC,KAAK,KAAK,SAAS,IAAI,EAAE,KAAK,EAAE,IAAI,CAAC,KAAK,EAAE,CAAC;QACtD,GAAG,CAAC,IAAI,CAAC,OAAO,KAAK,SAAS,IAAI,EAAE,OAAO,EAAE,IAAI,CAAC,OAAO,EAAE,CAAC;KAC7D,CAAC;IACF,MAAM,IAAI,GAAG,IAAA,gCAAW,EACtB,kBAAkB,EAClB,SAAS,EACT,EAAE,EACF,kBAAkB,CACnB,CAAC;IACF,MAAM,OAAO,GAAG,IAAI;QAClB,CAAC,CAAC,GAAG,EAAE,CACH,uCAAuC,CACrC,cAAc,EACd,WAAW,EACX,IAAI,CACL;QACL,CAAC,CAAC,GAAG,EAAE,CACH,oCAAoC,CAClC,cAAc,EACd,WAAW,EACX,eAAe,EACf,IAAI,CACL,CAAC;IAER,OAAO;QACL,IAAI;QACJ,OAAO;KACR,CAAC;AACJ,CAAC;AAED,SAAS,oCAAoC,CAC3C,cAA8B,EAC9B,WAAwB,EACxB,eAAgC,EAChC,IAAY;IAEZ,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,kBAAkB;QAClB,OAAO,IAAA,wBAAgB,EACrB,IAAI,EACJ,YAAY,IAAA,mCAAc,EAAC,UAAU,CAAC,kBAAkB,MAAM,oCAAoC,iBAAiB,oBAAoB,EACvI,GAAG,IAAA,mCAAc,EAAC,UAAU,CAAC,qBAAqB,IAAA,mCAAc,EAAC,WAAW,CAAC,6CAA6C,EAC1H,8BAA8B,IAAA,mCAAc,EAAE,WAA4B,CAAC,aAAa,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,EAAE,CACzG,CAAC;IACJ,CAAC;IAED,IAAI,eAAe,CAAC,IAAI,KAAK,6BAAS,CAAC,gBAAgB,EAAE,CAAC;QACxD,kBAAkB;QAClB,OAAO,IAAA,wBAAgB,EACrB,IAAI,EACJ,YAAY,IAAA,mCAAc,EAAC,UAAU,CAAC,kBAAkB,MAAM,oCAAoC,iBAAiB,oBAAoB,EACvI,GAAG,IAAA,mCAAc,EAAC,UAAU,CAAC,qBAAqB,IAAA,mCAAc,EAAC,WAAW,CAAC,oCAAoC,IAAA,mCAAc,EAAE,WAA4B,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,CAC/K,CAAC;IACJ,CAAC;IAED,IAAI,eAAe,CAAC,IAAI,KAAK,6BAAS,CAAC,YAAY,EAAE,CAAC;QACpD,kBAAkB;QAClB,MAAM,wBAAwB,GAAG,IAAA,wBAAgB,EAC/C,IAAI,EACJ,YAAY,IAAA,mCAAc,EAAC,UAAU,CAAC,kBAAkB,MAAM,oCAAoC,iBAAiB,oBAAoB,EACvI,GAAG,IAAA,mCAAc,EAAC,UAAU,CAAC,qBAAqB,IAAA,mCAAc,EAAC,WAAW,CAAC,0CAA0C,EACvH,4BAA4B,IAAA,mCAAc,EAAC,WAAW,CAAC,KAAK,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,EAAE,CAC7E,CAAC;QAEF,IACE,uBAAuB,IAAI,WAAW;YACtC,WAAW,CAAC,qBAAqB,EACjC,CAAC;YACD,kBAAkB;YAClB,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,kBAAkB;QAClB,OAAO,IAAA,wBAAgB,EACrB,IAAI,EACJ,YAAY,IAAA,mCAAc,EAAC,UAAU,CAAC,kBAAkB,MAAM,oCAAoC,QAAQ,oBAAoB,EAC9H,GAAG,IAAA,mCAAc,EAAC,UAAU,CAAC,uBAAuB,IAAA,mCAAc,EAAC,MAAM,CAAC,8BAA8B,IAAA,mCAAc,EAAC,MAAM,CAAC,gCAAgC,IAAI,GAAG,EACrK,sCAAsC,IAAI,kBAAkB,IAAA,mCAAc,EAAC,yBAAyB,CAAC,EAAE,CACxG,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,kBAAkB;QAClB,OAAO,IAAA,wBAAgB,EACrB,IAAI,EACJ,YAAY,IAAA,mCAAc,EAAC,UAAU,CAAC,kBAAkB,MAAM,oCAAoC,QAAQ,oBAAoB,EAC9H,GAAG,IAAA,mCAAc,EAAC,UAAU,CAAC,eAAe,IAAA,mCAAc,EAAC,MAAM,CAAC,8BAA8B,IAAA,mCAAc,EAAC,MAAM,CAAC,mCAAmC,QAAQ,GAAG,EACpK,yCAAyC,QAAQ,kBAAkB,IAAA,mCAAc,EAAC,wBAAwB,CAAC,EAAE,CAC9G,CAAC;IACJ,CAAC;IAED,iDAAiD;IACjD,MAAM,kBAAkB,GAAG,WAAW,CAAC,oBAAoB,CAAC,cAAc,CAAC,CAAC;IAC5E,kBAAkB;IAClB,OAAO,IAAA,wBAAgB,EACrB,IAAI,EACJ,YAAY,IAAA,mCAAc,EAAC,UAAU,CAAC,oBAAoB,MAAM,oCAAoC,QAAQ,oBAAoB,EAChI,GAAG,IAAA,mCAAc,EAAC,UAAU,CAAC,gCAAgC,eAAe,EAAE,EAC9E,GAAG,IAAA,mCAAc,EAAC,UAAU,CAAC,eAAe,IAAA,mCAAc,EAAC,cAAc,CAAC,QAAQ,EAAE,CAAC,EAAE,EACvF,QAAQ,MAAM,oCAAoC,QAAQ,kBAAkB,IAAA,mCAAc,EAAC,IAAA,iBAAS,EAAC,kBAAkB,CAAC,CAAC,EAAE,CAC5H,CAAC;AACJ,CAAC;AAED,SAAS,uCAAuC,CAC9C,cAA8B,EAC9B,WAAwB,EACxB,IAAY;IAEZ,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,kBAAkB;IAClB,OAAO,IAAA,wBAAgB,EACrB,IAAI,EACJ,YAAY,IAAA,mCAAc,EAAC,UAAU,CAAC,wBAAwB,MAAM,oCAAoC,QAAQ,oBAAoB,EACpI,GAAG,IAAA,mCAAc,EAAC,UAAU,CAAC,eAAe,IAAA,mCAAc,EAAC,cAAc,CAAC,QAAQ,EAAE,CAAC,EAAE,EACvF,QAAQ,MAAM,oCAAoC,QAAQ,kBAAkB,IAAA,mCAAc,EAAC,IAAA,iBAAS,EAAC,kBAAkB,CAAC,CAAC,EAAE,CAC5H,CAAC;AACJ,CAAC"}

package/dist/matchers/toSatisfySchemaInApiSpec.d.ts

@@ -1,3 +0,0 @@
-import type { OpenApiSpec } from '@ehuelsmann/openapi-validator';
-export default function (this: jest.MatcherContext, received: unknown, schemaName: string, openApiSpec: OpenApiSpec): jest.CustomMatcherResult;
-//# sourceMappingURL=toSatisfySchemaInApiSpec.d.ts.map

package/dist/matchers/toSatisfySchemaInApiSpec.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"toSatisfySchemaInApiSpec.d.ts","sourceRoot":"","sources":["../../src/matchers/toSatisfySchemaInApiSpec.ts"],"names":[],"mappings":"AASA,OAAO,KAAK,EAAE,WAAW,EAA2B,MAAM,+BAA+B,CAAC;AAG1F,MAAM,CAAC,OAAO,WACZ,IAAI,EAAE,IAAI,CAAC,cAAc,EACzB,QAAQ,EAAE,OAAO,EACjB,UAAU,EAAE,MAAM,EAClB,WAAW,EAAE,WAAW,GACvB,IAAI,CAAC,mBAAmB,CAkD1B"}

package/dist/matchers/toSatisfySchemaInApiSpec.js

@@ -1,36 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.default = default_1;
-const jest_matcher_utils_1 = require("jest-matcher-utils");
-const utils_1 = require("../utils");
-function default_1(received, schemaName, openApiSpec) {
-    const matcherHintOptions = {
-        comment: "Matches 'received' to a schema defined in your API spec, then validates 'received' against it",
-        ...(this.isNot !== undefined && { isNot: this.isNot }),
-        ...(this.promise !== undefined && { promise: this.promise }),
-    };
-    const hint = (0, jest_matcher_utils_1.matcherHint)('toSatisfySchemaInApiSpec', undefined, 'schemaName', matcherHintOptions);
-    const schema = openApiSpec.getSchemaObject(schemaName);
-    if (!schema) {
-        // alert users they are misusing this assertion
-        throw new Error((0, jest_matcher_utils_1.matcherErrorMessage)(hint, `${(0, jest_matcher_utils_1.EXPECTED_COLOR)('schemaName')} must match a schema in your API spec`, (0, jest_matcher_utils_1.printWithType)('schemaName', schemaName, jest_matcher_utils_1.printExpected)));
-    }
-    const validationError = openApiSpec.validateObject(received, schema);
-    const pass = !validationError;
-    const message = pass
-        ? () => getExpectReceivedNotToSatisfySchemaInApiSpecMsg(received, schemaName, schema, hint)
-        : () => getExpectReceivedToSatisfySchemaInApiSpecMsg(received, schemaName, schema, validationError, hint);
-    return {
-        pass,
-        message,
-    };
-}
-function getExpectReceivedToSatisfySchemaInApiSpecMsg(received, schemaName, schema, validationError, hint) {
-    // prettier-ignore
-    return (0, utils_1.joinWithNewLines)(hint, `expected ${(0, jest_matcher_utils_1.RECEIVED_COLOR)('received')} to satisfy the '${schemaName}' schema defined in your API spec`, `${(0, jest_matcher_utils_1.RECEIVED_COLOR)('received')} did not satisfy it because: ${validationError}`, `${(0, jest_matcher_utils_1.RECEIVED_COLOR)('received')} was: ${(0, jest_matcher_utils_1.RECEIVED_COLOR)((0, utils_1.stringify)(received))}`, `The '${schemaName}' schema in API spec: ${(0, jest_matcher_utils_1.EXPECTED_COLOR)((0, utils_1.stringify)(schema))}`);
-}
-function getExpectReceivedNotToSatisfySchemaInApiSpecMsg(received, schemaName, schema, hint) {
-    // prettier-ignore
-    return (0, utils_1.joinWithNewLines)(hint, `expected ${(0, jest_matcher_utils_1.RECEIVED_COLOR)('received')} not to satisfy the '${schemaName}' schema defined in your API spec`, `${(0, jest_matcher_utils_1.RECEIVED_COLOR)('received')} was: ${(0, jest_matcher_utils_1.RECEIVED_COLOR)((0, utils_1.stringify)(received))}`, `The '${schemaName}' schema in API spec: ${(0, jest_matcher_utils_1.EXPECTED_COLOR)((0, utils_1.stringify)(schema))}`);
-}
-//# sourceMappingURL=toSatisfySchemaInApiSpec.js.map

package/dist/matchers/toSatisfySchemaInApiSpec.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"toSatisfySchemaInApiSpec.js","sourceRoot":"","sources":["../../src/matchers/toSatisfySchemaInApiSpec.ts"],"names":[],"mappings":";;AAYA,4BAuDC;AAnED,2DAQ4B;AAE5B,oCAAuD;AAEvD,mBAEE,QAAiB,EACjB,UAAkB,EAClB,WAAwB;IAExB,MAAM,kBAAkB,GAAuB;QAC7C,OAAO,EACL,+FAA+F;QACjG,GAAG,CAAC,IAAI,CAAC,KAAK,KAAK,SAAS,IAAI,EAAE,KAAK,EAAE,IAAI,CAAC,KAAK,EAAE,CAAC;QACtD,GAAG,CAAC,IAAI,CAAC,OAAO,KAAK,SAAS,IAAI,EAAE,OAAO,EAAE,IAAI,CAAC,OAAO,EAAE,CAAC;KAC7D,CAAC;IACF,MAAM,IAAI,GAAG,IAAA,gCAAW,EACtB,0BAA0B,EAC1B,SAAS,EACT,YAAY,EACZ,kBAAkB,CACnB,CAAC;IAEF,MAAM,MAAM,GAAG,WAAW,CAAC,eAAe,CAAC,UAAU,CAAC,CAAC;IACvD,IAAI,CAAC,MAAM,EAAE,CAAC;QACZ,+CAA+C;QAC/C,MAAM,IAAI,KAAK,CACb,IAAA,wCAAmB,EACjB,IAAI,EACJ,GAAG,IAAA,mCAAc,EAAC,YAAY,CAAC,uCAAuC,EACtE,IAAA,kCAAa,EAAC,YAAY,EAAE,UAAU,EAAE,kCAAa,CAAC,CACvD,CACF,CAAC;IACJ,CAAC;IAED,MAAM,eAAe,GAAG,WAAW,CAAC,cAAc,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;IACrE,MAAM,IAAI,GAAG,CAAC,eAAe,CAAC;IAE9B,MAAM,OAAO,GAAG,IAAI;QAClB,CAAC,CAAC,GAAG,EAAE,CACH,+CAA+C,CAC7C,QAAQ,EACR,UAAU,EACV,MAAM,EACN,IAAI,CACL;QACL,CAAC,CAAC,GAAG,EAAE,CACH,4CAA4C,CAC1C,QAAQ,EACR,UAAU,EACV,MAAM,EACN,eAAe,EACf,IAAI,CACL,CAAC;IAER,OAAO;QACL,IAAI;QACJ,OAAO;KACR,CAAC;AACJ,CAAC;AAED,SAAS,4CAA4C,CACnD,QAAiB,EACjB,UAAkB,EAClB,MAAc,EACd,eAAgC,EAChC,IAAY;IAEZ,kBAAkB;IAClB,OAAO,IAAA,wBAAgB,EACrB,IAAI,EACJ,YAAY,IAAA,mCAAc,EAAC,UAAU,CAAC,oBAAoB,UAAU,mCAAmC,EACvG,GAAG,IAAA,mCAAc,EAAC,UAAU,CAAC,gCAAgC,eAAe,EAAE,EAC9E,GAAG,IAAA,mCAAc,EAAC,UAAU,CAAC,SAAS,IAAA,mCAAc,EAAC,IAAA,iBAAS,EAAC,QAAQ,CAAC,CAAC,EAAE,EAC3E,QAAQ,UAAU,yBAAyB,IAAA,mCAAc,EAAC,IAAA,iBAAS,EAAC,MAAM,CAAC,CAAC,EAAE,CAC/E,CAAC;AACJ,CAAC;AAED,SAAS,+CAA+C,CACtD,QAAiB,EACjB,UAAkB,EAClB,MAAc,EACd,IAAY;IAEZ,kBAAkB;IAClB,OAAO,IAAA,wBAAgB,EACrB,IAAI,EACJ,YAAY,IAAA,mCAAc,EAAC,UAAU,CAAC,wBAAwB,UAAU,mCAAmC,EAC3G,GAAG,IAAA,mCAAc,EAAC,UAAU,CAAC,SAAS,IAAA,mCAAc,EAAC,IAAA,iBAAS,EAAC,QAAQ,CAAC,CAAC,EAAE,EAC3E,QAAQ,UAAU,yBAAyB,IAAA,mCAAc,EAAC,IAAA,iBAAS,EAAC,MAAM,CAAC,CAAC,EAAE,CAC/E,CAAC;AACJ,CAAC"}

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":["../src/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":["../src/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"}