oas 31.1.2 → 32.0.0

package/README.md

@@ -81,8 +81,11 @@ Because this library has full TypeScript types and docblocks this README is not
 | `.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. |
+| `.getSecurityScheme()` | Retrieve a security scheme from the API definition. |
 | `.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 -->
 
@@ -157,6 +160,7 @@ const operation = petstore.operation('/pet', 'post');
 | `.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. |
@@ -212,6 +216,7 @@ const operation = petstore.operation('/pet', 'post');
 | Method | Description |
 | :--- | :--- |
 | `.getResponseAsJSONSchema()` | Retrive and convert a response on this operation into JSON Schema. |
+| `.getResponseContentTypes()` | Retrieve an array of all content types that this operation can return. |
 | `.getResponseByStatusCode()` | Retrieve the raw response object for a given status code. |
 | `.getResponseExamples()` | Retrieve an array of all response examples that this operation has defined. |
 | `.getResponseStatusCodes()` | Retrieve all status codes that this operation may respond with. |

package/dist/analyzer/index.cjs

@@ -1,15 +1,14 @@
 "use strict";Object.defineProperty(exports, "__esModule", {value: true});
 
-var _chunkSYZDNSG6cjs = require('../chunk-SYZDNSG6.cjs');
-require('../chunk-BRYRBTD7.cjs');
+var _chunk7H5IXVWYcjs = require('../chunk-7H5IXVWY.cjs');
 
 
 
 var _chunkW6GBV2JTcjs = require('../chunk-W6GBV2JT.cjs');
-require('../chunk-O3GIPZLC.cjs');
-require('../chunk-B5WP4BJM.cjs');
+require('../chunk-AQUZF2EA.cjs');
+require('../chunk-7RDMAMMI.cjs');
 require('../chunk-AYA3UT4L.cjs');
-require('../chunk-VQBEI5WI.cjs');
+require('../chunk-YPR7YTHM.cjs');
 
 // src/analyzer/queries/openapi.ts
 function additionalProperties(definition) {
@@ -21,7 +20,7 @@ function callbacks(definition) {
   );
 }
 async function circularRefs(definition) {
-  const oas = new (0, _chunkSYZDNSG6cjs.Oas)(JSON.parse(JSON.stringify(definition)));
+  const oas = new (0, _chunk7H5IXVWYcjs.Oas)(structuredClone(definition));
   await oas.dereference();
   const results = oas.getCircularReferences();
   results.sort();
@@ -34,7 +33,7 @@ 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, _chunkSYZDNSG6cjs.Oas)(structuredClone(definition));
+  const oas = new (0, _chunk7H5IXVWYcjs.Oas)(structuredClone(definition));
   const originalSizeInBytes = Buffer.from(JSON.stringify(oas.api)).length;
   const raw = Number((originalSizeInBytes / (1024 * 1024)).toFixed(2));
   await oas.dereference();

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","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,iCAA8B;AAC9B;AACA;ACFO,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,IAAA,CAAK,KAAA,CAAM,IAAA,CAAK,SAAA,CAAU,UAAU,CAAC,CAAC,CAAA;AAC1D,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;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;ADpIA;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,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,CAACb,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,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;AACF,4zBAAC","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(JSON.parse(JSON.stringify(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 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  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  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 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      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/queries/openapi.ts","../../src/analyzer/index.ts"],"names":["additionalProperties","callbacks","circularRefs","commonParameters","discriminators","links","parameterSerialization","polymorphism","refNames","serverVariables","xmlSchemas","xmlRequests","xmlResponses","webhooks"],"mappings":"AAAA;AACE;AACF,yDAA8B;AAC9B;AACE;AACA;AACF,yDAA8B;AAC9B,iCAA8B;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;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;ADrIA;AACA;AEzEA,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,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,CAACb,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,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;AFyEA;AACE;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACF,4zBAAC","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 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  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  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 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      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"]}

package/dist/analyzer/index.js

@@ -1,15 +1,14 @@
 import {
   Oas
-} from "../chunk-LSH3X5NA.js";
-import "../chunk-HGVFNEKW.js";
+} from "../chunk-4JRU2N6C.js";
 import {
   query,
   refizePointer
 } from "../chunk-CKC36IL7.js";
-import "../chunk-VA3NKXX7.js";
-import "../chunk-5EP6HY2E.js";
+import "../chunk-ORCSXEZP.js";
+import "../chunk-HYH37HS2.js";
 import "../chunk-S27IGTVG.js";
-import "../chunk-7MARUOFZ.js";
+import "../chunk-MNOEMVCF.js";
 
 // src/analyzer/queries/openapi.ts
 function additionalProperties(definition) {
@@ -21,7 +20,7 @@ function callbacks(definition) {
   );
 }
 async function circularRefs(definition) {
-  const oas = new Oas(JSON.parse(JSON.stringify(definition)));
+  const oas = new Oas(structuredClone(definition));
   await oas.dereference();
   const results = oas.getCircularReferences();
   results.sort();

package/dist/analyzer/index.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/analyzer/queries/openapi.ts","../../src/analyzer/index.ts"],"sourcesContent":["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(JSON.parse(JSON.stringify(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 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  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  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 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      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"],"mappings":";;;;;;;;;;;;;;AAWO,SAAS,qBAAqB,YAAmC;AACtE,SAAO,MAAM,CAAC,yBAAyB,GAAG,UAAU,EAAE,IAAI,SAAO,cAAc,IAAI,OAAO,CAAC;AAC7F;AAQO,SAAS,UAAU,YAAmC;AAC3D,SAAO,MAAM,CAAC,0BAA0B,qCAAqC,GAAG,UAAU,EAAE;AAAA,IAAI,SAC9F,cAAc,IAAI,OAAO;AAAA,EAC3B;AACF;AAQA,eAAsB,aAAa,YAA4C;AAG7E,QAAM,MAAM,IAAI,IAAI,KAAK,MAAM,KAAK,UAAU,UAAU,CAAC,CAAC;AAC1D,QAAM,IAAI,YAAY;AAEtB,QAAM,UAAU,IAAI,sBAAsB;AAE1C,UAAQ,KAAK;AACb,SAAO;AACT;AAQO,SAAS,iBAAiB,YAAmC;AAClE,SAAO,MAAM,CAAC,wBAAwB,GAAG,UAAU,EAAE,IAAI,SAAO,cAAc,IAAI,OAAO,CAAC;AAC5F;AAQO,SAAS,eAAe,YAAmC;AAChE,SAAO,MAAM,CAAC,kBAAkB,GAAG,UAAU,EAAE,IAAI,SAAO,cAAc,IAAI,OAAO,CAAC;AACtF;AASA,eAAsB,SAAS,YAAsF;AACnH,QAAM,MAAM,IAAI,IAAI,gBAAgB,UAAU,CAAC;AAE/C,QAAM,sBAAsB,OAAO,KAAK,KAAK,UAAU,IAAI,GAAG,CAAC,EAAE;AACjE,QAAM,MAAM,QAAQ,uBAAuB,OAAO,OAAO,QAAQ,CAAC,CAAC;AAEnE,QAAM,IAAI,YAAY;AAEtB,MAAI;AACJ,MAAI;AACF,UAAM,0BAA0B,OAAO,KAAK,KAAK,UAAU,IAAI,GAAG,CAAC,EAAE;AACrE,mBAAe,QAAQ,2BAA2B,OAAO,OAAO,QAAQ,CAAC,CAAC;AAAA,EAC5E,SAAS,KAAK;AAGZ,QAAI,eAAe,YAAY;AAC7B,qBAAe;AAAA,IACjB,OAAO;AACL,YAAM;AAAA,IACR;AAAA,EACF;AAEA,SAAO,EAAE,KAAK,aAAa;AAC7B;AAQO,SAAS,MAAM,YAAmC;AACvD,SAAO,MAAM,CAAC,sBAAsB,4BAA4B,GAAG,UAAU,EAAE,IAAI,SAAO,cAAc,IAAI,OAAO,CAAC;AACtH;AASO,SAAS,WAAW,YAAmC;AAC5D,QAAM,UAAU,MAAM;AAAA,IACpB,IAAI;AAAA,MACF,MAAM,CAAC,mBAAmB,GAAG,UAAU,EAAE,QAAQ,SAAO;AAGtD,eAAO,OAAO,KAAK,IAAI,KAAK;AAAA,MAC9B,CAAC;AAAA,IACH;AAAA,EACF;AAEA,UAAQ,KAAK;AACb,SAAO;AACT;AAQO,SAAS,uBAAuB,YAAmC;AACxE,SAAO,MAAM,CAAC,yBAAyB,GAAG,UAAU,EAAE,IAAI,SAAO,cAAc,IAAI,OAAO,CAAC;AAC7F;AAQO,SAAS,aAAa,YAAmC;AAC9D,QAAM,UAAU,MAAM;AAAA,IACpB,IAAI,IAAI,MAAM,CAAC,aAAa,aAAa,WAAW,GAAG,UAAU,EAAE,IAAI,SAAO,cAAc,IAAI,OAAO,CAAC,CAAC;AAAA,EAC3G;AAEA,UAAQ,KAAK;AACb,SAAO;AACT;AAQO,SAAS,SAAS,YAAmC;AAC1D,SAAO,MAAM,CAAC,0BAA0B,GAAG,UAAU,EAAE,IAAI,SAAO,cAAc,IAAI,OAAO,CAAC;AAC9F;AAQO,SAAS,cAAc,YAAmC;AAC/D,SAAO,MAAM,KAAK,IAAI,IAAI,MAAM,CAAC,oCAAoC,GAAG,UAAU,EAAE,IAAI,SAAO,IAAI,KAAe,CAAC,CAAC;AACtH;AAQO,SAAS,gBAAgB,YAAmC;AACjE,SAAO,MAAM,CAAC,uBAAuB,GAAG,UAAU,EAAE,IAAI,SAAO,cAAc,IAAI,OAAO,CAAC;AAC3F;AAQO,SAAS,gBAAgB,YAAiC;AAC/D,SAAO,MAAM,CAAC,aAAa,GAAG,UAAU,EAAE,QAAQ,SAAO,OAAO,KAAK,IAAI,KAAK,CAAC,EAAE;AACnF;AAOO,SAAS,SAAS,YAAmC;AAC1D,SAAO,MAAM,CAAC,eAAe,GAAG,UAAU,EAAE,IAAI,SAAO,cAAc,IAAI,OAAO,CAAC;AACnF;AASO,SAAS,YAAY,YAAmC;AAC7D,SAAO;AAAA,IACL;AAAA,MACE;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,IACF;AAAA,IACA;AAAA,EACF,EAAE,IAAI,SAAO,cAAc,IAAI,OAAO,CAAC;AACzC;AASO,SAAS,aAAa,YAAmC;AAC9D,SAAO;AAAA,IACL;AAAA,MACE;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,IACF;AAAA,IACA;AAAA,EACF,EAAE,IAAI,SAAO,cAAc,IAAI,OAAO,CAAC;AACzC;AAQO,SAAS,WAAW,YAAmC;AAC5D,SAAO,MAAM,CAAC,8BAA8B,uBAAuB,sBAAsB,GAAG,UAAU,EAAE;AAAA,IAAI,SAC1G,cAAc,IAAI,OAAO;AAAA,EAC3B;AACF;;;AC7MA,eAAsB,SAAS,YAA+C;AAC5E,QAAMA,wBAAuB,qBAA4B,UAAU;AACnE,QAAMC,aAAY,UAAiB,UAAU;AAC7C,QAAMC,gBAAe,MAAM,aAAoB,UAAU;AACzD,QAAMC,oBAAmB,iBAAwB,UAAU;AAC3D,QAAMC,kBAAiB,eAAsB,UAAU;AACvD,QAAM,EAAE,KAAK,aAAa,cAAc,qBAAqB,IAAI,MAAM,SAAgB,UAAU;AACjG,QAAMC,SAAQ,MAAa,UAAU;AACrC,QAAMC,0BAAyB,uBAA8B,UAAU;AACvE,QAAMC,gBAAe,aAAoB,UAAU;AACnD,QAAMC,YAAW,SAAgB,UAAU;AAC3C,QAAMC,mBAAkB,gBAAuB,UAAU;AACzD,QAAMC,cAAa,WAAkB,UAAU;AAC/C,QAAMC,eAAc,YAAmB,UAAU;AACjD,QAAMC,gBAAe,aAAoB,UAAU;AACnD,QAAMC,YAAW,SAAgB,UAAU;AAE3C,QAAM,WAAwB;AAAA,IAC5B,SAAS;AAAA,MACP,sBAAsB;AAAA,QACpB,MAAM;AAAA,QACN,OAAO;AAAA,MACT;AAAA,MACA,YAAY;AAAA,QACV,MAAM;AAAA,QACN,OAAO,WAAkB,UAAU;AAAA,MACrC;AAAA,MACA,gBAAgB;AAAA,QACd,MAAM;AAAA,QACN,OAAO,gBAAuB,UAAU;AAAA,MAC1C;AAAA,MACA,aAAa;AAAA,QACX,MAAM;AAAA,QACN,OAAO;AAAA,MACT;AAAA,MACA,eAAe;AAAA,QACb,MAAM;AAAA,QACN,OAAO,cAAqB,UAAU;AAAA,MACxC;AAAA,IACF;AAAA,IACA,SAAS;AAAA,MACP,sBAAsB;AAAA,QACpB,SAAS,CAAC,CAACb,sBAAqB;AAAA,QAChC,WAAWA;AAAA,MACb;AAAA,MACA,WAAW;AAAA,QACT,SAAS,CAAC,CAACC,WAAU;AAAA,QACrB,WAAWA;AAAA,MACb;AAAA,MACA,cAAc;AAAA,QACZ,SAAS,CAAC,CAACC,cAAa;AAAA,QACxB,WAAWA;AAAA,MACb;AAAA,MACA,kBAAkB;AAAA,QAChB,SAAS,CAAC,CAACC,kBAAiB;AAAA,QAC5B,WAAWA;AAAA,MACb;AAAA,MACA,gBAAgB;AAAA,QACd,SAAS,CAAC,CAACC,gBAAe;AAAA,QAC1B,WAAWA;AAAA,MACb;AAAA,MACA,OAAO;AAAA,QACL,SAAS,CAAC,CAACC,OAAM;AAAA,QACjB,WAAWA;AAAA,MACb;AAAA,MACA,OAAO;AAAA,QACL,SAAS,CAAC,CAACC,wBAAuB;AAAA,QAClC,WAAWA;AAAA,MACb;AAAA,MACA,cAAc;AAAA,QACZ,SAAS,CAAC,CAACC,cAAa;AAAA,QACxB,WAAWA;AAAA,MACb;AAAA,MACA,UAAU;AAAA,QACR,SAAS,CAAC,CAACC,UAAS;AAAA,QACpB,WAAWA;AAAA,MACb;AAAA,MACA,iBAAiB;AAAA,QACf,SAAS,CAAC,CAACC,iBAAgB;AAAA,QAC3B,WAAWA;AAAA,MACb;AAAA,MACA,aAAa;AAAA,QACX,SAAS,CAAC,CAACE,aAAY;AAAA,QACvB,WAAWA;AAAA,MACb;AAAA,MACA,cAAc;AAAA,QACZ,SAAS,CAAC,CAACC,cAAa;AAAA,QACxB,WAAWA;AAAA,MACb;AAAA,MACA,YAAY;AAAA,QACV,SAAS,CAAC,CAACF,YAAW;AAAA,QACtB,WAAWA;AAAA,MACb;AAAA,MACA,UAAU;AAAA,QACR,SAAS,CAAC,CAACG,UAAS;AAAA,QACpB,WAAWA;AAAA,MACb;AAAA,IACF;AAAA,EACF;AAEA,SAAO;AACT;","names":["additionalProperties","callbacks","circularRefs","commonParameters","discriminators","links","parameterSerialization","polymorphism","refNames","serverVariables","xmlSchemas","xmlRequests","xmlResponses","webhooks"]}
+{"version":3,"sources":["../../src/analyzer/queries/openapi.ts","../../src/analyzer/index.ts"],"sourcesContent":["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 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  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  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 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      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"],"mappings":";;;;;;;;;;;;;AAWO,SAAS,qBAAqB,YAAmC;AACtE,SAAO,MAAM,CAAC,yBAAyB,GAAG,UAAU,EAAE,IAAI,SAAO,cAAc,IAAI,OAAO,CAAC;AAC7F;AAQO,SAAS,UAAU,YAAmC;AAC3D,SAAO,MAAM,CAAC,0BAA0B,qCAAqC,GAAG,UAAU,EAAE;AAAA,IAAI,SAC9F,cAAc,IAAI,OAAO;AAAA,EAC3B;AACF;AAQA,eAAsB,aAAa,YAA4C;AAG7E,QAAM,MAAM,IAAI,IAAI,gBAAgB,UAAU,CAAC;AAC/C,QAAM,IAAI,YAAY;AAEtB,QAAM,UAAU,IAAI,sBAAsB;AAE1C,UAAQ,KAAK;AACb,SAAO;AACT;AAQO,SAAS,iBAAiB,YAAmC;AAClE,SAAO,MAAM,CAAC,wBAAwB,GAAG,UAAU,EAAE,IAAI,SAAO,cAAc,IAAI,OAAO,CAAC;AAC5F;AAQO,SAAS,eAAe,YAAmC;AAChE,SAAO,MAAM,CAAC,kBAAkB,GAAG,UAAU,EAAE,IAAI,SAAO,cAAc,IAAI,OAAO,CAAC;AACtF;AASA,eAAsB,SAAS,YAAsF;AACnH,QAAM,MAAM,IAAI,IAAI,gBAAgB,UAAU,CAAC;AAE/C,QAAM,sBAAsB,OAAO,KAAK,KAAK,UAAU,IAAI,GAAG,CAAC,EAAE;AACjE,QAAM,MAAM,QAAQ,uBAAuB,OAAO,OAAO,QAAQ,CAAC,CAAC;AAEnE,QAAM,IAAI,YAAY;AAEtB,MAAI;AACJ,MAAI;AACF,UAAM,0BAA0B,OAAO,KAAK,KAAK,UAAU,IAAI,GAAG,CAAC,EAAE;AACrE,mBAAe,QAAQ,2BAA2B,OAAO,OAAO,QAAQ,CAAC,CAAC;AAAA,EAC5E,SAAS,KAAK;AAGZ,QAAI,eAAe,YAAY;AAC7B,qBAAe;AAAA,IACjB,OAAO;AACL,YAAM;AAAA,IACR;AAAA,EACF;AAEA,SAAO,EAAE,KAAK,aAAa;AAC7B;AAQO,SAAS,MAAM,YAAmC;AACvD,SAAO,MAAM,CAAC,sBAAsB,4BAA4B,GAAG,UAAU,EAAE,IAAI,SAAO,cAAc,IAAI,OAAO,CAAC;AACtH;AASO,SAAS,WAAW,YAAmC;AAC5D,QAAM,UAAU,MAAM;AAAA,IACpB,IAAI;AAAA,MACF,MAAM,CAAC,mBAAmB,GAAG,UAAU,EAAE,QAAQ,SAAO;AAGtD,eAAO,OAAO,KAAK,IAAI,KAAK;AAAA,MAC9B,CAAC;AAAA,IACH;AAAA,EACF;AAEA,UAAQ,KAAK;AACb,SAAO;AACT;AAQO,SAAS,uBAAuB,YAAmC;AACxE,SAAO,MAAM,CAAC,yBAAyB,GAAG,UAAU,EAAE,IAAI,SAAO,cAAc,IAAI,OAAO,CAAC;AAC7F;AAQO,SAAS,aAAa,YAAmC;AAC9D,QAAM,UAAU,MAAM;AAAA,IACpB,IAAI,IAAI,MAAM,CAAC,aAAa,aAAa,WAAW,GAAG,UAAU,EAAE,IAAI,SAAO,cAAc,IAAI,OAAO,CAAC,CAAC;AAAA,EAC3G;AAEA,UAAQ,KAAK;AACb,SAAO;AACT;AAQO,SAAS,SAAS,YAAmC;AAC1D,SAAO,MAAM,CAAC,0BAA0B,GAAG,UAAU,EAAE,IAAI,SAAO,cAAc,IAAI,OAAO,CAAC;AAC9F;AAQO,SAAS,cAAc,YAAmC;AAC/D,SAAO,MAAM,KAAK,IAAI,IAAI,MAAM,CAAC,oCAAoC,GAAG,UAAU,EAAE,IAAI,SAAO,IAAI,KAAe,CAAC,CAAC;AACtH;AAQO,SAAS,gBAAgB,YAAmC;AACjE,SAAO,MAAM,CAAC,uBAAuB,GAAG,UAAU,EAAE,IAAI,SAAO,cAAc,IAAI,OAAO,CAAC;AAC3F;AAQO,SAAS,gBAAgB,YAAiC;AAC/D,SAAO,MAAM,CAAC,aAAa,GAAG,UAAU,EAAE,QAAQ,SAAO,OAAO,KAAK,IAAI,KAAK,CAAC,EAAE;AACnF;AAOO,SAAS,SAAS,YAAmC;AAC1D,SAAO,MAAM,CAAC,eAAe,GAAG,UAAU,EAAE,IAAI,SAAO,cAAc,IAAI,OAAO,CAAC;AACnF;AASO,SAAS,YAAY,YAAmC;AAC7D,SAAO;AAAA,IACL;AAAA,MACE;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,IACF;AAAA,IACA;AAAA,EACF,EAAE,IAAI,SAAO,cAAc,IAAI,OAAO,CAAC;AACzC;AASO,SAAS,aAAa,YAAmC;AAC9D,SAAO;AAAA,IACL;AAAA,MACE;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,IACF;AAAA,IACA;AAAA,EACF,EAAE,IAAI,SAAO,cAAc,IAAI,OAAO,CAAC;AACzC;AAQO,SAAS,WAAW,YAAmC;AAC5D,SAAO,MAAM,CAAC,8BAA8B,uBAAuB,sBAAsB,GAAG,UAAU,EAAE;AAAA,IAAI,SAC1G,cAAc,IAAI,OAAO;AAAA,EAC3B;AACF;;;AC7MA,eAAsB,SAAS,YAA+C;AAC5E,QAAMA,wBAAuB,qBAA4B,UAAU;AACnE,QAAMC,aAAY,UAAiB,UAAU;AAC7C,QAAMC,gBAAe,MAAM,aAAoB,UAAU;AACzD,QAAMC,oBAAmB,iBAAwB,UAAU;AAC3D,QAAMC,kBAAiB,eAAsB,UAAU;AACvD,QAAM,EAAE,KAAK,aAAa,cAAc,qBAAqB,IAAI,MAAM,SAAgB,UAAU;AACjG,QAAMC,SAAQ,MAAa,UAAU;AACrC,QAAMC,0BAAyB,uBAA8B,UAAU;AACvE,QAAMC,gBAAe,aAAoB,UAAU;AACnD,QAAMC,YAAW,SAAgB,UAAU;AAC3C,QAAMC,mBAAkB,gBAAuB,UAAU;AACzD,QAAMC,cAAa,WAAkB,UAAU;AAC/C,QAAMC,eAAc,YAAmB,UAAU;AACjD,QAAMC,gBAAe,aAAoB,UAAU;AACnD,QAAMC,YAAW,SAAgB,UAAU;AAE3C,QAAM,WAAwB;AAAA,IAC5B,SAAS;AAAA,MACP,sBAAsB;AAAA,QACpB,MAAM;AAAA,QACN,OAAO;AAAA,MACT;AAAA,MACA,YAAY;AAAA,QACV,MAAM;AAAA,QACN,OAAO,WAAkB,UAAU;AAAA,MACrC;AAAA,MACA,gBAAgB;AAAA,QACd,MAAM;AAAA,QACN,OAAO,gBAAuB,UAAU;AAAA,MAC1C;AAAA,MACA,aAAa;AAAA,QACX,MAAM;AAAA,QACN,OAAO;AAAA,MACT;AAAA,MACA,eAAe;AAAA,QACb,MAAM;AAAA,QACN,OAAO,cAAqB,UAAU;AAAA,MACxC;AAAA,IACF;AAAA,IACA,SAAS;AAAA,MACP,sBAAsB;AAAA,QACpB,SAAS,CAAC,CAACb,sBAAqB;AAAA,QAChC,WAAWA;AAAA,MACb;AAAA,MACA,WAAW;AAAA,QACT,SAAS,CAAC,CAACC,WAAU;AAAA,QACrB,WAAWA;AAAA,MACb;AAAA,MACA,cAAc;AAAA,QACZ,SAAS,CAAC,CAACC,cAAa;AAAA,QACxB,WAAWA;AAAA,MACb;AAAA,MACA,kBAAkB;AAAA,QAChB,SAAS,CAAC,CAACC,kBAAiB;AAAA,QAC5B,WAAWA;AAAA,MACb;AAAA,MACA,gBAAgB;AAAA,QACd,SAAS,CAAC,CAACC,gBAAe;AAAA,QAC1B,WAAWA;AAAA,MACb;AAAA,MACA,OAAO;AAAA,QACL,SAAS,CAAC,CAACC,OAAM;AAAA,QACjB,WAAWA;AAAA,MACb;AAAA,MACA,OAAO;AAAA,QACL,SAAS,CAAC,CAACC,wBAAuB;AAAA,QAClC,WAAWA;AAAA,MACb;AAAA,MACA,cAAc;AAAA,QACZ,SAAS,CAAC,CAACC,cAAa;AAAA,QACxB,WAAWA;AAAA,MACb;AAAA,MACA,UAAU;AAAA,QACR,SAAS,CAAC,CAACC,UAAS;AAAA,QACpB,WAAWA;AAAA,MACb;AAAA,MACA,iBAAiB;AAAA,QACf,SAAS,CAAC,CAACC,iBAAgB;AAAA,QAC3B,WAAWA;AAAA,MACb;AAAA,MACA,aAAa;AAAA,QACX,SAAS,CAAC,CAACE,aAAY;AAAA,QACvB,WAAWA;AAAA,MACb;AAAA,MACA,cAAc;AAAA,QACZ,SAAS,CAAC,CAACC,cAAa;AAAA,QACxB,WAAWA;AAAA,MACb;AAAA,MACA,YAAY;AAAA,QACV,SAAS,CAAC,CAACF,YAAW;AAAA,QACtB,WAAWA;AAAA,MACb;AAAA,MACA,UAAU;AAAA,QACR,SAAS,CAAC,CAACG,UAAS;AAAA,QACpB,WAAWA;AAAA,MACb;AAAA,IACF;AAAA,EACF;AAEA,SAAO;AACT;","names":["additionalProperties","callbacks","circularRefs","commonParameters","discriminators","links","parameterSerialization","polymorphism","refNames","serverVariables","xmlSchemas","xmlRequests","xmlResponses","webhooks"]}

package/dist/{chunk-LSH3X5NA.js → chunk-4JRU2N6C.js}

@@ -1,18 +1,14 @@
 import {
   Operation,
-  Webhook,
-  buildDiscriminatorOneOf,
-  findDiscriminatorChildren
-} from "./chunk-HGVFNEKW.js";
+  Webhook
+} from "./chunk-ORCSXEZP.js";
 import {
   SERVER_VARIABLE_REGEX,
-  supportedMethods
-} from "./chunk-VA3NKXX7.js";
-import {
+  decorateComponentSchemasWithRefName,
   dereferenceRef,
   getDereferencingOptions,
-  isPrimitive
-} from "./chunk-5EP6HY2E.js";
+  supportedMethods
+} from "./chunk-HYH37HS2.js";
 import {
   CODE_SAMPLES,
   HEADERS,
@@ -27,7 +23,7 @@ import {
 import {
   isOpenAPI31,
   isRef
-} from "./chunk-7MARUOFZ.js";
+} from "./chunk-MNOEMVCF.js";
 
 // src/index.ts
 import { dereference } from "@readme/openapi-parser";
@@ -202,7 +198,7 @@ function findTargetPath(pathMatches) {
 // src/index.ts
 var Oas = class _Oas {
   /**
-   * An OpenAPI API Definition.
+   * The current OpenAPI definition.
    */
   api;
   /**
@@ -220,6 +216,13 @@ var Oas = class _Oas {
    * it doesn't initiate multiple dereferencing processes.
    */
   dereferencing;
+  /**
+   * Have the component schemas within this API definition been decorated with our
+   * `x-readme-ref-name` extension?
+   *
+   * @see {@link decorateComponentSchemas}
+   */
+  schemasDecorated = false;
   /**
    * @param oas An OpenAPI definition.
    * @param user The information about a user that we should use when pulling auth tokens from
@@ -394,7 +397,7 @@ var Oas = class _Oas {
         if (webhookPath && !isRef(webhookPath)) {
           if (webhookPath?.[method]) {
             operation = webhookPath[method];
-            return new Webhook(this.api, path, method, operation);
+            return new Webhook(this, path, method, operation);
           }
         }
       }
@@ -405,7 +408,7 @@ var Oas = class _Oas {
         operation = dereferenceRef(pathItem[method], this.api);
       }
     }
-    return new Operation(this.api, path, method, operation);
+    return new Operation(this, path, method, operation);
   }
   findOperationMatches(url) {
     const { origin, hostname } = new URL(url);
@@ -545,6 +548,39 @@ var Oas = class _Oas {
     }
     return getAuth(this.api, user, selectedApp);
   }
+  /**
+   * Determine if a security scheme exists within the API definition.
+   *
+   * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.0.md#security-scheme-object}
+   * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#security-scheme-object}
+   * @param name The name of the security scheme to check for.
+   */
+  hasSecurityScheme(name) {
+    return Boolean(this.api?.components?.securitySchemes?.[name]);
+  }
+  /**
+   * Retrieve a security scheme from the API definition.
+   *
+   * If the found security scheme is a `$ref` pointer it will be lazily dereferenced; if the scheme
+   * cannot be resolved after that process (eg. it's circular or is an invalid `$ref`) then
+   * `undefined` will be returned.
+   *
+   * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.0.md#security-scheme-object}
+   * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#security-scheme-object}
+   * @param name The name of the security scheme to retrieve.
+   */
+  getSecurityScheme(name) {
+    if (!this.hasSecurityScheme(name)) {
+      return void 0;
+    }
+    let scheme = this.api?.components?.securitySchemes?.[name];
+    if (!scheme) return void 0;
+    if (isRef(scheme)) {
+      scheme = dereferenceRef(scheme, this.api);
+      if (!scheme || isRef(scheme)) return void 0;
+    }
+    return scheme;
+  }
   /**
    * Returns the `paths` object that exists in this API definition but with every `method` mapped
    * to an instance of the `Operation` class.
@@ -562,11 +598,15 @@ var Oas = class _Oas {
         return;
       }
       paths[path] = {};
-      const pathItem = this.api.paths[path];
+      let pathItem = this.api.paths[path];
       if (!pathItem) {
         return;
       } else if (isRef(pathItem)) {
         this.api.paths[path] = dereferenceRef(pathItem, this.api);
+        pathItem = this.api.paths[path];
+        if (!pathItem || isRef(pathItem)) {
+          return;
+        }
       }
       Object.keys(pathItem).forEach((method) => {
         if (!supportedMethods.includes(method)) {
@@ -747,24 +787,11 @@ var Oas = class _Oas {
     });
   }
   /**
-   * Retrieve any circular `$ref` pointers that maybe present within the API definition.
-   *
-   * This method requires that you first dereference the definition.
-   *
-   * @see Oas.dereference
-   */
-  getCircularReferences() {
-    if (!this.dereferencing.complete) {
-      throw new Error(".dereference() must be called first in order for this method to obtain circular references.");
-    }
-    return this.dereferencing.circularRefs;
-  }
-  /**
-   * Dereference the current OAS definition so it can be parsed free of worries of `$ref` schemas
-   * and circular structures.
+   * Dereference the current API definition so it can be parsed free from the hassle of resolving
+   * `$ref` schemas and circular structures.
    *
    */
-  async dereference(opts = { preserveRefAsJSONSchemaTitle: false }) {
+  async dereference(opts) {
     if (this.dereferencing.complete) {
       return new Promise((resolve) => {
         resolve(true);
@@ -776,26 +803,15 @@ var Oas = class _Oas {
       });
     }
     this.dereferencing.processing = true;
-    const { children: discriminatorChildrenMap } = findDiscriminatorChildren(this.api);
-    const { api, promises } = this;
-    if (api?.components?.schemas && typeof api.components.schemas === "object") {
-      Object.keys(api.components.schemas).forEach((schemaName) => {
-        if (isPrimitive(api.components?.schemas?.[schemaName]) || Array.isArray(api.components?.schemas?.[schemaName]) || api.components?.schemas?.[schemaName] === null) {
-          return;
-        }
-        if (opts.preserveRefAsJSONSchemaTitle) {
-          (api.components?.schemas?.[schemaName]).title = schemaName;
-        }
-        (api.components?.schemas?.[schemaName])["x-readme-ref-name"] = schemaName;
-      });
+    if (!this.schemasDecorated) {
+      decorateComponentSchemasWithRefName(this.api);
+      this.schemasDecorated = true;
     }
+    const { api, promises } = this;
     const circularRefs = /* @__PURE__ */ new Set();
     const dereferencingOptions = getDereferencingOptions(circularRefs);
     return dereference(api, dereferencingOptions).then((dereferenced) => {
       this.api = dereferenced;
-      if (this.api?.components?.schemas && discriminatorChildrenMap.size > 0) {
-        buildDiscriminatorOneOf(this.api, discriminatorChildrenMap);
-      }
       this.promises = promises;
       this.dereferencing = {
         processing: false,
@@ -803,8 +819,8 @@ var Oas = class _Oas {
         // We need to convert our `Set` to an array in order to match the typings.
         circularRefs: [...circularRefs]
       };
-      if (opts.cb) {
-        opts.cb();
+      if (opts?.cb) {
+        opts?.cb();
       }
     }).then(() => {
       return this.promises.map((deferred) => deferred.resolve());
@@ -814,9 +830,30 @@ var Oas = class _Oas {
       throw err;
     });
   }
+  /**
+   * Determine if the current API definition has been dereferenced or not.
+   *
+   * @see Oas.dereference
+   */
+  isDereferenced() {
+    return this.dereferencing.processing || this.dereferencing.complete;
+  }
+  /**
+   * Retrieve any circular `$ref` pointers that maybe present within the API definition.
+   *
+   * This method requires that you first dereference the definition.
+   *
+   * @see Oas.dereference
+   */
+  getCircularReferences() {
+    if (!this.dereferencing.complete) {
+      throw new Error(".dereference() must be called first in order for this method to obtain circular references.");
+    }
+    return this.dereferencing.circularRefs;
+  }
 };
 
 export {
   Oas
 };
-//# sourceMappingURL=chunk-LSH3X5NA.js.map
+//# sourceMappingURL=chunk-4JRU2N6C.js.map