oas 36.0.3 → 37.0.0

package/README.md

@@ -76,8 +76,6 @@ Because this library has full TypeScript types and docblocks this README is not
 <!-- prettier-ignore-start -->
 | Method | Description |
 | :--- | :--- |
-| `.dereference()` | Dereference the current OpenAPI definition. Note that this will ignore circular references. |
-| `.getCircularReferences()` | Retrieve an array of any circular `$ref` pointer that may exist wthin the OpenAPI definition. Note that this requires `.dereference()` to be called first. |
 | `.getDefinition()` | Retrieve the OpenAPI definition that was fed into the `Oas` constructor. |
 | `.getTags()` | Retrieve an array of all tags that exist within the API definition and are set on operations. |
 | `.getPaths()` | Retrieve every operation that exists within the API definition. This returns an array of instances of the `Operation` class. |
@@ -85,7 +83,6 @@ Because this library has full TypeScript types and docblocks this README is not
 | `.getVersion()` | Retrieve the OpenAPI version that this API definition is targeted for. |
 | `.getWebhooks()` | Retrieve every webhook operation that exists within the API definition. This returns an array of instances of the `Webhook` class. |
 | `.hasSecurityScheme()` | Determine if a security scheme exists within the API definition. |
-| `.isDereferenced()` | Determine if the current API definition has been dereferenced or not. |
 | `#init()` | An alternative for `new Oas()` that you can use if the typing on the `Oas` constructor gives you trouble. Typing OpenAPI definitions is hard! |
 <!-- prettier-ignore-end -->
 
@@ -155,12 +152,10 @@ const operation = petstore.operation('/pet', 'post');
 <!-- prettier-ignore-start -->
 | Method | Description |
 | :--- | :--- |
-| `.dereference()` | Dereference the current operation. Note that this will ignore circular references. |
 | `.getContentType()` | Retrieve the primary request body content type. If multiple are present, prefer whichever is JSON-compliant. |
 | `.getDescription()` | Retrieve the `description` that's set on this operation. This supports common descriptions that may be set at the [path item level](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#path-item-object). |
 | `.getOperationId()` | Retrieve the `operationId` that's present on the operation, and if one is not present one will be created based off the method + path and returned instead. |
 | `.hasOperationId()` | Determine if the operation has an `operationId` present. |
-| `.isDereferenced()` | Determine if the current operation schema has been dereferenced or not. |
 | `.isDeprecated()` | Determine if this operation is marked as deprecated. |
 | `.isFormUrlEncoded()` | Determine if this operation requires its payload to be delivered as `application/x-www-form-urlencoded`. |
 | `.isJson()` | Determine if this operation requires its payload to be delivered as JSON. |

package/dist/analyzer/index.cjs

@@ -1,14 +1,79 @@
-"use strict";Object.defineProperty(exports, "__esModule", {value: true});
-
-var _chunkLJWHPW4Hcjs = require('../chunk-LJWHPW4H.cjs');
-require('../chunk-BJCTM2ME.cjs');
-
+"use strict";Object.defineProperty(exports, "__esModule", {value: true}); function _optionalChain(ops) { let lastAccessLHS = undefined; let value = ops[0]; let i = 1; while (i < ops.length) { const op = ops[i]; const fn = ops[i + 1]; i += 2; if ((op === 'optionalAccess' || op === 'optionalCall') && value == null) { return undefined; } if (op === 'access' || op === 'optionalAccess') { lastAccessLHS = value; value = fn(value); } else if (op === 'call' || op === 'optionalCall') { value = fn((...args) => value.call(lastAccessLHS, ...args)); lastAccessLHS = undefined; } } return value; }
 
 
 var _chunkW6GBV2JTcjs = require('../chunk-W6GBV2JT.cjs');
-require('../chunk-SCWW2SNX.cjs');
-require('../chunk-AYA3UT4L.cjs');
-require('../chunk-7PWF3F2W.cjs');
+
+// src/analyzer/dereference.ts
+var _openapiparser = require('@readme/openapi-parser');
+function getDereferencingOptions(circularRefs2) {
+  return {
+    resolve: {
+      // We shouldn't be resolving external pointers at this point so just ignore them.
+      external: false
+    },
+    dereference: {
+      // If circular `$refs` are ignored they'll remain in the schema as `$ref: String`, otherwise
+      // `$ref` just won't exist. This, in tandem with `onCircular`, allows us to do easy and
+      // accumulate a list of circular references.
+      circular: "ignore",
+      onCircular: (path) => {
+        circularRefs2.add(`#${path.split("#")[1]}`);
+      }
+    }
+  };
+}
+var dereferenceStates = /* @__PURE__ */ new WeakMap();
+function getDereferenceState(definition) {
+  let state = dereferenceStates.get(definition);
+  if (!state) {
+    state = {
+      processing: false,
+      complete: false,
+      circularRefs: [],
+      promises: []
+    };
+    dereferenceStates.set(definition, state);
+  }
+  return state;
+}
+async function dereferenceOas(definition, opts) {
+  const state = getDereferenceState(definition);
+  if (state.complete && state.result) {
+    return state.result;
+  }
+  if (state.processing) {
+    return new Promise((resolve, reject) => {
+      state.promises.push({ resolve, reject });
+    });
+  }
+  state.processing = true;
+  const circularRefs2 = /* @__PURE__ */ new Set();
+  const dereferencingOptions = getDereferencingOptions(circularRefs2);
+  const { promises } = state;
+  return _openapiparser.dereference.call(void 0, definition, dereferencingOptions).then((dereferenced) => {
+    const result = {
+      api: dereferenced,
+      circularRefs: [...circularRefs2]
+    };
+    state.result = result;
+    state.circularRefs = result.circularRefs;
+    state.processing = false;
+    state.complete = true;
+    if (_optionalChain([opts, 'optionalAccess', _ => _.cb])) {
+      opts.cb();
+    }
+    return result;
+  }).then((result) => {
+    promises.forEach((deferred) => deferred.resolve(result));
+    state.promises = [];
+    return result;
+  }).catch((err) => {
+    state.processing = false;
+    promises.forEach((deferred) => deferred.reject(err));
+    state.promises = [];
+    throw err;
+  });
+}
 
 // src/analyzer/queries/openapi.ts
 function additionalProperties(definition) {
@@ -20,9 +85,8 @@ function callbacks(definition) {
   );
 }
 async function circularRefs(definition) {
-  const oas = new (0, _chunkLJWHPW4Hcjs.Oas)(structuredClone(definition));
-  await oas.dereference();
-  const results = oas.getCircularReferences();
+  const { circularRefs: refs } = await dereferenceOas(structuredClone(definition));
+  const results = [...refs];
   results.sort();
   return results;
 }
@@ -32,14 +96,12 @@ function commonParameters(definition) {
 function discriminators(definition) {
   return _chunkW6GBV2JTcjs.query.call(void 0, ["$..discriminator"], definition).map((res) => _chunkW6GBV2JTcjs.refizePointer.call(void 0, res.pointer));
 }
-async function fileSize(definition) {
-  const oas = new (0, _chunkLJWHPW4Hcjs.Oas)(structuredClone(definition));
-  const originalSizeInBytes = Buffer.from(JSON.stringify(oas.api)).length;
+function fileSize(definition, definitionDereferenced) {
+  const originalSizeInBytes = Buffer.from(JSON.stringify(definition)).length;
   const raw = Number((originalSizeInBytes / (1024 * 1024)).toFixed(2));
-  await oas.dereference();
   let dereferenced;
   try {
-    const dereferencedSizeInBytes = Buffer.from(JSON.stringify(oas.api)).length;
+    const dereferencedSizeInBytes = Buffer.from(JSON.stringify(definitionDereferenced)).length;
     dereferenced = Number((dereferencedSizeInBytes / (1024 * 1024)).toFixed(2));
   } catch (err) {
     if (err instanceof RangeError) {
@@ -77,9 +139,6 @@ function polymorphism(definition) {
 function references(definition) {
   return _chunkW6GBV2JTcjs.query.call(void 0, ["$..$ref^"], definition).map((res) => _chunkW6GBV2JTcjs.refizePointer.call(void 0, res.pointer));
 }
-function refNames(definition) {
-  return _chunkW6GBV2JTcjs.query.call(void 0, ["$..['x-readme-ref-name']"], definition).map((res) => _chunkW6GBV2JTcjs.refizePointer.call(void 0, res.pointer));
-}
 function securityTypes(definition) {
   return Array.from(new Set(_chunkW6GBV2JTcjs.query.call(void 0, ["$.components.securitySchemes..type"], definition).map((res) => res.value)));
 }
@@ -126,17 +185,18 @@ function xmlSchemas(definition) {
 
 // src/analyzer/index.ts
 async function analyzer(definition) {
+  const clonedDefinition = structuredClone(definition);
+  const { api: dereferencedApi, circularRefs: dereferencedCircularRefs } = await dereferenceOas(clonedDefinition);
   const additionalProperties2 = additionalProperties(definition);
   const callbacks2 = callbacks(definition);
-  const circularRefs2 = await circularRefs(definition);
+  const circularRefs2 = [...dereferencedCircularRefs].toSorted();
   const commonParameters2 = commonParameters(definition);
   const discriminators2 = discriminators(definition);
-  const { raw: rawFileSize, dereferenced: dereferencedFileSize } = await fileSize(definition);
+  const { raw: rawFileSize, dereferenced: dereferencedFileSize } = fileSize(definition, dereferencedApi);
   const links2 = links(definition);
   const parameterSerialization2 = parameterSerialization(definition);
   const polymorphism2 = polymorphism(definition);
   const references2 = references(definition);
-  const refNames2 = refNames(definition);
   const serverVariables2 = serverVariables(definition);
   const xmlSchemas2 = xmlSchemas(definition);
   const xmlRequests2 = xmlRequests(definition);
@@ -202,10 +262,6 @@ async function analyzer(definition) {
         present: !!references2.length,
         locations: references2
       },
-      refNames: {
-        present: !!refNames2.length,
-        locations: refNames2
-      },
       serverVariables: {
         present: !!serverVariables2.length,
         locations: serverVariables2
@@ -250,6 +306,5 @@ async function analyzer(definition) {
 
 
 
-
-exports.analyzeAdditionalProperties = additionalProperties; exports.analyzeCallbacks = callbacks; exports.analyzeCircularRefs = circularRefs; exports.analyzeCommonParameters = commonParameters; exports.analyzeDiscriminators = discriminators; exports.analyzeFileSize = fileSize; exports.analyzeLinks = links; exports.analyzeMediaTypes = mediaTypes; exports.analyzeParameterSerialization = parameterSerialization; exports.analyzePolymorphism = polymorphism; exports.analyzeRefNames = refNames; exports.analyzeReferences = references; exports.analyzeSecurityTypes = securityTypes; exports.analyzeServerVariables = serverVariables; exports.analyzeTotalOperations = totalOperations; exports.analyzeWebhooks = webhooks; exports.analyzeXMLRequests = xmlRequests; exports.analyzeXMLResponses = xmlResponses; exports.analyzeXMLSchemas = xmlSchemas; exports.analyzer = analyzer;
+exports.analyzeAdditionalProperties = additionalProperties; exports.analyzeCallbacks = callbacks; exports.analyzeCircularRefs = circularRefs; exports.analyzeCommonParameters = commonParameters; exports.analyzeDiscriminators = discriminators; exports.analyzeFileSize = fileSize; exports.analyzeLinks = links; exports.analyzeMediaTypes = mediaTypes; exports.analyzeParameterSerialization = parameterSerialization; exports.analyzePolymorphism = polymorphism; exports.analyzeReferences = references; exports.analyzeSecurityTypes = securityTypes; exports.analyzeServerVariables = serverVariables; exports.analyzeTotalOperations = totalOperations; exports.analyzeWebhooks = webhooks; exports.analyzeXMLRequests = xmlRequests; exports.analyzeXMLResponses = xmlResponses; exports.analyzeXMLSchemas = xmlSchemas; exports.analyzer = analyzer;
 //# sourceMappingURL=index.cjs.map

package/dist/analyzer/index.cjs.map

@@ -1 +1 @@
-{"version":3,"sources":["/Users/erunion/code/readme/oas/packages/oas/dist/analyzer/index.cjs","../../src/analyzer/queries/openapi.ts","../../src/analyzer/index.ts"],"names":["additionalProperties","callbacks","circularRefs","commonParameters","discriminators","links","parameterSerialization","polymorphism","references","refNames","serverVariables","xmlSchemas","xmlRequests","xmlResponses","webhooks"],"mappings":"AAAA;AACE;AACF,yDAA8B;AAC9B,iCAA8B;AAC9B;AACE;AACA;AACF,yDAA8B;AAC9B,iCAA8B;AAC9B,iCAA8B;AAC9B,iCAA8B;AAC9B;AACA;ACDO,SAAS,oBAAA,CAAqB,UAAA,EAAmC;AACtE,EAAA,OAAO,qCAAA,CAAO,yBAAyB,CAAA,EAAG,UAAU,CAAA,CAAE,GAAA,CAAI,CAAA,GAAA,EAAA,GAAO,6CAAA,GAAc,CAAI,OAAO,CAAC,CAAA;AAC7F;AAQO,SAAS,SAAA,CAAU,UAAA,EAAmC;AAC3D,EAAA,OAAO,qCAAA,CAAO,wBAAA,EAA0B,qCAAqC,CAAA,EAAG,UAAU,CAAA,CAAE,GAAA;AAAA,IAAI,CAAA,GAAA,EAAA,GAC9F,6CAAA,GAAc,CAAI,OAAO;AAAA,EAC3B,CAAA;AACF;AAQA,MAAA,SAAsB,YAAA,CAAa,UAAA,EAA4C;AAG7E,EAAA,MAAM,IAAA,EAAM,IAAI,0BAAA,CAAI,eAAA,CAAgB,UAAU,CAAC,CAAA;AAC/C,EAAA,MAAM,GAAA,CAAI,WAAA,CAAY,CAAA;AAEtB,EAAA,MAAM,QAAA,EAAU,GAAA,CAAI,qBAAA,CAAsB,CAAA;AAE1C,EAAA,OAAA,CAAQ,IAAA,CAAK,CAAA;AACb,EAAA,OAAO,OAAA;AACT;AAQO,SAAS,gBAAA,CAAiB,UAAA,EAAmC;AAClE,EAAA,OAAO,qCAAA,CAAO,wBAAwB,CAAA,EAAG,UAAU,CAAA,CAAE,GAAA,CAAI,CAAA,GAAA,EAAA,GAAO,6CAAA,GAAc,CAAI,OAAO,CAAC,CAAA;AAC5F;AAQO,SAAS,cAAA,CAAe,UAAA,EAAmC;AAChE,EAAA,OAAO,qCAAA,CAAO,kBAAkB,CAAA,EAAG,UAAU,CAAA,CAAE,GAAA,CAAI,CAAA,GAAA,EAAA,GAAO,6CAAA,GAAc,CAAI,OAAO,CAAC,CAAA;AACtF;AASA,MAAA,SAAsB,QAAA,CAAS,UAAA,EAAsF;AACnH,EAAA,MAAM,IAAA,EAAM,IAAI,0BAAA,CAAI,eAAA,CAAgB,UAAU,CAAC,CAAA;AAE/C,EAAA,MAAM,oBAAA,EAAsB,MAAA,CAAO,IAAA,CAAK,IAAA,CAAK,SAAA,CAAU,GAAA,CAAI,GAAG,CAAC,CAAA,CAAE,MAAA;AACjE,EAAA,MAAM,IAAA,EAAM,MAAA,CAAA,CAAQ,oBAAA,EAAA,CAAuB,KAAA,EAAO,IAAA,CAAA,CAAA,CAAO,OAAA,CAAQ,CAAC,CAAC,CAAA;AAEnE,EAAA,MAAM,GAAA,CAAI,WAAA,CAAY,CAAA;AAEtB,EAAA,IAAI,YAAA;AACJ,EAAA,IAAI;AACF,IAAA,MAAM,wBAAA,EAA0B,MAAA,CAAO,IAAA,CAAK,IAAA,CAAK,SAAA,CAAU,GAAA,CAAI,GAAG,CAAC,CAAA,CAAE,MAAA;AACrE,IAAA,aAAA,EAAe,MAAA,CAAA,CAAQ,wBAAA,EAAA,CAA2B,KAAA,EAAO,IAAA,CAAA,CAAA,CAAO,OAAA,CAAQ,CAAC,CAAC,CAAA;AAAA,EAC5E,EAAA,MAAA,CAAS,GAAA,EAAK;AAGZ,IAAA,GAAA,CAAI,IAAA,WAAe,UAAA,EAAY;AAC7B,MAAA,aAAA,EAAe,GAAA;AAAA,IACjB,EAAA,KAAO;AACL,MAAA,MAAM,GAAA;AAAA,IACR;AAAA,EACF;AAEA,EAAA,OAAO,EAAE,GAAA,EAAK,aAAa,CAAA;AAC7B;AAQO,SAAS,KAAA,CAAM,UAAA,EAAmC;AACvD,EAAA,OAAO,qCAAA,CAAO,oBAAA,EAAsB,4BAA4B,CAAA,EAAG,UAAU,CAAA,CAAE,GAAA,CAAI,CAAA,GAAA,EAAA,GAAO,6CAAA,GAAc,CAAI,OAAO,CAAC,CAAA;AACtH;AASO,SAAS,UAAA,CAAW,UAAA,EAAmC;AAC5D,EAAA,MAAM,QAAA,EAAU,KAAA,CAAM,IAAA;AAAA,IACpB,IAAI,GAAA;AAAA,MACF,qCAAA,CAAO,mBAAmB,CAAA,EAAG,UAAU,CAAA,CAAE,OAAA,CAAQ,CAAA,GAAA,EAAA,GAAO;AAGtD,QAAA,OAAO,MAAA,CAAO,IAAA,CAAK,GAAA,CAAI,KAAK,CAAA;AAAA,MAC9B,CAAC;AAAA,IACH;AAAA,EACF,CAAA;AAEA,EAAA,OAAA,CAAQ,IAAA,CAAK,CAAA;AACb,EAAA,OAAO,OAAA;AACT;AAQO,SAAS,sBAAA,CAAuB,UAAA,EAAmC;AACxE,EAAA,OAAO,qCAAA,CAAO,yBAAyB,CAAA,EAAG,UAAU,CAAA,CAAE,GAAA,CAAI,CAAA,GAAA,EAAA,GAAO,6CAAA,GAAc,CAAI,OAAO,CAAC,CAAA;AAC7F;AAQO,SAAS,YAAA,CAAa,UAAA,EAAmC;AAC9D,EAAA,MAAM,QAAA,EAAU,KAAA,CAAM,IAAA;AAAA,IACpB,IAAI,GAAA,CAAI,qCAAA,CAAO,WAAA,EAAa,WAAA,EAAa,WAAW,CAAA,EAAG,UAAU,CAAA,CAAE,GAAA,CAAI,CAAA,GAAA,EAAA,GAAO,6CAAA,GAAc,CAAI,OAAO,CAAC,CAAC;AAAA,EAC3G,CAAA;AAEA,EAAA,OAAA,CAAQ,IAAA,CAAK,CAAA;AACb,EAAA,OAAO,OAAA;AACT;AAMO,SAAS,UAAA,CAAW,UAAA,EAAmC;AAC5D,EAAA,OAAO,qCAAA,CAAO,UAAU,CAAA,EAAG,UAAU,CAAA,CAAE,GAAA,CAAI,CAAA,GAAA,EAAA,GAAO,6CAAA,GAAc,CAAI,OAAO,CAAC,CAAA;AAC9E;AAQO,SAAS,QAAA,CAAS,UAAA,EAAmC;AAC1D,EAAA,OAAO,qCAAA,CAAO,0BAA0B,CAAA,EAAG,UAAU,CAAA,CAAE,GAAA,CAAI,CAAA,GAAA,EAAA,GAAO,6CAAA,GAAc,CAAI,OAAO,CAAC,CAAA;AAC9F;AAQO,SAAS,aAAA,CAAc,UAAA,EAAmC;AAC/D,EAAA,OAAO,KAAA,CAAM,IAAA,CAAK,IAAI,GAAA,CAAI,qCAAA,CAAO,oCAAoC,CAAA,EAAG,UAAU,CAAA,CAAE,GAAA,CAAI,CAAA,GAAA,EAAA,GAAO,GAAA,CAAI,KAAe,CAAC,CAAC,CAAA;AACtH;AAQO,SAAS,eAAA,CAAgB,UAAA,EAAmC;AACjE,EAAA,OAAO,qCAAA,CAAO,uBAAuB,CAAA,EAAG,UAAU,CAAA,CAAE,GAAA,CAAI,CAAA,GAAA,EAAA,GAAO,6CAAA,GAAc,CAAI,OAAO,CAAC,CAAA;AAC3F;AAQO,SAAS,eAAA,CAAgB,UAAA,EAAiC;AAC/D,EAAA,OAAO,qCAAA,CAAO,aAAa,CAAA,EAAG,UAAU,CAAA,CAAE,OAAA,CAAQ,CAAA,GAAA,EAAA,GAAO,MAAA,CAAO,IAAA,CAAK,GAAA,CAAI,KAAK,CAAC,CAAA,CAAE,MAAA;AACnF;AAOO,SAAS,QAAA,CAAS,UAAA,EAAmC;AAC1D,EAAA,OAAO,qCAAA,CAAO,eAAe,CAAA,EAAG,UAAU,CAAA,CAAE,GAAA,CAAI,CAAA,GAAA,EAAA,GAAO,6CAAA,GAAc,CAAI,OAAO,CAAC,CAAA;AACnF;AASO,SAAS,WAAA,CAAY,UAAA,EAAmC;AAC7D,EAAA,OAAO,qCAAA;AAAA,IACL;AAAA,MACE,qCAAA;AAAA,MACA,4DAAA;AAAA,MACA,yCAAA;AAAA,MACA,8BAAA;AAAA,MACA,qDAAA;AAAA,MACA;AAAA,IACF,CAAA;AAAA,IACA;AAAA,EACF,CAAA,CAAE,GAAA,CAAI,CAAA,GAAA,EAAA,GAAO,6CAAA,GAAc,CAAI,OAAO,CAAC,CAAA;AACzC;AASO,SAAS,YAAA,CAAa,UAAA,EAAmC;AAC9D,EAAA,OAAO,qCAAA;AAAA,IACL;AAAA,MACE,mCAAA;AAAA,MACA,0DAAA;AAAA,MACA,uCAAA;AAAA,MACA,4BAAA;AAAA,MACA,mDAAA;AAAA,MACA;AAAA,IACF,CAAA;AAAA,IACA;AAAA,EACF,CAAA,CAAE,GAAA,CAAI,CAAA,GAAA,EAAA,GAAO,6CAAA,GAAc,CAAI,OAAO,CAAC,CAAA;AACzC;AAQO,SAAS,UAAA,CAAW,UAAA,EAAmC;AAC5D,EAAA,OAAO,qCAAA,CAAO,4BAAA,EAA8B,qBAAA,EAAuB,sBAAsB,CAAA,EAAG,UAAU,CAAA,CAAE,GAAA;AAAA,IAAI,CAAA,GAAA,EAAA,GAC1G,6CAAA,GAAc,CAAI,OAAO;AAAA,EAC3B,CAAA;AACF;AD1IA;AACA;AE1EA,MAAA,SAAsB,QAAA,CAAS,UAAA,EAA+C;AAC5E,EAAA,MAAMA,sBAAAA,EAAuB,oBAAA,CAA4B,UAAU,CAAA;AACnE,EAAA,MAAMC,WAAAA,EAAY,SAAA,CAAiB,UAAU,CAAA;AAC7C,EAAA,MAAMC,cAAAA,EAAe,MAAM,YAAA,CAAoB,UAAU,CAAA;AACzD,EAAA,MAAMC,kBAAAA,EAAmB,gBAAA,CAAwB,UAAU,CAAA;AAC3D,EAAA,MAAMC,gBAAAA,EAAiB,cAAA,CAAsB,UAAU,CAAA;AACvD,EAAA,MAAM,EAAE,GAAA,EAAK,WAAA,EAAa,YAAA,EAAc,qBAAqB,EAAA,EAAI,MAAM,QAAA,CAAgB,UAAU,CAAA;AACjG,EAAA,MAAMC,OAAAA,EAAQ,KAAA,CAAa,UAAU,CAAA;AACrC,EAAA,MAAMC,wBAAAA,EAAyB,sBAAA,CAA8B,UAAU,CAAA;AACvE,EAAA,MAAMC,cAAAA,EAAe,YAAA,CAAoB,UAAU,CAAA;AACnD,EAAA,MAAMC,YAAAA,EAAa,UAAA,CAAkB,UAAU,CAAA;AAC/C,EAAA,MAAMC,UAAAA,EAAW,QAAA,CAAgB,UAAU,CAAA;AAC3C,EAAA,MAAMC,iBAAAA,EAAkB,eAAA,CAAuB,UAAU,CAAA;AACzD,EAAA,MAAMC,YAAAA,EAAa,UAAA,CAAkB,UAAU,CAAA;AAC/C,EAAA,MAAMC,aAAAA,EAAc,WAAA,CAAmB,UAAU,CAAA;AACjD,EAAA,MAAMC,cAAAA,EAAe,YAAA,CAAoB,UAAU,CAAA;AACnD,EAAA,MAAMC,UAAAA,EAAW,QAAA,CAAgB,UAAU,CAAA;AAE3C,EAAA,MAAM,SAAA,EAAwB;AAAA,IAC5B,OAAA,EAAS;AAAA,MACP,oBAAA,EAAsB;AAAA,QACpB,IAAA,EAAM,wBAAA;AAAA,QACN,KAAA,EAAO;AAAA,MACT,CAAA;AAAA,MACA,UAAA,EAAY;AAAA,QACV,IAAA,EAAM,YAAA;AAAA,QACN,KAAA,EAAO,UAAA,CAAkB,UAAU;AAAA,MACrC,CAAA;AAAA,MACA,cAAA,EAAgB;AAAA,QACd,IAAA,EAAM,WAAA;AAAA,QACN,KAAA,EAAO,eAAA,CAAuB,UAAU;AAAA,MAC1C,CAAA;AAAA,MACA,WAAA,EAAa;AAAA,QACX,IAAA,EAAM,eAAA;AAAA,QACN,KAAA,EAAO;AAAA,MACT,CAAA;AAAA,MACA,aAAA,EAAe;AAAA,QACb,IAAA,EAAM,eAAA;AAAA,QACN,KAAA,EAAO,aAAA,CAAqB,UAAU;AAAA,MACxC;AAAA,IACF,CAAA;AAAA,IACA,OAAA,EAAS;AAAA,MACP,oBAAA,EAAsB;AAAA,QACpB,OAAA,EAAS,CAAC,CAACd,qBAAAA,CAAqB,MAAA;AAAA,QAChC,SAAA,EAAWA;AAAA,MACb,CAAA;AAAA,MACA,SAAA,EAAW;AAAA,QACT,OAAA,EAAS,CAAC,CAACC,UAAAA,CAAU,MAAA;AAAA,QACrB,SAAA,EAAWA;AAAA,MACb,CAAA;AAAA,MACA,YAAA,EAAc;AAAA,QACZ,OAAA,EAAS,CAAC,CAACC,aAAAA,CAAa,MAAA;AAAA,QACxB,SAAA,EAAWA;AAAA,MACb,CAAA;AAAA,MACA,gBAAA,EAAkB;AAAA,QAChB,OAAA,EAAS,CAAC,CAACC,iBAAAA,CAAiB,MAAA;AAAA,QAC5B,SAAA,EAAWA;AAAA,MACb,CAAA;AAAA,MACA,cAAA,EAAgB;AAAA,QACd,OAAA,EAAS,CAAC,CAACC,eAAAA,CAAe,MAAA;AAAA,QAC1B,SAAA,EAAWA;AAAA,MACb,CAAA;AAAA,MACA,KAAA,EAAO;AAAA,QACL,OAAA,EAAS,CAAC,CAACC,MAAAA,CAAM,MAAA;AAAA,QACjB,SAAA,EAAWA;AAAA,MACb,CAAA;AAAA,MACA,KAAA,EAAO;AAAA,QACL,OAAA,EAAS,CAAC,CAACC,uBAAAA,CAAuB,MAAA;AAAA,QAClC,SAAA,EAAWA;AAAA,MACb,CAAA;AAAA,MACA,YAAA,EAAc;AAAA,QACZ,OAAA,EAAS,CAAC,CAACC,aAAAA,CAAa,MAAA;AAAA,QACxB,SAAA,EAAWA;AAAA,MACb,CAAA;AAAA,MACA,UAAA,EAAY;AAAA,QACV,OAAA,EAAS,CAAC,CAACC,WAAAA,CAAW,MAAA;AAAA,QACtB,SAAA,EAAWA;AAAA,MACb,CAAA;AAAA,MACA,QAAA,EAAU;AAAA,QACR,OAAA,EAAS,CAAC,CAACC,SAAAA,CAAS,MAAA;AAAA,QACpB,SAAA,EAAWA;AAAA,MACb,CAAA;AAAA,MACA,eAAA,EAAiB;AAAA,QACf,OAAA,EAAS,CAAC,CAACC,gBAAAA,CAAgB,MAAA;AAAA,QAC3B,SAAA,EAAWA;AAAA,MACb,CAAA;AAAA,MACA,WAAA,EAAa;AAAA,QACX,OAAA,EAAS,CAAC,CAACE,YAAAA,CAAY,MAAA;AAAA,QACvB,SAAA,EAAWA;AAAA,MACb,CAAA;AAAA,MACA,YAAA,EAAc;AAAA,QACZ,OAAA,EAAS,CAAC,CAACC,aAAAA,CAAa,MAAA;AAAA,QACxB,SAAA,EAAWA;AAAA,MACb,CAAA;AAAA,MACA,UAAA,EAAY;AAAA,QACV,OAAA,EAAS,CAAC,CAACF,WAAAA,CAAW,MAAA;AAAA,QACtB,SAAA,EAAWA;AAAA,MACb,CAAA;AAAA,MACA,QAAA,EAAU;AAAA,QACR,OAAA,EAAS,CAAC,CAACG,SAAAA,CAAS,MAAA;AAAA,QACpB,SAAA,EAAWA;AAAA,MACb;AAAA,IACF;AAAA,EACF,CAAA;AAEA,EAAA,OAAO,QAAA;AACT;AF0EA;AACE;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACF,o2BAAC","file":"/Users/erunion/code/readme/oas/packages/oas/dist/analyzer/index.cjs","sourcesContent":[null,"import type { OASDocument } from '../../types.js';\n\nimport Oas from '../../index.js';\nimport { query, refizePointer } from '../util.js';\n\n/**\n * Determine if a given API definition uses the `additionalProperties` schema property.\n *\n * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#schema-object}\n * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#schema-object}\n */\nexport function additionalProperties(definition: OASDocument): string[] {\n  return query(['$..additionalProperties'], definition).map(res => refizePointer(res.pointer));\n}\n\n/**\n * Determine if a given API definition utilizes `callbacks`.\n *\n * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#callback-object}\n * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#callback-object}\n */\nexport function callbacks(definition: OASDocument): string[] {\n  return query(['$.components.callbacks', '$.paths.*[?(@.callbacks)].callbacks'], definition).map(res =>\n    refizePointer(res.pointer),\n  );\n}\n\n/**\n * Determine if a given API definition has circular refs.\n *\n * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#schema-object}\n * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#schema-object}\n */\nexport async function circularRefs(definition: OASDocument): Promise<string[]> {\n  // Dereferencing will update the passed in variable, which we don't want to do, so we\n  // instantiated `Oas` with a clone.\n  const oas = new Oas(structuredClone(definition));\n  await oas.dereference();\n\n  const results = oas.getCircularReferences();\n\n  results.sort();\n  return results;\n}\n\n/**\n * Determine if a given API definition utilizes common parameters.\n *\n * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#path-item-object}\n * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#path-item-object}\n */\nexport function commonParameters(definition: OASDocument): string[] {\n  return query(['$..paths[*].parameters'], definition).map(res => refizePointer(res.pointer));\n}\n\n/**\n * Determine if a given API definition utilizes discriminators.\n *\n * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#discriminator-object}\n * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#discriminator-object}\n */\nexport function discriminators(definition: OASDocument): string[] {\n  return query(['$..discriminator'], definition).map(res => refizePointer(res.pointer));\n}\n\n/**\n * Calculate the size of the raw and dereferenced OpenAPI file in MB.\n *\n * If a dereferenced API definition is too large to be stringified the file size will be returned\n * as NaN.\n *\n */\nexport async function fileSize(definition: OASDocument): Promise<{ raw: number; dereferenced: number | typeof NaN }> {\n  const oas = new Oas(structuredClone(definition));\n\n  const originalSizeInBytes = Buffer.from(JSON.stringify(oas.api)).length;\n  const raw = Number((originalSizeInBytes / (1024 * 1024)).toFixed(2));\n\n  await oas.dereference();\n\n  let dereferenced: number;\n  try {\n    const dereferencedSizeInBytes = Buffer.from(JSON.stringify(oas.api)).length;\n    dereferenced = Number((dereferencedSizeInBytes / (1024 * 1024)).toFixed(2));\n  } catch (err) {\n    // If the dereferenced API definition is too large to be stringified then we don't have a safer\n    // way to estimate its size that wouldn't sacrifice accuracy so we'll just return NaN.\n    if (err instanceof RangeError) {\n      dereferenced = NaN;\n    } else {\n      throw err;\n    }\n  }\n\n  return { raw, dereferenced };\n}\n\n/**\n * Determine if a given API definition utilizes `links`.\n *\n * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#link-object}\n * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#link-object}\n */\nexport function links(definition: OASDocument): string[] {\n  return query(['$.components.links', '$.paths..responses.*.links'], definition).map(res => refizePointer(res.pointer));\n}\n\n/**\n * Determine all of the available media types used within an API definition.\n *\n * @todo This query currently picks up false positives if there is an object named `content`.\n * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#request-body-object}\n * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#request-body-object}\n */\nexport function mediaTypes(definition: OASDocument): string[] {\n  const results = Array.from(\n    new Set(\n      query(['$..paths..content'], definition).flatMap(res => {\n        // This'll transform `results`, which looks like `[['application/json'], ['text/xml']]`\n        // into `['application/json', 'text/xml']`.\n        return Object.keys(res.value);\n      }),\n    ),\n  );\n\n  results.sort();\n  return results;\n}\n\n/**\n * Determine if a given API definition uses parameter serialization.\n *\n * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#parameter-object}\n * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#parameter-object}\n */\nexport function parameterSerialization(definition: OASDocument): string[] {\n  return query(['$..parameters[*].style^'], definition).map(res => refizePointer(res.pointer));\n}\n\n/**\n * Determine if a given API definition utilizes schema polymorphism and/of interitance.\n *\n * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#schema-object}\n * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#schema-object}\n */\nexport function polymorphism(definition: OASDocument): string[] {\n  const results = Array.from(\n    new Set(query(['$..allOf^', '$..anyOf^', '$..oneOf^'], definition).map(res => refizePointer(res.pointer))),\n  );\n\n  results.sort();\n  return results;\n}\n\n/**\n * Determine if a given API definition utilizes `$ref` pointers.\n *\n */\nexport function references(definition: OASDocument): string[] {\n  return query(['$..$ref^'], definition).map(res => refizePointer(res.pointer));\n}\n\n/**\n * Determine if a given API definition previously had references by checking if we added the\n * `x-readme-ref-name` extension after dereferencing. This extension is added only during the\n * dereferencing process.\n *\n */\nexport function refNames(definition: OASDocument): string[] {\n  return query([\"$..['x-readme-ref-name']\"], definition).map(res => refizePointer(res.pointer));\n}\n\n/**\n * Determine every kind of security type that a given API definition has documented.\n *\n * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#security-scheme-object}\n * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#security-scheme-object}\n */\nexport function securityTypes(definition: OASDocument): string[] {\n  return Array.from(new Set(query(['$.components.securitySchemes..type'], definition).map(res => res.value as string)));\n}\n\n/**\n * Determine if a given API definition utilizes server variables.\n *\n * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#server-variable-object}\n * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#server-variable-object}\n */\nexport function serverVariables(definition: OASDocument): string[] {\n  return query(['$.servers..variables^'], definition).map(res => refizePointer(res.pointer));\n}\n\n/**\n * Determine how many operations are defined in a given API definition.\n *\n * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#operation-object}\n * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#operation-object}\n */\nexport function totalOperations(definition: OASDocument): number {\n  return query(['$..paths[*]'], definition).flatMap(res => Object.keys(res.value)).length;\n}\n\n/**\n * Determine if a given API definition utilizes `webhooks` support in OpenAPI 3.1.\n *\n * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#oasWebhooks}\n */\nexport function webhooks(definition: OASDocument): string[] {\n  return query(['$.webhooks[*]'], definition).map(res => refizePointer(res.pointer));\n}\n\n/**\n * Determine if a given API definition uses XML in a request body payload.\n *\n * @todo detect `+xml` media types\n * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#media-type-object}\n * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#media-type-object}\n */\nexport function xmlRequests(definition: OASDocument): string[] {\n  return query(\n    [\n      \"$..requestBody..['application/xml']\",\n      \"$..requestBody..['application/xml-external-parsed-entity']\",\n      \"$..requestBody..['application/xml-dtd']\",\n      \"$..requestBody..['text/xml']\",\n      \"$..requestBody..['text/xml-external-parsed-entity']\",\n      '$..requestBody.content[?(@property.match(/\\\\+xml$/i))]',\n    ],\n    definition,\n  ).map(res => refizePointer(res.pointer));\n}\n\n/**\n * Determine if a given API definition uses XML in a response body.\n *\n * @todo detect `+xml` media types\n * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#media-type-object}\n * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#media-type-object}\n */\nexport function xmlResponses(definition: OASDocument): string[] {\n  return query(\n    [\n      \"$..responses..['application/xml']\",\n      \"$..responses..['application/xml-external-parsed-entity']\",\n      \"$..responses..['application/xml-dtd']\",\n      \"$..responses..['text/xml']\",\n      \"$..responses..['text/xml-external-parsed-entity']\",\n      '$..responses[*].content[?(@property.match(/\\\\+xml$/i))]',\n    ],\n    definition,\n  ).map(res => refizePointer(res.pointer));\n}\n\n/**\n * Determine if a given API definition utilises the XML object for defining XML schemas.\n *\n * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#xml-object}\n * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#xml-object}\n */\nexport function xmlSchemas(definition: OASDocument): string[] {\n  return query(['$.components.schemas..xml^', '$..parameters..xml^', '$..requestBody..xml^'], definition).map(res =>\n    refizePointer(res.pointer),\n  );\n}\n","import type { OASDocument } from '../types.js';\nimport type { OASAnalysis } from './types.js';\n\nimport {\n  additionalProperties as analyzeAdditionalProperties,\n  callbacks as analyzeCallbacks,\n  circularRefs as analyzeCircularRefs,\n  commonParameters as analyzeCommonParameters,\n  discriminators as analyzeDiscriminators,\n  fileSize as analyzeFileSize,\n  links as analyzeLinks,\n  mediaTypes as analyzeMediaTypes,\n  parameterSerialization as analyzeParameterSerialization,\n  polymorphism as analyzePolymorphism,\n  references as analyzeReferences,\n  refNames as analyzeRefNames,\n  securityTypes as analyzeSecurityTypes,\n  serverVariables as analyzeServerVariables,\n  totalOperations as analyzeTotalOperations,\n  webhooks as analyzeWebhooks,\n  xmlRequests as analyzeXMLRequests,\n  xmlResponses as analyzeXMLResponses,\n  xmlSchemas as analyzeXMLSchemas,\n} from './queries/openapi.js';\n\nexport {\n  analyzeAdditionalProperties,\n  analyzeCallbacks,\n  analyzeCircularRefs,\n  analyzeCommonParameters,\n  analyzeDiscriminators,\n  analyzeFileSize,\n  analyzeLinks,\n  analyzeMediaTypes,\n  analyzeParameterSerialization,\n  analyzePolymorphism,\n  analyzeReferences,\n  analyzeRefNames,\n  analyzeSecurityTypes,\n  analyzeServerVariables,\n  analyzeTotalOperations,\n  analyzeWebhooks,\n  analyzeXMLRequests,\n  analyzeXMLResponses,\n  analyzeXMLSchemas,\n};\n\n/**\n * Analyze a given OpenAPI or Swagger definition for any OpenAPI or JSON Schema feature uses it\n * may contain or utilize.\n *\n */\nexport async function analyzer(definition: OASDocument): Promise<OASAnalysis> {\n  const additionalProperties = analyzeAdditionalProperties(definition);\n  const callbacks = analyzeCallbacks(definition);\n  const circularRefs = await analyzeCircularRefs(definition);\n  const commonParameters = analyzeCommonParameters(definition);\n  const discriminators = analyzeDiscriminators(definition);\n  const { raw: rawFileSize, dereferenced: dereferencedFileSize } = await analyzeFileSize(definition);\n  const links = analyzeLinks(definition);\n  const parameterSerialization = analyzeParameterSerialization(definition);\n  const polymorphism = analyzePolymorphism(definition);\n  const references = analyzeReferences(definition);\n  const refNames = analyzeRefNames(definition);\n  const serverVariables = analyzeServerVariables(definition);\n  const xmlSchemas = analyzeXMLSchemas(definition);\n  const xmlRequests = analyzeXMLRequests(definition);\n  const xmlResponses = analyzeXMLResponses(definition);\n  const webhooks = analyzeWebhooks(definition);\n\n  const analysis: OASAnalysis = {\n    general: {\n      dereferencedFileSize: {\n        name: 'Dereferenced File Size',\n        found: dereferencedFileSize,\n      },\n      mediaTypes: {\n        name: 'Media Type',\n        found: analyzeMediaTypes(definition),\n      },\n      operationTotal: {\n        name: 'Operation',\n        found: analyzeTotalOperations(definition),\n      },\n      rawFileSize: {\n        name: 'Raw File Size',\n        found: rawFileSize,\n      },\n      securityTypes: {\n        name: 'Security Type',\n        found: analyzeSecurityTypes(definition),\n      },\n    },\n    openapi: {\n      additionalProperties: {\n        present: !!additionalProperties.length,\n        locations: additionalProperties,\n      },\n      callbacks: {\n        present: !!callbacks.length,\n        locations: callbacks,\n      },\n      circularRefs: {\n        present: !!circularRefs.length,\n        locations: circularRefs,\n      },\n      commonParameters: {\n        present: !!commonParameters.length,\n        locations: commonParameters,\n      },\n      discriminators: {\n        present: !!discriminators.length,\n        locations: discriminators,\n      },\n      links: {\n        present: !!links.length,\n        locations: links,\n      },\n      style: {\n        present: !!parameterSerialization.length,\n        locations: parameterSerialization,\n      },\n      polymorphism: {\n        present: !!polymorphism.length,\n        locations: polymorphism,\n      },\n      references: {\n        present: !!references.length,\n        locations: references,\n      },\n      refNames: {\n        present: !!refNames.length,\n        locations: refNames,\n      },\n      serverVariables: {\n        present: !!serverVariables.length,\n        locations: serverVariables,\n      },\n      xmlRequests: {\n        present: !!xmlRequests.length,\n        locations: xmlRequests,\n      },\n      xmlResponses: {\n        present: !!xmlResponses.length,\n        locations: xmlResponses,\n      },\n      xmlSchemas: {\n        present: !!xmlSchemas.length,\n        locations: xmlSchemas,\n      },\n      webhooks: {\n        present: !!webhooks.length,\n        locations: webhooks,\n      },\n    },\n  };\n\n  return analysis;\n}\n"]}
+{"version":3,"sources":["/Users/erunion/code/readme/oas/packages/oas/dist/analyzer/index.cjs","../../src/analyzer/dereference.ts","../../src/analyzer/queries/openapi.ts","../../src/analyzer/index.ts"],"names":["circularRefs","additionalProperties","callbacks","commonParameters","discriminators","links","parameterSerialization","polymorphism","references","serverVariables","xmlRequests","xmlResponses","xmlSchemas","webhooks"],"mappings":"AAAA;AACE;AACA;AACF,yDAA8B;AAC9B;AACA;ACFA,uDAA4B;AAM5B,SAAS,uBAAA,CAAwBA,aAAAA,EAA2E;AAC1G,EAAA,OAAO;AAAA,IACL,OAAA,EAAS;AAAA;AAAA,MAEP,QAAA,EAAU;AAAA,IACZ,CAAA;AAAA,IACA,WAAA,EAAa;AAAA;AAAA;AAAA;AAAA,MAIX,QAAA,EAAU,QAAA;AAAA,MAEV,UAAA,EAAY,CAAC,IAAA,EAAA,GAAiB;AAK5B,QAAAA,aAAAA,CAAa,GAAA,CAAI,CAAA,CAAA,EAAI,IAAA,CAAK,KAAA,CAAM,GAAG,CAAA,CAAE,CAAC,CAAC,CAAA,CAAA;AACzC,MAAA;AACF,IAAA;AACF,EAAA;AACF;AAkB8B;AAE6C;AAC7B,EAAA;AAChC,EAAA;AACF,IAAA;AACM,MAAA;AACF,MAAA;AACK,MAAA;AACJ,MAAA;AACb,IAAA;AACuC,IAAA;AACzC,EAAA;AAEO,EAAA;AACT;AAkBiC;AACa,EAAA;AAER,EAAA;AACrB,IAAA;AACf,EAAA;AAEsB,EAAA;AACoB,IAAA;AACC,MAAA;AACxC,IAAA;AACH,EAAA;AAEmB,EAAA;AAEuB,EAAA;AACb,EAAA;AACR,EAAA;AAEuB,EAAA;AAEH,IAAA;AAC9B,MAAA;AACyB,MAAA;AAChC,IAAA;AAEe,IAAA;AACa,IAAA;AACT,IAAA;AACF,IAAA;AAGH,IAAA;AACJ,MAAA;AACV,IAAA;AAEO,IAAA;AAEO,EAAA;AACwB,IAAA;AACpB,IAAA;AACX,IAAA;AAEK,EAAA;AACO,IAAA;AACmB,IAAA;AACpB,IAAA;AACZ,IAAA;AACP,EAAA;AACL;ADtDiD;AACA;AElEuB;AAC5B,EAAA;AAC5C;AAQ6D;AACnB,EAAA;AACb,IAAA;AAC3B,EAAA;AACF;AAQ+E;AAGxC,EAAA;AAEb,EAAA;AACX,EAAA;AACN,EAAA;AACT;AAQoE;AACzB,EAAA;AAC3C;AAQkE;AACjB,EAAA;AACjD;AAWE;AAE6C,EAAA;AACF,EAAA;AAEvC,EAAA;AACA,EAAA;AAC0C,IAAA;AACrB,IAAA;AACX,EAAA;AAGmB,IAAA;AACd,MAAA;AACV,IAAA;AACC,MAAA;AACR,IAAA;AACF,EAAA;AAE2B,EAAA;AAC7B;AAQyD;AACnB,EAAA;AACtC;AAS8D;AACtC,EAAA;AAChB,IAAA;AACuC,MAAA;AAGX,QAAA;AAC7B,MAAA;AACH,IAAA;AACF,EAAA;AAEa,EAAA;AACN,EAAA;AACT;AAQ0E;AAC9B,EAAA;AAC5C;AAQgE;AACxC,EAAA;AACqB,IAAA;AAC3C,EAAA;AAEa,EAAA;AACN,EAAA;AACT;AAM8D;AACjB,EAAA;AAC7C;AAQiE;AAC9B,EAAA;AACnC;AAQmE;AACzB,EAAA;AAC1C;AAQiE;AACrB,EAAA;AAC5C;AAO4D;AACd,EAAA;AAC9C;AAS+D;AACtD,EAAA;AACL,IAAA;AACE,MAAA;AACA,MAAA;AACA,MAAA;AACA,MAAA;AACA,MAAA;AACA,MAAA;AACF,IAAA;AACA,IAAA;AACqC,EAAA;AACzC;AASgE;AACvD,EAAA;AACL,IAAA;AACE,MAAA;AACA,MAAA;AACA,MAAA;AACA,MAAA;AACA,MAAA;AACA,MAAA;AACF,IAAA;AACA,IAAA;AACqC,EAAA;AACzC;AAQ8D;AAChB,EAAA;AACjB,IAAA;AAC3B,EAAA;AACF;AFlEiD;AACA;AGtI6B;AACnC,EAAA;AACG,EAAA;AAEf,EAAA;AACgB,EAAA;AACpB,EAAA;AACwB,EAAA;AACJ,EAAA;AACL,EAAA;AACH,EAAA;AACN,EAAA;AACoB,EAAA;AACJ,EAAA;AACA,EAAA;AACA,EAAA;AACE,EAAA;AACE,EAAA;AACR,EAAA;AAEb,EAAA;AACnB,IAAA;AACe,MAAA;AACd,QAAA;AACC,QAAA;AACT,MAAA;AACY,MAAA;AACJ,QAAA;AAC6B,QAAA;AACrC,MAAA;AACgB,MAAA;AACR,QAAA;AACkC,QAAA;AAC1C,MAAA;AACa,MAAA;AACL,QAAA;AACC,QAAA;AACT,MAAA;AACe,MAAA;AACP,QAAA;AACgC,QAAA;AACxC,MAAA;AACF,IAAA;AACS,IAAA;AACe,MAAA;AACY,QAAA;AACrBC,QAAAA;AACb,MAAA;AACW,MAAA;AACY,QAAA;AACVC,QAAAA;AACb,MAAA;AACc,MAAA;AACY,QAAA;AACbF,QAAAA;AACb,MAAA;AACkB,MAAA;AACY,QAAA;AACjBG,QAAAA;AACb,MAAA;AACgB,MAAA;AACY,QAAA;AACfC,QAAAA;AACb,MAAA;AACO,MAAA;AACY,QAAA;AACNC,QAAAA;AACb,MAAA;AACO,MAAA;AAC6B,QAAA;AACvBC,QAAAA;AACb,MAAA;AACc,MAAA;AACY,QAAA;AACbC,QAAAA;AACb,MAAA;AACY,MAAA;AACY,QAAA;AACXC,QAAAA;AACb,MAAA;AACiB,MAAA;AACY,QAAA;AAChBC,QAAAA;AACb,MAAA;AACa,MAAA;AACY,QAAA;AACZC,QAAAA;AACb,MAAA;AACc,MAAA;AACY,QAAA;AACbC,QAAAA;AACb,MAAA;AACY,MAAA;AACY,QAAA;AACXC,QAAAA;AACb,MAAA;AACU,MAAA;AACY,QAAA;AACTC,QAAAA;AACb,MAAA;AACF,IAAA;AACF,EAAA;AAEO,EAAA;AACT;AHqIiD;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA","file":"/Users/erunion/code/readme/oas/packages/oas/dist/analyzer/index.cjs","sourcesContent":[null,"import type { OASDocument } from '../types.js';\nimport type { ParserOptions } from '@readme/openapi-parser';\n\nimport { dereference } from '@readme/openapi-parser';\n\n/**\n * Retrive our dereferencing configuration for `@readme/openapi-parser`.\n *\n */\nfunction getDereferencingOptions(circularRefs: Set<string>): Pick<ParserOptions, 'resolve' | 'dereference'> {\n  return {\n    resolve: {\n      // We shouldn't be resolving external pointers at this point so just ignore them.\n      external: false,\n    },\n    dereference: {\n      // If circular `$refs` are ignored they'll remain in the schema as `$ref: String`, otherwise\n      // `$ref` just won't exist. This, in tandem with `onCircular`, allows us to do easy and\n      // accumulate a list of circular references.\n      circular: 'ignore',\n\n      onCircular: (path: string) => {\n        // The circular references that are coming out of `json-schema-ref-parser` are prefixed\n        // with the schema path (file path, URL, whatever) that the schema exists in. Because we\n        // don't care about this information for this reporting mechanism, and only the `$ref`\n        // pointer, we're removing it.\n        circularRefs.add(`#${path.split('#')[1]}`);\n      },\n    },\n  };\n}\n\ninterface DereferenceOasResult {\n  api: OASDocument;\n  circularRefs: string[];\n}\n\ninterface DereferenceOasState {\n  circularRefs: string[];\n  complete: boolean;\n  processing: boolean;\n  promises: {\n    reject: (err: unknown) => void;\n    resolve: (result: DereferenceOasResult) => void;\n  }[];\n  result?: DereferenceOasResult;\n}\n\nconst dereferenceStates = new WeakMap<OASDocument, DereferenceOasState>();\n\nfunction getDereferenceState(definition: OASDocument): DereferenceOasState {\n  let state = dereferenceStates.get(definition);\n  if (!state) {\n    state = {\n      processing: false,\n      complete: false,\n      circularRefs: [],\n      promises: [],\n    };\n    dereferenceStates.set(definition, state);\n  }\n\n  return state;\n}\n\n/**\n * Dereference a given OpenAPI definition so it can be parsed free from the hassle of resolving\n * `$ref` schemas and circular structures.\n *\n */\nexport async function dereferenceOas(\n  definition: OASDocument,\n  opts?: {\n    /**\n     * A callback method can be supplied to be called when dereferencing is complete. Used for\n     * debugging that the multi-promise handling within this method works.\n     *\n     * @private\n     */\n    cb?: () => void;\n  },\n): Promise<DereferenceOasResult> {\n  const state = getDereferenceState(definition);\n\n  if (state.complete && state.result) {\n    return state.result;\n  }\n\n  if (state.processing) {\n    return new Promise((resolve, reject) => {\n      state.promises.push({ resolve, reject });\n    });\n  }\n\n  state.processing = true;\n\n  const circularRefs: Set<string> = new Set();\n  const dereferencingOptions = getDereferencingOptions(circularRefs);\n  const { promises } = state;\n\n  return dereference<OASDocument>(definition, dereferencingOptions)\n    .then((dereferenced: OASDocument) => {\n      const result: DereferenceOasResult = {\n        api: dereferenced,\n        circularRefs: [...circularRefs],\n      };\n\n      state.result = result;\n      state.circularRefs = result.circularRefs;\n      state.processing = false;\n      state.complete = true;\n\n      // Used for debugging that dereferencing promise awaiting works.\n      if (opts?.cb) {\n        opts.cb();\n      }\n\n      return result;\n    })\n    .then(result => {\n      promises.forEach(deferred => deferred.resolve(result));\n      state.promises = [];\n      return result;\n    })\n    .catch(err => {\n      state.processing = false;\n      promises.forEach(deferred => deferred.reject(err));\n      state.promises = [];\n      throw err;\n    });\n}\n","import type { OASDocument } from '../../types.js';\n\nimport { dereferenceOas } from '../dereference.js';\nimport { query, refizePointer } from '../util.js';\n\n/**\n * Determine if a given API definition uses the `additionalProperties` schema property.\n *\n * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#schema-object}\n * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#schema-object}\n */\nexport function additionalProperties(definition: OASDocument): string[] {\n  return query(['$..additionalProperties'], definition).map(res => refizePointer(res.pointer));\n}\n\n/**\n * Determine if a given API definition utilizes `callbacks`.\n *\n * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#callback-object}\n * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#callback-object}\n */\nexport function callbacks(definition: OASDocument): string[] {\n  return query(['$.components.callbacks', '$.paths.*[?(@.callbacks)].callbacks'], definition).map(res =>\n    refizePointer(res.pointer),\n  );\n}\n\n/**\n * Determine if a given API definition has circular refs.\n *\n * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#schema-object}\n * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#schema-object}\n */\nexport async function circularRefs(definition: OASDocument): Promise<string[]> {\n  // Dereferencing will update the passed in variable, which we don't want to do, so we\n  // instantiated `Oas` with a clone.\n  const { circularRefs: refs } = await dereferenceOas(structuredClone(definition));\n\n  const results = [...refs];\n  results.sort();\n  return results;\n}\n\n/**\n * Determine if a given API definition utilizes common parameters.\n *\n * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#path-item-object}\n * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#path-item-object}\n */\nexport function commonParameters(definition: OASDocument): string[] {\n  return query(['$..paths[*].parameters'], definition).map(res => refizePointer(res.pointer));\n}\n\n/**\n * Determine if a given API definition utilizes discriminators.\n *\n * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#discriminator-object}\n * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#discriminator-object}\n */\nexport function discriminators(definition: OASDocument): string[] {\n  return query(['$..discriminator'], definition).map(res => refizePointer(res.pointer));\n}\n\n/**\n * Calculate the size of the raw and dereferenced OpenAPI file in MB.\n *\n * If a dereferenced API definition is too large to be stringified the file size will be returned\n * as NaN.\n *\n */\nexport function fileSize(\n  definition: OASDocument,\n  definitionDereferenced: OASDocument,\n): { raw: number; dereferenced: number | typeof NaN } {\n  const originalSizeInBytes = Buffer.from(JSON.stringify(definition)).length;\n  const raw = Number((originalSizeInBytes / (1024 * 1024)).toFixed(2));\n\n  let dereferenced: number;\n  try {\n    const dereferencedSizeInBytes = Buffer.from(JSON.stringify(definitionDereferenced)).length;\n    dereferenced = Number((dereferencedSizeInBytes / (1024 * 1024)).toFixed(2));\n  } catch (err) {\n    // If the dereferenced API definition is too large to be stringified then we don't have a safer\n    // way to estimate its size that wouldn't sacrifice accuracy so we'll just return NaN.\n    if (err instanceof RangeError) {\n      dereferenced = NaN;\n    } else {\n      throw err;\n    }\n  }\n\n  return { raw, dereferenced };\n}\n\n/**\n * Determine if a given API definition utilizes `links`.\n *\n * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#link-object}\n * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#link-object}\n */\nexport function links(definition: OASDocument): string[] {\n  return query(['$.components.links', '$.paths..responses.*.links'], definition).map(res => refizePointer(res.pointer));\n}\n\n/**\n * Determine all of the available media types used within an API definition.\n *\n * @todo This query currently picks up false positives if there is an object named `content`.\n * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#request-body-object}\n * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#request-body-object}\n */\nexport function mediaTypes(definition: OASDocument): string[] {\n  const results = Array.from(\n    new Set(\n      query(['$..paths..content'], definition).flatMap(res => {\n        // This'll transform `results`, which looks like `[['application/json'], ['text/xml']]`\n        // into `['application/json', 'text/xml']`.\n        return Object.keys(res.value);\n      }),\n    ),\n  );\n\n  results.sort();\n  return results;\n}\n\n/**\n * Determine if a given API definition uses parameter serialization.\n *\n * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#parameter-object}\n * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#parameter-object}\n */\nexport function parameterSerialization(definition: OASDocument): string[] {\n  return query(['$..parameters[*].style^'], definition).map(res => refizePointer(res.pointer));\n}\n\n/**\n * Determine if a given API definition utilizes schema polymorphism and/of interitance.\n *\n * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#schema-object}\n * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#schema-object}\n */\nexport function polymorphism(definition: OASDocument): string[] {\n  const results = Array.from(\n    new Set(query(['$..allOf^', '$..anyOf^', '$..oneOf^'], definition).map(res => refizePointer(res.pointer))),\n  );\n\n  results.sort();\n  return results;\n}\n\n/**\n * Determine if a given API definition utilizes `$ref` pointers.\n *\n */\nexport function references(definition: OASDocument): string[] {\n  return query(['$..$ref^'], definition).map(res => refizePointer(res.pointer));\n}\n\n/**\n * Determine every kind of security type that a given API definition has documented.\n *\n * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#security-scheme-object}\n * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#security-scheme-object}\n */\nexport function securityTypes(definition: OASDocument): string[] {\n  return Array.from(new Set(query(['$.components.securitySchemes..type'], definition).map(res => res.value as string)));\n}\n\n/**\n * Determine if a given API definition utilizes server variables.\n *\n * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#server-variable-object}\n * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#server-variable-object}\n */\nexport function serverVariables(definition: OASDocument): string[] {\n  return query(['$.servers..variables^'], definition).map(res => refizePointer(res.pointer));\n}\n\n/**\n * Determine how many operations are defined in a given API definition.\n *\n * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#operation-object}\n * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#operation-object}\n */\nexport function totalOperations(definition: OASDocument): number {\n  return query(['$..paths[*]'], definition).flatMap(res => Object.keys(res.value)).length;\n}\n\n/**\n * Determine if a given API definition utilizes `webhooks` support in OpenAPI 3.1.\n *\n * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#oasWebhooks}\n */\nexport function webhooks(definition: OASDocument): string[] {\n  return query(['$.webhooks[*]'], definition).map(res => refizePointer(res.pointer));\n}\n\n/**\n * Determine if a given API definition uses XML in a request body payload.\n *\n * @todo detect `+xml` media types\n * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#media-type-object}\n * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#media-type-object}\n */\nexport function xmlRequests(definition: OASDocument): string[] {\n  return query(\n    [\n      \"$..requestBody..['application/xml']\",\n      \"$..requestBody..['application/xml-external-parsed-entity']\",\n      \"$..requestBody..['application/xml-dtd']\",\n      \"$..requestBody..['text/xml']\",\n      \"$..requestBody..['text/xml-external-parsed-entity']\",\n      '$..requestBody.content[?(@property.match(/\\\\+xml$/i))]',\n    ],\n    definition,\n  ).map(res => refizePointer(res.pointer));\n}\n\n/**\n * Determine if a given API definition uses XML in a response body.\n *\n * @todo detect `+xml` media types\n * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#media-type-object}\n * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#media-type-object}\n */\nexport function xmlResponses(definition: OASDocument): string[] {\n  return query(\n    [\n      \"$..responses..['application/xml']\",\n      \"$..responses..['application/xml-external-parsed-entity']\",\n      \"$..responses..['application/xml-dtd']\",\n      \"$..responses..['text/xml']\",\n      \"$..responses..['text/xml-external-parsed-entity']\",\n      '$..responses[*].content[?(@property.match(/\\\\+xml$/i))]',\n    ],\n    definition,\n  ).map(res => refizePointer(res.pointer));\n}\n\n/**\n * Determine if a given API definition utilises the XML object for defining XML schemas.\n *\n * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#xml-object}\n * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#xml-object}\n */\nexport function xmlSchemas(definition: OASDocument): string[] {\n  return query(['$.components.schemas..xml^', '$..parameters..xml^', '$..requestBody..xml^'], definition).map(res =>\n    refizePointer(res.pointer),\n  );\n}\n","import type { OASDocument } from '../types.js';\nimport type { OASAnalysis } from './types.js';\n\nimport { dereferenceOas } from './dereference.js';\nimport {\n  additionalProperties as analyzeAdditionalProperties,\n  callbacks as analyzeCallbacks,\n  circularRefs as analyzeCircularRefs,\n  commonParameters as analyzeCommonParameters,\n  discriminators as analyzeDiscriminators,\n  fileSize as analyzeFileSize,\n  links as analyzeLinks,\n  mediaTypes as analyzeMediaTypes,\n  parameterSerialization as analyzeParameterSerialization,\n  polymorphism as analyzePolymorphism,\n  references as analyzeReferences,\n  securityTypes as analyzeSecurityTypes,\n  serverVariables as analyzeServerVariables,\n  totalOperations as analyzeTotalOperations,\n  webhooks as analyzeWebhooks,\n  xmlRequests as analyzeXMLRequests,\n  xmlResponses as analyzeXMLResponses,\n  xmlSchemas as analyzeXMLSchemas,\n} from './queries/openapi.js';\n\nexport {\n  analyzeAdditionalProperties,\n  analyzeCallbacks,\n  analyzeCircularRefs,\n  analyzeCommonParameters,\n  analyzeDiscriminators,\n  analyzeFileSize,\n  analyzeLinks,\n  analyzeMediaTypes,\n  analyzeParameterSerialization,\n  analyzePolymorphism,\n  analyzeReferences,\n  analyzeSecurityTypes,\n  analyzeServerVariables,\n  analyzeTotalOperations,\n  analyzeWebhooks,\n  analyzeXMLRequests,\n  analyzeXMLResponses,\n  analyzeXMLSchemas,\n};\n\n/**\n * Analyze a given OpenAPI or Swagger definition for any OpenAPI or JSON Schema feature uses it\n * may contain or utilize.\n *\n */\nexport async function analyzer(definition: OASDocument): Promise<OASAnalysis> {\n  const clonedDefinition = structuredClone(definition);\n  const { api: dereferencedApi, circularRefs: dereferencedCircularRefs } = await dereferenceOas(clonedDefinition);\n\n  const additionalProperties = analyzeAdditionalProperties(definition);\n  const callbacks = analyzeCallbacks(definition);\n  const circularRefs = [...dereferencedCircularRefs].toSorted();\n  const commonParameters = analyzeCommonParameters(definition);\n  const discriminators = analyzeDiscriminators(definition);\n  const { raw: rawFileSize, dereferenced: dereferencedFileSize } = analyzeFileSize(definition, dereferencedApi);\n  const links = analyzeLinks(definition);\n  const parameterSerialization = analyzeParameterSerialization(definition);\n  const polymorphism = analyzePolymorphism(definition);\n  const references = analyzeReferences(definition);\n  const serverVariables = analyzeServerVariables(definition);\n  const xmlSchemas = analyzeXMLSchemas(definition);\n  const xmlRequests = analyzeXMLRequests(definition);\n  const xmlResponses = analyzeXMLResponses(definition);\n  const webhooks = analyzeWebhooks(definition);\n\n  const analysis: OASAnalysis = {\n    general: {\n      dereferencedFileSize: {\n        name: 'Dereferenced File Size',\n        found: dereferencedFileSize,\n      },\n      mediaTypes: {\n        name: 'Media Type',\n        found: analyzeMediaTypes(definition),\n      },\n      operationTotal: {\n        name: 'Operation',\n        found: analyzeTotalOperations(definition),\n      },\n      rawFileSize: {\n        name: 'Raw File Size',\n        found: rawFileSize,\n      },\n      securityTypes: {\n        name: 'Security Type',\n        found: analyzeSecurityTypes(definition),\n      },\n    },\n    openapi: {\n      additionalProperties: {\n        present: !!additionalProperties.length,\n        locations: additionalProperties,\n      },\n      callbacks: {\n        present: !!callbacks.length,\n        locations: callbacks,\n      },\n      circularRefs: {\n        present: !!circularRefs.length,\n        locations: circularRefs,\n      },\n      commonParameters: {\n        present: !!commonParameters.length,\n        locations: commonParameters,\n      },\n      discriminators: {\n        present: !!discriminators.length,\n        locations: discriminators,\n      },\n      links: {\n        present: !!links.length,\n        locations: links,\n      },\n      style: {\n        present: !!parameterSerialization.length,\n        locations: parameterSerialization,\n      },\n      polymorphism: {\n        present: !!polymorphism.length,\n        locations: polymorphism,\n      },\n      references: {\n        present: !!references.length,\n        locations: references,\n      },\n      serverVariables: {\n        present: !!serverVariables.length,\n        locations: serverVariables,\n      },\n      xmlRequests: {\n        present: !!xmlRequests.length,\n        locations: xmlRequests,\n      },\n      xmlResponses: {\n        present: !!xmlResponses.length,\n        locations: xmlResponses,\n      },\n      xmlSchemas: {\n        present: !!xmlSchemas.length,\n        locations: xmlSchemas,\n      },\n      webhooks: {\n        present: !!webhooks.length,\n        locations: webhooks,\n      },\n    },\n  };\n\n  return analysis;\n}\n"]}

package/dist/analyzer/index.d.cts

@@ -45,10 +45,10 @@ declare function discriminators(definition: OASDocument): string[];
  * as NaN.
  *
  */
-declare function fileSize(definition: OASDocument): Promise<{
+declare function fileSize(definition: OASDocument, definitionDereferenced: OASDocument): {
     raw: number;
     dereferenced: number | typeof NaN;
-}>;
+};
 /**
  * Determine if a given API definition utilizes `links`.
  *
@@ -83,13 +83,6 @@ declare function polymorphism(definition: OASDocument): string[];
  *
  */
 declare function references(definition: OASDocument): string[];
-/**
- * Determine if a given API definition previously had references by checking if we added the
- * `x-readme-ref-name` extension after dereferencing. This extension is added only during the
- * dereferencing process.
- *
- */
-declare function refNames(definition: OASDocument): string[];
 /**
  * Determine every kind of security type that a given API definition has documented.
  *
@@ -148,4 +141,4 @@ declare function xmlSchemas(definition: OASDocument): string[];
  */
 declare function analyzer(definition: OASDocument): Promise<OASAnalysis>;
 
-export { additionalProperties as analyzeAdditionalProperties, callbacks as analyzeCallbacks, circularRefs as analyzeCircularRefs, commonParameters as analyzeCommonParameters, discriminators as analyzeDiscriminators, fileSize as analyzeFileSize, links as analyzeLinks, mediaTypes as analyzeMediaTypes, parameterSerialization as analyzeParameterSerialization, polymorphism as analyzePolymorphism, refNames as analyzeRefNames, references as analyzeReferences, securityTypes as analyzeSecurityTypes, serverVariables as analyzeServerVariables, totalOperations as analyzeTotalOperations, webhooks as analyzeWebhooks, xmlRequests as analyzeXMLRequests, xmlResponses as analyzeXMLResponses, xmlSchemas as analyzeXMLSchemas, analyzer };
+export { additionalProperties as analyzeAdditionalProperties, callbacks as analyzeCallbacks, circularRefs as analyzeCircularRefs, commonParameters as analyzeCommonParameters, discriminators as analyzeDiscriminators, fileSize as analyzeFileSize, links as analyzeLinks, mediaTypes as analyzeMediaTypes, parameterSerialization as analyzeParameterSerialization, polymorphism as analyzePolymorphism, references as analyzeReferences, securityTypes as analyzeSecurityTypes, serverVariables as analyzeServerVariables, totalOperations as analyzeTotalOperations, webhooks as analyzeWebhooks, xmlRequests as analyzeXMLRequests, xmlResponses as analyzeXMLResponses, xmlSchemas as analyzeXMLSchemas, analyzer };

package/dist/analyzer/index.d.ts

@@ -45,10 +45,10 @@ declare function discriminators(definition: OASDocument): string[];
  * as NaN.
  *
  */
-declare function fileSize(definition: OASDocument): Promise<{
+declare function fileSize(definition: OASDocument, definitionDereferenced: OASDocument): {
     raw: number;
     dereferenced: number | typeof NaN;
-}>;
+};
 /**
  * Determine if a given API definition utilizes `links`.
  *
@@ -83,13 +83,6 @@ declare function polymorphism(definition: OASDocument): string[];
  *
  */
 declare function references(definition: OASDocument): string[];
-/**
- * Determine if a given API definition previously had references by checking if we added the
- * `x-readme-ref-name` extension after dereferencing. This extension is added only during the
- * dereferencing process.
- *
- */
-declare function refNames(definition: OASDocument): string[];
 /**
  * Determine every kind of security type that a given API definition has documented.
  *
@@ -148,4 +141,4 @@ declare function xmlSchemas(definition: OASDocument): string[];
  */
 declare function analyzer(definition: OASDocument): Promise<OASAnalysis>;
 
-export { additionalProperties as analyzeAdditionalProperties, callbacks as analyzeCallbacks, circularRefs as analyzeCircularRefs, commonParameters as analyzeCommonParameters, discriminators as analyzeDiscriminators, fileSize as analyzeFileSize, links as analyzeLinks, mediaTypes as analyzeMediaTypes, parameterSerialization as analyzeParameterSerialization, polymorphism as analyzePolymorphism, refNames as analyzeRefNames, references as analyzeReferences, securityTypes as analyzeSecurityTypes, serverVariables as analyzeServerVariables, totalOperations as analyzeTotalOperations, webhooks as analyzeWebhooks, xmlRequests as analyzeXMLRequests, xmlResponses as analyzeXMLResponses, xmlSchemas as analyzeXMLSchemas, analyzer };
+export { additionalProperties as analyzeAdditionalProperties, callbacks as analyzeCallbacks, circularRefs as analyzeCircularRefs, commonParameters as analyzeCommonParameters, discriminators as analyzeDiscriminators, fileSize as analyzeFileSize, links as analyzeLinks, mediaTypes as analyzeMediaTypes, parameterSerialization as analyzeParameterSerialization, polymorphism as analyzePolymorphism, references as analyzeReferences, securityTypes as analyzeSecurityTypes, serverVariables as analyzeServerVariables, totalOperations as analyzeTotalOperations, webhooks as analyzeWebhooks, xmlRequests as analyzeXMLRequests, xmlResponses as analyzeXMLResponses, xmlSchemas as analyzeXMLSchemas, analyzer };

package/dist/analyzer/index.js

@@ -1,14 +1,79 @@
-import {
-  Oas
-} from "../chunk-4WJUHXQH.js";
-import "../chunk-RQZ2BPMU.js";
 import {
   query,
   refizePointer
 } from "../chunk-CKC36IL7.js";
-import "../chunk-6MDVLJ3A.js";
-import "../chunk-S27IGTVG.js";
-import "../chunk-XG4HGNCN.js";
+
+// src/analyzer/dereference.ts
+import { dereference } from "@readme/openapi-parser";
+function getDereferencingOptions(circularRefs2) {
+  return {
+    resolve: {
+      // We shouldn't be resolving external pointers at this point so just ignore them.
+      external: false
+    },
+    dereference: {
+      // If circular `$refs` are ignored they'll remain in the schema as `$ref: String`, otherwise
+      // `$ref` just won't exist. This, in tandem with `onCircular`, allows us to do easy and
+      // accumulate a list of circular references.
+      circular: "ignore",
+      onCircular: (path) => {
+        circularRefs2.add(`#${path.split("#")[1]}`);
+      }
+    }
+  };
+}
+var dereferenceStates = /* @__PURE__ */ new WeakMap();
+function getDereferenceState(definition) {
+  let state = dereferenceStates.get(definition);
+  if (!state) {
+    state = {
+      processing: false,
+      complete: false,
+      circularRefs: [],
+      promises: []
+    };
+    dereferenceStates.set(definition, state);
+  }
+  return state;
+}
+async function dereferenceOas(definition, opts) {
+  const state = getDereferenceState(definition);
+  if (state.complete && state.result) {
+    return state.result;
+  }
+  if (state.processing) {
+    return new Promise((resolve, reject) => {
+      state.promises.push({ resolve, reject });
+    });
+  }
+  state.processing = true;
+  const circularRefs2 = /* @__PURE__ */ new Set();
+  const dereferencingOptions = getDereferencingOptions(circularRefs2);
+  const { promises } = state;
+  return dereference(definition, dereferencingOptions).then((dereferenced) => {
+    const result = {
+      api: dereferenced,
+      circularRefs: [...circularRefs2]
+    };
+    state.result = result;
+    state.circularRefs = result.circularRefs;
+    state.processing = false;
+    state.complete = true;
+    if (opts?.cb) {
+      opts.cb();
+    }
+    return result;
+  }).then((result) => {
+    promises.forEach((deferred) => deferred.resolve(result));
+    state.promises = [];
+    return result;
+  }).catch((err) => {
+    state.processing = false;
+    promises.forEach((deferred) => deferred.reject(err));
+    state.promises = [];
+    throw err;
+  });
+}
 
 // src/analyzer/queries/openapi.ts
 function additionalProperties(definition) {
@@ -20,9 +85,8 @@ function callbacks(definition) {
   );
 }
 async function circularRefs(definition) {
-  const oas = new Oas(structuredClone(definition));
-  await oas.dereference();
-  const results = oas.getCircularReferences();
+  const { circularRefs: refs } = await dereferenceOas(structuredClone(definition));
+  const results = [...refs];
   results.sort();
   return results;
 }
@@ -32,14 +96,12 @@ function commonParameters(definition) {
 function discriminators(definition) {
   return query(["$..discriminator"], definition).map((res) => refizePointer(res.pointer));
 }
-async function fileSize(definition) {
-  const oas = new Oas(structuredClone(definition));
-  const originalSizeInBytes = Buffer.from(JSON.stringify(oas.api)).length;
+function fileSize(definition, definitionDereferenced) {
+  const originalSizeInBytes = Buffer.from(JSON.stringify(definition)).length;
   const raw = Number((originalSizeInBytes / (1024 * 1024)).toFixed(2));
-  await oas.dereference();
   let dereferenced;
   try {
-    const dereferencedSizeInBytes = Buffer.from(JSON.stringify(oas.api)).length;
+    const dereferencedSizeInBytes = Buffer.from(JSON.stringify(definitionDereferenced)).length;
     dereferenced = Number((dereferencedSizeInBytes / (1024 * 1024)).toFixed(2));
   } catch (err) {
     if (err instanceof RangeError) {
@@ -77,9 +139,6 @@ function polymorphism(definition) {
 function references(definition) {
   return query(["$..$ref^"], definition).map((res) => refizePointer(res.pointer));
 }
-function refNames(definition) {
-  return query(["$..['x-readme-ref-name']"], definition).map((res) => refizePointer(res.pointer));
-}
 function securityTypes(definition) {
   return Array.from(new Set(query(["$.components.securitySchemes..type"], definition).map((res) => res.value)));
 }
@@ -126,17 +185,18 @@ function xmlSchemas(definition) {
 
 // src/analyzer/index.ts
 async function analyzer(definition) {
+  const clonedDefinition = structuredClone(definition);
+  const { api: dereferencedApi, circularRefs: dereferencedCircularRefs } = await dereferenceOas(clonedDefinition);
   const additionalProperties2 = additionalProperties(definition);
   const callbacks2 = callbacks(definition);
-  const circularRefs2 = await circularRefs(definition);
+  const circularRefs2 = [...dereferencedCircularRefs].toSorted();
   const commonParameters2 = commonParameters(definition);
   const discriminators2 = discriminators(definition);
-  const { raw: rawFileSize, dereferenced: dereferencedFileSize } = await fileSize(definition);
+  const { raw: rawFileSize, dereferenced: dereferencedFileSize } = fileSize(definition, dereferencedApi);
   const links2 = links(definition);
   const parameterSerialization2 = parameterSerialization(definition);
   const polymorphism2 = polymorphism(definition);
   const references2 = references(definition);
-  const refNames2 = refNames(definition);
   const serverVariables2 = serverVariables(definition);
   const xmlSchemas2 = xmlSchemas(definition);
   const xmlRequests2 = xmlRequests(definition);
@@ -202,10 +262,6 @@ async function analyzer(definition) {
         present: !!references2.length,
         locations: references2
       },
-      refNames: {
-        present: !!refNames2.length,
-        locations: refNames2
-      },
       serverVariables: {
         present: !!serverVariables2.length,
         locations: serverVariables2
@@ -241,7 +297,6 @@ export {
   mediaTypes as analyzeMediaTypes,
   parameterSerialization as analyzeParameterSerialization,
   polymorphism as analyzePolymorphism,
-  refNames as analyzeRefNames,
   references as analyzeReferences,
   securityTypes as analyzeSecurityTypes,
   serverVariables as analyzeServerVariables,