oas-normalize 11.1.4 → 12.1.0

package/README.md

@@ -5,7 +5,7 @@
 </p>
 
 <p align="center">
-  Tooling for converting, validating, and parsing OpenAPI, Swagger, and Postman API definitions
+  Tooling for converting, validating, and parsing OpenAPI, Swagger, and Postman API definitions.
 </p>
 
 <p align="center">
@@ -27,126 +27,154 @@ npm install oas-normalize
 
 ## Usage
 
-```javascript
+```ts
 import OASNormalize from 'oas-normalize';
-// const { default: OASNormalize } = require('oas-normalize'); // If you're using CJS.
 
 const oas = new OASNormalize(
   'https://raw.githubusercontent.com/OAI/OpenAPI-Specification/master/examples/v3.0/petstore-expanded.yaml',
-  // ...or a string, path, JSON blob, whatever you've got.
+  // ...or a JSON object, YAML, a file path, stringified JSON, whatever you have.
 );
 
-oas
+await oas
   .validate()
-  .then(definition => {
-    // Definition will always be JSON, and valid.
-    console.log(definition);
+  .then(() => {
+    // The API definition is valid!
   })
   .catch(err => {
-    console.log(err);
+    console.error(err);
   });
 ```
 
-### `#bundle()`
+> [!WARNING]
+> Support for Postman collections is experimental. If you've supplied a Postman collection to the library, it will **always** be converted to OpenAPI, using [`@readme/postman-to-openapi`](https://npm.im/@readme/postman-to-openapi) before doing any bundling, validating, etc.
 
-> **Note**
->
-> Because Postman collections don't support `$ref` pointers, this method will automatically upconvert a Postman collection to OpenAPI if supplied one.
+### `.load()`
+
+Load and retrive the API definition that `oas-normalize` was initialized with. Every method of `oas-normalize` utilizes this internally however if you would like to retrieve the original API _definition_ supplied (for example if all you had was a URL, a file path, or a buffer), you can use `.load()` to automatically resolve and return its contents.
+
+```ts
+const file = await oas.load();
+console.log(file);
+```
+
+### `.bundle()`
 
 Bundle up the given API definition, resolving any external `$ref` pointers in the process.
 
-```js
-await oas.bundle().then(definition => {
-  console.log(definition);
-});
+```ts
+const definition = await oas.bundle();
+console.log(definition);
 ```
 
-### `#deref()`
+### `.convert()`
 
-> **Note**
->
-> Because Postman collections don't support `$ref` pointers, this method will automatically upconvert a Postman collection to OpenAPI if supplied one.
+Convert a given API definition into an OpenAPI definition JSON object.
+
+```ts
+await oas
+  .convert()
+  .then(definition => {
+    // Definition will always be an OpenAPI JSON object, regardless if a
+    // Swagger definition, Postman collection, or even YAML was supplied.
+    console.log(definition);
+  })
+  .catch(err => {
+    console.error(err);
+  });
+```
+
+### `.deref()`
 
 Dereference the given API definition, resolving all `$ref` pointers in the process.
 
-```js
-await oas.deref().then(definition => {
-  console.log(definition);
-});
+```ts
+const definition = await oas.bundle();
+console.log(definition);
 ```
 
-### `#validate({ convertToLatest?: boolean })`
+### `.validate()`
 
-Validate and optionally convert to OpenAPI, a given API definition. This supports Swagger 2.0, OpenAPI 3.x API definitions as well as Postman 2.x collections.
+Validate a given API definition. This supports Swagger 2.0 and OpenAPI 3.x API definitions, as well as Postman 2.x collections.
 
-Please note that if you've supplied a Postman collection to the library it will **always** be converted to OpenAPI, using [@readme/postman-to-openapi](https://npm.im/@readme/postman-to-openapi), and we will only validate resulting OpenAPI definition.
-
-```js
-await oas.validate().then(definition => {
-  console.log(definition);
-});
+```ts
+try {
+  await oas.validate();
+  // The API definition is valid!
+} catch (err) {
+  console.error(err);
+}
 ```
 
-#### Options
+#### Error Handling
 
-<!-- prettier-ignore-start -->
-| Option | Type | Description |
-| :--- | :--- | :--- |
-| `convertToLatest` | Boolean | By default `#validate` will not upconvert Swagger API definitions to OpenAPI so if you wish for this to happen, supply `true`. |
-<!-- prettier-ignore-end -->
+All thrown validation error messages that direct the user to the line(s) where their errors are present:
 
-#### Error Handling
+```
+OpenAPI schema validation failed.
 
-For validation errors, when available, you'll get back an object:
-
-```js
-{
-  "details": [
-    // Ajv pathing errors. For example:
-    /* {
-      "instancePath": "/components/securitySchemes/tlsAuth",
-      "schemaPath": "#/properties/securitySchemes/patternProperties/%5E%5Ba-zA-Z0-9%5C.%5C-_%5D%2B%24/oneOf",
-      "keyword": "oneOf",
-      "params": { "passingSchemas": null },
-      "message": "must match exactly one schema in oneOf"
-    }, */
-  ]
-}
+REQUIRED must have required property 'url'
+
+   7 |   },
+   8 |   "servers": [
+>  9 |     {
+     |     ^ ☹️  url is missing here!
+  10 |       "urll": "http://petstore.swagger.io/v2"
+  11 |     }
+  12 |   ],
 ```
 
-`message` is almost always there, but `path` is less dependable.
+However if you would like to programatically access this information the `SyntaxError` error that is thrown contains a `details` array of [AJV](https://npm.im/ajv) errors:
+
+```json
+[
+  {
+    "instancePath": "/servers/0",
+    "schemaPath": "#/required",
+    "keyword": "required",
+    "params": { "missingProperty": "url" },
+    "message": "must have required property 'url'",
+  },
+  {
+    "instancePath": "/servers/0",
+    "schemaPath": "#/additionalProperties",
+    "keyword": "additionalProperties",
+    "params": { "additionalProperty": "urll" },
+    "message": "must NOT have additional properties",
+  },
+];
+```
 
-### `#version()`
+### `.version()`
 
 Load and retrieve version information about a supplied API definition.
 
-```js
-await oas.version().then(({ specification, version }) => {
-  console.log(specification); // openapi
-  console.log(version); // 3.1.0
-});
+```ts
+const { specification, version } = await oas.version();
+
+console.log(specification); // openapi
+console.log(version); // 3.1.0
 ```
 
 ### Options
 
 ##### Enable local paths
 
-For security reasons, you need to opt into allowing fetching by a local path. To enable it supply the `enablePaths` option to the class instance:
+For security reasons, you need to opt into allowing fetching by a local path. To enable this supply the `enablePaths` option to the class instance:
 
-```js
+```ts
 const oas = new OASNormalize('./petstore.json', { enablePaths: true });
 ```
 
 ##### Colorized errors
 
-If you wish errors from `.validate()` to be styled and colorized, supply `colorizeErrors: true` to your instance of `OASNormalize`:
+If you wish errors from `.validate()` to be styled and colorized, supply `colorizeErrors: true` to the class instance:
 
-```js
+```ts
 const oas = new OASNormalize('https://example.com/petstore.json', {
   colorizeErrors: true,
 });
 ```
 
-Error messages will look like such:
+When enabled thrown validation error messages will now resemble the following:
 
 <img src="https://user-images.githubusercontent.com/33762/137796648-7e1157c2-cee4-466e-9129-dd2a743dd163.png" width="600" />

package/dist/{chunk-K75HC34M.cjs → chunk-GZL345SR.cjs}

@@ -3,11 +3,24 @@ var _jsyaml = require('js-yaml'); var _jsyaml2 = _interopRequireDefault(_jsyaml)
 function isBuffer(obj) {
   return obj != null && obj.constructor != null && typeof obj.constructor.isBuffer === "function" && !!obj.constructor.isBuffer(obj);
 }
-function normalizeURL(url) {
-  if (url.startsWith("https://github.com/") && url.includes("/blob/")) {
-    return url.replace("github.com", "raw.githubusercontent.com").replace("/blob/", "/");
+function prepareURL(url) {
+  const options = {};
+  const u = new URL(url);
+  if (u.username || u.password) {
+    options.headers = {
+      Authorization: `Basic ${btoa(`${u.username}:${u.password}`)}`
+    };
+    u.username = "";
+    u.password = "";
   }
-  return url;
+  if (u.host === "github.com" && u.pathname.includes("/blob/")) {
+    u.host = "raw.githubusercontent.com";
+    u.pathname = u.pathname.replace("/blob/", "/");
+  }
+  return {
+    url: u.toString(),
+    options
+  };
 }
 function getType(obj) {
   if (isBuffer(obj)) {
@@ -67,5 +80,5 @@ function getAPIDefinitionType(schema) {
 
 
 
-exports.isBuffer = isBuffer; exports.normalizeURL = normalizeURL; exports.getType = getType; exports.isOpenAPI = isOpenAPI; exports.isPostman = isPostman; exports.isSwagger = isSwagger; exports.stringToJSON = stringToJSON; exports.isAPIDefinition = isAPIDefinition; exports.getAPIDefinitionType = getAPIDefinitionType;
-//# sourceMappingURL=chunk-K75HC34M.cjs.map
+exports.isBuffer = isBuffer; exports.prepareURL = prepareURL; exports.getType = getType; exports.isOpenAPI = isOpenAPI; exports.isPostman = isPostman; exports.isSwagger = isSwagger; exports.stringToJSON = stringToJSON; exports.isAPIDefinition = isAPIDefinition; exports.getAPIDefinitionType = getAPIDefinitionType;
+//# sourceMappingURL=chunk-GZL345SR.cjs.map

package/dist/chunk-GZL345SR.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["/Users/erunion/code/readme/oas/packages/oas-normalize/dist/chunk-GZL345SR.cjs","../src/lib/utils.ts"],"names":[],"mappings":"AAAA;ACAA,iFAAkC;AAM3B,SAAS,QAAA,CAAS,GAAA,EAAU;AACjC,EAAA,OACE,IAAA,GAAO,KAAA,GACP,GAAA,CAAI,YAAA,GAAe,KAAA,GACnB,OAAO,GAAA,CAAI,WAAA,CAAY,SAAA,IAAa,WAAA,GACpC,CAAC,CAAC,GAAA,CAAI,WAAA,CAAY,QAAA,CAAS,GAAG,CAAA;AAElC;AAMO,SAAS,UAAA,CAAW,GAAA,EAAa;AACtC,EAAA,MAAM,QAAA,EAAuB,CAAC,CAAA;AAC9B,EAAA,MAAM,EAAA,EAAI,IAAI,GAAA,CAAI,GAAG,CAAA;AAIrB,EAAA,GAAA,CAAI,CAAA,CAAE,SAAA,GAAY,CAAA,CAAE,QAAA,EAAU;AAC5B,IAAA,OAAA,CAAQ,QAAA,EAAU;AAAA,MAChB,aAAA,EAAe,CAAA,MAAA,EAAS,IAAA,CAAK,CAAA,EAAA;AAC/B,IAAA;AAEa,IAAA;AACA,IAAA;AACf,EAAA;AAGiC,EAAA;AACtB,IAAA;AACuB,IAAA;AAClC,EAAA;AAEO,EAAA;AACW,IAAA;AAChB,IAAA;AACF,EAAA;AACF;AAMkC;AACb,EAAA;AACV,IAAA;AACiB,EAAA;AACjB,IAAA;AACiB,EAAA;AACD,IAAA;AACd,MAAA;AACmB,IAAA;AAEnB,MAAA;AACoB,IAAA;AACpB,MAAA;AACT,IAAA;AAEO,IAAA;AACT,EAAA;AAEO,EAAA;AACT;AAM2D;AACzC,EAAA;AAClB;AAaoE;AACjC,EAAA;AACnC;AAM2D;AACzC,EAAA;AAClB;AAMgG;AAC9D,EAAA;AACvB,IAAA;AACyB,EAAA;AAER,IAAA;AAC1B,EAAA;AAE2B,EAAA;AAC7B;AAMiE;AACnC,EAAA;AAC9B;AAMqC;AACZ,EAAA;AACd,IAAA;AACqB,EAAA;AACrB,IAAA;AACqB,EAAA;AACrB,IAAA;AACT,EAAA;AAEO,EAAA;AACT;ADpEoC;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA","file":"/Users/erunion/code/readme/oas/packages/oas-normalize/dist/chunk-GZL345SR.cjs","sourcesContent":[null,"import YAML, { JSON_SCHEMA } from 'js-yaml';\n\n/**\n * Determine if a given variable is a `Buffer`.\n *\n */\nexport function isBuffer(obj: any) {\n  return (\n    obj != null &&\n    obj.constructor != null &&\n    typeof obj.constructor.isBuffer === 'function' &&\n    !!obj.constructor.isBuffer(obj)\n  );\n}\n\n/**\n * Deconstruct a URL into a payload for a `fetch` request.\n *\n */\nexport function prepareURL(url: string) {\n  const options: RequestInit = {};\n  const u = new URL(url);\n\n  // `fetch` doesn't support supplying basic auth credentials in the URL so we need to move them\n  // into a header.\n  if (u.username || u.password) {\n    options.headers = {\n      Authorization: `Basic ${btoa(`${u.username}:${u.password}`)}`,\n    };\n\n    u.username = '';\n    u.password = '';\n  }\n\n  // Transform GitHub sources into their raw content URLs.\n  if (u.host === 'github.com' && u.pathname.includes('/blob/')) {\n    u.host = 'raw.githubusercontent.com';\n    u.pathname = u.pathname.replace('/blob/', '/');\n  }\n\n  return {\n    url: u.toString(),\n    options,\n  };\n}\n\n/**\n * Determine the type of a given variable. Returns `false` if unrecognized.\n *\n */\nexport function getType(obj: any) {\n  if (isBuffer(obj)) {\n    return 'buffer';\n  } else if (typeof obj === 'object') {\n    return 'json';\n  } else if (typeof obj === 'string') {\n    if (obj.match(/\\s*{/)) {\n      return 'string-json';\n    } else if (obj.match(/\\n/)) {\n      // Not sure about this...\n      return 'string-yaml';\n    } else if (obj.substring(0, 4) === 'http') {\n      return 'url';\n    }\n\n    return 'path';\n  }\n\n  return false;\n}\n\n/**\n * Determine if a given schema if an OpenAPI definition.\n *\n */\nexport function isOpenAPI(schema: Record<string, unknown>) {\n  return !!schema.openapi;\n}\n\n/**\n * Determine if a given schema is a Postman collection.\n *\n * Unfortunately the Postman schema spec doesn't have anything like `openapi` or `swagger` for us\n * to look at but it does require that `info` and `item` be present and as `item` doesn't exist in\n * OpenAPI or Swagger we can use the combination of those two properties to determine if what we\n * have is a Postman collection.\n *\n * @see {@link https://schema.postman.com/json/collection/v2.0.0/collection.json}\n * @see {@link https://schema.postman.com/json/collection/v2.1.0/collection.json}\n */\nexport function isPostman(schema: Record<string, unknown>): boolean {\n  return !!schema.info && !!schema.item;\n}\n\n/**\n * Determine if a given schema if an Swagger definition.\n *\n */\nexport function isSwagger(schema: Record<string, unknown>) {\n  return !!schema.swagger;\n}\n\n/**\n * Convert a YAML blob or stringified JSON object into a JSON object.\n *\n */\nexport function stringToJSON(string: Record<string, unknown> | string): Record<string, unknown> {\n  if (typeof string === 'object') {\n    return string;\n  } else if (string.match(/^\\s*{/)) {\n    // eslint-disable-next-line try-catch-failsafe/json-parse\n    return JSON.parse(string);\n  }\n\n  return YAML.load(string, { schema: JSON_SCHEMA }) as Record<string, unknown>;\n}\n\n/**\n * Determine if a given schema is an API definition that we can support.\n *\n */\nexport function isAPIDefinition(schema: Record<string, unknown>) {\n  return isOpenAPI(schema) || isPostman(schema) || isSwagger(schema);\n}\n\n/**\n * Retrieve the type of API definition that a given schema is.\n *\n */\nexport function getAPIDefinitionType(schema: Record<string, unknown>) {\n  if (isOpenAPI(schema)) {\n    return 'openapi';\n  } else if (isPostman(schema)) {\n    return 'postman';\n  } else if (isSwagger(schema)) {\n    return 'swagger';\n  }\n\n  return 'unknown';\n}\n"]}

package/dist/{chunk-XOS5M44Y.js → chunk-J322YOXV.js}

@@ -3,11 +3,24 @@ import YAML, { JSON_SCHEMA } from "js-yaml";
 function isBuffer(obj) {
   return obj != null && obj.constructor != null && typeof obj.constructor.isBuffer === "function" && !!obj.constructor.isBuffer(obj);
 }
-function normalizeURL(url) {
-  if (url.startsWith("https://github.com/") && url.includes("/blob/")) {
-    return url.replace("github.com", "raw.githubusercontent.com").replace("/blob/", "/");
+function prepareURL(url) {
+  const options = {};
+  const u = new URL(url);
+  if (u.username || u.password) {
+    options.headers = {
+      Authorization: `Basic ${btoa(`${u.username}:${u.password}`)}`
+    };
+    u.username = "";
+    u.password = "";
   }
-  return url;
+  if (u.host === "github.com" && u.pathname.includes("/blob/")) {
+    u.host = "raw.githubusercontent.com";
+    u.pathname = u.pathname.replace("/blob/", "/");
+  }
+  return {
+    url: u.toString(),
+    options
+  };
 }
 function getType(obj) {
   if (isBuffer(obj)) {
@@ -59,7 +72,7 @@ function getAPIDefinitionType(schema) {
 
 export {
   isBuffer,
-  normalizeURL,
+  prepareURL,
   getType,
   isOpenAPI,
   isPostman,
@@ -68,4 +81,4 @@ export {
   isAPIDefinition,
   getAPIDefinitionType
 };
-//# sourceMappingURL=chunk-XOS5M44Y.js.map
+//# sourceMappingURL=chunk-J322YOXV.js.map

package/dist/chunk-J322YOXV.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/lib/utils.ts"],"sourcesContent":["import YAML, { JSON_SCHEMA } from 'js-yaml';\n\n/**\n * Determine if a given variable is a `Buffer`.\n *\n */\nexport function isBuffer(obj: any) {\n  return (\n    obj != null &&\n    obj.constructor != null &&\n    typeof obj.constructor.isBuffer === 'function' &&\n    !!obj.constructor.isBuffer(obj)\n  );\n}\n\n/**\n * Deconstruct a URL into a payload for a `fetch` request.\n *\n */\nexport function prepareURL(url: string) {\n  const options: RequestInit = {};\n  const u = new URL(url);\n\n  // `fetch` doesn't support supplying basic auth credentials in the URL so we need to move them\n  // into a header.\n  if (u.username || u.password) {\n    options.headers = {\n      Authorization: `Basic ${btoa(`${u.username}:${u.password}`)}`,\n    };\n\n    u.username = '';\n    u.password = '';\n  }\n\n  // Transform GitHub sources into their raw content URLs.\n  if (u.host === 'github.com' && u.pathname.includes('/blob/')) {\n    u.host = 'raw.githubusercontent.com';\n    u.pathname = u.pathname.replace('/blob/', '/');\n  }\n\n  return {\n    url: u.toString(),\n    options,\n  };\n}\n\n/**\n * Determine the type of a given variable. Returns `false` if unrecognized.\n *\n */\nexport function getType(obj: any) {\n  if (isBuffer(obj)) {\n    return 'buffer';\n  } else if (typeof obj === 'object') {\n    return 'json';\n  } else if (typeof obj === 'string') {\n    if (obj.match(/\\s*{/)) {\n      return 'string-json';\n    } else if (obj.match(/\\n/)) {\n      // Not sure about this...\n      return 'string-yaml';\n    } else if (obj.substring(0, 4) === 'http') {\n      return 'url';\n    }\n\n    return 'path';\n  }\n\n  return false;\n}\n\n/**\n * Determine if a given schema if an OpenAPI definition.\n *\n */\nexport function isOpenAPI(schema: Record<string, unknown>) {\n  return !!schema.openapi;\n}\n\n/**\n * Determine if a given schema is a Postman collection.\n *\n * Unfortunately the Postman schema spec doesn't have anything like `openapi` or `swagger` for us\n * to look at but it does require that `info` and `item` be present and as `item` doesn't exist in\n * OpenAPI or Swagger we can use the combination of those two properties to determine if what we\n * have is a Postman collection.\n *\n * @see {@link https://schema.postman.com/json/collection/v2.0.0/collection.json}\n * @see {@link https://schema.postman.com/json/collection/v2.1.0/collection.json}\n */\nexport function isPostman(schema: Record<string, unknown>): boolean {\n  return !!schema.info && !!schema.item;\n}\n\n/**\n * Determine if a given schema if an Swagger definition.\n *\n */\nexport function isSwagger(schema: Record<string, unknown>) {\n  return !!schema.swagger;\n}\n\n/**\n * Convert a YAML blob or stringified JSON object into a JSON object.\n *\n */\nexport function stringToJSON(string: Record<string, unknown> | string): Record<string, unknown> {\n  if (typeof string === 'object') {\n    return string;\n  } else if (string.match(/^\\s*{/)) {\n    // eslint-disable-next-line try-catch-failsafe/json-parse\n    return JSON.parse(string);\n  }\n\n  return YAML.load(string, { schema: JSON_SCHEMA }) as Record<string, unknown>;\n}\n\n/**\n * Determine if a given schema is an API definition that we can support.\n *\n */\nexport function isAPIDefinition(schema: Record<string, unknown>) {\n  return isOpenAPI(schema) || isPostman(schema) || isSwagger(schema);\n}\n\n/**\n * Retrieve the type of API definition that a given schema is.\n *\n */\nexport function getAPIDefinitionType(schema: Record<string, unknown>) {\n  if (isOpenAPI(schema)) {\n    return 'openapi';\n  } else if (isPostman(schema)) {\n    return 'postman';\n  } else if (isSwagger(schema)) {\n    return 'swagger';\n  }\n\n  return 'unknown';\n}\n"],"mappings":";AAAA,OAAO,QAAQ,mBAAmB;AAM3B,SAAS,SAAS,KAAU;AACjC,SACE,OAAO,QACP,IAAI,eAAe,QACnB,OAAO,IAAI,YAAY,aAAa,cACpC,CAAC,CAAC,IAAI,YAAY,SAAS,GAAG;AAElC;AAMO,SAAS,WAAW,KAAa;AACtC,QAAM,UAAuB,CAAC;AAC9B,QAAM,IAAI,IAAI,IAAI,GAAG;AAIrB,MAAI,EAAE,YAAY,EAAE,UAAU;AAC5B,YAAQ,UAAU;AAAA,MAChB,eAAe,SAAS,KAAK,GAAG,EAAE,QAAQ,IAAI,EAAE,QAAQ,EAAE,CAAC;AAAA,IAC7D;AAEA,MAAE,WAAW;AACb,MAAE,WAAW;AAAA,EACf;AAGA,MAAI,EAAE,SAAS,gBAAgB,EAAE,SAAS,SAAS,QAAQ,GAAG;AAC5D,MAAE,OAAO;AACT,MAAE,WAAW,EAAE,SAAS,QAAQ,UAAU,GAAG;AAAA,EAC/C;AAEA,SAAO;AAAA,IACL,KAAK,EAAE,SAAS;AAAA,IAChB;AAAA,EACF;AACF;AAMO,SAAS,QAAQ,KAAU;AAChC,MAAI,SAAS,GAAG,GAAG;AACjB,WAAO;AAAA,EACT,WAAW,OAAO,QAAQ,UAAU;AAClC,WAAO;AAAA,EACT,WAAW,OAAO,QAAQ,UAAU;AAClC,QAAI,IAAI,MAAM,MAAM,GAAG;AACrB,aAAO;AAAA,IACT,WAAW,IAAI,MAAM,IAAI,GAAG;AAE1B,aAAO;AAAA,IACT,WAAW,IAAI,UAAU,GAAG,CAAC,MAAM,QAAQ;AACzC,aAAO;AAAA,IACT;AAEA,WAAO;AAAA,EACT;AAEA,SAAO;AACT;AAMO,SAAS,UAAU,QAAiC;AACzD,SAAO,CAAC,CAAC,OAAO;AAClB;AAaO,SAAS,UAAU,QAA0C;AAClE,SAAO,CAAC,CAAC,OAAO,QAAQ,CAAC,CAAC,OAAO;AACnC;AAMO,SAAS,UAAU,QAAiC;AACzD,SAAO,CAAC,CAAC,OAAO;AAClB;AAMO,SAAS,aAAa,QAAmE;AAC9F,MAAI,OAAO,WAAW,UAAU;AAC9B,WAAO;AAAA,EACT,WAAW,OAAO,MAAM,OAAO,GAAG;AAEhC,WAAO,KAAK,MAAM,MAAM;AAAA,EAC1B;AAEA,SAAO,KAAK,KAAK,QAAQ,EAAE,QAAQ,YAAY,CAAC;AAClD;AAMO,SAAS,gBAAgB,QAAiC;AAC/D,SAAO,UAAU,MAAM,KAAK,UAAU,MAAM,KAAK,UAAU,MAAM;AACnE;AAMO,SAAS,qBAAqB,QAAiC;AACpE,MAAI,UAAU,MAAM,GAAG;AACrB,WAAO;AAAA,EACT,WAAW,UAAU,MAAM,GAAG;AAC5B,WAAO;AAAA,EACT,WAAW,UAAU,MAAM,GAAG;AAC5B,WAAO;AAAA,EACT;AAEA,SAAO;AACT;","names":[]}

package/dist/index.cjs

@@ -6,7 +6,7 @@
 
 
 
-var _chunkK75HC34Mcjs = require('./chunk-K75HC34M.cjs');
+var _chunkGZL345SRcjs = require('./chunk-GZL345SR.cjs');
 
 // src/index.ts
 var _fs = require('fs'); var _fs2 = _interopRequireDefault(_fs);
@@ -21,7 +21,7 @@ var OASNormalize = class _OASNormalize {
       enablePaths: false,
       ...opts
     };
-    this.type = _chunkK75HC34Mcjs.getType.call(void 0, this.file);
+    this.type = _chunkGZL345SRcjs.getType.call(void 0, this.file);
     this.cache = {
       load: false,
       bundle: false,
@@ -29,14 +29,15 @@ var OASNormalize = class _OASNormalize {
     };
   }
   /**
-   * @private
+   * Load and return the API definition that `oas-normalize` was initialized with.
+   *
    */
   async load() {
-    if (this.cache.load) return Promise.resolve(this.cache.load);
+    if (this.cache.load) return this.cache.load;
     const resolve = (obj) => {
-      const ret = _chunkK75HC34Mcjs.stringToJSON.call(void 0, obj);
+      const ret = _chunkGZL345SRcjs.stringToJSON.call(void 0, obj);
       this.cache.load = ret;
-      return Promise.resolve(ret);
+      return ret;
     };
     switch (this.type) {
       case "json":
@@ -46,24 +47,22 @@ var OASNormalize = class _OASNormalize {
       case "buffer":
         return resolve(this.file.toString());
       case "url":
-        const resp = await fetch(_chunkK75HC34Mcjs.normalizeURL.call(void 0, this.file)).then((res) => res.text());
+        const { url, options } = _chunkGZL345SRcjs.prepareURL.call(void 0, this.file);
+        const resp = await fetch(url, options).then((res) => res.text());
         return resolve(resp);
       case "path":
         if (!this.opts.enablePaths) {
-          return Promise.reject(new Error("Use `opts.enablePaths` to enable accessing local files."));
+          throw new Error("Use `opts.enablePaths` to enable accessing local files.");
         }
         const contents = _fs2.default.readFileSync(this.file).toString();
         if (!contents.trim()) {
-          return Promise.reject(new Error("No file contents found."));
+          throw new Error("No file contents found.");
         }
         return resolve(contents);
       default:
-        return Promise.reject(new Error("Could not load this file."));
+        throw new Error("Could not load this file.");
     }
   }
-  /**
-   * @private
-   */
   static async convertPostmanToOpenAPI(schema) {
     return _postmantoopenapi2.default.call(void 0, JSON.stringify(schema), void 0, { outputFormat: "json", replaceVars: true }).then(
       JSON.parse
@@ -74,9 +73,9 @@ var OASNormalize = class _OASNormalize {
    *
    */
   async bundle() {
-    if (this.cache.bundle) return Promise.resolve(this.cache.bundle);
+    if (this.cache.bundle) return this.cache.bundle;
     return this.load().then((schema) => {
-      if (_chunkK75HC34Mcjs.isPostman.call(void 0, schema)) {
+      if (_chunkGZL345SRcjs.isPostman.call(void 0, schema)) {
         return _OASNormalize.convertPostmanToOpenAPI(schema);
       }
       return schema;
@@ -90,9 +89,9 @@ var OASNormalize = class _OASNormalize {
    *
    */
   async deref() {
-    if (this.cache.deref) return Promise.resolve(this.cache.deref);
+    if (this.cache.deref) return this.cache.deref;
     return this.load().then((schema) => {
-      if (_chunkK75HC34Mcjs.isPostman.call(void 0, schema)) {
+      if (_chunkGZL345SRcjs.isPostman.call(void 0, schema)) {
         return _OASNormalize.convertPostmanToOpenAPI(schema);
       }
       return schema;
@@ -102,37 +101,54 @@ var OASNormalize = class _OASNormalize {
     });
   }
   /**
-   * Validate, and potentially convert to OpenAPI, a given API definition.
+   * Convert a given API definition to OpenAPI if it is not already.
    *
    */
-  async validate(opts = { convertToLatest: false }) {
-    const convertToLatest = opts.convertToLatest;
+  async convert() {
+    if (this.cache.convert) return this.cache.convert;
+    return this.load().then(async (schema) => {
+      return _chunkGZL345SRcjs.isPostman.call(void 0, schema) ? _OASNormalize.convertPostmanToOpenAPI(schema) : schema;
+    }).then(async (schema) => {
+      if (!_chunkGZL345SRcjs.isSwagger.call(void 0, schema) && !_chunkGZL345SRcjs.isOpenAPI.call(void 0, schema)) {
+        throw new Error("The supplied API definition is unsupported.");
+      } else if (_chunkGZL345SRcjs.isOpenAPI.call(void 0, schema)) {
+        return schema;
+      }
+      const baseVersion = parseInt(schema.swagger, 10);
+      if (baseVersion === 1) {
+        throw new Error("Swagger v1.2 is unsupported.");
+      }
+      return _swagger2openapi2.default.convertObj(schema, { anchors: true }).then((options) => options.openapi);
+    });
+  }
+  /**
+   * Validate a given API definition.
+   *
+   * If supplied a Postman collection it will be converted to OpenAPI first and then run through
+   * standard OpenAPI validation.
+   *
+   */
+  async validate(opts = {}) {
     const parserOptions = opts.parser || {};
     if (!parserOptions.validate) {
       parserOptions.validate = {};
     }
     parserOptions.validate.colorizeErrors = this.opts.colorizeErrors;
     return this.load().then(async (schema) => {
-      if (!_chunkK75HC34Mcjs.isPostman.call(void 0, schema)) {
-        return schema;
-      }
-      return _OASNormalize.convertPostmanToOpenAPI(schema);
+      return _chunkGZL345SRcjs.isPostman.call(void 0, schema) ? _OASNormalize.convertPostmanToOpenAPI(schema) : schema;
     }).then(async (schema) => {
-      if (!_chunkK75HC34Mcjs.isSwagger.call(void 0, schema) && !_chunkK75HC34Mcjs.isOpenAPI.call(void 0, schema)) {
-        return Promise.reject(new Error("The supplied API definition is unsupported."));
-      } else if (_chunkK75HC34Mcjs.isSwagger.call(void 0, schema)) {
+      if (!_chunkGZL345SRcjs.isSwagger.call(void 0, schema) && !_chunkGZL345SRcjs.isOpenAPI.call(void 0, schema)) {
+        throw new Error("The supplied API definition is unsupported.");
+      } else if (_chunkGZL345SRcjs.isSwagger.call(void 0, schema)) {
         const baseVersion = parseInt(schema.swagger, 10);
         if (baseVersion === 1) {
-          return Promise.reject(new Error("Swagger v1.2 is unsupported."));
+          throw new Error("Swagger v1.2 is unsupported.");
         }
       }
       const clonedSchema = JSON.parse(JSON.stringify(schema));
       return _openapiparser2.default.validate(clonedSchema, parserOptions).then(() => {
-        if (!convertToLatest || _chunkK75HC34Mcjs.isOpenAPI.call(void 0, schema)) {
-          return schema;
-        }
-        return _swagger2openapi2.default.convertObj(schema, { anchors: true }).then((options) => options.openapi);
-      }).catch((err) => Promise.reject(err));
+        return true;
+      });
     });
   }
   /**
@@ -141,7 +157,7 @@ var OASNormalize = class _OASNormalize {
    */
   async version() {
     return this.load().then((schema) => {
-      switch (_chunkK75HC34Mcjs.getAPIDefinitionType.call(void 0, schema)) {
+      switch (_chunkGZL345SRcjs.getAPIDefinitionType.call(void 0, schema)) {
         case "openapi":
           return {
             specification: "openapi",

package/dist/index.cjs.map

@@ -1 +1 @@
-{"version":3,"sources":["/Users/erunion/code/readme/oas/packages/oas-normalize/dist/index.cjs","../src/index.ts"],"names":[],"mappings":"AAAA;AACE;AACA;AACA;AACA;AACA;AACA;AACA;AACF,wDAAA;AACA;AACA;ACPA,gEAAe;AAEf,qHAA0B;AAC1B,kIAA6B;AAC7B,oHAAsB;AAItB,IAAqB,aAAA,EAArB,MAAqB,cAAa;AAAA,EAahC,WAAA,CAAY,IAAA,EAAW,IAAA,EAAgB;AACrC,IAAA,IAAA,CAAK,KAAA,EAAO,IAAA;AACZ,IAAA,IAAA,CAAK,KAAA,EAAO;AAAA,MACV,cAAA,EAAgB,KAAA;AAAA,MAChB,WAAA,EAAa,KAAA;AAAA,MACb,GAAG;AAAA,IACL,CAAA;AAEA,IAAA,IAAA,CAAK,KAAA,EAAa,uCAAA,IAAQ,CAAK,IAAI,CAAA;AAEnC,IAAA,IAAA,CAAK,MAAA,EAAQ;AAAA,MACX,IAAA,EAAM,KAAA;AAAA,MACN,MAAA,EAAQ,KAAA;AAAA,MACR,KAAA,EAAO;AAAA,IACT,CAAA;AAAA,EACF;AAAA;AAAA;AAAA;AAAA,EAKA,MAAM,IAAA,CAAA,EAAyC;AAC7C,IAAA,GAAA,CAAI,IAAA,CAAK,KAAA,CAAM,IAAA,EAAM,OAAO,OAAA,CAAQ,OAAA,CAAQ,IAAA,CAAK,KAAA,CAAM,IAAI,CAAA;AAE3D,IAAA,MAAM,QAAA,EAAU,CAAC,GAAA,EAAA,GAAkD;AACjE,MAAA,MAAM,IAAA,EAAY,4CAAA,GAAgB,CAAA;AAClC,MAAA,IAAA,CAAK,KAAA,CAAM,KAAA,EAAO,GAAA;AAClB,MAAA,OAAO,OAAA,CAAQ,OAAA,CAAQ,GAAG,CAAA;AAAA,IAC5B,CAAA;AAEA,IAAA,OAAA,CAAQ,IAAA,CAAK,IAAA,EAAM;AAAA,MACjB,KAAK,MAAA;AAAA,MACL,KAAK,aAAA;AAAA,MACL,KAAK,aAAA;AACH,QAAA,OAAO,OAAA,CAAQ,IAAA,CAAK,IAAI,CAAA;AAAA,MAE1B,KAAK,QAAA;AACH,QAAA,OAAO,OAAA,CAAQ,IAAA,CAAK,IAAA,CAAK,QAAA,CAAS,CAAC,CAAA;AAAA,MAErC,KAAK,KAAA;AACH,QAAA,MAAM,KAAA,EAAO,MAAM,KAAA,CAAY,4CAAA,IAAa,CAAK,IAAI,CAAC,CAAA,CAAE,IAAA,CAAK,CAAA,GAAA,EAAA,GAAO,GAAA,CAAI,IAAA,CAAK,CAAC,CAAA;AAC9E,QAAA,OAAO,OAAA,CAAQ,IAAI,CAAA;AAAA,MAErB,KAAK,MAAA;AAEH,QAAA,GAAA,CAAI,CAAC,IAAA,CAAK,IAAA,CAAK,WAAA,EAAa;AAC1B,UAAA,OAAO,OAAA,CAAQ,MAAA,CAAO,IAAI,KAAA,CAAM,yDAAyD,CAAC,CAAA;AAAA,QAC5F;AAEA,QAAA,MAAM,SAAA,EAAW,YAAA,CAAG,YAAA,CAAa,IAAA,CAAK,IAAI,CAAA,CAAE,QAAA,CAAS,CAAA;AACrD,QAAA,GAAA,CAAI,CAAC,QAAA,CAAS,IAAA,CAAK,CAAA,EAAG;AACpB,UAAA,OAAO,OAAA,CAAQ,MAAA,CAAO,IAAI,KAAA,CAAM,yBAAyB,CAAC,CAAA;AAAA,QAC5D;AACA,QAAA,OAAO,OAAA,CAAQ,QAAQ,CAAA;AAAA,MAEzB,OAAA;AACE,QAAA,OAAO,OAAA,CAAQ,MAAA,CAAO,IAAI,KAAA,CAAM,2BAA2B,CAAC,CAAA;AAAA,IAChE;AAAA,EACF;AAAA;AAAA;AAAA;AAAA,EAKA,OAAA,MAAa,uBAAA,CAAwB,MAAA,EAAa;AAChD,IAAA,OAAO,wCAAA,IAAiB,CAAK,SAAA,CAAU,MAAM,CAAA,EAAG,KAAA,CAAA,EAAW,EAAE,YAAA,EAAc,MAAA,EAAQ,WAAA,EAAa,KAAK,CAAC,CAAA,CAAE,IAAA;AAAA,MACtG,IAAA,CAAK;AAAA,IACP,CAAA;AAAA,EACF;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,MAAM,MAAA,CAAA,EAAS;AACb,IAAA,GAAA,CAAI,IAAA,CAAK,KAAA,CAAM,MAAA,EAAQ,OAAO,OAAA,CAAQ,OAAA,CAAQ,IAAA,CAAK,KAAA,CAAM,MAAM,CAAA;AAE/D,IAAA,OAAO,IAAA,CAAK,IAAA,CAAK,CAAA,CACd,IAAA,CAAK,CAAA,MAAA,EAAA,GAAU;AAId,MAAA,GAAA,CAAU,yCAAA,MAAgB,CAAA,EAAG;AAC3B,QAAA,OAAO,aAAA,CAAa,uBAAA,CAAwB,MAAM,CAAA;AAAA,MACpD;AAEA,MAAA,OAAO,MAAA;AAAA,IACT,CAAC,CAAA,CACA,IAAA,CAAK,CAAA,MAAA,EAAA,GAAU,uBAAA,CAAc,MAAA,CAAO,MAAM,CAAC,CAAA,CAC3C,IAAA,CAAK,CAAA,MAAA,EAAA,GAAU;AACd,MAAA,IAAA,CAAK,KAAA,CAAM,OAAA,EAAS,MAAA;AACpB,MAAA,OAAO,MAAA;AAAA,IACT,CAAC,CAAA;AAAA,EACL;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,MAAM,KAAA,CAAA,EAAQ;AACZ,IAAA,GAAA,CAAI,IAAA,CAAK,KAAA,CAAM,KAAA,EAAO,OAAO,OAAA,CAAQ,OAAA,CAAQ,IAAA,CAAK,KAAA,CAAM,KAAK,CAAA;AAE7D,IAAA,OAAO,IAAA,CAAK,IAAA,CAAK,CAAA,CACd,IAAA,CAAK,CAAA,MAAA,EAAA,GAAU;AAId,MAAA,GAAA,CAAU,yCAAA,MAAgB,CAAA,EAAG;AAC3B,QAAA,OAAO,aAAA,CAAa,uBAAA,CAAwB,MAAM,CAAA;AAAA,MACpD;AAEA,MAAA,OAAO,MAAA;AAAA,IACT,CAAC,CAAA,CACA,IAAA,CAAK,CAAA,MAAA,EAAA,GAAU,uBAAA,CAAc,WAAA,CAAY,MAAM,CAAC,CAAA,CAChD,IAAA,CAAK,CAAA,YAAA,EAAA,GAAgB;AACpB,MAAA,IAAA,CAAK,KAAA,CAAM,MAAA,EAAQ,YAAA;AACnB,MAAA,OAAO,YAAA;AAAA,IACT,CAAC,CAAA;AAAA,EACL;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,MAAM,QAAA,CACJ,KAAA,EAMI,EAAE,eAAA,EAAiB,MAAM,CAAA,EACF;AAC3B,IAAA,MAAM,gBAAA,EAAkB,IAAA,CAAK,eAAA;AAC7B,IAAA,MAAM,cAAA,EAAgB,IAAA,CAAK,OAAA,GAAU,CAAC,CAAA;AACtC,IAAA,GAAA,CAAI,CAAC,aAAA,CAAc,QAAA,EAAU;AAC3B,MAAA,aAAA,CAAc,SAAA,EAAW,CAAC,CAAA;AAAA,IAC5B;AAEA,IAAA,aAAA,CAAc,QAAA,CAAS,eAAA,EAAiB,IAAA,CAAK,IAAA,CAAK,cAAA;AAElD,IAAA,OAAO,IAAA,CAAK,IAAA,CAAK,CAAA,CACd,IAAA,CAAK,MAAA,CAAM,MAAA,EAAA,GAAU;AACpB,MAAA,GAAA,CAAI,CAAO,yCAAA,MAAgB,CAAA,EAAG;AAC5B,QAAA,OAAO,MAAA;AAAA,MACT;AAEA,MAAA,OAAO,aAAA,CAAa,uBAAA,CAAwB,MAAM,CAAA;AAAA,IACpD,CAAC,CAAA,CACA,IAAA,CAAK,MAAA,CAAM,MAAA,EAAA,GAAU;AACpB,MAAA,GAAA,CAAI,CAAO,yCAAA,MAAgB,EAAA,GAAK,CAAO,yCAAA,MAAgB,CAAA,EAAG;AACxD,QAAA,OAAO,OAAA,CAAQ,MAAA,CAAO,IAAI,KAAA,CAAM,6CAA6C,CAAC,CAAA;AAAA,MAChF,EAAA,KAAA,GAAA,CAAiB,yCAAA,MAAgB,CAAA,EAAG;AAClC,QAAA,MAAM,YAAA,EAAc,QAAA,CAAS,MAAA,CAAO,OAAA,EAAS,EAAE,CAAA;AAC/C,QAAA,GAAA,CAAI,YAAA,IAAgB,CAAA,EAAG;AACrB,UAAA,OAAO,OAAA,CAAQ,MAAA,CAAO,IAAI,KAAA,CAAM,8BAA8B,CAAC,CAAA;AAAA,QACjE;AAAA,MACF;AAUA,MAAA,MAAM,aAAA,EAAe,IAAA,CAAK,KAAA,CAAM,IAAA,CAAK,SAAA,CAAU,MAAM,CAAC,CAAA;AAEtD,MAAA,OAAO,uBAAA,CACJ,QAAA,CAAS,YAAA,EAAc,aAAa,CAAA,CACpC,IAAA,CAAK,CAAA,EAAA,GAAM;AACV,QAAA,GAAA,CAAI,CAAC,gBAAA,GAAyB,yCAAA,MAAgB,CAAA,EAAG;AAC/C,UAAA,OAAO,MAAA;AAAA,QACT;AAEA,QAAA,OAAO,yBAAA,CACJ,UAAA,CAAW,MAAA,EAAQ,EAAE,OAAA,EAAS,KAAK,CAAC,CAAA,CACpC,IAAA,CAAK,CAAC,OAAA,EAAA,GAA2C,OAAA,CAAQ,OAAO,CAAA;AAAA,MACrE,CAAC,CAAA,CACA,KAAA,CAAM,CAAA,GAAA,EAAA,GAAO,OAAA,CAAQ,MAAA,CAAO,GAAG,CAAC,CAAA;AAAA,IACrC,CAAC,CAAA;AAAA,EACL;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,MAAM,OAAA,CAAA,EAAsG;AAC1G,IAAA,OAAO,IAAA,CAAK,IAAA,CAAK,CAAA,CAAE,IAAA,CAAK,CAAA,MAAA,EAAA,GAAU;AAChC,MAAA,OAAA,CAAc,oDAAA,MAA2B,CAAA,EAAG;AAAA,QAC1C,KAAK,SAAA;AACH,UAAA,OAAO;AAAA,YACL,aAAA,EAAe,SAAA;AAAA,YACf,OAAA,EAAU,MAAA,CAAyC;AAAA,UACrD,CAAA;AAAA,QAEF,KAAK,SAAA;AACH,UAAA,IAAI,QAAA,EAAU,SAAA;AACd,UAAA,GAAA,iBAAK,MAAA,2BAAQ,IAAA,6BAAiC,QAAA,EAAQ;AAIpD,YAAA,MAAM,MAAA,EAAA,iBAAS,MAAA,6BAAQ,MAAA,CAAA,CAAgC,MAAA,CAAO,KAAA;AAAA,cAC5D;AAAA,YACF,CAAA;AAEA,YAAA,GAAA,CAAI,KAAA,EAAO;AACT,cAAA,QAAA,EAAU,KAAA,CAAM,CAAC,CAAA;AAAA,YACnB;AAAA,UACF;AAEA,UAAA,OAAO;AAAA,YACL,aAAA,EAAe,SAAA;AAAA,YACf;AAAA,UACF,CAAA;AAAA,QAEF,KAAK,SAAA;AACH,UAAA,OAAO;AAAA,YACL,aAAA,EAAe,SAAA;AAAA,YACf,OAAA,EAAU,MAAA,CAAyC;AAAA,UACrD,CAAA;AAAA,QAEF,OAAA;AACE,UAAA,MAAM,IAAI,KAAA,CAAM,wBAAwB,CAAA;AAAA,MAC5C;AAAA,IACF,CAAC,CAAA;AAAA,EACH;AACF,CAAA;AD5EA;AACE;AACF,+BAAA","file":"/Users/erunion/code/readme/oas/packages/oas-normalize/dist/index.cjs","sourcesContent":[null,"import type { Options } from './lib/types.js';\nimport type { OpenAPI, OpenAPIV2, OpenAPIV3 } from 'openapi-types';\n\nimport fs from 'node:fs';\n\nimport openapiParser from '@readme/openapi-parser';\nimport postmanToOpenAPI from '@readme/postman-to-openapi';\nimport converter from 'swagger2openapi';\n\nimport * as utils from './lib/utils.js';\n\nexport default class OASNormalize {\n  cache: {\n    bundle?: OpenAPI.Document | false;\n    deref?: OpenAPI.Document | false;\n    load?: Record<string, unknown> | false;\n  };\n\n  file: any;\n\n  opts: Options;\n\n  type: ReturnType<typeof utils.getType>;\n\n  constructor(file: any, opts?: Options) {\n    this.file = file;\n    this.opts = {\n      colorizeErrors: false,\n      enablePaths: false,\n      ...opts,\n    };\n\n    this.type = utils.getType(this.file);\n\n    this.cache = {\n      load: false,\n      bundle: false,\n      deref: false,\n    };\n  }\n\n  /**\n   * @private\n   */\n  async load(): Promise<Record<string, unknown>> {\n    if (this.cache.load) return Promise.resolve(this.cache.load);\n\n    const resolve = (obj: Parameters<typeof utils.stringToJSON>[0]) => {\n      const ret = utils.stringToJSON(obj);\n      this.cache.load = ret;\n      return Promise.resolve(ret);\n    };\n\n    switch (this.type) {\n      case 'json':\n      case 'string-json':\n      case 'string-yaml':\n        return resolve(this.file);\n\n      case 'buffer':\n        return resolve(this.file.toString());\n\n      case 'url':\n        const resp = await fetch(utils.normalizeURL(this.file)).then(res => res.text());\n        return resolve(resp);\n\n      case 'path':\n        // Load a local file\n        if (!this.opts.enablePaths) {\n          return Promise.reject(new Error('Use `opts.enablePaths` to enable accessing local files.'));\n        }\n\n        const contents = fs.readFileSync(this.file).toString();\n        if (!contents.trim()) {\n          return Promise.reject(new Error('No file contents found.'));\n        }\n        return resolve(contents);\n\n      default:\n        return Promise.reject(new Error('Could not load this file.'));\n    }\n  }\n\n  /**\n   * @private\n   */\n  static async convertPostmanToOpenAPI(schema: any) {\n    return postmanToOpenAPI(JSON.stringify(schema), undefined, { outputFormat: 'json', replaceVars: true }).then(\n      JSON.parse,\n    );\n  }\n\n  /**\n   * Bundle up the given API definition, resolving any external `$ref` pointers in the process.\n   *\n   */\n  async bundle() {\n    if (this.cache.bundle) return Promise.resolve(this.cache.bundle);\n\n    return this.load()\n      .then(schema => {\n        // Though Postman collections don't support `$ref` pointers for us to bundle we'll still\n        // upconvert it to an OpenAPI definition file so our returned dataset is always one of\n        // those for a Postman dataset.\n        if (utils.isPostman(schema)) {\n          return OASNormalize.convertPostmanToOpenAPI(schema);\n        }\n\n        return schema;\n      })\n      .then(schema => openapiParser.bundle(schema))\n      .then(bundle => {\n        this.cache.bundle = bundle;\n        return bundle;\n      });\n  }\n\n  /**\n   * Dereference the given API definition.\n   *\n   */\n  async deref() {\n    if (this.cache.deref) return Promise.resolve(this.cache.deref);\n\n    return this.load()\n      .then(schema => {\n        // Though Postman collections don't support `$ref` pointers for us to dereference we'll\n        // still upconvert it to an OpenAPI definition file so our returned dataset is always one\n        // of those for a Postman dataset.\n        if (utils.isPostman(schema)) {\n          return OASNormalize.convertPostmanToOpenAPI(schema);\n        }\n\n        return schema;\n      })\n      .then(schema => openapiParser.dereference(schema))\n      .then(dereferenced => {\n        this.cache.deref = dereferenced;\n        return dereferenced;\n      });\n  }\n\n  /**\n   * Validate, and potentially convert to OpenAPI, a given API definition.\n   *\n   */\n  async validate(\n    opts: {\n      /**\n       * Automatically convert the supplied API definition to the latest version of OpenAPI.\n       */\n      convertToLatest?: boolean;\n      parser?: openapiParser.Options;\n    } = { convertToLatest: false },\n  ): Promise<OpenAPI.Document> {\n    const convertToLatest = opts.convertToLatest;\n    const parserOptions = opts.parser || {};\n    if (!parserOptions.validate) {\n      parserOptions.validate = {};\n    }\n\n    parserOptions.validate.colorizeErrors = this.opts.colorizeErrors;\n\n    return this.load()\n      .then(async schema => {\n        if (!utils.isPostman(schema)) {\n          return schema;\n        }\n\n        return OASNormalize.convertPostmanToOpenAPI(schema);\n      })\n      .then(async schema => {\n        if (!utils.isSwagger(schema) && !utils.isOpenAPI(schema)) {\n          return Promise.reject(new Error('The supplied API definition is unsupported.'));\n        } else if (utils.isSwagger(schema)) {\n          const baseVersion = parseInt(schema.swagger, 10);\n          if (baseVersion === 1) {\n            return Promise.reject(new Error('Swagger v1.2 is unsupported.'));\n          }\n        }\n\n        /**\n         * `openapiParser.validate()` dereferences schemas at the same time as validation and does\n         * not give us an option to disable this. Since all we already have a dereferencing method\n         * on this library and our `validate()` method here just needs to tell us if the definition\n         * is valid or not we need to clone it before passing it over to `openapi-parser` so as to\n         * not run into pass-by-reference problems.\n         */\n        // eslint-disable-next-line try-catch-failsafe/json-parse\n        const clonedSchema = JSON.parse(JSON.stringify(schema));\n\n        return openapiParser\n          .validate(clonedSchema, parserOptions)\n          .then(() => {\n            if (!convertToLatest || utils.isOpenAPI(schema)) {\n              return schema;\n            }\n\n            return converter\n              .convertObj(schema, { anchors: true })\n              .then((options: { openapi: OpenAPI.Document }) => options.openapi);\n          })\n          .catch(err => Promise.reject(err));\n      });\n  }\n\n  /**\n   * Retrieve OpenAPI, Swagger, or Postman version information about the supplied API definition.\n   *\n   */\n  async version(): Promise<{ specification: 'openapi' | 'postman' | 'swagger'; version: string | 'unknown' }> {\n    return this.load().then(schema => {\n      switch (utils.getAPIDefinitionType(schema)) {\n        case 'openapi':\n          return {\n            specification: 'openapi',\n            version: (schema as unknown as OpenAPIV3.Document).openapi,\n          };\n\n        case 'postman':\n          let version = 'unknown';\n          if ((schema?.info as Record<string, string>)?.schema) {\n            // Though `info.schema` is required by the Postman spec there's no strictness to its\n            // contents so we'll do our best to extract a version out of this schema URL that they\n            // seem to usually match. If not we'll fallback to treating it as an `unknown` version.\n            const match = (schema?.info as Record<string, string>).schema.match(\n              /http(s?):\\/\\/schema.getpostman.com\\/json\\/collection\\/v([0-9.]+)\\//,\n            );\n\n            if (match) {\n              version = match[2];\n            }\n          }\n\n          return {\n            specification: 'postman',\n            version,\n          };\n\n        case 'swagger':\n          return {\n            specification: 'swagger',\n            version: (schema as unknown as OpenAPIV2.Document).swagger,\n          };\n\n        default:\n          throw new Error('Unknown file detected.');\n      }\n    });\n  }\n}\n"]}
+{"version":3,"sources":["/Users/erunion/code/readme/oas/packages/oas-normalize/dist/index.cjs","../src/index.ts"],"names":[],"mappings":"AAAA;AACE;AACA;AACA;AACA;AACA;AACA;AACA;AACF,wDAAA;AACA;AACA;ACPA,gEAAe;AAEf,qHAA0B;AAC1B,kIAA6B;AAC7B,oHAAsB;AAItB,IAAqB,aAAA,EAArB,MAAqB,cAAa;AAAA,EAchC,WAAA,CAAY,IAAA,EAAW,IAAA,EAAgB;AACrC,IAAA,IAAA,CAAK,KAAA,EAAO,IAAA;AACZ,IAAA,IAAA,CAAK,KAAA,EAAO;AAAA,MACV,cAAA,EAAgB,KAAA;AAAA,MAChB,WAAA,EAAa,KAAA;AAAA,MACb,GAAG;AAAA,IACL,CAAA;AAEA,IAAA,IAAA,CAAK,KAAA,EAAa,uCAAA,IAAQ,CAAK,IAAI,CAAA;AAEnC,IAAA,IAAA,CAAK,MAAA,EAAQ;AAAA,MACX,IAAA,EAAM,KAAA;AAAA,MACN,MAAA,EAAQ,KAAA;AAAA,MACR,KAAA,EAAO;AAAA,IACT,CAAA;AAAA,EACF;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,MAAM,IAAA,CAAA,EAAyC;AAC7C,IAAA,GAAA,CAAI,IAAA,CAAK,KAAA,CAAM,IAAA,EAAM,OAAO,IAAA,CAAK,KAAA,CAAM,IAAA;AAEvC,IAAA,MAAM,QAAA,EAAU,CAAC,GAAA,EAAA,GAAkD;AACjE,MAAA,MAAM,IAAA,EAAY,4CAAA,GAAgB,CAAA;AAClC,MAAA,IAAA,CAAK,KAAA,CAAM,KAAA,EAAO,GAAA;AAClB,MAAA,OAAO,GAAA;AAAA,IACT,CAAA;AAEA,IAAA,OAAA,CAAQ,IAAA,CAAK,IAAA,EAAM;AAAA,MACjB,KAAK,MAAA;AAAA,MACL,KAAK,aAAA;AAAA,MACL,KAAK,aAAA;AACH,QAAA,OAAO,OAAA,CAAQ,IAAA,CAAK,IAAI,CAAA;AAAA,MAE1B,KAAK,QAAA;AACH,QAAA,OAAO,OAAA,CAAQ,IAAA,CAAK,IAAA,CAAK,QAAA,CAAS,CAAC,CAAA;AAAA,MAErC,KAAK,KAAA;AACH,QAAA,MAAM,EAAE,GAAA,EAAK,QAAQ,EAAA,EAAU,0CAAA,IAAW,CAAK,IAAI,CAAA;AACnD,QAAA,MAAM,KAAA,EAAO,MAAM,KAAA,CAAM,GAAA,EAAK,OAAO,CAAA,CAAE,IAAA,CAAK,CAAA,GAAA,EAAA,GAAO,GAAA,CAAI,IAAA,CAAK,CAAC,CAAA;AAC7D,QAAA,OAAO,OAAA,CAAQ,IAAI,CAAA;AAAA,MAErB,KAAK,MAAA;AAEH,QAAA,GAAA,CAAI,CAAC,IAAA,CAAK,IAAA,CAAK,WAAA,EAAa;AAC1B,UAAA,MAAM,IAAI,KAAA,CAAM,yDAAyD,CAAA;AAAA,QAC3E;AAEA,QAAA,MAAM,SAAA,EAAW,YAAA,CAAG,YAAA,CAAa,IAAA,CAAK,IAAI,CAAA,CAAE,QAAA,CAAS,CAAA;AACrD,QAAA,GAAA,CAAI,CAAC,QAAA,CAAS,IAAA,CAAK,CAAA,EAAG;AACpB,UAAA,MAAM,IAAI,KAAA,CAAM,yBAAyB,CAAA;AAAA,QAC3C;AACA,QAAA,OAAO,OAAA,CAAQ,QAAQ,CAAA;AAAA,MAEzB,OAAA;AACE,QAAA,MAAM,IAAI,KAAA,CAAM,2BAA2B,CAAA;AAAA,IAC/C;AAAA,EACF;AAAA,EAEA,OAAA,MAAqB,uBAAA,CAAwB,MAAA,EAAa;AACxD,IAAA,OAAO,wCAAA,IAAiB,CAAK,SAAA,CAAU,MAAM,CAAA,EAAG,KAAA,CAAA,EAAW,EAAE,YAAA,EAAc,MAAA,EAAQ,WAAA,EAAa,KAAK,CAAC,CAAA,CAAE,IAAA;AAAA,MACtG,IAAA,CAAK;AAAA,IACP,CAAA;AAAA,EACF;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,MAAM,MAAA,CAAA,EAAS;AACb,IAAA,GAAA,CAAI,IAAA,CAAK,KAAA,CAAM,MAAA,EAAQ,OAAO,IAAA,CAAK,KAAA,CAAM,MAAA;AAEzC,IAAA,OAAO,IAAA,CAAK,IAAA,CAAK,CAAA,CACd,IAAA,CAAK,CAAA,MAAA,EAAA,GAAU;AAId,MAAA,GAAA,CAAU,yCAAA,MAAgB,CAAA,EAAG;AAC3B,QAAA,OAAO,aAAA,CAAa,uBAAA,CAAwB,MAAM,CAAA;AAAA,MACpD;AAEA,MAAA,OAAO,MAAA;AAAA,IACT,CAAC,CAAA,CACA,IAAA,CAAK,CAAA,MAAA,EAAA,GAAU,uBAAA,CAAc,MAAA,CAAO,MAAM,CAAC,CAAA,CAC3C,IAAA,CAAK,CAAA,MAAA,EAAA,GAAU;AACd,MAAA,IAAA,CAAK,KAAA,CAAM,OAAA,EAAS,MAAA;AACpB,MAAA,OAAO,MAAA;AAAA,IACT,CAAC,CAAA;AAAA,EACL;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,MAAM,KAAA,CAAA,EAAQ;AACZ,IAAA,GAAA,CAAI,IAAA,CAAK,KAAA,CAAM,KAAA,EAAO,OAAO,IAAA,CAAK,KAAA,CAAM,KAAA;AAExC,IAAA,OAAO,IAAA,CAAK,IAAA,CAAK,CAAA,CACd,IAAA,CAAK,CAAA,MAAA,EAAA,GAAU;AAId,MAAA,GAAA,CAAU,yCAAA,MAAgB,CAAA,EAAG;AAC3B,QAAA,OAAO,aAAA,CAAa,uBAAA,CAAwB,MAAM,CAAA;AAAA,MACpD;AAEA,MAAA,OAAO,MAAA;AAAA,IACT,CAAC,CAAA,CACA,IAAA,CAAK,CAAA,MAAA,EAAA,GAAU,uBAAA,CAAc,WAAA,CAAY,MAAM,CAAC,CAAA,CAChD,IAAA,CAAK,CAAA,YAAA,EAAA,GAAgB;AACpB,MAAA,IAAA,CAAK,KAAA,CAAM,MAAA,EAAQ,YAAA;AACnB,MAAA,OAAO,YAAA;AAAA,IACT,CAAC,CAAA;AAAA,EACL;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,MAAM,OAAA,CAAA,EAAqC;AACzC,IAAA,GAAA,CAAI,IAAA,CAAK,KAAA,CAAM,OAAA,EAAS,OAAO,IAAA,CAAK,KAAA,CAAM,OAAA;AAE1C,IAAA,OAAO,IAAA,CAAK,IAAA,CAAK,CAAA,CACd,IAAA,CAAK,MAAA,CAAM,MAAA,EAAA,GAAU;AAEpB,MAAA,OAAa,yCAAA,MAAgB,EAAA,EAAI,aAAA,CAAa,uBAAA,CAAwB,MAAM,EAAA,EAAI,MAAA;AAAA,IAClF,CAAC,CAAA,CACA,IAAA,CAAK,MAAA,CAAM,MAAA,EAAA,GAAU;AACpB,MAAA,GAAA,CAAI,CAAO,yCAAA,MAAgB,EAAA,GAAK,CAAO,yCAAA,MAAgB,CAAA,EAAG;AACxD,QAAA,MAAM,IAAI,KAAA,CAAM,6CAA6C,CAAA;AAAA,MAC/D,EAAA,KAAA,GAAA,CAAiB,yCAAA,MAAgB,CAAA,EAAG;AAClC,QAAA,OAAO,MAAA;AAAA,MACT;AAEA,MAAA,MAAM,YAAA,EAAc,QAAA,CAAS,MAAA,CAAO,OAAA,EAAS,EAAE,CAAA;AAC/C,MAAA,GAAA,CAAI,YAAA,IAAgB,CAAA,EAAG;AACrB,QAAA,MAAM,IAAI,KAAA,CAAM,8BAA8B,CAAA;AAAA,MAChD;AAEA,MAAA,OAAO,yBAAA,CACJ,UAAA,CAAW,MAAA,EAAQ,EAAE,OAAA,EAAS,KAAK,CAAC,CAAA,CACpC,IAAA,CAAK,CAAC,OAAA,EAAA,GAA2C,OAAA,CAAQ,OAAO,CAAA;AAAA,IACrE,CAAC,CAAA;AAAA,EACL;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,MAAM,QAAA,CACJ,KAAA,EAEI,CAAC,CAAA,EACU;AACf,IAAA,MAAM,cAAA,EAAgB,IAAA,CAAK,OAAA,GAAU,CAAC,CAAA;AACtC,IAAA,GAAA,CAAI,CAAC,aAAA,CAAc,QAAA,EAAU;AAC3B,MAAA,aAAA,CAAc,SAAA,EAAW,CAAC,CAAA;AAAA,IAC5B;AAEA,IAAA,aAAA,CAAc,QAAA,CAAS,eAAA,EAAiB,IAAA,CAAK,IAAA,CAAK,cAAA;AAElD,IAAA,OAAO,IAAA,CAAK,IAAA,CAAK,CAAA,CACd,IAAA,CAAK,MAAA,CAAM,MAAA,EAAA,GAAU;AAGpB,MAAA,OAAa,yCAAA,MAAgB,EAAA,EAAI,aAAA,CAAa,uBAAA,CAAwB,MAAM,EAAA,EAAI,MAAA;AAAA,IAClF,CAAC,CAAA,CACA,IAAA,CAAK,MAAA,CAAM,MAAA,EAAA,GAAU;AACpB,MAAA,GAAA,CAAI,CAAO,yCAAA,MAAgB,EAAA,GAAK,CAAO,yCAAA,MAAgB,CAAA,EAAG;AACxD,QAAA,MAAM,IAAI,KAAA,CAAM,6CAA6C,CAAA;AAAA,MAC/D,EAAA,KAAA,GAAA,CAAiB,yCAAA,MAAgB,CAAA,EAAG;AAClC,QAAA,MAAM,YAAA,EAAc,QAAA,CAAS,MAAA,CAAO,OAAA,EAAS,EAAE,CAAA;AAC/C,QAAA,GAAA,CAAI,YAAA,IAAgB,CAAA,EAAG;AACrB,UAAA,MAAM,IAAI,KAAA,CAAM,8BAA8B,CAAA;AAAA,QAChD;AAAA,MACF;AAUA,MAAA,MAAM,aAAA,EAAe,IAAA,CAAK,KAAA,CAAM,IAAA,CAAK,SAAA,CAAU,MAAM,CAAC,CAAA;AAEtD,MAAA,OAAO,uBAAA,CAAc,QAAA,CAAS,YAAA,EAAc,aAAa,CAAA,CAAE,IAAA,CAAK,CAAA,EAAA,GAAM;AAEpE,QAAA,OAAO,IAAA;AAAA,MACT,CAAC,CAAA;AAAA,IACH,CAAC,CAAA;AAAA,EACL;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,MAAM,OAAA,CAAA,EAAsG;AAC1G,IAAA,OAAO,IAAA,CAAK,IAAA,CAAK,CAAA,CAAE,IAAA,CAAK,CAAA,MAAA,EAAA,GAAU;AAChC,MAAA,OAAA,CAAc,oDAAA,MAA2B,CAAA,EAAG;AAAA,QAC1C,KAAK,SAAA;AACH,UAAA,OAAO;AAAA,YACL,aAAA,EAAe,SAAA;AAAA,YACf,OAAA,EAAU,MAAA,CAAyC;AAAA,UACrD,CAAA;AAAA,QAEF,KAAK,SAAA;AACH,UAAA,IAAI,QAAA,EAAU,SAAA;AACd,UAAA,GAAA,iBAAK,MAAA,2BAAQ,IAAA,6BAAiC,QAAA,EAAQ;AAIpD,YAAA,MAAM,MAAA,EAAA,iBAAS,MAAA,6BAAQ,MAAA,CAAA,CAAgC,MAAA,CAAO,KAAA;AAAA,cAC5D;AAAA,YACF,CAAA;AAEA,YAAA,GAAA,CAAI,KAAA,EAAO;AACT,cAAA,QAAA,EAAU,KAAA,CAAM,CAAC,CAAA;AAAA,YACnB;AAAA,UACF;AAEA,UAAA,OAAO;AAAA,YACL,aAAA,EAAe,SAAA;AAAA,YACf;AAAA,UACF,CAAA;AAAA,QAEF,KAAK,SAAA;AACH,UAAA,OAAO;AAAA,YACL,aAAA,EAAe,SAAA;AAAA,YACf,OAAA,EAAU,MAAA,CAAyC;AAAA,UACrD,CAAA;AAAA,QAEF,OAAA;AACE,UAAA,MAAM,IAAI,KAAA,CAAM,wBAAwB,CAAA;AAAA,MAC5C;AAAA,IACF,CAAC,CAAA;AAAA,EACH;AACF,CAAA;AD9EA;AACE;AACF,+BAAA","file":"/Users/erunion/code/readme/oas/packages/oas-normalize/dist/index.cjs","sourcesContent":[null,"import type { Options } from './lib/types.js';\nimport type { OpenAPI, OpenAPIV2, OpenAPIV3 } from 'openapi-types';\n\nimport fs from 'node:fs';\n\nimport openapiParser from '@readme/openapi-parser';\nimport postmanToOpenAPI from '@readme/postman-to-openapi';\nimport converter from 'swagger2openapi';\n\nimport * as utils from './lib/utils.js';\n\nexport default class OASNormalize {\n  cache: {\n    bundle?: OpenAPI.Document | false;\n    convert?: OpenAPI.Document | false;\n    deref?: OpenAPI.Document | false;\n    load?: Record<string, unknown> | false;\n  };\n\n  file: any;\n\n  opts: Options;\n\n  type: ReturnType<typeof utils.getType>;\n\n  constructor(file: any, opts?: Options) {\n    this.file = file;\n    this.opts = {\n      colorizeErrors: false,\n      enablePaths: false,\n      ...opts,\n    };\n\n    this.type = utils.getType(this.file);\n\n    this.cache = {\n      load: false,\n      bundle: false,\n      deref: false,\n    };\n  }\n\n  /**\n   * Load and return the API definition that `oas-normalize` was initialized with.\n   *\n   */\n  async load(): Promise<Record<string, unknown>> {\n    if (this.cache.load) return this.cache.load;\n\n    const resolve = (obj: Parameters<typeof utils.stringToJSON>[0]) => {\n      const ret = utils.stringToJSON(obj);\n      this.cache.load = ret;\n      return ret;\n    };\n\n    switch (this.type) {\n      case 'json':\n      case 'string-json':\n      case 'string-yaml':\n        return resolve(this.file);\n\n      case 'buffer':\n        return resolve(this.file.toString());\n\n      case 'url':\n        const { url, options } = utils.prepareURL(this.file);\n        const resp = await fetch(url, options).then(res => res.text());\n        return resolve(resp);\n\n      case 'path':\n        // Load a local file\n        if (!this.opts.enablePaths) {\n          throw new Error('Use `opts.enablePaths` to enable accessing local files.');\n        }\n\n        const contents = fs.readFileSync(this.file).toString();\n        if (!contents.trim()) {\n          throw new Error('No file contents found.');\n        }\n        return resolve(contents);\n\n      default:\n        throw new Error('Could not load this file.');\n    }\n  }\n\n  private static async convertPostmanToOpenAPI(schema: any) {\n    return postmanToOpenAPI(JSON.stringify(schema), undefined, { outputFormat: 'json', replaceVars: true }).then(\n      JSON.parse,\n    );\n  }\n\n  /**\n   * Bundle up the given API definition, resolving any external `$ref` pointers in the process.\n   *\n   */\n  async bundle() {\n    if (this.cache.bundle) return this.cache.bundle;\n\n    return this.load()\n      .then(schema => {\n        // Though Postman collections don't support `$ref` pointers for us to bundle we'll still\n        // upconvert it to an OpenAPI definition file so our returned dataset is always one of\n        // those for a Postman dataset.\n        if (utils.isPostman(schema)) {\n          return OASNormalize.convertPostmanToOpenAPI(schema);\n        }\n\n        return schema;\n      })\n      .then(schema => openapiParser.bundle(schema))\n      .then(bundle => {\n        this.cache.bundle = bundle;\n        return bundle;\n      });\n  }\n\n  /**\n   * Dereference the given API definition.\n   *\n   */\n  async deref() {\n    if (this.cache.deref) return this.cache.deref;\n\n    return this.load()\n      .then(schema => {\n        // Though Postman collections don't support `$ref` pointers for us to dereference we'll\n        // still upconvert it to an OpenAPI definition file so our returned dataset is always one\n        // of those for a Postman dataset.\n        if (utils.isPostman(schema)) {\n          return OASNormalize.convertPostmanToOpenAPI(schema);\n        }\n\n        return schema;\n      })\n      .then(schema => openapiParser.dereference(schema))\n      .then(dereferenced => {\n        this.cache.deref = dereferenced;\n        return dereferenced;\n      });\n  }\n\n  /**\n   * Convert a given API definition to OpenAPI if it is not already.\n   *\n   */\n  async convert(): Promise<OpenAPI.Document> {\n    if (this.cache.convert) return this.cache.convert;\n\n    return this.load()\n      .then(async schema => {\n        // If we have a Postman collection we need to convert it to OpenAPI.\n        return utils.isPostman(schema) ? OASNormalize.convertPostmanToOpenAPI(schema) : schema;\n      })\n      .then(async schema => {\n        if (!utils.isSwagger(schema) && !utils.isOpenAPI(schema)) {\n          throw new Error('The supplied API definition is unsupported.');\n        } else if (utils.isOpenAPI(schema)) {\n          return schema;\n        }\n\n        const baseVersion = parseInt(schema.swagger, 10);\n        if (baseVersion === 1) {\n          throw new Error('Swagger v1.2 is unsupported.');\n        }\n\n        return converter\n          .convertObj(schema, { anchors: true })\n          .then((options: { openapi: OpenAPI.Document }) => options.openapi);\n      });\n  }\n\n  /**\n   * Validate a given API definition.\n   *\n   * If supplied a Postman collection it will be converted to OpenAPI first and then run through\n   * standard OpenAPI validation.\n   *\n   */\n  async validate(\n    opts: {\n      parser?: openapiParser.Options;\n    } = {},\n  ): Promise<true> {\n    const parserOptions = opts.parser || {};\n    if (!parserOptions.validate) {\n      parserOptions.validate = {};\n    }\n\n    parserOptions.validate.colorizeErrors = this.opts.colorizeErrors;\n\n    return this.load()\n      .then(async schema => {\n        // Because we don't have something akin to `openapi-parser` for Postman collections we just\n        // always convert them to OpenAPI.\n        return utils.isPostman(schema) ? OASNormalize.convertPostmanToOpenAPI(schema) : schema;\n      })\n      .then(async schema => {\n        if (!utils.isSwagger(schema) && !utils.isOpenAPI(schema)) {\n          throw new Error('The supplied API definition is unsupported.');\n        } else if (utils.isSwagger(schema)) {\n          const baseVersion = parseInt(schema.swagger, 10);\n          if (baseVersion === 1) {\n            throw new Error('Swagger v1.2 is unsupported.');\n          }\n        }\n\n        /**\n         * `openapiParser.validate()` dereferences schemas at the same time as validation, mutating\n         * the supplied parameter in the process, and does not give us an option to disable this.\n         * As we already have a dereferencing method on this library, and this method just needs to\n         * tell us if the API definition is valid or not, we need to clone the schema before\n         * supplying it to `openapi-parser`.\n         */\n        // eslint-disable-next-line try-catch-failsafe/json-parse\n        const clonedSchema = JSON.parse(JSON.stringify(schema));\n\n        return openapiParser.validate(clonedSchema, parserOptions).then(() => {\n          // The API definition, whatever its format or specification, is valid.\n          return true;\n        });\n      });\n  }\n\n  /**\n   * Retrieve OpenAPI, Swagger, or Postman version information about the supplied API definition.\n   *\n   */\n  async version(): Promise<{ specification: 'openapi' | 'postman' | 'swagger'; version: string | 'unknown' }> {\n    return this.load().then(schema => {\n      switch (utils.getAPIDefinitionType(schema)) {\n        case 'openapi':\n          return {\n            specification: 'openapi',\n            version: (schema as unknown as OpenAPIV3.Document).openapi,\n          };\n\n        case 'postman':\n          let version = 'unknown';\n          if ((schema?.info as Record<string, string>)?.schema) {\n            // Though `info.schema` is required by the Postman spec there's no strictness to its\n            // contents so we'll do our best to extract a version out of this schema URL that they\n            // seem to usually match. If not we'll fallback to treating it as an `unknown` version.\n            const match = (schema?.info as Record<string, string>).schema.match(\n              /http(s?):\\/\\/schema.getpostman.com\\/json\\/collection\\/v([0-9.]+)\\//,\n            );\n\n            if (match) {\n              version = match[2];\n            }\n          }\n\n          return {\n            specification: 'postman',\n            version,\n          };\n\n        case 'swagger':\n          return {\n            specification: 'swagger',\n            version: (schema as unknown as OpenAPIV2.Document).swagger,\n          };\n\n        default:\n          throw new Error('Unknown file detected.');\n      }\n    });\n  }\n}\n"]}

package/dist/index.d.cts

@@ -6,6 +6,7 @@ import { getType } from './lib/utils.cjs';
 declare class OASNormalize {
     cache: {
         bundle?: OpenAPI.Document | false;
+        convert?: OpenAPI.Document | false;
         deref?: OpenAPI.Document | false;
         load?: Record<string, unknown> | false;
     };
@@ -14,13 +15,11 @@ declare class OASNormalize {
     type: ReturnType<typeof getType>;
     constructor(file: any, opts?: Options);
     /**
-     * @private
+     * Load and return the API definition that `oas-normalize` was initialized with.
+     *
      */
     load(): Promise<Record<string, unknown>>;
-    /**
-     * @private
-     */
-    static convertPostmanToOpenAPI(schema: any): Promise<any>;
+    private static convertPostmanToOpenAPI;
     /**
      * Bundle up the given API definition, resolving any external `$ref` pointers in the process.
      *
@@ -32,16 +31,20 @@ declare class OASNormalize {
      */
     deref(): Promise<OpenAPI.Document<{}>>;
     /**
-     * Validate, and potentially convert to OpenAPI, a given API definition.
+     * Convert a given API definition to OpenAPI if it is not already.
+     *
+     */
+    convert(): Promise<OpenAPI.Document>;
+    /**
+     * Validate a given API definition.
+     *
+     * If supplied a Postman collection it will be converted to OpenAPI first and then run through
+     * standard OpenAPI validation.
      *
      */
     validate(opts?: {
-        /**
-         * Automatically convert the supplied API definition to the latest version of OpenAPI.
-         */
-        convertToLatest?: boolean;
         parser?: openapiParser.Options;
-    }): Promise<OpenAPI.Document>;
+    }): Promise<true>;
     /**
      * Retrieve OpenAPI, Swagger, or Postman version information about the supplied API definition.
      *

package/dist/index.d.ts

@@ -6,6 +6,7 @@ import { getType } from './lib/utils.js';
 declare class OASNormalize {
     cache: {
         bundle?: OpenAPI.Document | false;
+        convert?: OpenAPI.Document | false;
         deref?: OpenAPI.Document | false;
         load?: Record<string, unknown> | false;
     };
@@ -14,13 +15,11 @@ declare class OASNormalize {
     type: ReturnType<typeof getType>;
     constructor(file: any, opts?: Options);
     /**
-     * @private
+     * Load and return the API definition that `oas-normalize` was initialized with.
+     *
      */
     load(): Promise<Record<string, unknown>>;
-    /**
-     * @private
-     */
-    static convertPostmanToOpenAPI(schema: any): Promise<any>;
+    private static convertPostmanToOpenAPI;
     /**
      * Bundle up the given API definition, resolving any external `$ref` pointers in the process.
      *
@@ -32,16 +31,20 @@ declare class OASNormalize {
      */
     deref(): Promise<OpenAPI.Document<{}>>;
     /**
-     * Validate, and potentially convert to OpenAPI, a given API definition.
+     * Convert a given API definition to OpenAPI if it is not already.
+     *
+     */
+    convert(): Promise<OpenAPI.Document>;
+    /**
+     * Validate a given API definition.
+     *
+     * If supplied a Postman collection it will be converted to OpenAPI first and then run through
+     * standard OpenAPI validation.
      *
      */
     validate(opts?: {
-        /**
-         * Automatically convert the supplied API definition to the latest version of OpenAPI.
-         */
-        convertToLatest?: boolean;
         parser?: openapiParser.Options;
-    }): Promise<OpenAPI.Document>;
+    }): Promise<true>;
     /**
      * Retrieve OpenAPI, Swagger, or Postman version information about the supplied API definition.
      *

package/dist/index.js

@@ -4,9 +4,9 @@ import {
   isOpenAPI,
   isPostman,
   isSwagger,
-  normalizeURL,
+  prepareURL,
   stringToJSON
-} from "./chunk-XOS5M44Y.js";
+} from "./chunk-J322YOXV.js";
 
 // src/index.ts
 import fs from "node:fs";
@@ -29,14 +29,15 @@ var OASNormalize = class _OASNormalize {
     };
   }
   /**
-   * @private
+   * Load and return the API definition that `oas-normalize` was initialized with.
+   *
    */
   async load() {
-    if (this.cache.load) return Promise.resolve(this.cache.load);
+    if (this.cache.load) return this.cache.load;
     const resolve = (obj) => {
       const ret = stringToJSON(obj);
       this.cache.load = ret;
-      return Promise.resolve(ret);
+      return ret;
     };
     switch (this.type) {
       case "json":
@@ -46,24 +47,22 @@ var OASNormalize = class _OASNormalize {
       case "buffer":
         return resolve(this.file.toString());
       case "url":
-        const resp = await fetch(normalizeURL(this.file)).then((res) => res.text());
+        const { url, options } = prepareURL(this.file);
+        const resp = await fetch(url, options).then((res) => res.text());
         return resolve(resp);
       case "path":
         if (!this.opts.enablePaths) {
-          return Promise.reject(new Error("Use `opts.enablePaths` to enable accessing local files."));
+          throw new Error("Use `opts.enablePaths` to enable accessing local files.");
         }
         const contents = fs.readFileSync(this.file).toString();
         if (!contents.trim()) {
-          return Promise.reject(new Error("No file contents found."));
+          throw new Error("No file contents found.");
         }
         return resolve(contents);
       default:
-        return Promise.reject(new Error("Could not load this file."));
+        throw new Error("Could not load this file.");
     }
   }
-  /**
-   * @private
-   */
   static async convertPostmanToOpenAPI(schema) {
     return postmanToOpenAPI(JSON.stringify(schema), void 0, { outputFormat: "json", replaceVars: true }).then(
       JSON.parse
@@ -74,7 +73,7 @@ var OASNormalize = class _OASNormalize {
    *
    */
   async bundle() {
-    if (this.cache.bundle) return Promise.resolve(this.cache.bundle);
+    if (this.cache.bundle) return this.cache.bundle;
     return this.load().then((schema) => {
       if (isPostman(schema)) {
         return _OASNormalize.convertPostmanToOpenAPI(schema);
@@ -90,7 +89,7 @@ var OASNormalize = class _OASNormalize {
    *
    */
   async deref() {
-    if (this.cache.deref) return Promise.resolve(this.cache.deref);
+    if (this.cache.deref) return this.cache.deref;
     return this.load().then((schema) => {
       if (isPostman(schema)) {
         return _OASNormalize.convertPostmanToOpenAPI(schema);
@@ -102,37 +101,54 @@ var OASNormalize = class _OASNormalize {
     });
   }
   /**
-   * Validate, and potentially convert to OpenAPI, a given API definition.
+   * Convert a given API definition to OpenAPI if it is not already.
+   *
+   */
+  async convert() {
+    if (this.cache.convert) return this.cache.convert;
+    return this.load().then(async (schema) => {
+      return isPostman(schema) ? _OASNormalize.convertPostmanToOpenAPI(schema) : schema;
+    }).then(async (schema) => {
+      if (!isSwagger(schema) && !isOpenAPI(schema)) {
+        throw new Error("The supplied API definition is unsupported.");
+      } else if (isOpenAPI(schema)) {
+        return schema;
+      }
+      const baseVersion = parseInt(schema.swagger, 10);
+      if (baseVersion === 1) {
+        throw new Error("Swagger v1.2 is unsupported.");
+      }
+      return converter.convertObj(schema, { anchors: true }).then((options) => options.openapi);
+    });
+  }
+  /**
+   * Validate a given API definition.
+   *
+   * If supplied a Postman collection it will be converted to OpenAPI first and then run through
+   * standard OpenAPI validation.
    *
    */
-  async validate(opts = { convertToLatest: false }) {
-    const convertToLatest = opts.convertToLatest;
+  async validate(opts = {}) {
     const parserOptions = opts.parser || {};
     if (!parserOptions.validate) {
       parserOptions.validate = {};
     }
     parserOptions.validate.colorizeErrors = this.opts.colorizeErrors;
     return this.load().then(async (schema) => {
-      if (!isPostman(schema)) {
-        return schema;
-      }
-      return _OASNormalize.convertPostmanToOpenAPI(schema);
+      return isPostman(schema) ? _OASNormalize.convertPostmanToOpenAPI(schema) : schema;
     }).then(async (schema) => {
       if (!isSwagger(schema) && !isOpenAPI(schema)) {
-        return Promise.reject(new Error("The supplied API definition is unsupported."));
+        throw new Error("The supplied API definition is unsupported.");
       } else if (isSwagger(schema)) {
         const baseVersion = parseInt(schema.swagger, 10);
         if (baseVersion === 1) {
-          return Promise.reject(new Error("Swagger v1.2 is unsupported."));
+          throw new Error("Swagger v1.2 is unsupported.");
         }
       }
       const clonedSchema = JSON.parse(JSON.stringify(schema));
       return openapiParser.validate(clonedSchema, parserOptions).then(() => {
-        if (!convertToLatest || isOpenAPI(schema)) {
-          return schema;
-        }
-        return converter.convertObj(schema, { anchors: true }).then((options) => options.openapi);
-      }).catch((err) => Promise.reject(err));
+        return true;
+      });
     });
   }
   /**

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/index.ts"],"sourcesContent":["import type { Options } from './lib/types.js';\nimport type { OpenAPI, OpenAPIV2, OpenAPIV3 } from 'openapi-types';\n\nimport fs from 'node:fs';\n\nimport openapiParser from '@readme/openapi-parser';\nimport postmanToOpenAPI from '@readme/postman-to-openapi';\nimport converter from 'swagger2openapi';\n\nimport * as utils from './lib/utils.js';\n\nexport default class OASNormalize {\n  cache: {\n    bundle?: OpenAPI.Document | false;\n    deref?: OpenAPI.Document | false;\n    load?: Record<string, unknown> | false;\n  };\n\n  file: any;\n\n  opts: Options;\n\n  type: ReturnType<typeof utils.getType>;\n\n  constructor(file: any, opts?: Options) {\n    this.file = file;\n    this.opts = {\n      colorizeErrors: false,\n      enablePaths: false,\n      ...opts,\n    };\n\n    this.type = utils.getType(this.file);\n\n    this.cache = {\n      load: false,\n      bundle: false,\n      deref: false,\n    };\n  }\n\n  /**\n   * @private\n   */\n  async load(): Promise<Record<string, unknown>> {\n    if (this.cache.load) return Promise.resolve(this.cache.load);\n\n    const resolve = (obj: Parameters<typeof utils.stringToJSON>[0]) => {\n      const ret = utils.stringToJSON(obj);\n      this.cache.load = ret;\n      return Promise.resolve(ret);\n    };\n\n    switch (this.type) {\n      case 'json':\n      case 'string-json':\n      case 'string-yaml':\n        return resolve(this.file);\n\n      case 'buffer':\n        return resolve(this.file.toString());\n\n      case 'url':\n        const resp = await fetch(utils.normalizeURL(this.file)).then(res => res.text());\n        return resolve(resp);\n\n      case 'path':\n        // Load a local file\n        if (!this.opts.enablePaths) {\n          return Promise.reject(new Error('Use `opts.enablePaths` to enable accessing local files.'));\n        }\n\n        const contents = fs.readFileSync(this.file).toString();\n        if (!contents.trim()) {\n          return Promise.reject(new Error('No file contents found.'));\n        }\n        return resolve(contents);\n\n      default:\n        return Promise.reject(new Error('Could not load this file.'));\n    }\n  }\n\n  /**\n   * @private\n   */\n  static async convertPostmanToOpenAPI(schema: any) {\n    return postmanToOpenAPI(JSON.stringify(schema), undefined, { outputFormat: 'json', replaceVars: true }).then(\n      JSON.parse,\n    );\n  }\n\n  /**\n   * Bundle up the given API definition, resolving any external `$ref` pointers in the process.\n   *\n   */\n  async bundle() {\n    if (this.cache.bundle) return Promise.resolve(this.cache.bundle);\n\n    return this.load()\n      .then(schema => {\n        // Though Postman collections don't support `$ref` pointers for us to bundle we'll still\n        // upconvert it to an OpenAPI definition file so our returned dataset is always one of\n        // those for a Postman dataset.\n        if (utils.isPostman(schema)) {\n          return OASNormalize.convertPostmanToOpenAPI(schema);\n        }\n\n        return schema;\n      })\n      .then(schema => openapiParser.bundle(schema))\n      .then(bundle => {\n        this.cache.bundle = bundle;\n        return bundle;\n      });\n  }\n\n  /**\n   * Dereference the given API definition.\n   *\n   */\n  async deref() {\n    if (this.cache.deref) return Promise.resolve(this.cache.deref);\n\n    return this.load()\n      .then(schema => {\n        // Though Postman collections don't support `$ref` pointers for us to dereference we'll\n        // still upconvert it to an OpenAPI definition file so our returned dataset is always one\n        // of those for a Postman dataset.\n        if (utils.isPostman(schema)) {\n          return OASNormalize.convertPostmanToOpenAPI(schema);\n        }\n\n        return schema;\n      })\n      .then(schema => openapiParser.dereference(schema))\n      .then(dereferenced => {\n        this.cache.deref = dereferenced;\n        return dereferenced;\n      });\n  }\n\n  /**\n   * Validate, and potentially convert to OpenAPI, a given API definition.\n   *\n   */\n  async validate(\n    opts: {\n      /**\n       * Automatically convert the supplied API definition to the latest version of OpenAPI.\n       */\n      convertToLatest?: boolean;\n      parser?: openapiParser.Options;\n    } = { convertToLatest: false },\n  ): Promise<OpenAPI.Document> {\n    const convertToLatest = opts.convertToLatest;\n    const parserOptions = opts.parser || {};\n    if (!parserOptions.validate) {\n      parserOptions.validate = {};\n    }\n\n    parserOptions.validate.colorizeErrors = this.opts.colorizeErrors;\n\n    return this.load()\n      .then(async schema => {\n        if (!utils.isPostman(schema)) {\n          return schema;\n        }\n\n        return OASNormalize.convertPostmanToOpenAPI(schema);\n      })\n      .then(async schema => {\n        if (!utils.isSwagger(schema) && !utils.isOpenAPI(schema)) {\n          return Promise.reject(new Error('The supplied API definition is unsupported.'));\n        } else if (utils.isSwagger(schema)) {\n          const baseVersion = parseInt(schema.swagger, 10);\n          if (baseVersion === 1) {\n            return Promise.reject(new Error('Swagger v1.2 is unsupported.'));\n          }\n        }\n\n        /**\n         * `openapiParser.validate()` dereferences schemas at the same time as validation and does\n         * not give us an option to disable this. Since all we already have a dereferencing method\n         * on this library and our `validate()` method here just needs to tell us if the definition\n         * is valid or not we need to clone it before passing it over to `openapi-parser` so as to\n         * not run into pass-by-reference problems.\n         */\n        // eslint-disable-next-line try-catch-failsafe/json-parse\n        const clonedSchema = JSON.parse(JSON.stringify(schema));\n\n        return openapiParser\n          .validate(clonedSchema, parserOptions)\n          .then(() => {\n            if (!convertToLatest || utils.isOpenAPI(schema)) {\n              return schema;\n            }\n\n            return converter\n              .convertObj(schema, { anchors: true })\n              .then((options: { openapi: OpenAPI.Document }) => options.openapi);\n          })\n          .catch(err => Promise.reject(err));\n      });\n  }\n\n  /**\n   * Retrieve OpenAPI, Swagger, or Postman version information about the supplied API definition.\n   *\n   */\n  async version(): Promise<{ specification: 'openapi' | 'postman' | 'swagger'; version: string | 'unknown' }> {\n    return this.load().then(schema => {\n      switch (utils.getAPIDefinitionType(schema)) {\n        case 'openapi':\n          return {\n            specification: 'openapi',\n            version: (schema as unknown as OpenAPIV3.Document).openapi,\n          };\n\n        case 'postman':\n          let version = 'unknown';\n          if ((schema?.info as Record<string, string>)?.schema) {\n            // Though `info.schema` is required by the Postman spec there's no strictness to its\n            // contents so we'll do our best to extract a version out of this schema URL that they\n            // seem to usually match. If not we'll fallback to treating it as an `unknown` version.\n            const match = (schema?.info as Record<string, string>).schema.match(\n              /http(s?):\\/\\/schema.getpostman.com\\/json\\/collection\\/v([0-9.]+)\\//,\n            );\n\n            if (match) {\n              version = match[2];\n            }\n          }\n\n          return {\n            specification: 'postman',\n            version,\n          };\n\n        case 'swagger':\n          return {\n            specification: 'swagger',\n            version: (schema as unknown as OpenAPIV2.Document).swagger,\n          };\n\n        default:\n          throw new Error('Unknown file detected.');\n      }\n    });\n  }\n}\n"],"mappings":";;;;;;;;;;;AAGA,OAAO,QAAQ;AAEf,OAAO,mBAAmB;AAC1B,OAAO,sBAAsB;AAC7B,OAAO,eAAe;AAItB,IAAqB,eAArB,MAAqB,cAAa;AAAA,EAahC,YAAY,MAAW,MAAgB;AACrC,SAAK,OAAO;AACZ,SAAK,OAAO;AAAA,MACV,gBAAgB;AAAA,MAChB,aAAa;AAAA,MACb,GAAG;AAAA,IACL;AAEA,SAAK,OAAa,QAAQ,KAAK,IAAI;AAEnC,SAAK,QAAQ;AAAA,MACX,MAAM;AAAA,MACN,QAAQ;AAAA,MACR,OAAO;AAAA,IACT;AAAA,EACF;AAAA;AAAA;AAAA;AAAA,EAKA,MAAM,OAAyC;AAC7C,QAAI,KAAK,MAAM,KAAM,QAAO,QAAQ,QAAQ,KAAK,MAAM,IAAI;AAE3D,UAAM,UAAU,CAAC,QAAkD;AACjE,YAAM,MAAY,aAAa,GAAG;AAClC,WAAK,MAAM,OAAO;AAClB,aAAO,QAAQ,QAAQ,GAAG;AAAA,IAC5B;AAEA,YAAQ,KAAK,MAAM;AAAA,MACjB,KAAK;AAAA,MACL,KAAK;AAAA,MACL,KAAK;AACH,eAAO,QAAQ,KAAK,IAAI;AAAA,MAE1B,KAAK;AACH,eAAO,QAAQ,KAAK,KAAK,SAAS,CAAC;AAAA,MAErC,KAAK;AACH,cAAM,OAAO,MAAM,MAAY,aAAa,KAAK,IAAI,CAAC,EAAE,KAAK,SAAO,IAAI,KAAK,CAAC;AAC9E,eAAO,QAAQ,IAAI;AAAA,MAErB,KAAK;AAEH,YAAI,CAAC,KAAK,KAAK,aAAa;AAC1B,iBAAO,QAAQ,OAAO,IAAI,MAAM,yDAAyD,CAAC;AAAA,QAC5F;AAEA,cAAM,WAAW,GAAG,aAAa,KAAK,IAAI,EAAE,SAAS;AACrD,YAAI,CAAC,SAAS,KAAK,GAAG;AACpB,iBAAO,QAAQ,OAAO,IAAI,MAAM,yBAAyB,CAAC;AAAA,QAC5D;AACA,eAAO,QAAQ,QAAQ;AAAA,MAEzB;AACE,eAAO,QAAQ,OAAO,IAAI,MAAM,2BAA2B,CAAC;AAAA,IAChE;AAAA,EACF;AAAA;AAAA;AAAA;AAAA,EAKA,aAAa,wBAAwB,QAAa;AAChD,WAAO,iBAAiB,KAAK,UAAU,MAAM,GAAG,QAAW,EAAE,cAAc,QAAQ,aAAa,KAAK,CAAC,EAAE;AAAA,MACtG,KAAK;AAAA,IACP;AAAA,EACF;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,MAAM,SAAS;AACb,QAAI,KAAK,MAAM,OAAQ,QAAO,QAAQ,QAAQ,KAAK,MAAM,MAAM;AAE/D,WAAO,KAAK,KAAK,EACd,KAAK,YAAU;AAId,UAAU,UAAU,MAAM,GAAG;AAC3B,eAAO,cAAa,wBAAwB,MAAM;AAAA,MACpD;AAEA,aAAO;AAAA,IACT,CAAC,EACA,KAAK,YAAU,cAAc,OAAO,MAAM,CAAC,EAC3C,KAAK,YAAU;AACd,WAAK,MAAM,SAAS;AACpB,aAAO;AAAA,IACT,CAAC;AAAA,EACL;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,MAAM,QAAQ;AACZ,QAAI,KAAK,MAAM,MAAO,QAAO,QAAQ,QAAQ,KAAK,MAAM,KAAK;AAE7D,WAAO,KAAK,KAAK,EACd,KAAK,YAAU;AAId,UAAU,UAAU,MAAM,GAAG;AAC3B,eAAO,cAAa,wBAAwB,MAAM;AAAA,MACpD;AAEA,aAAO;AAAA,IACT,CAAC,EACA,KAAK,YAAU,cAAc,YAAY,MAAM,CAAC,EAChD,KAAK,kBAAgB;AACpB,WAAK,MAAM,QAAQ;AACnB,aAAO;AAAA,IACT,CAAC;AAAA,EACL;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,MAAM,SACJ,OAMI,EAAE,iBAAiB,MAAM,GACF;AAC3B,UAAM,kBAAkB,KAAK;AAC7B,UAAM,gBAAgB,KAAK,UAAU,CAAC;AACtC,QAAI,CAAC,cAAc,UAAU;AAC3B,oBAAc,WAAW,CAAC;AAAA,IAC5B;AAEA,kBAAc,SAAS,iBAAiB,KAAK,KAAK;AAElD,WAAO,KAAK,KAAK,EACd,KAAK,OAAM,WAAU;AACpB,UAAI,CAAO,UAAU,MAAM,GAAG;AAC5B,eAAO;AAAA,MACT;AAEA,aAAO,cAAa,wBAAwB,MAAM;AAAA,IACpD,CAAC,EACA,KAAK,OAAM,WAAU;AACpB,UAAI,CAAO,UAAU,MAAM,KAAK,CAAO,UAAU,MAAM,GAAG;AACxD,eAAO,QAAQ,OAAO,IAAI,MAAM,6CAA6C,CAAC;AAAA,MAChF,WAAiB,UAAU,MAAM,GAAG;AAClC,cAAM,cAAc,SAAS,OAAO,SAAS,EAAE;AAC/C,YAAI,gBAAgB,GAAG;AACrB,iBAAO,QAAQ,OAAO,IAAI,MAAM,8BAA8B,CAAC;AAAA,QACjE;AAAA,MACF;AAUA,YAAM,eAAe,KAAK,MAAM,KAAK,UAAU,MAAM,CAAC;AAEtD,aAAO,cACJ,SAAS,cAAc,aAAa,EACpC,KAAK,MAAM;AACV,YAAI,CAAC,mBAAyB,UAAU,MAAM,GAAG;AAC/C,iBAAO;AAAA,QACT;AAEA,eAAO,UACJ,WAAW,QAAQ,EAAE,SAAS,KAAK,CAAC,EACpC,KAAK,CAAC,YAA2C,QAAQ,OAAO;AAAA,MACrE,CAAC,EACA,MAAM,SAAO,QAAQ,OAAO,GAAG,CAAC;AAAA,IACrC,CAAC;AAAA,EACL;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,MAAM,UAAsG;AAC1G,WAAO,KAAK,KAAK,EAAE,KAAK,YAAU;AAChC,cAAc,qBAAqB,MAAM,GAAG;AAAA,QAC1C,KAAK;AACH,iBAAO;AAAA,YACL,eAAe;AAAA,YACf,SAAU,OAAyC;AAAA,UACrD;AAAA,QAEF,KAAK;AACH,cAAI,UAAU;AACd,cAAK,QAAQ,MAAiC,QAAQ;AAIpD,kBAAM,SAAS,QAAQ,MAAgC,OAAO;AAAA,cAC5D;AAAA,YACF;AAEA,gBAAI,OAAO;AACT,wBAAU,MAAM,CAAC;AAAA,YACnB;AAAA,UACF;AAEA,iBAAO;AAAA,YACL,eAAe;AAAA,YACf;AAAA,UACF;AAAA,QAEF,KAAK;AACH,iBAAO;AAAA,YACL,eAAe;AAAA,YACf,SAAU,OAAyC;AAAA,UACrD;AAAA,QAEF;AACE,gBAAM,IAAI,MAAM,wBAAwB;AAAA,MAC5C;AAAA,IACF,CAAC;AAAA,EACH;AACF;","names":[]}
+{"version":3,"sources":["../src/index.ts"],"sourcesContent":["import type { Options } from './lib/types.js';\nimport type { OpenAPI, OpenAPIV2, OpenAPIV3 } from 'openapi-types';\n\nimport fs from 'node:fs';\n\nimport openapiParser from '@readme/openapi-parser';\nimport postmanToOpenAPI from '@readme/postman-to-openapi';\nimport converter from 'swagger2openapi';\n\nimport * as utils from './lib/utils.js';\n\nexport default class OASNormalize {\n  cache: {\n    bundle?: OpenAPI.Document | false;\n    convert?: OpenAPI.Document | false;\n    deref?: OpenAPI.Document | false;\n    load?: Record<string, unknown> | false;\n  };\n\n  file: any;\n\n  opts: Options;\n\n  type: ReturnType<typeof utils.getType>;\n\n  constructor(file: any, opts?: Options) {\n    this.file = file;\n    this.opts = {\n      colorizeErrors: false,\n      enablePaths: false,\n      ...opts,\n    };\n\n    this.type = utils.getType(this.file);\n\n    this.cache = {\n      load: false,\n      bundle: false,\n      deref: false,\n    };\n  }\n\n  /**\n   * Load and return the API definition that `oas-normalize` was initialized with.\n   *\n   */\n  async load(): Promise<Record<string, unknown>> {\n    if (this.cache.load) return this.cache.load;\n\n    const resolve = (obj: Parameters<typeof utils.stringToJSON>[0]) => {\n      const ret = utils.stringToJSON(obj);\n      this.cache.load = ret;\n      return ret;\n    };\n\n    switch (this.type) {\n      case 'json':\n      case 'string-json':\n      case 'string-yaml':\n        return resolve(this.file);\n\n      case 'buffer':\n        return resolve(this.file.toString());\n\n      case 'url':\n        const { url, options } = utils.prepareURL(this.file);\n        const resp = await fetch(url, options).then(res => res.text());\n        return resolve(resp);\n\n      case 'path':\n        // Load a local file\n        if (!this.opts.enablePaths) {\n          throw new Error('Use `opts.enablePaths` to enable accessing local files.');\n        }\n\n        const contents = fs.readFileSync(this.file).toString();\n        if (!contents.trim()) {\n          throw new Error('No file contents found.');\n        }\n        return resolve(contents);\n\n      default:\n        throw new Error('Could not load this file.');\n    }\n  }\n\n  private static async convertPostmanToOpenAPI(schema: any) {\n    return postmanToOpenAPI(JSON.stringify(schema), undefined, { outputFormat: 'json', replaceVars: true }).then(\n      JSON.parse,\n    );\n  }\n\n  /**\n   * Bundle up the given API definition, resolving any external `$ref` pointers in the process.\n   *\n   */\n  async bundle() {\n    if (this.cache.bundle) return this.cache.bundle;\n\n    return this.load()\n      .then(schema => {\n        // Though Postman collections don't support `$ref` pointers for us to bundle we'll still\n        // upconvert it to an OpenAPI definition file so our returned dataset is always one of\n        // those for a Postman dataset.\n        if (utils.isPostman(schema)) {\n          return OASNormalize.convertPostmanToOpenAPI(schema);\n        }\n\n        return schema;\n      })\n      .then(schema => openapiParser.bundle(schema))\n      .then(bundle => {\n        this.cache.bundle = bundle;\n        return bundle;\n      });\n  }\n\n  /**\n   * Dereference the given API definition.\n   *\n   */\n  async deref() {\n    if (this.cache.deref) return this.cache.deref;\n\n    return this.load()\n      .then(schema => {\n        // Though Postman collections don't support `$ref` pointers for us to dereference we'll\n        // still upconvert it to an OpenAPI definition file so our returned dataset is always one\n        // of those for a Postman dataset.\n        if (utils.isPostman(schema)) {\n          return OASNormalize.convertPostmanToOpenAPI(schema);\n        }\n\n        return schema;\n      })\n      .then(schema => openapiParser.dereference(schema))\n      .then(dereferenced => {\n        this.cache.deref = dereferenced;\n        return dereferenced;\n      });\n  }\n\n  /**\n   * Convert a given API definition to OpenAPI if it is not already.\n   *\n   */\n  async convert(): Promise<OpenAPI.Document> {\n    if (this.cache.convert) return this.cache.convert;\n\n    return this.load()\n      .then(async schema => {\n        // If we have a Postman collection we need to convert it to OpenAPI.\n        return utils.isPostman(schema) ? OASNormalize.convertPostmanToOpenAPI(schema) : schema;\n      })\n      .then(async schema => {\n        if (!utils.isSwagger(schema) && !utils.isOpenAPI(schema)) {\n          throw new Error('The supplied API definition is unsupported.');\n        } else if (utils.isOpenAPI(schema)) {\n          return schema;\n        }\n\n        const baseVersion = parseInt(schema.swagger, 10);\n        if (baseVersion === 1) {\n          throw new Error('Swagger v1.2 is unsupported.');\n        }\n\n        return converter\n          .convertObj(schema, { anchors: true })\n          .then((options: { openapi: OpenAPI.Document }) => options.openapi);\n      });\n  }\n\n  /**\n   * Validate a given API definition.\n   *\n   * If supplied a Postman collection it will be converted to OpenAPI first and then run through\n   * standard OpenAPI validation.\n   *\n   */\n  async validate(\n    opts: {\n      parser?: openapiParser.Options;\n    } = {},\n  ): Promise<true> {\n    const parserOptions = opts.parser || {};\n    if (!parserOptions.validate) {\n      parserOptions.validate = {};\n    }\n\n    parserOptions.validate.colorizeErrors = this.opts.colorizeErrors;\n\n    return this.load()\n      .then(async schema => {\n        // Because we don't have something akin to `openapi-parser` for Postman collections we just\n        // always convert them to OpenAPI.\n        return utils.isPostman(schema) ? OASNormalize.convertPostmanToOpenAPI(schema) : schema;\n      })\n      .then(async schema => {\n        if (!utils.isSwagger(schema) && !utils.isOpenAPI(schema)) {\n          throw new Error('The supplied API definition is unsupported.');\n        } else if (utils.isSwagger(schema)) {\n          const baseVersion = parseInt(schema.swagger, 10);\n          if (baseVersion === 1) {\n            throw new Error('Swagger v1.2 is unsupported.');\n          }\n        }\n\n        /**\n         * `openapiParser.validate()` dereferences schemas at the same time as validation, mutating\n         * the supplied parameter in the process, and does not give us an option to disable this.\n         * As we already have a dereferencing method on this library, and this method just needs to\n         * tell us if the API definition is valid or not, we need to clone the schema before\n         * supplying it to `openapi-parser`.\n         */\n        // eslint-disable-next-line try-catch-failsafe/json-parse\n        const clonedSchema = JSON.parse(JSON.stringify(schema));\n\n        return openapiParser.validate(clonedSchema, parserOptions).then(() => {\n          // The API definition, whatever its format or specification, is valid.\n          return true;\n        });\n      });\n  }\n\n  /**\n   * Retrieve OpenAPI, Swagger, or Postman version information about the supplied API definition.\n   *\n   */\n  async version(): Promise<{ specification: 'openapi' | 'postman' | 'swagger'; version: string | 'unknown' }> {\n    return this.load().then(schema => {\n      switch (utils.getAPIDefinitionType(schema)) {\n        case 'openapi':\n          return {\n            specification: 'openapi',\n            version: (schema as unknown as OpenAPIV3.Document).openapi,\n          };\n\n        case 'postman':\n          let version = 'unknown';\n          if ((schema?.info as Record<string, string>)?.schema) {\n            // Though `info.schema` is required by the Postman spec there's no strictness to its\n            // contents so we'll do our best to extract a version out of this schema URL that they\n            // seem to usually match. If not we'll fallback to treating it as an `unknown` version.\n            const match = (schema?.info as Record<string, string>).schema.match(\n              /http(s?):\\/\\/schema.getpostman.com\\/json\\/collection\\/v([0-9.]+)\\//,\n            );\n\n            if (match) {\n              version = match[2];\n            }\n          }\n\n          return {\n            specification: 'postman',\n            version,\n          };\n\n        case 'swagger':\n          return {\n            specification: 'swagger',\n            version: (schema as unknown as OpenAPIV2.Document).swagger,\n          };\n\n        default:\n          throw new Error('Unknown file detected.');\n      }\n    });\n  }\n}\n"],"mappings":";;;;;;;;;;;AAGA,OAAO,QAAQ;AAEf,OAAO,mBAAmB;AAC1B,OAAO,sBAAsB;AAC7B,OAAO,eAAe;AAItB,IAAqB,eAArB,MAAqB,cAAa;AAAA,EAchC,YAAY,MAAW,MAAgB;AACrC,SAAK,OAAO;AACZ,SAAK,OAAO;AAAA,MACV,gBAAgB;AAAA,MAChB,aAAa;AAAA,MACb,GAAG;AAAA,IACL;AAEA,SAAK,OAAa,QAAQ,KAAK,IAAI;AAEnC,SAAK,QAAQ;AAAA,MACX,MAAM;AAAA,MACN,QAAQ;AAAA,MACR,OAAO;AAAA,IACT;AAAA,EACF;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,MAAM,OAAyC;AAC7C,QAAI,KAAK,MAAM,KAAM,QAAO,KAAK,MAAM;AAEvC,UAAM,UAAU,CAAC,QAAkD;AACjE,YAAM,MAAY,aAAa,GAAG;AAClC,WAAK,MAAM,OAAO;AAClB,aAAO;AAAA,IACT;AAEA,YAAQ,KAAK,MAAM;AAAA,MACjB,KAAK;AAAA,MACL,KAAK;AAAA,MACL,KAAK;AACH,eAAO,QAAQ,KAAK,IAAI;AAAA,MAE1B,KAAK;AACH,eAAO,QAAQ,KAAK,KAAK,SAAS,CAAC;AAAA,MAErC,KAAK;AACH,cAAM,EAAE,KAAK,QAAQ,IAAU,WAAW,KAAK,IAAI;AACnD,cAAM,OAAO,MAAM,MAAM,KAAK,OAAO,EAAE,KAAK,SAAO,IAAI,KAAK,CAAC;AAC7D,eAAO,QAAQ,IAAI;AAAA,MAErB,KAAK;AAEH,YAAI,CAAC,KAAK,KAAK,aAAa;AAC1B,gBAAM,IAAI,MAAM,yDAAyD;AAAA,QAC3E;AAEA,cAAM,WAAW,GAAG,aAAa,KAAK,IAAI,EAAE,SAAS;AACrD,YAAI,CAAC,SAAS,KAAK,GAAG;AACpB,gBAAM,IAAI,MAAM,yBAAyB;AAAA,QAC3C;AACA,eAAO,QAAQ,QAAQ;AAAA,MAEzB;AACE,cAAM,IAAI,MAAM,2BAA2B;AAAA,IAC/C;AAAA,EACF;AAAA,EAEA,aAAqB,wBAAwB,QAAa;AACxD,WAAO,iBAAiB,KAAK,UAAU,MAAM,GAAG,QAAW,EAAE,cAAc,QAAQ,aAAa,KAAK,CAAC,EAAE;AAAA,MACtG,KAAK;AAAA,IACP;AAAA,EACF;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,MAAM,SAAS;AACb,QAAI,KAAK,MAAM,OAAQ,QAAO,KAAK,MAAM;AAEzC,WAAO,KAAK,KAAK,EACd,KAAK,YAAU;AAId,UAAU,UAAU,MAAM,GAAG;AAC3B,eAAO,cAAa,wBAAwB,MAAM;AAAA,MACpD;AAEA,aAAO;AAAA,IACT,CAAC,EACA,KAAK,YAAU,cAAc,OAAO,MAAM,CAAC,EAC3C,KAAK,YAAU;AACd,WAAK,MAAM,SAAS;AACpB,aAAO;AAAA,IACT,CAAC;AAAA,EACL;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,MAAM,QAAQ;AACZ,QAAI,KAAK,MAAM,MAAO,QAAO,KAAK,MAAM;AAExC,WAAO,KAAK,KAAK,EACd,KAAK,YAAU;AAId,UAAU,UAAU,MAAM,GAAG;AAC3B,eAAO,cAAa,wBAAwB,MAAM;AAAA,MACpD;AAEA,aAAO;AAAA,IACT,CAAC,EACA,KAAK,YAAU,cAAc,YAAY,MAAM,CAAC,EAChD,KAAK,kBAAgB;AACpB,WAAK,MAAM,QAAQ;AACnB,aAAO;AAAA,IACT,CAAC;AAAA,EACL;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,MAAM,UAAqC;AACzC,QAAI,KAAK,MAAM,QAAS,QAAO,KAAK,MAAM;AAE1C,WAAO,KAAK,KAAK,EACd,KAAK,OAAM,WAAU;AAEpB,aAAa,UAAU,MAAM,IAAI,cAAa,wBAAwB,MAAM,IAAI;AAAA,IAClF,CAAC,EACA,KAAK,OAAM,WAAU;AACpB,UAAI,CAAO,UAAU,MAAM,KAAK,CAAO,UAAU,MAAM,GAAG;AACxD,cAAM,IAAI,MAAM,6CAA6C;AAAA,MAC/D,WAAiB,UAAU,MAAM,GAAG;AAClC,eAAO;AAAA,MACT;AAEA,YAAM,cAAc,SAAS,OAAO,SAAS,EAAE;AAC/C,UAAI,gBAAgB,GAAG;AACrB,cAAM,IAAI,MAAM,8BAA8B;AAAA,MAChD;AAEA,aAAO,UACJ,WAAW,QAAQ,EAAE,SAAS,KAAK,CAAC,EACpC,KAAK,CAAC,YAA2C,QAAQ,OAAO;AAAA,IACrE,CAAC;AAAA,EACL;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,MAAM,SACJ,OAEI,CAAC,GACU;AACf,UAAM,gBAAgB,KAAK,UAAU,CAAC;AACtC,QAAI,CAAC,cAAc,UAAU;AAC3B,oBAAc,WAAW,CAAC;AAAA,IAC5B;AAEA,kBAAc,SAAS,iBAAiB,KAAK,KAAK;AAElD,WAAO,KAAK,KAAK,EACd,KAAK,OAAM,WAAU;AAGpB,aAAa,UAAU,MAAM,IAAI,cAAa,wBAAwB,MAAM,IAAI;AAAA,IAClF,CAAC,EACA,KAAK,OAAM,WAAU;AACpB,UAAI,CAAO,UAAU,MAAM,KAAK,CAAO,UAAU,MAAM,GAAG;AACxD,cAAM,IAAI,MAAM,6CAA6C;AAAA,MAC/D,WAAiB,UAAU,MAAM,GAAG;AAClC,cAAM,cAAc,SAAS,OAAO,SAAS,EAAE;AAC/C,YAAI,gBAAgB,GAAG;AACrB,gBAAM,IAAI,MAAM,8BAA8B;AAAA,QAChD;AAAA,MACF;AAUA,YAAM,eAAe,KAAK,MAAM,KAAK,UAAU,MAAM,CAAC;AAEtD,aAAO,cAAc,SAAS,cAAc,aAAa,EAAE,KAAK,MAAM;AAEpE,eAAO;AAAA,MACT,CAAC;AAAA,IACH,CAAC;AAAA,EACL;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,MAAM,UAAsG;AAC1G,WAAO,KAAK,KAAK,EAAE,KAAK,YAAU;AAChC,cAAc,qBAAqB,MAAM,GAAG;AAAA,QAC1C,KAAK;AACH,iBAAO;AAAA,YACL,eAAe;AAAA,YACf,SAAU,OAAyC;AAAA,UACrD;AAAA,QAEF,KAAK;AACH,cAAI,UAAU;AACd,cAAK,QAAQ,MAAiC,QAAQ;AAIpD,kBAAM,SAAS,QAAQ,MAAgC,OAAO;AAAA,cAC5D;AAAA,YACF;AAEA,gBAAI,OAAO;AACT,wBAAU,MAAM,CAAC;AAAA,YACnB;AAAA,UACF;AAEA,iBAAO;AAAA,YACL,eAAe;AAAA,YACf;AAAA,UACF;AAAA,QAEF,KAAK;AACH,iBAAO;AAAA,YACL,eAAe;AAAA,YACf,SAAU,OAAyC;AAAA,UACrD;AAAA,QAEF;AACE,gBAAM,IAAI,MAAM,wBAAwB;AAAA,MAC5C;AAAA,IACF,CAAC;AAAA,EACH;AACF;","names":[]}

package/dist/lib/utils.cjs

@@ -8,7 +8,7 @@
 
 
 
-var _chunkK75HC34Mcjs = require('../chunk-K75HC34M.cjs');
+var _chunkGZL345SRcjs = require('../chunk-GZL345SR.cjs');
 
 
 
@@ -19,5 +19,5 @@ var _chunkK75HC34Mcjs = require('../chunk-K75HC34M.cjs');
 
 
 
-exports.getAPIDefinitionType = _chunkK75HC34Mcjs.getAPIDefinitionType; exports.getType = _chunkK75HC34Mcjs.getType; exports.isAPIDefinition = _chunkK75HC34Mcjs.isAPIDefinition; exports.isBuffer = _chunkK75HC34Mcjs.isBuffer; exports.isOpenAPI = _chunkK75HC34Mcjs.isOpenAPI; exports.isPostman = _chunkK75HC34Mcjs.isPostman; exports.isSwagger = _chunkK75HC34Mcjs.isSwagger; exports.normalizeURL = _chunkK75HC34Mcjs.normalizeURL; exports.stringToJSON = _chunkK75HC34Mcjs.stringToJSON;
+exports.getAPIDefinitionType = _chunkGZL345SRcjs.getAPIDefinitionType; exports.getType = _chunkGZL345SRcjs.getType; exports.isAPIDefinition = _chunkGZL345SRcjs.isAPIDefinition; exports.isBuffer = _chunkGZL345SRcjs.isBuffer; exports.isOpenAPI = _chunkGZL345SRcjs.isOpenAPI; exports.isPostman = _chunkGZL345SRcjs.isPostman; exports.isSwagger = _chunkGZL345SRcjs.isSwagger; exports.prepareURL = _chunkGZL345SRcjs.prepareURL; exports.stringToJSON = _chunkGZL345SRcjs.stringToJSON;
 //# sourceMappingURL=utils.cjs.map

package/dist/lib/utils.cjs.map

@@ -1 +1 @@
-{"version":3,"sources":["/Users/erunion/code/readme/oas/packages/oas-normalize/dist/lib/utils.cjs"],"names":[],"mappings":"AAAA;AACE;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACF,yDAA8B;AAC9B;AACE;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACF,geAAC","file":"/Users/erunion/code/readme/oas/packages/oas-normalize/dist/lib/utils.cjs"}
+{"version":3,"sources":["/Users/erunion/code/readme/oas/packages/oas-normalize/dist/lib/utils.cjs"],"names":[],"mappings":"AAAA;AACE;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACF,yDAA8B;AAC9B;AACE;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACF,4dAAC","file":"/Users/erunion/code/readme/oas/packages/oas-normalize/dist/lib/utils.cjs"}

package/dist/lib/utils.d.cts

@@ -4,9 +4,13 @@
  */
 declare function isBuffer(obj: any): boolean;
 /**
- * Converts GitHub blob URLs to raw URLs
+ * Deconstruct a URL into a payload for a `fetch` request.
+ *
  */
-declare function normalizeURL(url: string): string;
+declare function prepareURL(url: string): {
+    url: string;
+    options: RequestInit;
+};
 /**
  * Determine the type of a given variable. Returns `false` if unrecognized.
  *
@@ -50,4 +54,4 @@ declare function isAPIDefinition(schema: Record<string, unknown>): boolean;
  */
 declare function getAPIDefinitionType(schema: Record<string, unknown>): "openapi" | "postman" | "swagger" | "unknown";
 
-export { getAPIDefinitionType, getType, isAPIDefinition, isBuffer, isOpenAPI, isPostman, isSwagger, normalizeURL, stringToJSON };
+export { getAPIDefinitionType, getType, isAPIDefinition, isBuffer, isOpenAPI, isPostman, isSwagger, prepareURL, stringToJSON };

package/dist/lib/utils.d.ts

@@ -4,9 +4,13 @@
  */
 declare function isBuffer(obj: any): boolean;
 /**
- * Converts GitHub blob URLs to raw URLs
+ * Deconstruct a URL into a payload for a `fetch` request.
+ *
  */
-declare function normalizeURL(url: string): string;
+declare function prepareURL(url: string): {
+    url: string;
+    options: RequestInit;
+};
 /**
  * Determine the type of a given variable. Returns `false` if unrecognized.
  *
@@ -50,4 +54,4 @@ declare function isAPIDefinition(schema: Record<string, unknown>): boolean;
  */
 declare function getAPIDefinitionType(schema: Record<string, unknown>): "openapi" | "postman" | "swagger" | "unknown";
 
-export { getAPIDefinitionType, getType, isAPIDefinition, isBuffer, isOpenAPI, isPostman, isSwagger, normalizeURL, stringToJSON };
+export { getAPIDefinitionType, getType, isAPIDefinition, isBuffer, isOpenAPI, isPostman, isSwagger, prepareURL, stringToJSON };

package/dist/lib/utils.js

@@ -6,9 +6,9 @@ import {
   isOpenAPI,
   isPostman,
   isSwagger,
-  normalizeURL,
+  prepareURL,
   stringToJSON
-} from "../chunk-XOS5M44Y.js";
+} from "../chunk-J322YOXV.js";
 export {
   getAPIDefinitionType,
   getType,
@@ -17,7 +17,7 @@ export {
   isOpenAPI,
   isPostman,
   isSwagger,
-  normalizeURL,
+  prepareURL,
   stringToJSON
 };
 //# sourceMappingURL=utils.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "oas-normalize",
-  "version": "11.1.4",
+  "version": "12.1.0",
   "description": "Tooling for converting, validating, and parsing OpenAPI, Swagger, and Postman API definitions",
   "type": "module",
   "exports": {
@@ -53,6 +53,7 @@
   },
   "scripts": {
     "attw": "attw --pack --format table-flipped",
+    "bench": "echo 'Please run benchmarks from the root!' && exit 1",
     "build": "tsup",
     "lint": "npm run lint:types && npm run lint:js",
     "lint:js": "eslint . --ext .js,.ts --ignore-path ../../.gitignore",
@@ -63,7 +64,7 @@
   },
   "license": "MIT",
   "dependencies": {
-    "@readme/openapi-parser": "^2.6.0",
+    "@readme/openapi-parser": "^2.7.0",
     "@readme/postman-to-openapi": "^4.1.0",
     "js-yaml": "^4.1.0",
     "openapi-types": "^12.1.3",
@@ -74,11 +75,11 @@
     "@types/js-yaml": "^4.0.9",
     "@types/swagger2openapi": "^7.0.4",
     "eslint": "^8.57.0",
-    "nock": "^14.0.0-beta.12",
+    "nock": "^14.0.0",
     "tsup": "^8.0.2",
     "typescript": "^5.1.6",
-    "vitest": "^2.1.3"
+    "vitest": "^3.0.4"
   },
   "prettier": "@readme/eslint-config/prettier",
-  "gitHead": "d711a5f5b1fe655567e96e6940c52410dcb10e56"
+  "gitHead": "815ed445419978add2aaec344aa876f8914d9fb6"
 }

package/dist/chunk-K75HC34M.cjs.map

@@ -1 +0,0 @@
-{"version":3,"sources":["/Users/erunion/code/readme/oas/packages/oas-normalize/dist/chunk-K75HC34M.cjs","../src/lib/utils.ts"],"names":[],"mappings":"AAAA;ACAA,iFAAkC;AAM3B,SAAS,QAAA,CAAS,GAAA,EAAU;AACjC,EAAA,OACE,IAAA,GAAO,KAAA,GACP,GAAA,CAAI,YAAA,GAAe,KAAA,GACnB,OAAO,GAAA,CAAI,WAAA,CAAY,SAAA,IAAa,WAAA,GACpC,CAAC,CAAC,GAAA,CAAI,WAAA,CAAY,QAAA,CAAS,GAAG,CAAA;AAElC;AAKO,SAAS,YAAA,CAAa,GAAA,EAAa;AACxC,EAAA,GAAA,CAAI,GAAA,CAAI,UAAA,CAAW,qBAAqB,EAAA,GAAK,GAAA,CAAI,QAAA,CAAS,QAAQ,CAAA,EAAG;AACnE,IAAA,OAAO,GAAA,CAAI,OAAA,CAAQ,YAAA,EAAc,2BAA2B,CAAA,CAAE,OAAA,CAAQ,QAAA,EAAU,GAAG,CAAA;AAAA,EACrF;AACA,EAAA,OAAO,GAAA;AACT;AAMO,SAAS,OAAA,CAAQ,GAAA,EAAU;AAChC,EAAA,GAAA,CAAI,QAAA,CAAS,GAAG,CAAA,EAAG;AACjB,IAAA,OAAO,QAAA;AAAA,EACT,EAAA,KAAA,GAAA,CAAW,OAAO,IAAA,IAAQ,QAAA,EAAU;AAClC,IAAA,OAAO,MAAA;AAAA,EACT,EAAA,KAAA,GAAA,CAAW,OAAO,IAAA,IAAQ,QAAA,EAAU;AAClC,IAAA,GAAA,CAAI,GAAA,CAAI,KAAA,CAAM,MAAM,CAAA,EAAG;AACrB,MAAA,OAAO,aAAA;AAAA,IACT,EAAA,KAAA,GAAA,CAAW,GAAA,CAAI,KAAA,CAAM,IAAI,CAAA,EAAG;AAE1B,MAAA,OAAO,aAAA;AAAA,IACT,EAAA,KAAA,GAAA,CAAW,GAAA,CAAI,SAAA,CAAU,CAAA,EAAG,CAAC,EAAA,IAAM,MAAA,EAAQ;AACzC,MAAA,OAAO,KAAA;AAAA,IACT;AAEA,IAAA,OAAO,MAAA;AAAA,EACT;AAEA,EAAA,OAAO,KAAA;AACT;AAMO,SAAS,SAAA,CAAU,MAAA,EAAiC;AACzD,EAAA,OAAO,CAAC,CAAC,MAAA,CAAO,OAAA;AAClB;AAaO,SAAS,SAAA,CAAU,MAAA,EAA0C;AAClE,EAAA,OAAO,CAAC,CAAC,MAAA,CAAO,KAAA,GAAQ,CAAC,CAAC,MAAA,CAAO,IAAA;AACnC;AAMO,SAAS,SAAA,CAAU,MAAA,EAAiC;AACzD,EAAA,OAAO,CAAC,CAAC,MAAA,CAAO,OAAA;AAClB;AAMO,SAAS,YAAA,CAAa,MAAA,EAAmE;AAC9F,EAAA,GAAA,CAAI,OAAO,OAAA,IAAW,QAAA,EAAU;AAC9B,IAAA,OAAO,MAAA;AAAA,EACT,EAAA,KAAA,GAAA,CAAW,MAAA,CAAO,KAAA,CAAM,OAAO,CAAA,EAAG;AAEhC,IAAA,OAAO,IAAA,CAAK,KAAA,CAAM,MAAM,CAAA;AAAA,EAC1B;AAEA,EAAA,OAAO,gBAAA,CAAK,IAAA,CAAK,MAAA,EAAQ,EAAE,MAAA,EAAQ,oBAAY,CAAC,CAAA;AAClD;AAMO,SAAS,eAAA,CAAgB,MAAA,EAAiC;AAC/D,EAAA,OAAO,SAAA,CAAU,MAAM,EAAA,GAAK,SAAA,CAAU,MAAM,EAAA,GAAK,SAAA,CAAU,MAAM,CAAA;AACnE;AAMO,SAAS,oBAAA,CAAqB,MAAA,EAAiC;AACpE,EAAA,GAAA,CAAI,SAAA,CAAU,MAAM,CAAA,EAAG;AACrB,IAAA,OAAO,SAAA;AAAA,EACT,EAAA,KAAA,GAAA,CAAW,SAAA,CAAU,MAAM,CAAA,EAAG;AAC5B,IAAA,OAAO,SAAA;AAAA,EACT,EAAA,KAAA,GAAA,CAAW,SAAA,CAAU,MAAM,CAAA,EAAG;AAC5B,IAAA,OAAO,SAAA;AAAA,EACT;AAEA,EAAA,OAAO,SAAA;AACT;AD5DA;AACA;AACE;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACF,8TAAC","file":"/Users/erunion/code/readme/oas/packages/oas-normalize/dist/chunk-K75HC34M.cjs","sourcesContent":[null,"import YAML, { JSON_SCHEMA } from 'js-yaml';\n\n/**\n * Determine if a given variable is a `Buffer`.\n *\n */\nexport function isBuffer(obj: any) {\n  return (\n    obj != null &&\n    obj.constructor != null &&\n    typeof obj.constructor.isBuffer === 'function' &&\n    !!obj.constructor.isBuffer(obj)\n  );\n}\n\n/**\n * Converts GitHub blob URLs to raw URLs\n */\nexport function normalizeURL(url: string) {\n  if (url.startsWith('https://github.com/') && url.includes('/blob/')) {\n    return url.replace('github.com', 'raw.githubusercontent.com').replace('/blob/', '/');\n  }\n  return url;\n}\n\n/**\n * Determine the type of a given variable. Returns `false` if unrecognized.\n *\n */\nexport function getType(obj: any) {\n  if (isBuffer(obj)) {\n    return 'buffer';\n  } else if (typeof obj === 'object') {\n    return 'json';\n  } else if (typeof obj === 'string') {\n    if (obj.match(/\\s*{/)) {\n      return 'string-json';\n    } else if (obj.match(/\\n/)) {\n      // Not sure about this...\n      return 'string-yaml';\n    } else if (obj.substring(0, 4) === 'http') {\n      return 'url';\n    }\n\n    return 'path';\n  }\n\n  return false;\n}\n\n/**\n * Determine if a given schema if an OpenAPI definition.\n *\n */\nexport function isOpenAPI(schema: Record<string, unknown>) {\n  return !!schema.openapi;\n}\n\n/**\n * Determine if a given schema is a Postman collection.\n *\n * Unfortunately the Postman schema spec doesn't have anything like `openapi` or `swagger` for us\n * to look at but it does require that `info` and `item` be present and as `item` doesn't exist in\n * OpenAPI or Swagger we can use the combination of those two properties to determine if what we\n * have is a Postman collection.\n *\n * @see {@link https://schema.postman.com/json/collection/v2.0.0/collection.json}\n * @see {@link https://schema.postman.com/json/collection/v2.1.0/collection.json}\n */\nexport function isPostman(schema: Record<string, unknown>): boolean {\n  return !!schema.info && !!schema.item;\n}\n\n/**\n * Determine if a given schema if an Swagger definition.\n *\n */\nexport function isSwagger(schema: Record<string, unknown>) {\n  return !!schema.swagger;\n}\n\n/**\n * Convert a YAML blob or stringified JSON object into a JSON object.\n *\n */\nexport function stringToJSON(string: Record<string, unknown> | string): Record<string, unknown> {\n  if (typeof string === 'object') {\n    return string;\n  } else if (string.match(/^\\s*{/)) {\n    // eslint-disable-next-line try-catch-failsafe/json-parse\n    return JSON.parse(string);\n  }\n\n  return YAML.load(string, { schema: JSON_SCHEMA }) as Record<string, unknown>;\n}\n\n/**\n * Determine if a given schema is an API definition that we can support.\n *\n */\nexport function isAPIDefinition(schema: Record<string, unknown>) {\n  return isOpenAPI(schema) || isPostman(schema) || isSwagger(schema);\n}\n\n/**\n * Retrieve the type of API definition that a given schema is.\n *\n */\nexport function getAPIDefinitionType(schema: Record<string, unknown>) {\n  if (isOpenAPI(schema)) {\n    return 'openapi';\n  } else if (isPostman(schema)) {\n    return 'postman';\n  } else if (isSwagger(schema)) {\n    return 'swagger';\n  }\n\n  return 'unknown';\n}\n"]}

package/dist/chunk-XOS5M44Y.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":["../src/lib/utils.ts"],"sourcesContent":["import YAML, { JSON_SCHEMA } from 'js-yaml';\n\n/**\n * Determine if a given variable is a `Buffer`.\n *\n */\nexport function isBuffer(obj: any) {\n  return (\n    obj != null &&\n    obj.constructor != null &&\n    typeof obj.constructor.isBuffer === 'function' &&\n    !!obj.constructor.isBuffer(obj)\n  );\n}\n\n/**\n * Converts GitHub blob URLs to raw URLs\n */\nexport function normalizeURL(url: string) {\n  if (url.startsWith('https://github.com/') && url.includes('/blob/')) {\n    return url.replace('github.com', 'raw.githubusercontent.com').replace('/blob/', '/');\n  }\n  return url;\n}\n\n/**\n * Determine the type of a given variable. Returns `false` if unrecognized.\n *\n */\nexport function getType(obj: any) {\n  if (isBuffer(obj)) {\n    return 'buffer';\n  } else if (typeof obj === 'object') {\n    return 'json';\n  } else if (typeof obj === 'string') {\n    if (obj.match(/\\s*{/)) {\n      return 'string-json';\n    } else if (obj.match(/\\n/)) {\n      // Not sure about this...\n      return 'string-yaml';\n    } else if (obj.substring(0, 4) === 'http') {\n      return 'url';\n    }\n\n    return 'path';\n  }\n\n  return false;\n}\n\n/**\n * Determine if a given schema if an OpenAPI definition.\n *\n */\nexport function isOpenAPI(schema: Record<string, unknown>) {\n  return !!schema.openapi;\n}\n\n/**\n * Determine if a given schema is a Postman collection.\n *\n * Unfortunately the Postman schema spec doesn't have anything like `openapi` or `swagger` for us\n * to look at but it does require that `info` and `item` be present and as `item` doesn't exist in\n * OpenAPI or Swagger we can use the combination of those two properties to determine if what we\n * have is a Postman collection.\n *\n * @see {@link https://schema.postman.com/json/collection/v2.0.0/collection.json}\n * @see {@link https://schema.postman.com/json/collection/v2.1.0/collection.json}\n */\nexport function isPostman(schema: Record<string, unknown>): boolean {\n  return !!schema.info && !!schema.item;\n}\n\n/**\n * Determine if a given schema if an Swagger definition.\n *\n */\nexport function isSwagger(schema: Record<string, unknown>) {\n  return !!schema.swagger;\n}\n\n/**\n * Convert a YAML blob or stringified JSON object into a JSON object.\n *\n */\nexport function stringToJSON(string: Record<string, unknown> | string): Record<string, unknown> {\n  if (typeof string === 'object') {\n    return string;\n  } else if (string.match(/^\\s*{/)) {\n    // eslint-disable-next-line try-catch-failsafe/json-parse\n    return JSON.parse(string);\n  }\n\n  return YAML.load(string, { schema: JSON_SCHEMA }) as Record<string, unknown>;\n}\n\n/**\n * Determine if a given schema is an API definition that we can support.\n *\n */\nexport function isAPIDefinition(schema: Record<string, unknown>) {\n  return isOpenAPI(schema) || isPostman(schema) || isSwagger(schema);\n}\n\n/**\n * Retrieve the type of API definition that a given schema is.\n *\n */\nexport function getAPIDefinitionType(schema: Record<string, unknown>) {\n  if (isOpenAPI(schema)) {\n    return 'openapi';\n  } else if (isPostman(schema)) {\n    return 'postman';\n  } else if (isSwagger(schema)) {\n    return 'swagger';\n  }\n\n  return 'unknown';\n}\n"],"mappings":";AAAA,OAAO,QAAQ,mBAAmB;AAM3B,SAAS,SAAS,KAAU;AACjC,SACE,OAAO,QACP,IAAI,eAAe,QACnB,OAAO,IAAI,YAAY,aAAa,cACpC,CAAC,CAAC,IAAI,YAAY,SAAS,GAAG;AAElC;AAKO,SAAS,aAAa,KAAa;AACxC,MAAI,IAAI,WAAW,qBAAqB,KAAK,IAAI,SAAS,QAAQ,GAAG;AACnE,WAAO,IAAI,QAAQ,cAAc,2BAA2B,EAAE,QAAQ,UAAU,GAAG;AAAA,EACrF;AACA,SAAO;AACT;AAMO,SAAS,QAAQ,KAAU;AAChC,MAAI,SAAS,GAAG,GAAG;AACjB,WAAO;AAAA,EACT,WAAW,OAAO,QAAQ,UAAU;AAClC,WAAO;AAAA,EACT,WAAW,OAAO,QAAQ,UAAU;AAClC,QAAI,IAAI,MAAM,MAAM,GAAG;AACrB,aAAO;AAAA,IACT,WAAW,IAAI,MAAM,IAAI,GAAG;AAE1B,aAAO;AAAA,IACT,WAAW,IAAI,UAAU,GAAG,CAAC,MAAM,QAAQ;AACzC,aAAO;AAAA,IACT;AAEA,WAAO;AAAA,EACT;AAEA,SAAO;AACT;AAMO,SAAS,UAAU,QAAiC;AACzD,SAAO,CAAC,CAAC,OAAO;AAClB;AAaO,SAAS,UAAU,QAA0C;AAClE,SAAO,CAAC,CAAC,OAAO,QAAQ,CAAC,CAAC,OAAO;AACnC;AAMO,SAAS,UAAU,QAAiC;AACzD,SAAO,CAAC,CAAC,OAAO;AAClB;AAMO,SAAS,aAAa,QAAmE;AAC9F,MAAI,OAAO,WAAW,UAAU;AAC9B,WAAO;AAAA,EACT,WAAW,OAAO,MAAM,OAAO,GAAG;AAEhC,WAAO,KAAK,MAAM,MAAM;AAAA,EAC1B;AAEA,SAAO,KAAK,KAAK,QAAQ,EAAE,QAAQ,YAAY,CAAC;AAClD;AAMO,SAAS,gBAAgB,QAAiC;AAC/D,SAAO,UAAU,MAAM,KAAK,UAAU,MAAM,KAAK,UAAU,MAAM;AACnE;AAMO,SAAS,qBAAqB,QAAiC;AACpE,MAAI,UAAU,MAAM,GAAG;AACrB,WAAO;AAAA,EACT,WAAW,UAAU,MAAM,GAAG;AAC5B,WAAO;AAAA,EACT,WAAW,UAAU,MAAM,GAAG;AAC5B,WAAO;AAAA,EACT;AAEA,SAAO;AACT;","names":[]}