@ehuelsmann/openapi-validator 0.15.0 → 0.16.1

package/dist/index.mjs

@@ -0,0 +1,484 @@
+// lib/classes/errors/ValidationError.ts
+var ErrorCode = /* @__PURE__ */ ((ErrorCode2) => {
+  ErrorCode2[ErrorCode2["ServerNotFound"] = 0] = "ServerNotFound";
+  ErrorCode2[ErrorCode2["BasePathNotFound"] = 1] = "BasePathNotFound";
+  ErrorCode2[ErrorCode2["PathNotFound"] = 2] = "PathNotFound";
+  ErrorCode2[ErrorCode2["MethodNotFound"] = 3] = "MethodNotFound";
+  ErrorCode2[ErrorCode2["StatusNotFound"] = 4] = "StatusNotFound";
+  ErrorCode2[ErrorCode2["InvalidBody"] = 5] = "InvalidBody";
+  ErrorCode2[ErrorCode2["InvalidObject"] = 6] = "InvalidObject";
+  return ErrorCode2;
+})(ErrorCode || {});
+var ValidationError = class extends Error {
+  constructor(code, message) {
+    super(message);
+    this.code = code;
+  }
+  toString() {
+    return this.message;
+  }
+};
+
+// lib/openApiSpecFactory.ts
+import fs from "fs-extra";
+import yaml from "js-yaml";
+import OpenAPISchemaValidator from "openapi-schema-validator";
+import path from "path";
+import typeOf from "typeof";
+
+// lib/utils/common.utils.ts
+import { Path } from "path-parser";
+import url from "url";
+import { inspect } from "util";
+var stringify = (obj) => inspect(obj, { depth: null });
+var getPathname = (request) => (
+  // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+  url.parse(request.path).pathname
+);
+var convertOpenApiPathToColonForm = (openApiPath) => openApiPath.replace(/{/g, ":").replace(/}/g, "");
+var doesColonPathMatchPathname = (pathInColonForm, pathname) => {
+  const pathWithoutCommas = pathname.replace(/,/g, "");
+  const pathParamsInPathname = new Path(pathInColonForm).test(
+    pathWithoutCommas
+  );
+  return Boolean(pathParamsInPathname);
+};
+var doesOpenApiPathMatchPathname = (openApiPath, pathname) => {
+  const pathInColonForm = convertOpenApiPathToColonForm(openApiPath);
+  return doesColonPathMatchPathname(pathInColonForm, pathname);
+};
+var findOpenApiPathMatchingPossiblePathnames = (possiblePathnames, OAPaths) => {
+  let openApiPath;
+  for (const pathname of possiblePathnames) {
+    for (const OAPath of OAPaths) {
+      if (OAPath === pathname) {
+        return OAPath;
+      }
+      if (doesOpenApiPathMatchPathname(OAPath, pathname)) {
+        openApiPath = OAPath;
+      }
+    }
+  }
+  return openApiPath;
+};
+var defaultBasePath = "/";
+var getPathnameWithoutBasePath = (basePath, pathname) => basePath === defaultBasePath ? pathname : pathname.replace(basePath, "");
+
+// lib/classes/AbstractOpenApiSpec.ts
+import OpenAPIResponseValidator from "openapi-response-validator";
+var OpenApiSpec = class {
+  constructor(spec) {
+    this.spec = spec;
+  }
+  pathsObject() {
+    return this.spec.paths;
+  }
+  getPathItem(openApiPath) {
+    return this.pathsObject()[openApiPath];
+  }
+  paths() {
+    return Object.keys(this.pathsObject());
+  }
+  getSchemaObject(schemaName) {
+    var _a;
+    return (_a = this.getSchemaObjects()) == null ? void 0 : _a[schemaName];
+  }
+  getExpectedResponse(responseOperation, status) {
+    const response = responseOperation.responses[status];
+    if (!response) {
+      return void 0;
+    }
+    if ("$ref" in response) {
+      return this.findResponseDefinition(response.$ref);
+    }
+    return response;
+  }
+  findExpectedResponse(actualResponse) {
+    const actualRequest = actualResponse.req;
+    const expectedResponseOperation = this.findExpectedResponseOperation(actualRequest);
+    if (!expectedResponseOperation) {
+      throw new ValidationError(3 /* MethodNotFound */);
+    }
+    const { status } = actualResponse;
+    const expectedResponse = this.getExpectedResponse(
+      expectedResponseOperation,
+      status
+    );
+    if (!expectedResponse) {
+      throw new ValidationError(4 /* StatusNotFound */);
+    }
+    return { [status]: expectedResponse };
+  }
+  findOpenApiPathMatchingRequest(actualRequest) {
+    const actualPathname = getPathname(actualRequest);
+    const openApiPath = this.findOpenApiPathMatchingPathname(actualPathname);
+    return openApiPath;
+  }
+  findExpectedPathItem(actualRequest) {
+    const actualPathname = getPathname(actualRequest);
+    const openApiPath = this.findOpenApiPathMatchingPathname(actualPathname);
+    const pathItemObject = this.getPathItem(openApiPath);
+    return pathItemObject;
+  }
+  findExpectedResponseOperation(actualRequest) {
+    const pathItemObject = this.findExpectedPathItem(actualRequest);
+    const operationObject = pathItemObject[actualRequest.method.toLowerCase()];
+    return operationObject;
+  }
+  validateResponse(actualResponse) {
+    let expectedResponse;
+    try {
+      expectedResponse = this.findExpectedResponse(actualResponse);
+    } catch (error) {
+      if (error instanceof ValidationError) {
+        return error;
+      }
+      throw error;
+    }
+    const validator = new OpenAPIResponseValidator({
+      responses: expectedResponse,
+      ...this.getComponentDefinitionsProperty()
+    });
+    const expectedResStatus = Object.keys(expectedResponse)[0];
+    const validationError = validator.validateResponse(
+      expectedResStatus,
+      actualResponse.getBodyForValidation()
+    );
+    return validationError ? new ValidationError(
+      5 /* InvalidBody */,
+      validationError.errors.map(({ path: path2, message }) => `${path2} ${message}`).join(", ")
+    ) : null;
+  }
+  /*
+   * For consistency and to save maintaining another dependency,
+   * we validate objects using our response validator:
+   * We put the object inside a mock response, then validate
+   * the whole response against a mock expected response.
+   * The 2 mock responses are identical except for the body,
+   * thus validating the object against its schema.
+   */
+  validateObject(actualObject, schema) {
+    const mockResStatus = "200";
+    const mockExpectedResponse = { [mockResStatus]: { schema } };
+    const validator = new OpenAPIResponseValidator({
+      responses: mockExpectedResponse,
+      ...this.getComponentDefinitionsProperty(),
+      // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+      errorTransformer: ({ path: path2, message }) => ({
+        message: `${path2.replace("response", "object")} ${message}`
+      })
+    });
+    const validationError = validator.validateResponse(
+      mockResStatus,
+      actualObject
+    );
+    return validationError ? new ValidationError(
+      6 /* InvalidObject */,
+      validationError.errors.map((error) => error.message).join(", ")
+    ) : null;
+  }
+};
+
+// lib/classes/OpenApi2Spec.ts
+var basePathPropertyNotProvided = (spec) => !spec.basePath;
+var OpenApi2Spec = class extends OpenApiSpec {
+  constructor(spec) {
+    super(spec);
+    this.spec = spec;
+    this.didUserDefineBasePath = !basePathPropertyNotProvided(spec);
+  }
+  /**
+   * "If the basePath property is not provided, the API is served directly under the host
+   * @see https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#fixed-fields
+   */
+  findOpenApiPathMatchingPathname(pathname) {
+    const { basePath } = this.spec;
+    if (basePath && !pathname.startsWith(basePath)) {
+      throw new ValidationError(1 /* BasePathNotFound */);
+    }
+    const pathnameWithoutBasePath = basePath ? getPathnameWithoutBasePath(basePath, pathname) : pathname;
+    const openApiPath = findOpenApiPathMatchingPossiblePathnames(
+      [pathnameWithoutBasePath],
+      this.paths()
+    );
+    if (!openApiPath) {
+      throw new ValidationError(2 /* PathNotFound */);
+    }
+    return openApiPath;
+  }
+  findResponseDefinition(referenceString) {
+    var _a;
+    const nameOfResponseDefinition = referenceString.split("#/responses/")[1];
+    return (_a = this.spec.responses) == null ? void 0 : _a[nameOfResponseDefinition];
+  }
+  getComponentDefinitionsProperty() {
+    return { definitions: this.spec.definitions };
+  }
+  getSchemaObjects() {
+    return this.spec.definitions;
+  }
+};
+
+// lib/utils/OpenApi3Spec.utils.ts
+import generateCombinations from "combos";
+var unique = (array) => [...new Set(array)];
+var serversPropertyNotProvidedOrIsEmptyArray = (spec) => !spec.servers || !spec.servers.length;
+var getBasePath = (url2) => {
+  const basePathStartIndex = url2.replace("//", "  ").indexOf("/");
+  return basePathStartIndex !== -1 ? url2.slice(basePathStartIndex) : defaultBasePath;
+};
+var getPossibleValuesOfServerVariable = ({
+  default: defaultValue,
+  enum: enumMembers
+}) => enumMembers ? unique([defaultValue].concat(enumMembers)) : [defaultValue];
+var mapServerVariablesToPossibleValues = (serverVariables) => Object.entries(serverVariables).reduce(
+  (currentMap, [variableName, detailsOfPossibleValues]) => ({
+    ...currentMap,
+    [variableName]: getPossibleValuesOfServerVariable(
+      detailsOfPossibleValues
+    )
+  }),
+  {}
+);
+var convertTemplateExpressionToConcreteExpression = (templateExpression, mapOfVariablesToValues) => Object.entries(mapOfVariablesToValues).reduce(
+  (currentExpression, [variable, value]) => currentExpression.replace(`{${variable}}`, value),
+  templateExpression
+);
+var getPossibleConcreteBasePaths = (basePath, serverVariables) => {
+  const mapOfServerVariablesToPossibleValues = mapServerVariablesToPossibleValues(serverVariables);
+  const combinationsOfBasePathVariableValues = generateCombinations(
+    mapOfServerVariablesToPossibleValues
+  );
+  const possibleBasePaths = combinationsOfBasePathVariableValues.map(
+    (mapOfVariablesToValues) => convertTemplateExpressionToConcreteExpression(
+      basePath,
+      mapOfVariablesToValues
+    )
+  );
+  return possibleBasePaths;
+};
+var getPossibleBasePaths = (url2, serverVariables) => {
+  const basePath = getBasePath(url2);
+  return serverVariables ? getPossibleConcreteBasePaths(basePath, serverVariables) : [basePath];
+};
+var getMatchingServerUrlsAndServerBasePaths = (servers, pathname) => {
+  const matchesPathname = (basePath) => pathname.startsWith(basePath);
+  return servers.map(({ url: templatedUrl, variables }) => ({
+    templatedUrl,
+    possibleBasePaths: getPossibleBasePaths(templatedUrl, variables)
+  })).filter(({ possibleBasePaths }) => possibleBasePaths.some(matchesPathname)).map(({ templatedUrl, possibleBasePaths }) => {
+    const matchingBasePath = possibleBasePaths.find(matchesPathname);
+    return {
+      concreteUrl: templatedUrl.replace(
+        getBasePath(templatedUrl),
+        matchingBasePath
+      ),
+      matchingBasePath
+    };
+  });
+};
+
+// lib/classes/OpenApi3Spec.ts
+var OpenApi3Spec = class extends OpenApiSpec {
+  constructor(spec) {
+    super(spec);
+    this.spec = spec;
+    this.didUserDefineServers = !serversPropertyNotProvidedOrIsEmptyArray(spec);
+    this.ensureDefaultServer();
+  }
+  /**
+   * "If the servers property is not provided, or is an empty array, the default value would be a Server Object with a url value of '/'"
+   * @see https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#fixed-fields
+   */
+  ensureDefaultServer() {
+    if (serversPropertyNotProvidedOrIsEmptyArray(this.spec)) {
+      this.spec.servers = [{ url: defaultBasePath }];
+    }
+  }
+  servers() {
+    return this.spec.servers;
+  }
+  getServerUrls() {
+    return this.servers().map((server) => server.url);
+  }
+  getMatchingServerUrls(pathname) {
+    return getMatchingServerUrlsAndServerBasePaths(
+      this.servers(),
+      pathname
+    ).map(({ concreteUrl }) => concreteUrl);
+  }
+  getMatchingServerBasePaths(pathname) {
+    return getMatchingServerUrlsAndServerBasePaths(
+      this.servers(),
+      pathname
+    ).map(({ matchingBasePath }) => matchingBasePath);
+  }
+  findOpenApiPathMatchingPathname(pathname) {
+    const matchingServerBasePaths = this.getMatchingServerBasePaths(pathname);
+    if (!matchingServerBasePaths.length) {
+      throw new ValidationError(0 /* ServerNotFound */);
+    }
+    const possiblePathnames = matchingServerBasePaths.map(
+      (basePath) => getPathnameWithoutBasePath(basePath, pathname)
+    );
+    const openApiPath = findOpenApiPathMatchingPossiblePathnames(
+      possiblePathnames,
+      this.paths()
+    );
+    if (!openApiPath) {
+      throw new ValidationError(2 /* PathNotFound */);
+    }
+    return openApiPath;
+  }
+  findResponseDefinition(referenceString) {
+    var _a, _b;
+    const nameOfResponseDefinition = referenceString.split(
+      "#/components/responses/"
+    )[1];
+    return (_b = (_a = this.spec.components) == null ? void 0 : _a.responses) == null ? void 0 : _b[nameOfResponseDefinition];
+  }
+  getComponentDefinitionsProperty() {
+    return { components: this.spec.components };
+  }
+  getSchemaObjects() {
+    var _a;
+    return (_a = this.spec.components) == null ? void 0 : _a.schemas;
+  }
+};
+
+// lib/openApiSpecFactory.ts
+var isObject = (arg) => typeof arg === "object" && arg !== null && !Array.isArray(arg);
+function makeApiSpec(filepathOrObject) {
+  const spec = loadSpec(filepathOrObject);
+  validateSpec(spec);
+  const validSpec = spec;
+  if ("swagger" in validSpec) {
+    return new OpenApi2Spec(validSpec);
+  }
+  return new OpenApi3Spec(validSpec);
+}
+function loadSpec(arg) {
+  try {
+    if (typeof arg === "string") {
+      return loadFile(arg);
+    }
+    if (isObject(arg)) {
+      return arg;
+    }
+    throw new Error(`Received type '${typeOf(arg)}'`);
+  } catch (error) {
+    throw new Error(
+      `The provided argument must be either an absolute filepath or an object representing an OpenAPI specification.
+Error details: ${error.message}`
+    );
+  }
+}
+function loadFile(filepath) {
+  if (!path.isAbsolute(filepath)) {
+    throw new Error(`'${filepath}' is not an absolute filepath`);
+  }
+  const fileData = fs.readFileSync(filepath, { encoding: "utf8" });
+  try {
+    return yaml.load(fileData);
+  } catch (error) {
+    throw new Error(`Invalid YAML or JSON:
+${error.message}`);
+  }
+}
+function validateSpec(obj) {
+  try {
+    const validator = new OpenAPISchemaValidator({
+      version: obj.swagger || // '2.0'
+      obj.openapi
+      // '3.X.X'
+    });
+    const { errors } = validator.validate(obj);
+    if (errors.length > 0) {
+      throw new Error(stringify(errors));
+    }
+    return obj;
+  } catch (error) {
+    throw new Error(`Invalid OpenAPI spec: ${error.message}`);
+  }
+}
+
+// lib/classes/AbstractResponse.ts
+var AbstractResponse = class {
+  constructor(res) {
+    this.res = res;
+  }
+  summary() {
+    return {
+      body: this.body
+    };
+  }
+  toString() {
+    return stringify(this.summary());
+  }
+};
+
+// lib/classes/AxiosResponse.ts
+var AxiosResponse = class extends AbstractResponse {
+  constructor(res) {
+    super(res);
+    this.res = res;
+    this.status = res.status;
+    this.body = res.data;
+    this.req = res.request;
+    this.bodyHasNoContent = this.body === "";
+  }
+  getBodyForValidation() {
+    if (this.bodyHasNoContent) {
+      return null;
+    }
+    return this.body;
+  }
+};
+
+// lib/classes/SuperAgentResponse.ts
+var isEmptyObj = (obj) => !!obj && Object.entries(obj).length === 0 && obj.constructor === Object;
+var SuperAgentResponse = class extends AbstractResponse {
+  constructor(res) {
+    super(res);
+    this.res = res;
+    this.status = res.status;
+    this.body = res.body;
+    this.req = res.req;
+    this.isResTextPopulatedInsteadOfResBody = res.text !== "{}" && isEmptyObj(this.body);
+    this.bodyHasNoContent = res.text === "";
+  }
+  getBodyForValidation() {
+    if (this.bodyHasNoContent) {
+      return null;
+    }
+    if (this.isResTextPopulatedInsteadOfResBody) {
+      return this.res.text;
+    }
+    return this.body;
+  }
+  summary() {
+    return {
+      ...super.summary(),
+      ...this.isResTextPopulatedInsteadOfResBody && { text: this.res.text }
+    };
+  }
+};
+
+// lib/responseFactory.ts
+function makeResponse(res) {
+  if ("data" in res) {
+    return new AxiosResponse(res);
+  }
+  if ("status" in res) {
+    return new SuperAgentResponse(res);
+  }
+  throw new Error(
+    "Unsupported response object: expected axios, supertest, superagent, or chai-http response shape."
+  );
+}
+export {
+  ErrorCode,
+  makeApiSpec,
+  makeResponse
+};
+//# sourceMappingURL=index.mjs.map

package/dist/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../lib/classes/errors/ValidationError.ts","../lib/openApiSpecFactory.ts","../lib/utils/common.utils.ts","../lib/classes/AbstractOpenApiSpec.ts","../lib/classes/OpenApi2Spec.ts","../lib/utils/OpenApi3Spec.utils.ts","../lib/classes/OpenApi3Spec.ts","../lib/classes/AbstractResponse.ts","../lib/classes/AxiosResponse.ts","../lib/classes/SuperAgentResponse.ts","../lib/responseFactory.ts"],"sourcesContent":["export enum ErrorCode {\n  ServerNotFound,\n  BasePathNotFound,\n  PathNotFound,\n  MethodNotFound,\n  StatusNotFound,\n  InvalidBody,\n  InvalidObject,\n}\n\nexport default class ValidationError extends Error {\n  constructor(\n    public code: ErrorCode,\n    message?: string,\n  ) {\n    super(message);\n  }\n\n  override toString(): string {\n    return this.message;\n  }\n}\n","import fs from 'fs-extra';\nimport yaml from 'js-yaml';\nimport OpenAPISchemaValidator from 'openapi-schema-validator';\nimport type { OpenAPI, OpenAPIV2, OpenAPIV3 } from 'openapi-types';\nimport path from 'path';\nimport typeOf from 'typeof';\nimport OpenApi2Spec from './classes/OpenApi2Spec';\nimport OpenApi3Spec from './classes/OpenApi3Spec';\nimport { stringify } from './utils/common.utils';\n\ntype AnyObject = Record<string, unknown>;\n\nconst isObject = (arg: unknown): arg is AnyObject =>\n  typeof arg === 'object' && arg !== null && !Array.isArray(arg);\n\nexport default function makeApiSpec(\n  filepathOrObject: string | OpenAPI.Document,\n): OpenApi2Spec | OpenApi3Spec {\n  const spec = loadSpec(filepathOrObject);\n  validateSpec(spec);\n  const validSpec = spec as OpenAPI.Document;\n  if ('swagger' in validSpec) {\n    return new OpenApi2Spec(validSpec);\n  }\n  return new OpenApi3Spec(validSpec as OpenAPIV3.Document);\n}\n\nfunction loadSpec(arg: unknown): AnyObject {\n  try {\n    if (typeof arg === 'string') {\n      return loadFile(arg);\n    }\n    if (isObject(arg)) {\n      return arg;\n    }\n    throw new Error(`Received type '${typeOf(arg)}'`);\n  } catch (error) {\n    throw new Error(\n      `The provided argument must be either an absolute filepath or an object representing an OpenAPI specification.\\nError details: ${\n        (error as Error).message\n      }`,\n    );\n  }\n}\n\nfunction loadFile(filepath: string): AnyObject {\n  if (!path.isAbsolute(filepath)) {\n    throw new Error(`'${filepath}' is not an absolute filepath`);\n  }\n  const fileData = fs.readFileSync(filepath, { encoding: 'utf8' });\n  try {\n    return yaml.load(fileData) as AnyObject;\n  } catch (error) {\n    throw new Error(`Invalid YAML or JSON:\\n${(error as Error).message}`);\n  }\n}\n\nfunction validateSpec(obj: AnyObject): OpenAPI.Document {\n  try {\n    const validator = new OpenAPISchemaValidator({\n      version:\n        (obj as unknown as OpenAPIV2.Document).swagger || // '2.0'\n        (obj as unknown as OpenAPIV3.Document).openapi, // '3.X.X'\n    });\n    const { errors } = validator.validate(obj as OpenAPI.Document);\n    if (errors.length > 0) {\n      throw new Error(stringify(errors));\n    }\n    return obj as OpenAPI.Document;\n  } catch (error) {\n    throw new Error(`Invalid OpenAPI spec: ${(error as Error).message}`);\n  }\n}\n","import { Path } from 'path-parser';\nimport url from 'url';\nimport { inspect } from 'util';\nimport type { ActualRequest } from '../classes/AbstractResponse';\n\nexport const stringify = (obj: unknown): string =>\n  inspect(obj, { depth: null });\n\n/**\n * Excludes the query because path = pathname + query\n */\nexport const getPathname = (request: ActualRequest): string =>\n  // eslint-disable-next-line @typescript-eslint/no-non-null-assertion\n  url.parse(request.path).pathname!;\n\n/**\n * Converts all {foo} to :foo\n */\nconst convertOpenApiPathToColonForm = (openApiPath: string): string =>\n  openApiPath.replace(/{/g, ':').replace(/}/g, '');\n\nconst doesColonPathMatchPathname = (\n  pathInColonForm: string,\n  pathname: string,\n): boolean => {\n  /*\n   * By default, OpenAPI path parameters have `style: simple; explode: false` (https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#parameter-object)\n   * So array path parameters in the pathname of the actual request should be in the form: `/pathParams/a,b,c`\n   * `path-parser` fails to match parameter patterns to parameters containing commas.\n   * So we remove the commas.\n   */\n  const pathWithoutCommas = pathname.replace(/,/g, '');\n  const pathParamsInPathname = new Path(pathInColonForm).test(\n    pathWithoutCommas,\n  ); // => one of: null, {}, {exampleParam: 'foo'}\n  return Boolean(pathParamsInPathname);\n};\n\nconst doesOpenApiPathMatchPathname = (\n  openApiPath: string,\n  pathname: string,\n): boolean => {\n  const pathInColonForm = convertOpenApiPathToColonForm(openApiPath);\n  return doesColonPathMatchPathname(pathInColonForm, pathname);\n};\n\nexport const findOpenApiPathMatchingPossiblePathnames = (\n  possiblePathnames: string[],\n  OAPaths: string[],\n): string | undefined => {\n  let openApiPath: string | undefined;\n  // eslint-disable-next-line no-restricted-syntax\n  for (const pathname of possiblePathnames) {\n    // eslint-disable-next-line no-restricted-syntax\n    for (const OAPath of OAPaths) {\n      if (OAPath === pathname) {\n        return OAPath;\n      }\n      if (doesOpenApiPathMatchPathname(OAPath, pathname)) {\n        openApiPath = OAPath;\n      }\n    }\n  }\n  return openApiPath;\n};\n\nexport const defaultBasePath = '/';\n\nexport const getPathnameWithoutBasePath = (\n  basePath: string,\n  pathname: string,\n): string =>\n  basePath === defaultBasePath ? pathname : pathname.replace(basePath, '');\n","import OpenAPIResponseValidator, {\n  type OpenAPIResponseValidatorArgs,\n} from 'openapi-response-validator';\nimport type { OpenAPIV2, OpenAPIV3, OpenAPIV3_1 } from 'openapi-types';\nimport { getPathname } from '../utils/common.utils';\nimport type { ActualRequest, ActualResponse } from './AbstractResponse';\nimport ValidationError, { ErrorCode } from './errors/ValidationError';\n\ntype Document = OpenAPIV2.Document | OpenAPIV3.Document;\n\ntype Operation = OpenAPIV2.OperationObject | OpenAPIV3.OperationObject;\n\ntype HttpMethods = OpenAPIV2.HttpMethods;\n\ntype PathItemObject = OpenAPIV2.PathItemObject | OpenAPIV3.PathItemObject;\n\nexport type ResponseObjectWithSchema =\n  | (OpenAPIV2.ResponseObject & { schema: OpenAPIV2.Schema })\n  | (OpenAPIV3.ResponseObject & {\n      content: {\n        [media: string]: OpenAPIV3.MediaTypeObject & {\n          schema: OpenAPIV3.SchemaObject;\n        };\n      };\n    })\n  | (OpenAPIV3_1.ResponseObject & {\n      content: {\n        [media: string]: OpenAPIV3_1.MediaTypeObject & {\n          schema: OpenAPIV3_1.SchemaObject;\n        };\n      };\n    });\n\nexport type Schema = OpenAPIV2.Schema | OpenAPIV3.SchemaObject;\n\nexport default abstract class OpenApiSpec {\n  protected abstract getSchemaObjects(): Record<string, Schema> | undefined;\n\n  protected abstract findResponseDefinition(\n    referenceString: string,\n  ): ResponseObjectWithSchema | undefined;\n\n  protected abstract findOpenApiPathMatchingPathname(pathname: string): string;\n\n  protected abstract getComponentDefinitionsProperty():\n    | {\n        definitions: OpenAPIV2.Document['definitions'];\n      }\n    | {\n        components: OpenAPIV3.Document['components'];\n      };\n\n  constructor(protected spec: Document) {}\n\n  pathsObject(): Document['paths'] {\n    return this.spec.paths;\n  }\n\n  getPathItem(openApiPath: string): PathItemObject {\n    // eslint-disable-next-line @typescript-eslint/no-non-null-assertion\n    return this.pathsObject()[openApiPath]!;\n  }\n\n  paths(): string[] {\n    return Object.keys(this.pathsObject());\n  }\n\n  getSchemaObject(schemaName: string): Schema | undefined {\n    return this.getSchemaObjects()?.[schemaName];\n  }\n\n  getExpectedResponse(\n    responseOperation: Operation,\n    status: ActualResponse['status'],\n  ): ResponseObjectWithSchema | undefined {\n    const response = responseOperation.responses[status];\n    if (!response) {\n      return undefined;\n    }\n    if ('$ref' in response) {\n      return this.findResponseDefinition(response.$ref);\n    }\n    return response as ResponseObjectWithSchema;\n  }\n\n  findExpectedResponse(\n    actualResponse: ActualResponse,\n  ): Record<string, ResponseObjectWithSchema> {\n    const actualRequest = actualResponse.req;\n    const expectedResponseOperation =\n      this.findExpectedResponseOperation(actualRequest);\n    if (!expectedResponseOperation) {\n      throw new ValidationError(ErrorCode.MethodNotFound);\n    }\n\n    const { status } = actualResponse;\n    const expectedResponse = this.getExpectedResponse(\n      expectedResponseOperation,\n      status,\n    );\n    if (!expectedResponse) {\n      throw new ValidationError(ErrorCode.StatusNotFound);\n    }\n\n    return { [status]: expectedResponse };\n  }\n\n  findOpenApiPathMatchingRequest(actualRequest: ActualRequest): string {\n    const actualPathname = getPathname(actualRequest);\n    const openApiPath = this.findOpenApiPathMatchingPathname(actualPathname);\n    return openApiPath;\n  }\n\n  findExpectedPathItem(actualRequest: ActualRequest): PathItemObject {\n    const actualPathname = getPathname(actualRequest);\n    const openApiPath = this.findOpenApiPathMatchingPathname(actualPathname);\n    const pathItemObject = this.getPathItem(openApiPath);\n    return pathItemObject;\n  }\n\n  findExpectedResponseOperation(\n    actualRequest: ActualRequest,\n  ): Operation | undefined {\n    const pathItemObject = this.findExpectedPathItem(actualRequest);\n    const operationObject =\n      pathItemObject[actualRequest.method.toLowerCase() as HttpMethods];\n    return operationObject;\n  }\n\n  validateResponse(actualResponse: ActualResponse): ValidationError | null {\n    let expectedResponse: Record<string, ResponseObjectWithSchema>;\n    try {\n      expectedResponse = this.findExpectedResponse(actualResponse);\n    } catch (error) {\n      if (error instanceof ValidationError) {\n        return error;\n      }\n      throw error;\n    }\n    const validator = new OpenAPIResponseValidator({\n      responses: expectedResponse as OpenAPIResponseValidatorArgs['responses'],\n      ...this.getComponentDefinitionsProperty(),\n    } as OpenAPIResponseValidatorArgs);\n\n    // eslint-disable-next-line @typescript-eslint/no-non-null-assertion\n    const expectedResStatus = Object.keys(expectedResponse)[0]!;\n    const validationError = validator.validateResponse(\n      expectedResStatus,\n      actualResponse.getBodyForValidation(),\n    );\n    return validationError\n      ? new ValidationError(\n          ErrorCode.InvalidBody,\n          validationError.errors!\n            .map(({ path, message }: { path?: string; message: string }) => `${path} ${message}`)\n            .join(', '),\n        )\n      : null;\n  }\n\n  /*\n   * For consistency and to save maintaining another dependency,\n   * we validate objects using our response validator:\n   * We put the object inside a mock response, then validate\n   * the whole response against a mock expected response.\n   * The 2 mock responses are identical except for the body,\n   * thus validating the object against its schema.\n   */\n  validateObject(\n    actualObject: unknown,\n    schema: Schema,\n  ): ValidationError | null {\n    const mockResStatus = '200';\n    const mockExpectedResponse = { [mockResStatus]: { schema } };\n    const validator = new OpenAPIResponseValidator({\n      responses: mockExpectedResponse as OpenAPIResponseValidatorArgs['responses'],\n      ...this.getComponentDefinitionsProperty(),\n      // eslint-disable-next-line @typescript-eslint/no-non-null-assertion\n      errorTransformer: ({ path, message }: { path?: string; message: string; errorCode: string }) => ({\n        message: `${path!.replace('response', 'object')} ${message}`,\n      }),\n    } as OpenAPIResponseValidatorArgs);\n    const validationError = validator.validateResponse(\n      mockResStatus,\n      actualObject,\n    );\n    return validationError\n      ? new ValidationError(\n          ErrorCode.InvalidObject,\n          validationError.errors!.map((error: { message: string }) => error.message).join(', '),\n        )\n      : null;\n  }\n}\n","import type { OpenAPIV2 } from 'openapi-types';\nimport type { ResponseObjectWithSchema } from './AbstractOpenApiSpec';\nimport {\n  getPathnameWithoutBasePath,\n  findOpenApiPathMatchingPossiblePathnames,\n} from '../utils/common.utils';\nimport AbstractOpenApiSpec from './AbstractOpenApiSpec';\nimport ValidationError, { ErrorCode } from './errors/ValidationError';\n\nconst basePathPropertyNotProvided = (spec: OpenAPIV2.Document): boolean =>\n  !spec.basePath;\n\nexport default class OpenApi2Spec extends AbstractOpenApiSpec {\n  public didUserDefineBasePath: boolean;\n\n  constructor(public override spec: OpenAPIV2.Document) {\n    super(spec);\n    this.didUserDefineBasePath = !basePathPropertyNotProvided(spec);\n  }\n\n  /**\n   * \"If the basePath property is not provided, the API is served directly under the host\n   * @see https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#fixed-fields\n   */\n  findOpenApiPathMatchingPathname(pathname: string): string {\n    const { basePath } = this.spec;\n    if (basePath && !pathname.startsWith(basePath)) {\n      throw new ValidationError(ErrorCode.BasePathNotFound);\n    }\n    const pathnameWithoutBasePath = basePath\n      ? getPathnameWithoutBasePath(basePath, pathname)\n      : pathname;\n    const openApiPath = findOpenApiPathMatchingPossiblePathnames(\n      [pathnameWithoutBasePath],\n      this.paths(),\n    );\n    if (!openApiPath) {\n      throw new ValidationError(ErrorCode.PathNotFound);\n    }\n    return openApiPath;\n  }\n\n  findResponseDefinition(\n    referenceString: string,\n  ): ResponseObjectWithSchema | undefined {\n    // eslint-disable-next-line @typescript-eslint/no-non-null-assertion\n    const nameOfResponseDefinition = referenceString.split('#/responses/')[1]!;\n    return this.spec.responses?.[nameOfResponseDefinition] as\n      | ResponseObjectWithSchema\n      | undefined;\n  }\n\n  getComponentDefinitionsProperty(): {\n    definitions: OpenAPIV2.Document['definitions'];\n  } {\n    return { definitions: this.spec.definitions };\n  }\n\n  getSchemaObjects(): OpenAPIV2.Document['definitions'] {\n    return this.spec.definitions;\n  }\n}\n","import generateCombinations from 'combos';\nimport type { OpenAPIV3 } from 'openapi-types';\nimport { defaultBasePath } from './common.utils';\n\ntype ServerVariables = OpenAPIV3.ServerObject['variables'];\n\nconst unique = <T>(array: T[]): T[] => [...new Set(array)];\n\nexport const serversPropertyNotProvidedOrIsEmptyArray = (\n  spec: OpenAPIV3.Document,\n): boolean => !spec.servers || !spec.servers.length;\n\nconst getBasePath = (url: string): string => {\n  const basePathStartIndex = url.replace('//', '  ').indexOf('/');\n  return basePathStartIndex !== -1\n    ? url.slice(basePathStartIndex)\n    : defaultBasePath;\n};\n\nconst getPossibleValuesOfServerVariable = ({\n  default: defaultValue,\n  enum: enumMembers,\n}: OpenAPIV3.ServerVariableObject): string[] =>\n  enumMembers ? unique([defaultValue].concat(enumMembers)) : [defaultValue];\n\nconst mapServerVariablesToPossibleValues = (\n  serverVariables: NonNullable<ServerVariables>,\n): Record<string, string[]> =>\n  Object.entries(serverVariables).reduce(\n    (currentMap, [variableName, detailsOfPossibleValues]) => ({\n      ...currentMap,\n      [variableName]: getPossibleValuesOfServerVariable(\n        detailsOfPossibleValues,\n      ),\n    }),\n    {},\n  );\n\nconst convertTemplateExpressionToConcreteExpression = (\n  templateExpression: string,\n  mapOfVariablesToValues: Record<string, string>,\n) =>\n  Object.entries(mapOfVariablesToValues).reduce(\n    (currentExpression, [variable, value]) =>\n      currentExpression.replace(`{${variable}}`, value),\n    templateExpression,\n  );\n\nconst getPossibleConcreteBasePaths = (\n  basePath: string,\n  serverVariables: NonNullable<ServerVariables>,\n): string[] => {\n  const mapOfServerVariablesToPossibleValues =\n    mapServerVariablesToPossibleValues(serverVariables);\n  const combinationsOfBasePathVariableValues = generateCombinations(\n    mapOfServerVariablesToPossibleValues,\n  );\n  const possibleBasePaths = combinationsOfBasePathVariableValues.map(\n    (mapOfVariablesToValues) =>\n      convertTemplateExpressionToConcreteExpression(\n        basePath,\n        mapOfVariablesToValues,\n      ),\n  );\n  return possibleBasePaths;\n};\n\nconst getPossibleBasePaths = (\n  url: string,\n  serverVariables: ServerVariables,\n): string[] => {\n  const basePath = getBasePath(url);\n  return serverVariables\n    ? getPossibleConcreteBasePaths(basePath, serverVariables)\n    : [basePath];\n};\n\nexport const getMatchingServerUrlsAndServerBasePaths = (\n  servers: OpenAPIV3.ServerObject[],\n  pathname: string,\n): { concreteUrl: string; matchingBasePath: string }[] => {\n  const matchesPathname = (basePath: string): boolean =>\n    pathname.startsWith(basePath);\n  return servers\n    .map(({ url: templatedUrl, variables }) => ({\n      templatedUrl,\n      possibleBasePaths: getPossibleBasePaths(templatedUrl, variables),\n    }))\n    .filter(({ possibleBasePaths }) => possibleBasePaths.some(matchesPathname))\n    .map(({ templatedUrl, possibleBasePaths }) => {\n      // eslint-disable-next-line @typescript-eslint/no-non-null-assertion\n      const matchingBasePath = possibleBasePaths.find(matchesPathname)!;\n      return {\n        concreteUrl: templatedUrl.replace(\n          getBasePath(templatedUrl),\n          matchingBasePath,\n        ),\n        matchingBasePath,\n      };\n    });\n};\n","import type { OpenAPIV3 } from 'openapi-types';\nimport type { ResponseObjectWithSchema } from './AbstractOpenApiSpec';\nimport {\n  defaultBasePath,\n  findOpenApiPathMatchingPossiblePathnames,\n  getPathnameWithoutBasePath,\n} from '../utils/common.utils';\nimport {\n  serversPropertyNotProvidedOrIsEmptyArray,\n  getMatchingServerUrlsAndServerBasePaths,\n} from '../utils/OpenApi3Spec.utils';\nimport AbstractOpenApiSpec from './AbstractOpenApiSpec';\nimport ValidationError, { ErrorCode } from './errors/ValidationError';\n\nexport default class OpenApi3Spec extends AbstractOpenApiSpec {\n  public didUserDefineServers: boolean;\n\n  constructor(protected override spec: OpenAPIV3.Document) {\n    super(spec);\n    this.didUserDefineServers = !serversPropertyNotProvidedOrIsEmptyArray(spec);\n    this.ensureDefaultServer();\n  }\n\n  /**\n   * \"If the servers property is not provided, or is an empty array, the default value would be a Server Object with a url value of '/'\"\n   * @see https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#fixed-fields\n   */\n  ensureDefaultServer(): void {\n    if (serversPropertyNotProvidedOrIsEmptyArray(this.spec)) {\n      this.spec.servers = [{ url: defaultBasePath }];\n    }\n  }\n\n  servers(): OpenAPIV3.ServerObject[] {\n    // eslint-disable-next-line @typescript-eslint/no-non-null-assertion\n    return this.spec.servers!;\n  }\n\n  getServerUrls(): string[] {\n    return this.servers().map((server) => server.url);\n  }\n\n  getMatchingServerUrls(pathname: string): string[] {\n    return getMatchingServerUrlsAndServerBasePaths(\n      this.servers(),\n      pathname,\n    ).map(({ concreteUrl }) => concreteUrl);\n  }\n\n  getMatchingServerBasePaths(pathname: string): string[] {\n    return getMatchingServerUrlsAndServerBasePaths(\n      this.servers(),\n      pathname,\n    ).map(({ matchingBasePath }) => matchingBasePath);\n  }\n\n  findOpenApiPathMatchingPathname(pathname: string): string {\n    const matchingServerBasePaths = this.getMatchingServerBasePaths(pathname);\n    if (!matchingServerBasePaths.length) {\n      throw new ValidationError(ErrorCode.ServerNotFound);\n    }\n    const possiblePathnames = matchingServerBasePaths.map((basePath) =>\n      getPathnameWithoutBasePath(basePath, pathname),\n    );\n    const openApiPath = findOpenApiPathMatchingPossiblePathnames(\n      possiblePathnames,\n      this.paths(),\n    );\n    if (!openApiPath) {\n      throw new ValidationError(ErrorCode.PathNotFound);\n    }\n    return openApiPath;\n  }\n\n  findResponseDefinition(\n    referenceString: string,\n  ): ResponseObjectWithSchema | undefined {\n    // eslint-disable-next-line @typescript-eslint/no-non-null-assertion\n    const nameOfResponseDefinition = referenceString.split(\n      '#/components/responses/',\n    )[1]!;\n    return this.spec.components?.responses?.[nameOfResponseDefinition] as\n      | ResponseObjectWithSchema\n      | undefined;\n  }\n\n  getComponentDefinitionsProperty(): {\n    components: OpenAPIV3.Document['components'];\n  } {\n    return { components: this.spec.components };\n  }\n\n  getSchemaObjects(): OpenAPIV3.ComponentsObject['schemas'] {\n    return this.spec.components?.schemas;\n  }\n}\n","import { stringify } from '../utils/common.utils';\nimport type { RawAxiosResponse } from './AxiosResponse';\nimport type { RawSuperAgentResponse } from './SuperAgentResponse';\n\nexport type RawResponse =\n  | RawAxiosResponse\n  | RawSuperAgentResponse;\n\nexport default abstract class AbstractResponse {\n  declare public status: number;\n\n  declare public req: { method: string; path: string };\n\n  public abstract getBodyForValidation(): unknown;\n\n  protected body: unknown;\n\n  declare protected bodyHasNoContent: boolean;\n\n  constructor(protected res: RawResponse) {}\n\n  summary(): { body: unknown } {\n    return {\n      body: this.body,\n    };\n  }\n\n  toString(): string {\n    return stringify(this.summary());\n  }\n}\n\nexport type ActualResponse = AbstractResponse;\n\nexport type ActualRequest = AbstractResponse['req'];\n","import type { AxiosResponse as AxiosResponseType } from 'axios';\nimport AbstractResponse from './AbstractResponse';\n\nexport type RawAxiosResponse = AxiosResponseType;\n\nexport default class AxiosResponse extends AbstractResponse {\n  constructor(protected override res: RawAxiosResponse) {\n    super(res);\n    this.status = res.status;\n    this.body = res.data;\n    this.req = res.request;\n    this.bodyHasNoContent = this.body === '';\n  }\n\n  getBodyForValidation(): AxiosResponse['body'] {\n    if (this.bodyHasNoContent) {\n      return null;\n    }\n    return this.body;\n  }\n}\n","import type { Response, SuperAgentRequest } from 'superagent';\nimport AbstractResponse from './AbstractResponse';\n\n// eslint-disable-next-line @typescript-eslint/no-explicit-any\nconst isEmptyObj = (obj: any): obj is Record<string, never> =>\n  !!obj && Object.entries(obj).length === 0 && obj.constructor === Object;\n\nexport type RawSuperAgentResponse = Response & {\n  req: SuperAgentRequest & { path: string };\n};\n\nexport default class SuperAgentResponse extends AbstractResponse {\n  private isResTextPopulatedInsteadOfResBody: boolean;\n\n  constructor(protected override res: RawSuperAgentResponse) {\n    super(res);\n    this.status = res.status;\n    this.body = res.body;\n    this.req = res.req;\n    this.isResTextPopulatedInsteadOfResBody =\n      res.text !== '{}' && isEmptyObj(this.body);\n    this.bodyHasNoContent = res.text === '';\n  }\n\n  getBodyForValidation(): SuperAgentResponse['body'] {\n    if (this.bodyHasNoContent) {\n      return null;\n    }\n    if (this.isResTextPopulatedInsteadOfResBody) {\n      return this.res.text;\n    }\n    return this.body;\n  }\n\n  override summary(): ReturnType<AbstractResponse['summary']> & {\n    text?: string;\n  } {\n    return {\n      ...super.summary(),\n      ...(this.isResTextPopulatedInsteadOfResBody && { text: this.res.text }),\n    };\n  }\n}\n","import { RawResponse } from './classes/AbstractResponse';\nimport AxiosResponse from './classes/AxiosResponse';\nimport SuperAgentResponse from './classes/SuperAgentResponse';\n\nexport default function makeResponse(\n  res: RawResponse,\n): AxiosResponse | SuperAgentResponse {\n  if ('data' in res) {\n    return new AxiosResponse(res);\n  }\n  if ('status' in res) {\n    return new SuperAgentResponse(res);\n  }\n  throw new Error(\n    'Unsupported response object: expected axios, supertest, superagent, or chai-http response shape.',\n  );\n}\n"],"mappings":";AAAO,IAAK,YAAL,kBAAKA,eAAL;AACL,EAAAA,sBAAA;AACA,EAAAA,sBAAA;AACA,EAAAA,sBAAA;AACA,EAAAA,sBAAA;AACA,EAAAA,sBAAA;AACA,EAAAA,sBAAA;AACA,EAAAA,sBAAA;AAPU,SAAAA;AAAA,GAAA;AAUZ,IAAqB,kBAArB,cAA6C,MAAM;AAAA,EACjD,YACS,MACP,SACA;AACA,UAAM,OAAO;AAHN;AAAA,EAIT;AAAA,EAES,WAAmB;AAC1B,WAAO,KAAK;AAAA,EACd;AACF;;;ACrBA,OAAO,QAAQ;AACf,OAAO,UAAU;AACjB,OAAO,4BAA4B;AAEnC,OAAO,UAAU;AACjB,OAAO,YAAY;;;ACLnB,SAAS,YAAY;AACrB,OAAO,SAAS;AAChB,SAAS,eAAe;AAGjB,IAAM,YAAY,CAAC,QACxB,QAAQ,KAAK,EAAE,OAAO,KAAK,CAAC;AAKvB,IAAM,cAAc,CAAC;AAAA;AAAA,EAE1B,IAAI,MAAM,QAAQ,IAAI,EAAE;AAAA;AAK1B,IAAM,gCAAgC,CAAC,gBACrC,YAAY,QAAQ,MAAM,GAAG,EAAE,QAAQ,MAAM,EAAE;AAEjD,IAAM,6BAA6B,CACjC,iBACA,aACY;AAOZ,QAAM,oBAAoB,SAAS,QAAQ,MAAM,EAAE;AACnD,QAAM,uBAAuB,IAAI,KAAK,eAAe,EAAE;AAAA,IACrD;AAAA,EACF;AACA,SAAO,QAAQ,oBAAoB;AACrC;AAEA,IAAM,+BAA+B,CACnC,aACA,aACY;AACZ,QAAM,kBAAkB,8BAA8B,WAAW;AACjE,SAAO,2BAA2B,iBAAiB,QAAQ;AAC7D;AAEO,IAAM,2CAA2C,CACtD,mBACA,YACuB;AACvB,MAAI;AAEJ,aAAW,YAAY,mBAAmB;AAExC,eAAW,UAAU,SAAS;AAC5B,UAAI,WAAW,UAAU;AACvB,eAAO;AAAA,MACT;AACA,UAAI,6BAA6B,QAAQ,QAAQ,GAAG;AAClD,sBAAc;AAAA,MAChB;AAAA,IACF;AAAA,EACF;AACA,SAAO;AACT;AAEO,IAAM,kBAAkB;AAExB,IAAM,6BAA6B,CACxC,UACA,aAEA,aAAa,kBAAkB,WAAW,SAAS,QAAQ,UAAU,EAAE;;;ACxEzE,OAAO,8BAEA;AAiCP,IAA8B,cAA9B,MAA0C;AAAA,EAiBxC,YAAsB,MAAgB;AAAhB;AAAA,EAAiB;AAAA,EAEvC,cAAiC;AAC/B,WAAO,KAAK,KAAK;AAAA,EACnB;AAAA,EAEA,YAAY,aAAqC;AAE/C,WAAO,KAAK,YAAY,EAAE,WAAW;AAAA,EACvC;AAAA,EAEA,QAAkB;AAChB,WAAO,OAAO,KAAK,KAAK,YAAY,CAAC;AAAA,EACvC;AAAA,EAEA,gBAAgB,YAAwC;AAnE1D;AAoEI,YAAO,UAAK,iBAAiB,MAAtB,mBAA0B;AAAA,EACnC;AAAA,EAEA,oBACE,mBACA,QACsC;AACtC,UAAM,WAAW,kBAAkB,UAAU,MAAM;AACnD,QAAI,CAAC,UAAU;AACb,aAAO;AAAA,IACT;AACA,QAAI,UAAU,UAAU;AACtB,aAAO,KAAK,uBAAuB,SAAS,IAAI;AAAA,IAClD;AACA,WAAO;AAAA,EACT;AAAA,EAEA,qBACE,gBAC0C;AAC1C,UAAM,gBAAgB,eAAe;AACrC,UAAM,4BACJ,KAAK,8BAA8B,aAAa;AAClD,QAAI,CAAC,2BAA2B;AAC9B,YAAM,IAAI,sCAAwC;AAAA,IACpD;AAEA,UAAM,EAAE,OAAO,IAAI;AACnB,UAAM,mBAAmB,KAAK;AAAA,MAC5B;AAAA,MACA;AAAA,IACF;AACA,QAAI,CAAC,kBAAkB;AACrB,YAAM,IAAI,sCAAwC;AAAA,IACpD;AAEA,WAAO,EAAE,CAAC,MAAM,GAAG,iBAAiB;AAAA,EACtC;AAAA,EAEA,+BAA+B,eAAsC;AACnE,UAAM,iBAAiB,YAAY,aAAa;AAChD,UAAM,cAAc,KAAK,gCAAgC,cAAc;AACvE,WAAO;AAAA,EACT;AAAA,EAEA,qBAAqB,eAA8C;AACjE,UAAM,iBAAiB,YAAY,aAAa;AAChD,UAAM,cAAc,KAAK,gCAAgC,cAAc;AACvE,UAAM,iBAAiB,KAAK,YAAY,WAAW;AACnD,WAAO;AAAA,EACT;AAAA,EAEA,8BACE,eACuB;AACvB,UAAM,iBAAiB,KAAK,qBAAqB,aAAa;AAC9D,UAAM,kBACJ,eAAe,cAAc,OAAO,YAAY,CAAgB;AAClE,WAAO;AAAA,EACT;AAAA,EAEA,iBAAiB,gBAAwD;AACvE,QAAI;AACJ,QAAI;AACF,yBAAmB,KAAK,qBAAqB,cAAc;AAAA,IAC7D,SAAS,OAAO;AACd,UAAI,iBAAiB,iBAAiB;AACpC,eAAO;AAAA,MACT;AACA,YAAM;AAAA,IACR;AACA,UAAM,YAAY,IAAI,yBAAyB;AAAA,MAC7C,WAAW;AAAA,MACX,GAAG,KAAK,gCAAgC;AAAA,IAC1C,CAAiC;AAGjC,UAAM,oBAAoB,OAAO,KAAK,gBAAgB,EAAE,CAAC;AACzD,UAAM,kBAAkB,UAAU;AAAA,MAChC;AAAA,MACA,eAAe,qBAAqB;AAAA,IACtC;AACA,WAAO,kBACH,IAAI;AAAA;AAAA,MAEF,gBAAgB,OACb,IAAI,CAAC,EAAE,MAAAC,OAAM,QAAQ,MAA0C,GAAGA,KAAI,IAAI,OAAO,EAAE,EACnF,KAAK,IAAI;AAAA,IACd,IACA;AAAA,EACN;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAUA,eACE,cACA,QACwB;AACxB,UAAM,gBAAgB;AACtB,UAAM,uBAAuB,EAAE,CAAC,aAAa,GAAG,EAAE,OAAO,EAAE;AAC3D,UAAM,YAAY,IAAI,yBAAyB;AAAA,MAC7C,WAAW;AAAA,MACX,GAAG,KAAK,gCAAgC;AAAA;AAAA,MAExC,kBAAkB,CAAC,EAAE,MAAAA,OAAM,QAAQ,OAA8D;AAAA,QAC/F,SAAS,GAAGA,MAAM,QAAQ,YAAY,QAAQ,CAAC,IAAI,OAAO;AAAA,MAC5D;AAAA,IACF,CAAiC;AACjC,UAAM,kBAAkB,UAAU;AAAA,MAChC;AAAA,MACA;AAAA,IACF;AACA,WAAO,kBACH,IAAI;AAAA;AAAA,MAEF,gBAAgB,OAAQ,IAAI,CAAC,UAA+B,MAAM,OAAO,EAAE,KAAK,IAAI;AAAA,IACtF,IACA;AAAA,EACN;AACF;;;ACxLA,IAAM,8BAA8B,CAAC,SACnC,CAAC,KAAK;AAER,IAAqB,eAArB,cAA0C,YAAoB;AAAA,EAG5D,YAA4B,MAA0B;AACpD,UAAM,IAAI;AADgB;AAE1B,SAAK,wBAAwB,CAAC,4BAA4B,IAAI;AAAA,EAChE;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,gCAAgC,UAA0B;AACxD,UAAM,EAAE,SAAS,IAAI,KAAK;AAC1B,QAAI,YAAY,CAAC,SAAS,WAAW,QAAQ,GAAG;AAC9C,YAAM,IAAI,wCAA0C;AAAA,IACtD;AACA,UAAM,0BAA0B,WAC5B,2BAA2B,UAAU,QAAQ,IAC7C;AACJ,UAAM,cAAc;AAAA,MAClB,CAAC,uBAAuB;AAAA,MACxB,KAAK,MAAM;AAAA,IACb;AACA,QAAI,CAAC,aAAa;AAChB,YAAM,IAAI,oCAAsC;AAAA,IAClD;AACA,WAAO;AAAA,EACT;AAAA,EAEA,uBACE,iBACsC;AA5C1C;AA8CI,UAAM,2BAA2B,gBAAgB,MAAM,cAAc,EAAE,CAAC;AACxE,YAAO,UAAK,KAAK,cAAV,mBAAsB;AAAA,EAG/B;AAAA,EAEA,kCAEE;AACA,WAAO,EAAE,aAAa,KAAK,KAAK,YAAY;AAAA,EAC9C;AAAA,EAEA,mBAAsD;AACpD,WAAO,KAAK,KAAK;AAAA,EACnB;AACF;;;AC7DA,OAAO,0BAA0B;AAMjC,IAAM,SAAS,CAAI,UAAoB,CAAC,GAAG,IAAI,IAAI,KAAK,CAAC;AAElD,IAAM,2CAA2C,CACtD,SACY,CAAC,KAAK,WAAW,CAAC,KAAK,QAAQ;AAE7C,IAAM,cAAc,CAACC,SAAwB;AAC3C,QAAM,qBAAqBA,KAAI,QAAQ,MAAM,IAAI,EAAE,QAAQ,GAAG;AAC9D,SAAO,uBAAuB,KAC1BA,KAAI,MAAM,kBAAkB,IAC5B;AACN;AAEA,IAAM,oCAAoC,CAAC;AAAA,EACzC,SAAS;AAAA,EACT,MAAM;AACR,MACE,cAAc,OAAO,CAAC,YAAY,EAAE,OAAO,WAAW,CAAC,IAAI,CAAC,YAAY;AAE1E,IAAM,qCAAqC,CACzC,oBAEA,OAAO,QAAQ,eAAe,EAAE;AAAA,EAC9B,CAAC,YAAY,CAAC,cAAc,uBAAuB,OAAO;AAAA,IACxD,GAAG;AAAA,IACH,CAAC,YAAY,GAAG;AAAA,MACd;AAAA,IACF;AAAA,EACF;AAAA,EACA,CAAC;AACH;AAEF,IAAM,gDAAgD,CACpD,oBACA,2BAEA,OAAO,QAAQ,sBAAsB,EAAE;AAAA,EACrC,CAAC,mBAAmB,CAAC,UAAU,KAAK,MAClC,kBAAkB,QAAQ,IAAI,QAAQ,KAAK,KAAK;AAAA,EAClD;AACF;AAEF,IAAM,+BAA+B,CACnC,UACA,oBACa;AACb,QAAM,uCACJ,mCAAmC,eAAe;AACpD,QAAM,uCAAuC;AAAA,IAC3C;AAAA,EACF;AACA,QAAM,oBAAoB,qCAAqC;AAAA,IAC7D,CAAC,2BACC;AAAA,MACE;AAAA,MACA;AAAA,IACF;AAAA,EACJ;AACA,SAAO;AACT;AAEA,IAAM,uBAAuB,CAC3BA,MACA,oBACa;AACb,QAAM,WAAW,YAAYA,IAAG;AAChC,SAAO,kBACH,6BAA6B,UAAU,eAAe,IACtD,CAAC,QAAQ;AACf;AAEO,IAAM,0CAA0C,CACrD,SACA,aACwD;AACxD,QAAM,kBAAkB,CAAC,aACvB,SAAS,WAAW,QAAQ;AAC9B,SAAO,QACJ,IAAI,CAAC,EAAE,KAAK,cAAc,UAAU,OAAO;AAAA,IAC1C;AAAA,IACA,mBAAmB,qBAAqB,cAAc,SAAS;AAAA,EACjE,EAAE,EACD,OAAO,CAAC,EAAE,kBAAkB,MAAM,kBAAkB,KAAK,eAAe,CAAC,EACzE,IAAI,CAAC,EAAE,cAAc,kBAAkB,MAAM;AAE5C,UAAM,mBAAmB,kBAAkB,KAAK,eAAe;AAC/D,WAAO;AAAA,MACL,aAAa,aAAa;AAAA,QACxB,YAAY,YAAY;AAAA,QACxB;AAAA,MACF;AAAA,MACA;AAAA,IACF;AAAA,EACF,CAAC;AACL;;;ACtFA,IAAqB,eAArB,cAA0C,YAAoB;AAAA,EAG5D,YAA+B,MAA0B;AACvD,UAAM,IAAI;AADmB;AAE7B,SAAK,uBAAuB,CAAC,yCAAyC,IAAI;AAC1E,SAAK,oBAAoB;AAAA,EAC3B;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,sBAA4B;AAC1B,QAAI,yCAAyC,KAAK,IAAI,GAAG;AACvD,WAAK,KAAK,UAAU,CAAC,EAAE,KAAK,gBAAgB,CAAC;AAAA,IAC/C;AAAA,EACF;AAAA,EAEA,UAAoC;AAElC,WAAO,KAAK,KAAK;AAAA,EACnB;AAAA,EAEA,gBAA0B;AACxB,WAAO,KAAK,QAAQ,EAAE,IAAI,CAAC,WAAW,OAAO,GAAG;AAAA,EAClD;AAAA,EAEA,sBAAsB,UAA4B;AAChD,WAAO;AAAA,MACL,KAAK,QAAQ;AAAA,MACb;AAAA,IACF,EAAE,IAAI,CAAC,EAAE,YAAY,MAAM,WAAW;AAAA,EACxC;AAAA,EAEA,2BAA2B,UAA4B;AACrD,WAAO;AAAA,MACL,KAAK,QAAQ;AAAA,MACb;AAAA,IACF,EAAE,IAAI,CAAC,EAAE,iBAAiB,MAAM,gBAAgB;AAAA,EAClD;AAAA,EAEA,gCAAgC,UAA0B;AACxD,UAAM,0BAA0B,KAAK,2BAA2B,QAAQ;AACxE,QAAI,CAAC,wBAAwB,QAAQ;AACnC,YAAM,IAAI,sCAAwC;AAAA,IACpD;AACA,UAAM,oBAAoB,wBAAwB;AAAA,MAAI,CAAC,aACrD,2BAA2B,UAAU,QAAQ;AAAA,IAC/C;AACA,UAAM,cAAc;AAAA,MAClB;AAAA,MACA,KAAK,MAAM;AAAA,IACb;AACA,QAAI,CAAC,aAAa;AAChB,YAAM,IAAI,oCAAsC;AAAA,IAClD;AACA,WAAO;AAAA,EACT;AAAA,EAEA,uBACE,iBACsC;AA5E1C;AA8EI,UAAM,2BAA2B,gBAAgB;AAAA,MAC/C;AAAA,IACF,EAAE,CAAC;AACH,YAAO,gBAAK,KAAK,eAAV,mBAAsB,cAAtB,mBAAkC;AAAA,EAG3C;AAAA,EAEA,kCAEE;AACA,WAAO,EAAE,YAAY,KAAK,KAAK,WAAW;AAAA,EAC5C;AAAA,EAEA,mBAA0D;AA5F5D;AA6FI,YAAO,UAAK,KAAK,eAAV,mBAAsB;AAAA,EAC/B;AACF;;;ALnFA,IAAM,WAAW,CAAC,QAChB,OAAO,QAAQ,YAAY,QAAQ,QAAQ,CAAC,MAAM,QAAQ,GAAG;AAEhD,SAAR,YACL,kBAC6B;AAC7B,QAAM,OAAO,SAAS,gBAAgB;AACtC,eAAa,IAAI;AACjB,QAAM,YAAY;AAClB,MAAI,aAAa,WAAW;AAC1B,WAAO,IAAI,aAAa,SAAS;AAAA,EACnC;AACA,SAAO,IAAI,aAAa,SAA+B;AACzD;AAEA,SAAS,SAAS,KAAyB;AACzC,MAAI;AACF,QAAI,OAAO,QAAQ,UAAU;AAC3B,aAAO,SAAS,GAAG;AAAA,IACrB;AACA,QAAI,SAAS,GAAG,GAAG;AACjB,aAAO;AAAA,IACT;AACA,UAAM,IAAI,MAAM,kBAAkB,OAAO,GAAG,CAAC,GAAG;AAAA,EAClD,SAAS,OAAO;AACd,UAAM,IAAI;AAAA,MACR;AAAA,iBACG,MAAgB,OACnB;AAAA,IACF;AAAA,EACF;AACF;AAEA,SAAS,SAAS,UAA6B;AAC7C,MAAI,CAAC,KAAK,WAAW,QAAQ,GAAG;AAC9B,UAAM,IAAI,MAAM,IAAI,QAAQ,+BAA+B;AAAA,EAC7D;AACA,QAAM,WAAW,GAAG,aAAa,UAAU,EAAE,UAAU,OAAO,CAAC;AAC/D,MAAI;AACF,WAAO,KAAK,KAAK,QAAQ;AAAA,EAC3B,SAAS,OAAO;AACd,UAAM,IAAI,MAAM;AAAA,EAA2B,MAAgB,OAAO,EAAE;AAAA,EACtE;AACF;AAEA,SAAS,aAAa,KAAkC;AACtD,MAAI;AACF,UAAM,YAAY,IAAI,uBAAuB;AAAA,MAC3C,SACG,IAAsC;AAAA,MACtC,IAAsC;AAAA;AAAA,IAC3C,CAAC;AACD,UAAM,EAAE,OAAO,IAAI,UAAU,SAAS,GAAuB;AAC7D,QAAI,OAAO,SAAS,GAAG;AACrB,YAAM,IAAI,MAAM,UAAU,MAAM,CAAC;AAAA,IACnC;AACA,WAAO;AAAA,EACT,SAAS,OAAO;AACd,UAAM,IAAI,MAAM,yBAA0B,MAAgB,OAAO,EAAE;AAAA,EACrE;AACF;;;AMhEA,IAA8B,mBAA9B,MAA+C;AAAA,EAW7C,YAAsB,KAAkB;AAAlB;AAAA,EAAmB;AAAA,EAEzC,UAA6B;AAC3B,WAAO;AAAA,MACL,MAAM,KAAK;AAAA,IACb;AAAA,EACF;AAAA,EAEA,WAAmB;AACjB,WAAO,UAAU,KAAK,QAAQ,CAAC;AAAA,EACjC;AACF;;;ACzBA,IAAqB,gBAArB,cAA2C,iBAAiB;AAAA,EAC1D,YAA+B,KAAuB;AACpD,UAAM,GAAG;AADoB;AAE7B,SAAK,SAAS,IAAI;AAClB,SAAK,OAAO,IAAI;AAChB,SAAK,MAAM,IAAI;AACf,SAAK,mBAAmB,KAAK,SAAS;AAAA,EACxC;AAAA,EAEA,uBAA8C;AAC5C,QAAI,KAAK,kBAAkB;AACzB,aAAO;AAAA,IACT;AACA,WAAO,KAAK;AAAA,EACd;AACF;;;AChBA,IAAM,aAAa,CAAC,QAClB,CAAC,CAAC,OAAO,OAAO,QAAQ,GAAG,EAAE,WAAW,KAAK,IAAI,gBAAgB;AAMnE,IAAqB,qBAArB,cAAgD,iBAAiB;AAAA,EAG/D,YAA+B,KAA4B;AACzD,UAAM,GAAG;AADoB;AAE7B,SAAK,SAAS,IAAI;AAClB,SAAK,OAAO,IAAI;AAChB,SAAK,MAAM,IAAI;AACf,SAAK,qCACH,IAAI,SAAS,QAAQ,WAAW,KAAK,IAAI;AAC3C,SAAK,mBAAmB,IAAI,SAAS;AAAA,EACvC;AAAA,EAEA,uBAAmD;AACjD,QAAI,KAAK,kBAAkB;AACzB,aAAO;AAAA,IACT;AACA,QAAI,KAAK,oCAAoC;AAC3C,aAAO,KAAK,IAAI;AAAA,IAClB;AACA,WAAO,KAAK;AAAA,EACd;AAAA,EAES,UAEP;AACA,WAAO;AAAA,MACL,GAAG,MAAM,QAAQ;AAAA,MACjB,GAAI,KAAK,sCAAsC,EAAE,MAAM,KAAK,IAAI,KAAK;AAAA,IACvE;AAAA,EACF;AACF;;;ACtCe,SAAR,aACL,KACoC;AACpC,MAAI,UAAU,KAAK;AACjB,WAAO,IAAI,cAAc,GAAG;AAAA,EAC9B;AACA,MAAI,YAAY,KAAK;AACnB,WAAO,IAAI,mBAAmB,GAAG;AAAA,EACnC;AACA,QAAM,IAAI;AAAA,IACR;AAAA,EACF;AACF;","names":["ErrorCode","path","url"]}

package/package.json

@@ -1,20 +1,37 @@
 {
   "name": "@ehuelsmann/openapi-validator",
-  "version": "0.15.0",
+  "version": "0.16.1",
   "description": "Common code for jest-openapi and Chai OpenAPI Response Validator",
-  "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",
     "format": "prettier --write . --ignore-path ../../.prettierignore",
     "lint": "tsc --noEmit && eslint .",
     "lint:fix": "yarn lint --fix",
-    "build": "tsc",
+    "build": "tsup",
     "test": "echo",
     "test:ci": "echo",
     "prepack": "yarn build"
   },
-  "repository": "https://github.com/openapi-library/OpenAPIValidators/tree/master/packages/openapi-validator",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/ehuelsmann/OpenAPIValidators.git#master",
+    "directory": "packages/openapi-validator"
+  },
   "author": "OpenApiChai <openapichai@gmail.com>",
   "contributors": [
     "rwalle61 <richard.lh.waller@gmail.com>",
@@ -30,9 +47,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#openapi-validators",
+  "homepage": "https://github.com/ehuelsmann/OpenAPIValidators#openapi-validators",
   "publishConfig": {
     "access": "public"
   },
@@ -40,7 +57,6 @@
     "dist"
   ],
   "dependencies": {
-    "@types/request": "^2.48.7",
     "@types/superagent": "^4.1.12",
     "axios": "^1.15.0",
     "combos": "^0.2.0",
@@ -55,6 +71,7 @@
     "@types/fs-extra": "^9.0.12",
     "@types/js-yaml": "^4.0.3",
     "@types/typeof": "^1.0.0",
-    "openapi-types": "^12.1.3"
+    "openapi-types": "^12.1.3",
+    "tsup": "^8.5.1"
   }
 }

package/dist/classes/AbstractOpenApiSpec.d.ts

@@ -1,47 +0,0 @@
-import type { OpenAPIV2, OpenAPIV3, OpenAPIV3_1 } from 'openapi-types';
-import type { ActualRequest, ActualResponse } from './AbstractResponse';
-import ValidationError from './errors/ValidationError';
-type Document = OpenAPIV2.Document | OpenAPIV3.Document;
-type Operation = OpenAPIV2.OperationObject | OpenAPIV3.OperationObject;
-type PathItemObject = OpenAPIV2.PathItemObject | OpenAPIV3.PathItemObject;
-export type ResponseObjectWithSchema = (OpenAPIV2.ResponseObject & {
-    schema: OpenAPIV2.Schema;
-}) | (OpenAPIV3.ResponseObject & {
-    content: {
-        [media: string]: OpenAPIV3.MediaTypeObject & {
-            schema: OpenAPIV3.SchemaObject;
-        };
-    };
-}) | (OpenAPIV3_1.ResponseObject & {
-    content: {
-        [media: string]: OpenAPIV3_1.MediaTypeObject & {
-            schema: OpenAPIV3_1.SchemaObject;
-        };
-    };
-});
-export type Schema = OpenAPIV2.Schema | OpenAPIV3.SchemaObject;
-export default abstract class OpenApiSpec {
-    protected spec: Document;
-    protected abstract getSchemaObjects(): Record<string, Schema> | undefined;
-    protected abstract findResponseDefinition(referenceString: string): ResponseObjectWithSchema | undefined;
-    protected abstract findOpenApiPathMatchingPathname(pathname: string): string;
-    protected abstract getComponentDefinitionsProperty(): {
-        definitions: OpenAPIV2.Document['definitions'];
-    } | {
-        components: OpenAPIV3.Document['components'];
-    };
-    constructor(spec: Document);
-    pathsObject(): Document['paths'];
-    getPathItem(openApiPath: string): PathItemObject;
-    paths(): string[];
-    getSchemaObject(schemaName: string): Schema | undefined;
-    getExpectedResponse(responseOperation: Operation, status: ActualResponse['status']): ResponseObjectWithSchema | undefined;
-    findExpectedResponse(actualResponse: ActualResponse): Record<string, ResponseObjectWithSchema>;
-    findOpenApiPathMatchingRequest(actualRequest: ActualRequest): string;
-    findExpectedPathItem(actualRequest: ActualRequest): PathItemObject;
-    findExpectedResponseOperation(actualRequest: ActualRequest): Operation | undefined;
-    validateResponse(actualResponse: ActualResponse): ValidationError | null;
-    validateObject(actualObject: unknown, schema: Schema): ValidationError | null;
-}
-export {};
-//# sourceMappingURL=AbstractOpenApiSpec.d.ts.map