oas 37.0.0 → 37.2.0

package/dist/extensions.cjs

@@ -14,8 +14,8 @@
 
 
 
-var _chunkAYA3UT4Lcjs = require('./chunk-AYA3UT4L.cjs');
 
+var _chunk6HXOZ5GYcjs = require('./chunk-6HXOZ5GY.cjs');
 
 
 
@@ -31,5 +31,7 @@ var _chunkAYA3UT4Lcjs = require('./chunk-AYA3UT4L.cjs');
 
 
 
-exports.CODE_SAMPLES = _chunkAYA3UT4Lcjs.CODE_SAMPLES; exports.DISABLE_TAG_SORTING = _chunkAYA3UT4Lcjs.DISABLE_TAG_SORTING; exports.EXPLORER_ENABLED = _chunkAYA3UT4Lcjs.EXPLORER_ENABLED; exports.HEADERS = _chunkAYA3UT4Lcjs.HEADERS; exports.INTERNAL = _chunkAYA3UT4Lcjs.INTERNAL; exports.METRICS_ENABLED = _chunkAYA3UT4Lcjs.METRICS_ENABLED; exports.OAUTH_OPTIONS = _chunkAYA3UT4Lcjs.OAUTH_OPTIONS; exports.PARAMETER_ORDERING = _chunkAYA3UT4Lcjs.PARAMETER_ORDERING; exports.PROXY_ENABLED = _chunkAYA3UT4Lcjs.PROXY_ENABLED; exports.SAMPLES_LANGUAGES = _chunkAYA3UT4Lcjs.SAMPLES_LANGUAGES; exports.SIMPLE_MODE = _chunkAYA3UT4Lcjs.SIMPLE_MODE; exports.extensionDefaults = _chunkAYA3UT4Lcjs.extensionDefaults; exports.getExtension = _chunkAYA3UT4Lcjs.getExtension; exports.hasRootExtension = _chunkAYA3UT4Lcjs.hasRootExtension; exports.validateParameterOrdering = _chunkAYA3UT4Lcjs.validateParameterOrdering;
+
+
+exports.CODE_SAMPLES = _chunk6HXOZ5GYcjs.CODE_SAMPLES; exports.DISABLE_TAG_SORTING = _chunk6HXOZ5GYcjs.DISABLE_TAG_SORTING; exports.EXPLORER_ENABLED = _chunk6HXOZ5GYcjs.EXPLORER_ENABLED; exports.HEADERS = _chunk6HXOZ5GYcjs.HEADERS; exports.INTERNAL = _chunk6HXOZ5GYcjs.INTERNAL; exports.METRICS_ENABLED = _chunk6HXOZ5GYcjs.METRICS_ENABLED; exports.OAUTH_OPTIONS = _chunk6HXOZ5GYcjs.OAUTH_OPTIONS; exports.PARAMETER_ORDERING = _chunk6HXOZ5GYcjs.PARAMETER_ORDERING; exports.PROXY_ENABLED = _chunk6HXOZ5GYcjs.PROXY_ENABLED; exports.SAMPLES_LANGUAGES = _chunk6HXOZ5GYcjs.SAMPLES_LANGUAGES; exports.SIMPLE_MODE = _chunk6HXOZ5GYcjs.SIMPLE_MODE; exports.STATUS_URL = _chunk6HXOZ5GYcjs.STATUS_URL; exports.extensionDefaults = _chunk6HXOZ5GYcjs.extensionDefaults; exports.getExtension = _chunk6HXOZ5GYcjs.getExtension; exports.hasRootExtension = _chunk6HXOZ5GYcjs.hasRootExtension; exports.validateParameterOrdering = _chunk6HXOZ5GYcjs.validateParameterOrdering;
 //# sourceMappingURL=extensions.cjs.map

package/dist/extensions.cjs.map

@@ -1 +1 @@
-{"version":3,"sources":["/Users/erunion/code/readme/oas/packages/oas/dist/extensions.cjs"],"names":[],"mappings":"AAAA;AACE;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACF,wDAA6B;AAC7B;AACE;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACF,s4BAAC","file":"/Users/erunion/code/readme/oas/packages/oas/dist/extensions.cjs"}
+{"version":3,"sources":["/Users/erunion/code/readme/oas/packages/oas/dist/extensions.cjs"],"names":[],"mappings":"AAAA;AACE;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACF,wDAA6B;AAC7B;AACE;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACF,y7BAAC","file":"/Users/erunion/code/readme/oas/packages/oas/dist/extensions.cjs"}

package/dist/extensions.d.cts

@@ -1,4 +1,4 @@
-export { a as CODE_SAMPLES, D as DISABLE_TAG_SORTING, E as EXPLORER_ENABLED, b as Extensions, H as HEADERS, I as INTERNAL, M as METRICS_ENABLED, c as OAUTH_OPTIONS, P as PARAMETER_ORDERING, d as PROXY_ENABLED, S as SAMPLES_LANGUAGES, e as SIMPLE_MODE, f as extensionDefaults, g as getExtension, h as hasRootExtension, v as validateParameterOrdering } from './index.cjs';
+export { a as CODE_SAMPLES, D as DISABLE_TAG_SORTING, E as EXPLORER_ENABLED, b as Extensions, H as HEADERS, I as INTERNAL, M as METRICS_ENABLED, c as OAUTH_OPTIONS, P as PARAMETER_ORDERING, d as PROXY_ENABLED, S as SAMPLES_LANGUAGES, e as SIMPLE_MODE, f as STATUS_URL, g as extensionDefaults, h as getExtension, i as hasRootExtension, v as validateParameterOrdering } from './index.cjs';
 import './types.cjs';
 import 'path-to-regexp';
 import './get-parameters-as-json-schema-Cbp85O99.cjs';

package/dist/extensions.d.ts

@@ -1,4 +1,4 @@
-export { a as CODE_SAMPLES, D as DISABLE_TAG_SORTING, E as EXPLORER_ENABLED, b as Extensions, H as HEADERS, I as INTERNAL, M as METRICS_ENABLED, c as OAUTH_OPTIONS, P as PARAMETER_ORDERING, d as PROXY_ENABLED, S as SAMPLES_LANGUAGES, e as SIMPLE_MODE, f as extensionDefaults, g as getExtension, h as hasRootExtension, v as validateParameterOrdering } from './index.js';
+export { a as CODE_SAMPLES, D as DISABLE_TAG_SORTING, E as EXPLORER_ENABLED, b as Extensions, H as HEADERS, I as INTERNAL, M as METRICS_ENABLED, c as OAUTH_OPTIONS, P as PARAMETER_ORDERING, d as PROXY_ENABLED, S as SAMPLES_LANGUAGES, e as SIMPLE_MODE, f as STATUS_URL, g as extensionDefaults, h as getExtension, i as hasRootExtension, v as validateParameterOrdering } from './index.js';
 import './types.js';
 import 'path-to-regexp';
 import './get-parameters-as-json-schema-BZjPPE3y.js';

package/dist/extensions.js

@@ -10,11 +10,12 @@ import {
   PROXY_ENABLED,
   SAMPLES_LANGUAGES,
   SIMPLE_MODE,
+  STATUS_URL,
   extensionDefaults,
   getExtension,
   hasRootExtension,
   validateParameterOrdering
-} from "./chunk-S27IGTVG.js";
+} from "./chunk-LZNTJ4ZR.js";
 export {
   CODE_SAMPLES,
   DISABLE_TAG_SORTING,
@@ -27,6 +28,7 @@ export {
   PROXY_ENABLED,
   SAMPLES_LANGUAGES,
   SIMPLE_MODE,
+  STATUS_URL,
   extensionDefaults,
   getExtension,
   hasRootExtension,

package/dist/index.cjs

@@ -11,12 +11,12 @@
 
 
 
-var _chunkGS43VKJHcjs = require('./chunk-GS43VKJH.cjs');
+var _chunkYCSVUVACcjs = require('./chunk-YCSVUVAC.cjs');
 
 
 
 
-var _chunkUKD63LKGcjs = require('./chunk-UKD63LKG.cjs');
+var _chunkGPOPN7TQcjs = require('./chunk-GPOPN7TQ.cjs');
 
 
 
@@ -27,7 +27,7 @@ var _chunkUKD63LKGcjs = require('./chunk-UKD63LKG.cjs');
 
 
 
-var _chunkAYA3UT4Lcjs = require('./chunk-AYA3UT4L.cjs');
+var _chunk6HXOZ5GYcjs = require('./chunk-6HXOZ5GY.cjs');
 
 
 
@@ -73,7 +73,7 @@ function getByScheme(user, scheme = {}, selectedApp) {
 }
 function getAuth(api, user, selectedApp) {
   return Object.keys(_optionalChain([api, 'optionalAccess', _3 => _3.components, 'optionalAccess', _4 => _4.securitySchemes]) || {}).map((scheme) => {
-    const securityScheme = _chunkUKD63LKGcjs.dereferenceRef.call(void 0, _optionalChain([api, 'access', _5 => _5.components, 'optionalAccess', _6 => _6.securitySchemes, 'optionalAccess', _7 => _7[scheme]]), api);
+    const securityScheme = _chunkGPOPN7TQcjs.dereferenceRef.call(void 0, _optionalChain([api, 'access', _5 => _5.components, 'optionalAccess', _6 => _6.securitySchemes, 'optionalAccess', _7 => _7[scheme]]), api);
     if (!securityScheme || _chunk7PWF3F2Wcjs.isRef.call(void 0, securityScheme)) {
       return false;
     }
@@ -142,17 +142,17 @@ var Oas = class _Oas {
     return this.api;
   }
   url(selected = 0, variables) {
-    const url = _chunkGS43VKJHcjs.normalizedURLFromServers.call(void 0, this.api.servers, selected);
+    const url = _chunkYCSVUVACcjs.normalizedURLFromServers.call(void 0, this.api.servers, selected);
     return this.replaceUrl(url, variables || this.defaultVariables(selected)).trim();
   }
   variables(selected = 0) {
-    return _chunkGS43VKJHcjs.variablesFromServers.call(void 0, this.api.servers, selected);
+    return _chunkYCSVUVACcjs.variablesFromServers.call(void 0, this.api.servers, selected);
   }
   defaultVariables(selected = 0) {
-    return _chunkGS43VKJHcjs.defaultVariablesFromServers.call(void 0, this.api.servers, selected, this.user);
+    return _chunkYCSVUVACcjs.defaultVariablesFromServers.call(void 0, this.api.servers, selected, this.user);
   }
   splitUrl(selected = 0) {
-    return _chunkGS43VKJHcjs.splitUrlFromServers.call(void 0, this.api.servers, selected);
+    return _chunkYCSVUVACcjs.splitUrlFromServers.call(void 0, this.api.servers, selected);
   }
   /**
    * With a fully composed server URL, run through our list of known OAS servers and return back
@@ -170,13 +170,13 @@ var Oas = class _Oas {
    */
   splitVariables(baseUrl) {
     const matchedServer = (this.api.servers || []).map((server, i) => {
-      const rgx = _chunkGS43VKJHcjs.transformURLIntoRegex.call(void 0, server.url);
+      const rgx = _chunkYCSVUVACcjs.transformURLIntoRegex.call(void 0, server.url);
       const found = new RegExp(rgx).exec(baseUrl);
       if (!found) {
         return false;
       }
       const variables = {};
-      Array.from(server.url.matchAll(_chunkUKD63LKGcjs.SERVER_VARIABLE_REGEX)).forEach((variable, y) => {
+      Array.from(server.url.matchAll(_chunkGPOPN7TQcjs.SERVER_VARIABLE_REGEX)).forEach((variable, y) => {
         variables[variable[1]] = found[y + 1];
       });
       return {
@@ -206,8 +206,8 @@ var Oas = class _Oas {
    * @param variables An object containing variables to swap into the URL.
    */
   replaceUrl(url, variables = {}) {
-    return _chunkGS43VKJHcjs.stripTrailingSlash.call(void 0, 
-      url.replace(_chunkUKD63LKGcjs.SERVER_VARIABLE_REGEX, (original, key) => {
+    return _chunkYCSVUVACcjs.stripTrailingSlash.call(void 0, 
+      url.replace(_chunkGPOPN7TQcjs.SERVER_VARIABLE_REGEX, (original, key) => {
         if (key in variables) {
           const data = variables[key];
           if (typeof data === "object") {
@@ -218,7 +218,7 @@ var Oas = class _Oas {
             return String(data);
           }
         }
-        const userVariable = _chunkGS43VKJHcjs.getUserVariable.call(void 0, this.user, key);
+        const userVariable = _chunkYCSVUVACcjs.getUserVariable.call(void 0, this.user, key);
         if (userVariable) {
           return String(userVariable);
         }
@@ -238,22 +238,22 @@ var Oas = class _Oas {
     };
     if (opts.isWebhook) {
       if (_chunk7PWF3F2Wcjs.isOpenAPI31.call(void 0, this.api)) {
-        const webhookPath = _chunkUKD63LKGcjs.dereferenceRef.call(void 0, _optionalChain([this, 'access', _8 => _8.api, 'optionalAccess', _9 => _9.webhooks, 'optionalAccess', _10 => _10[path]]), this.api);
+        const webhookPath = _chunkGPOPN7TQcjs.dereferenceRef.call(void 0, _optionalChain([this, 'access', _8 => _8.api, 'optionalAccess', _9 => _9.webhooks, 'optionalAccess', _10 => _10[path]]), this.api);
         if (webhookPath && !_chunk7PWF3F2Wcjs.isRef.call(void 0, webhookPath)) {
           if (_optionalChain([webhookPath, 'optionalAccess', _11 => _11[method]])) {
             operation = webhookPath[method];
-            return new (0, _chunkGS43VKJHcjs.Webhook)(this, path, method, operation);
+            return new (0, _chunkYCSVUVACcjs.Webhook)(this, path, method, operation);
           }
         }
       }
     }
     if (_optionalChain([this, 'optionalAccess', _12 => _12.api, 'optionalAccess', _13 => _13.paths, 'optionalAccess', _14 => _14[path]])) {
-      const pathItem = _chunkUKD63LKGcjs.dereferenceRef.call(void 0, this.api.paths[path], this.api);
+      const pathItem = _chunkGPOPN7TQcjs.dereferenceRef.call(void 0, this.api.paths[path], this.api);
       if (_optionalChain([pathItem, 'optionalAccess', _15 => _15[method]])) {
-        operation = _chunkUKD63LKGcjs.dereferenceRef.call(void 0, pathItem[method], this.api);
+        operation = _chunkGPOPN7TQcjs.dereferenceRef.call(void 0, pathItem[method], this.api);
       }
     }
-    return new (0, _chunkGS43VKJHcjs.Operation)(this, path, method, operation);
+    return new (0, _chunkYCSVUVACcjs.Operation)(this, path, method, operation);
   }
   findOperationMatches(url) {
     const { origin, hostname } = new URL(url);
@@ -282,7 +282,7 @@ var Oas = class _Oas {
     }
     if (!matchedServer || !pathName) {
       const matchedServerAndPath = (servers || []).map((server) => {
-        const rgx = _chunkGS43VKJHcjs.transformURLIntoRegex.call(void 0, server.url);
+        const rgx = _chunkYCSVUVACcjs.transformURLIntoRegex.call(void 0, server.url);
         const found = new RegExp(rgx).exec(url);
         if (!found) {
           return;
@@ -303,7 +303,7 @@ var Oas = class _Oas {
     if (pathName === void 0) return void 0;
     if (pathName === "") pathName = "/";
     if (!paths || !targetServer) return void 0;
-    const annotatedPaths = _chunkGS43VKJHcjs.generatePathMatches.call(void 0, paths, pathName, targetServer.url);
+    const annotatedPaths = _chunkYCSVUVACcjs.generatePathMatches.call(void 0, paths, pathName, targetServer.url);
     if (!annotatedPaths.length) return void 0;
     return annotatedPaths;
   }
@@ -320,9 +320,9 @@ var Oas = class _Oas {
     if (!annotatedPaths) {
       return void 0;
     }
-    const matches = _chunkGS43VKJHcjs.filterPathMethods.call(void 0, annotatedPaths, method);
+    const matches = _chunkYCSVUVACcjs.filterPathMethods.call(void 0, annotatedPaths, method);
     if (!matches.length) return void 0;
-    return _chunkGS43VKJHcjs.findTargetPath.call(void 0, matches);
+    return _chunkYCSVUVACcjs.findTargetPath.call(void 0, matches);
   }
   /**
    * Discover an operation in an OAS from a fully-formed URL without an HTTP method. Will return an
@@ -335,7 +335,7 @@ var Oas = class _Oas {
     if (!annotatedPaths) {
       return void 0;
     }
-    return _chunkGS43VKJHcjs.findTargetPath.call(void 0, annotatedPaths);
+    return _chunkYCSVUVACcjs.findTargetPath.call(void 0, annotatedPaths);
   }
   /**
    * Retrieve an operation in an OAS from a fully-formed URL and HTTP method. Differs from
@@ -421,7 +421,7 @@ var Oas = class _Oas {
     let scheme = _optionalChain([this, 'access', _23 => _23.api, 'optionalAccess', _24 => _24.components, 'optionalAccess', _25 => _25.securitySchemes, 'optionalAccess', _26 => _26[name]]);
     if (!scheme) return void 0;
     if (_chunk7PWF3F2Wcjs.isRef.call(void 0, scheme)) {
-      scheme = _chunkUKD63LKGcjs.dereferenceRef.call(void 0, scheme, this.api);
+      scheme = _chunkGPOPN7TQcjs.dereferenceRef.call(void 0, scheme, this.api);
       if (!scheme || _chunk7PWF3F2Wcjs.isRef.call(void 0, scheme)) return void 0;
     }
     return scheme;
@@ -447,14 +447,14 @@ var Oas = class _Oas {
       if (!pathItem) {
         return;
       } else if (_chunk7PWF3F2Wcjs.isRef.call(void 0, pathItem)) {
-        this.api.paths[path] = _chunkUKD63LKGcjs.dereferenceRef.call(void 0, pathItem, this.api);
+        this.api.paths[path] = _chunkGPOPN7TQcjs.dereferenceRef.call(void 0, pathItem, this.api);
         pathItem = this.api.paths[path];
         if (!pathItem || _chunk7PWF3F2Wcjs.isRef.call(void 0, pathItem)) {
           return;
         }
       }
       Object.keys(pathItem).forEach((method) => {
-        if (!_chunkUKD63LKGcjs.supportedMethods.includes(method)) {
+        if (!_chunkGPOPN7TQcjs.supportedMethods.includes(method)) {
           return;
         }
         paths[path][method] = this.operation(path, method);
@@ -476,10 +476,10 @@ var Oas = class _Oas {
     }
     Object.keys(this.api.webhooks).forEach((id) => {
       webhooks[id] = {};
-      const webhookPath = _chunkUKD63LKGcjs.dereferenceRef.call(void 0, _optionalChain([this, 'access', _27 => _27.api, 'access', _28 => _28.webhooks, 'optionalAccess', _29 => _29[id]]), this.api);
+      const webhookPath = _chunkGPOPN7TQcjs.dereferenceRef.call(void 0, _optionalChain([this, 'access', _27 => _27.api, 'access', _28 => _28.webhooks, 'optionalAccess', _29 => _29[id]]), this.api);
       if (webhookPath) {
         Object.keys(webhookPath).forEach((method) => {
-          if (!_chunkUKD63LKGcjs.supportedMethods.includes(method)) {
+          if (!_chunkGPOPN7TQcjs.supportedMethods.includes(method)) {
             return;
           }
           webhooks[id][method] = this.operation(id, method, {
@@ -504,7 +504,7 @@ var Oas = class _Oas {
   getTags(setIfMissing = false) {
     const allTags = /* @__PURE__ */ new Set();
     const oasTags = _optionalChain([this, 'access', _30 => _30.api, 'access', _31 => _31.tags, 'optionalAccess', _32 => _32.map, 'call', _33 => _33((tag) => tag.name)]) || [];
-    const disableTagSorting = _chunkAYA3UT4Lcjs.getExtension.call(void 0, "disable-tag-sorting", this.api);
+    const disableTagSorting = _chunk6HXOZ5GYcjs.getExtension.call(void 0, "disable-tag-sorting", this.api);
     Object.entries(this.getPaths()).forEach(([path, operations]) => {
       Object.values(operations).forEach((operation) => {
         const tags = operation.getTags();
@@ -555,7 +555,7 @@ var Oas = class _Oas {
    * @param extension Specification extension to lookup.
    */
   hasExtension(extension) {
-    return _chunkAYA3UT4Lcjs.hasRootExtension.call(void 0, extension, this.api);
+    return _chunk6HXOZ5GYcjs.hasRootExtension.call(void 0, extension, this.api);
   }
   /**
    * Retrieve a custom specification extension off of the API definition.
@@ -565,7 +565,7 @@ var Oas = class _Oas {
    * @param extension Specification extension to lookup.
    */
   getExtension(extension, operation) {
-    return _chunkAYA3UT4Lcjs.getExtension.call(void 0, extension, this.api, operation);
+    return _chunk6HXOZ5GYcjs.getExtension.call(void 0, extension, this.api, operation);
   }
   /**
    * Determine if a given OpenAPI custom extension is valid or not.
@@ -583,16 +583,16 @@ var Oas = class _Oas {
         throw new TypeError('"x-readme" must be of type "Object"');
       }
       if (extension in data) {
-        if ([_chunkAYA3UT4Lcjs.CODE_SAMPLES, _chunkAYA3UT4Lcjs.HEADERS, _chunkAYA3UT4Lcjs.PARAMETER_ORDERING, _chunkAYA3UT4Lcjs.SAMPLES_LANGUAGES].includes(extension)) {
+        if ([_chunk6HXOZ5GYcjs.CODE_SAMPLES, _chunk6HXOZ5GYcjs.HEADERS, _chunk6HXOZ5GYcjs.PARAMETER_ORDERING, _chunk6HXOZ5GYcjs.SAMPLES_LANGUAGES].includes(extension)) {
           if (data[extension] !== void 0) {
             if (!Array.isArray(data[extension])) {
               throw new TypeError(`"x-readme.${extension}" must be of type "Array"`);
             }
-            if (extension === _chunkAYA3UT4Lcjs.PARAMETER_ORDERING) {
-              _chunkAYA3UT4Lcjs.validateParameterOrdering.call(void 0, data[extension], `x-readme.${extension}`);
+            if (extension === _chunk6HXOZ5GYcjs.PARAMETER_ORDERING) {
+              _chunk6HXOZ5GYcjs.validateParameterOrdering.call(void 0, data[extension], `x-readme.${extension}`);
             }
           }
-        } else if (extension === _chunkAYA3UT4Lcjs.OAUTH_OPTIONS) {
+        } else if (extension === _chunk6HXOZ5GYcjs.OAUTH_OPTIONS) {
           if (typeof data[extension] !== "object") {
             throw new TypeError(`"x-readme.${extension}" must be of type "Object"`);
           }
@@ -603,14 +603,14 @@ var Oas = class _Oas {
     }
     if (this.hasExtension(`x-${extension}`)) {
       const data = this.getExtension(`x-${extension}`);
-      if ([_chunkAYA3UT4Lcjs.CODE_SAMPLES, _chunkAYA3UT4Lcjs.HEADERS, _chunkAYA3UT4Lcjs.PARAMETER_ORDERING, _chunkAYA3UT4Lcjs.SAMPLES_LANGUAGES].includes(extension)) {
+      if ([_chunk6HXOZ5GYcjs.CODE_SAMPLES, _chunk6HXOZ5GYcjs.HEADERS, _chunk6HXOZ5GYcjs.PARAMETER_ORDERING, _chunk6HXOZ5GYcjs.SAMPLES_LANGUAGES].includes(extension)) {
         if (!Array.isArray(data)) {
           throw new TypeError(`"x-${extension}" must be of type "Array"`);
         }
-        if (extension === _chunkAYA3UT4Lcjs.PARAMETER_ORDERING) {
-          _chunkAYA3UT4Lcjs.validateParameterOrdering.call(void 0, data, `x-${extension}`);
+        if (extension === _chunk6HXOZ5GYcjs.PARAMETER_ORDERING) {
+          _chunk6HXOZ5GYcjs.validateParameterOrdering.call(void 0, data, `x-${extension}`);
         }
-      } else if (extension === _chunkAYA3UT4Lcjs.OAUTH_OPTIONS) {
+      } else if (extension === _chunk6HXOZ5GYcjs.OAUTH_OPTIONS) {
         if (typeof data !== "object") {
           throw new TypeError(`"x-${extension}" must be of type "Object"`);
         }
@@ -627,7 +627,7 @@ var Oas = class _Oas {
    * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#specification-extensions}
    */
   validateExtensions() {
-    Object.keys(_chunkAYA3UT4Lcjs.extensionDefaults).forEach((extension) => {
+    Object.keys(_chunk6HXOZ5GYcjs.extensionDefaults).forEach((extension) => {
       this.validateExtension(extension);
     });
   }

package/dist/index.d.cts

@@ -1035,6 +1035,20 @@ declare const SIMPLE_MODE = "simple-mode";
  * }
  */
 declare const DISABLE_TAG_SORTING = "disable-tag-sorting";
+/**
+ * A customer-declared health/status URL for the API. When present, it's surfaced to AI agents as
+ * the RFC 9727 `status` link relation in the project's `/.well-known/api-catalog`.
+ *
+ * @see {@link https://docs.readme.com/main/docs/openapi-extensions}
+ * @see {@link https://www.rfc-editor.org/rfc/rfc9727}
+ * @example
+ * {
+ *  "x-readme": {
+ *    "status-url": "https://status.example.com"
+ *  }
+ * }
+ */
+declare const STATUS_URL = "status-url";
 interface Extensions {
     [CODE_SAMPLES]: {
         /**
@@ -1109,6 +1123,7 @@ interface Extensions {
     [PROXY_ENABLED]: boolean;
     [SAMPLES_LANGUAGES]: string[];
     [SIMPLE_MODE]: boolean;
+    [STATUS_URL]: string | undefined;
 }
 declare const extensionDefaults: Extensions;
 /**
@@ -1131,4 +1146,4 @@ declare function validateParameterOrdering(ordering: (typeof extensionDefaults)[
 
 // @ts-ignore
 export = Oas;
-export { Callback as C, DISABLE_TAG_SORTING as D, EXPLORER_ENABLED as E, HEADERS as H, INTERNAL as I, METRICS_ENABLED as M, Operation as O, PARAMETER_ORDERING as P, SAMPLES_LANGUAGES as S, Webhook as W, CODE_SAMPLES as a, type Extensions as b, OAUTH_OPTIONS as c, PROXY_ENABLED as d, SIMPLE_MODE as e, extensionDefaults as f, getExtension as g, hasRootExtension as h, validateParameterOrdering as v };
+export { Callback as C, DISABLE_TAG_SORTING as D, EXPLORER_ENABLED as E, HEADERS as H, INTERNAL as I, METRICS_ENABLED as M, Operation as O, PARAMETER_ORDERING as P, SAMPLES_LANGUAGES as S, Webhook as W, CODE_SAMPLES as a, type Extensions as b, OAUTH_OPTIONS as c, PROXY_ENABLED as d, SIMPLE_MODE as e, STATUS_URL as f, extensionDefaults as g, getExtension as h, hasRootExtension as i, validateParameterOrdering as v };

package/dist/index.d.ts

@@ -1035,6 +1035,20 @@ declare const SIMPLE_MODE = "simple-mode";
  * }
  */
 declare const DISABLE_TAG_SORTING = "disable-tag-sorting";
+/**
+ * A customer-declared health/status URL for the API. When present, it's surfaced to AI agents as
+ * the RFC 9727 `status` link relation in the project's `/.well-known/api-catalog`.
+ *
+ * @see {@link https://docs.readme.com/main/docs/openapi-extensions}
+ * @see {@link https://www.rfc-editor.org/rfc/rfc9727}
+ * @example
+ * {
+ *  "x-readme": {
+ *    "status-url": "https://status.example.com"
+ *  }
+ * }
+ */
+declare const STATUS_URL = "status-url";
 interface Extensions {
     [CODE_SAMPLES]: {
         /**
@@ -1109,6 +1123,7 @@ interface Extensions {
     [PROXY_ENABLED]: boolean;
     [SAMPLES_LANGUAGES]: string[];
     [SIMPLE_MODE]: boolean;
+    [STATUS_URL]: string | undefined;
 }
 declare const extensionDefaults: Extensions;
 /**
@@ -1129,4 +1144,4 @@ declare function getExtension(extension: string | keyof Extensions, api: OASDocu
  */
 declare function validateParameterOrdering(ordering: (typeof extensionDefaults)[typeof PARAMETER_ORDERING] | undefined, extension: string): void;
 
-export { Callback as C, DISABLE_TAG_SORTING as D, EXPLORER_ENABLED as E, HEADERS as H, INTERNAL as I, METRICS_ENABLED as M, Operation as O, PARAMETER_ORDERING as P, SAMPLES_LANGUAGES as S, Webhook as W, CODE_SAMPLES as a, type Extensions as b, OAUTH_OPTIONS as c, PROXY_ENABLED as d, Oas as default, SIMPLE_MODE as e, extensionDefaults as f, getExtension as g, hasRootExtension as h, validateParameterOrdering as v };
+export { Callback as C, DISABLE_TAG_SORTING as D, EXPLORER_ENABLED as E, HEADERS as H, INTERNAL as I, METRICS_ENABLED as M, Operation as O, PARAMETER_ORDERING as P, SAMPLES_LANGUAGES as S, Webhook as W, CODE_SAMPLES as a, type Extensions as b, OAUTH_OPTIONS as c, PROXY_ENABLED as d, Oas as default, SIMPLE_MODE as e, STATUS_URL as f, extensionDefaults as g, getExtension as h, hasRootExtension as i, validateParameterOrdering as v };

package/dist/index.js

@@ -11,12 +11,12 @@ import {
   stripTrailingSlash,
   transformURLIntoRegex,
   variablesFromServers
-} from "./chunk-WIVQX3DA.js";
+} from "./chunk-LOR5XCEP.js";
 import {
   SERVER_VARIABLE_REGEX,
   dereferenceRef,
   supportedMethods
-} from "./chunk-IEN4GZPF.js";
+} from "./chunk-6QP66C5V.js";
 import {
   CODE_SAMPLES,
   HEADERS,
@@ -27,7 +27,7 @@ import {
   getExtension,
   hasRootExtension,
   validateParameterOrdering
-} from "./chunk-S27IGTVG.js";
+} from "./chunk-LZNTJ4ZR.js";
 import {
   isOpenAPI31,
   isRef

package/dist/operation/index.cjs

@@ -2,13 +2,13 @@
 
 
 
-var _chunkGS43VKJHcjs = require('../chunk-GS43VKJH.cjs');
-require('../chunk-UKD63LKG.cjs');
-require('../chunk-AYA3UT4L.cjs');
+var _chunkYCSVUVACcjs = require('../chunk-YCSVUVAC.cjs');
+require('../chunk-GPOPN7TQ.cjs');
+require('../chunk-6HXOZ5GY.cjs');
 require('../chunk-7PWF3F2W.cjs');
 
 
 
 
-exports.Callback = _chunkGS43VKJHcjs.Callback; exports.Operation = _chunkGS43VKJHcjs.Operation; exports.Webhook = _chunkGS43VKJHcjs.Webhook;
+exports.Callback = _chunkYCSVUVACcjs.Callback; exports.Operation = _chunkYCSVUVACcjs.Operation; exports.Webhook = _chunkYCSVUVACcjs.Webhook;
 //# sourceMappingURL=index.cjs.map

package/dist/operation/index.js

@@ -2,9 +2,9 @@ import {
   Callback,
   Operation,
   Webhook
-} from "../chunk-WIVQX3DA.js";
-import "../chunk-IEN4GZPF.js";
-import "../chunk-S27IGTVG.js";
+} from "../chunk-LOR5XCEP.js";
+import "../chunk-6QP66C5V.js";
+import "../chunk-LZNTJ4ZR.js";
 import "../chunk-XG4HGNCN.js";
 export {
   Callback,

package/dist/reducer/index.cjs

@@ -4,8 +4,8 @@ var _chunkW6GBV2JTcjs = require('../chunk-W6GBV2JT.cjs');
 
 
 
-var _chunkUKD63LKGcjs = require('../chunk-UKD63LKG.cjs');
-require('../chunk-AYA3UT4L.cjs');
+var _chunkGPOPN7TQcjs = require('../chunk-GPOPN7TQ.cjs');
+require('../chunk-6HXOZ5GY.cjs');
 
 
 
@@ -274,7 +274,7 @@ var OpenAPIReducer = (_class = class _OpenAPIReducer {
       const pathSegment = match[1];
       const method = match[2];
       if (pathSegment && method) {
-        return { path: _chunkUKD63LKGcjs.decodePointer.call(void 0, pathSegment), method };
+        return { path: _chunkGPOPN7TQcjs.decodePointer.call(void 0, pathSegment), method };
       }
     }
     return null;
@@ -293,7 +293,7 @@ var OpenAPIReducer = (_class = class _OpenAPIReducer {
       const webhookName = match[1];
       const method = match[2];
       if (webhookName && method) {
-        return { name: _chunkUKD63LKGcjs.decodePointer.call(void 0, webhookName), method };
+        return { name: _chunkGPOPN7TQcjs.decodePointer.call(void 0, webhookName), method };
       }
     }
     return null;
@@ -321,7 +321,7 @@ var OpenAPIReducer = (_class = class _OpenAPIReducer {
         }
       }
       Object.keys(_optionalChain([this, 'access', _23 => _23.definition, 'access', _24 => _24.paths, 'optionalAccess', _25 => _25[path]]) || {}).forEach((method) => {
-        if (method === "parameters" || !_chunkUKD63LKGcjs.supportedMethods.includes(method.toLowerCase())) {
+        if (method === "parameters" || !_chunkGPOPN7TQcjs.supportedMethods.includes(method.toLowerCase())) {
           return;
         }
         if (this.hasPathsToReduceBy) {
@@ -395,7 +395,7 @@ var OpenAPIReducer = (_class = class _OpenAPIReducer {
         return;
       }
       Object.keys(webhook).forEach((method) => {
-        if (method === "parameters" || !_chunkUKD63LKGcjs.supportedMethods.includes(method.toLowerCase())) {
+        if (method === "parameters" || !_chunkGPOPN7TQcjs.supportedMethods.includes(method.toLowerCase())) {
           return;
         }
         if (this.hasWebhooksToReduceBy) {
@@ -470,7 +470,7 @@ var OpenAPIReducer = (_class = class _OpenAPIReducer {
       }
       Object.keys(_optionalChain([this, 'access', _39 => _39.definition, 'access', _40 => _40.paths, 'optionalAccess', _41 => _41[path]]) || {}).forEach((method) => {
         const methodLC = method.toLowerCase();
-        if (method === "parameters" || !_chunkUKD63LKGcjs.supportedMethods.includes(methodLC)) {
+        if (method === "parameters" || !_chunkGPOPN7TQcjs.supportedMethods.includes(methodLC)) {
           return;
         }
         const retainedByRef = this.retainPathMethods.has(`${pathLC}|${methodLC}`) || Array.from(this.$refs).some((ref) => {
@@ -555,7 +555,7 @@ var OpenAPIReducer = (_class = class _OpenAPIReducer {
       }
       Object.keys(webhook).forEach((method) => {
         const methodLC = method.toLowerCase();
-        if (method === "parameters" || !_chunkUKD63LKGcjs.supportedMethods.includes(methodLC)) {
+        if (method === "parameters" || !_chunkGPOPN7TQcjs.supportedMethods.includes(methodLC)) {
           return;
         }
         const retainedByRef = this.retainWebhookMethods.has(`${nameLC}|${methodLC}`);

package/dist/reducer/index.js

@@ -4,8 +4,8 @@ import {
 import {
   decodePointer,
   supportedMethods
-} from "../chunk-IEN4GZPF.js";
-import "../chunk-S27IGTVG.js";
+} from "../chunk-6QP66C5V.js";
+import "../chunk-LZNTJ4ZR.js";
 import {
   isOpenAPI31,
   isRef

package/dist/utils.cjs

@@ -6,8 +6,8 @@
 
 
 
-var _chunkUKD63LKGcjs = require('./chunk-UKD63LKG.cjs');
-require('./chunk-AYA3UT4L.cjs');
+var _chunkGPOPN7TQcjs = require('./chunk-GPOPN7TQ.cjs');
+require('./chunk-6HXOZ5GY.cjs');
 require('./chunk-7PWF3F2W.cjs');
 
 
@@ -17,5 +17,5 @@ require('./chunk-7PWF3F2W.cjs');
 
 
 
-exports.SERVER_VARIABLE_REGEX = _chunkUKD63LKGcjs.SERVER_VARIABLE_REGEX; exports.dereferenceRef = _chunkUKD63LKGcjs.dereferenceRef; exports.dereferenceRefDeep = _chunkUKD63LKGcjs.dereferenceRefDeep; exports.getParameterContentType = _chunkUKD63LKGcjs.getParameterContentType; exports.jsonSchemaTypes = _chunkUKD63LKGcjs.types; exports.matchesMimeType = _chunkUKD63LKGcjs.matches_mimetype_default; exports.supportedMethods = _chunkUKD63LKGcjs.supportedMethods;
+exports.SERVER_VARIABLE_REGEX = _chunkGPOPN7TQcjs.SERVER_VARIABLE_REGEX; exports.dereferenceRef = _chunkGPOPN7TQcjs.dereferenceRef; exports.dereferenceRefDeep = _chunkGPOPN7TQcjs.dereferenceRefDeep; exports.getParameterContentType = _chunkGPOPN7TQcjs.getParameterContentType; exports.jsonSchemaTypes = _chunkGPOPN7TQcjs.types; exports.matchesMimeType = _chunkGPOPN7TQcjs.matches_mimetype_default; exports.supportedMethods = _chunkGPOPN7TQcjs.supportedMethods;
 //# sourceMappingURL=utils.cjs.map

package/dist/utils.js

@@ -6,8 +6,8 @@ import {
   matches_mimetype_default,
   supportedMethods,
   types
-} from "./chunk-IEN4GZPF.js";
-import "./chunk-S27IGTVG.js";
+} from "./chunk-6QP66C5V.js";
+import "./chunk-LZNTJ4ZR.js";
 import "./chunk-XG4HGNCN.js";
 export {
   SERVER_VARIABLE_REGEX,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "oas",
-  "version": "37.0.0",
+  "version": "37.2.0",
   "description": "Comprehensive tooling for working with OpenAPI definitions",
   "license": "MIT",
   "author": "ReadMe <support@readme.io> (https://readme.com)",
@@ -83,7 +83,7 @@
     "watch": "tsc --watch"
   },
   "dependencies": {
-    "@readme/openapi-parser": "^6.1.3",
+    "@readme/openapi-parser": "^6.2.1",
     "@types/json-schema": "^7.0.11",
     "json-schema-merge-allof": "^0.8.1",
     "jsonpath-plus": "^10.4.0",

package/dist/chunk-AYA3UT4L.cjs.map

@@ -1 +0,0 @@
-{"version":3,"sources":["/Users/erunion/code/readme/oas/packages/oas/dist/chunk-AYA3UT4L.cjs","../src/extensions.ts"],"names":[],"mappings":"AAAA;AC+BO,IAAM,aAAA,EAAe,cAAA;AAoBrB,IAAM,iBAAA,EAAmB,kBAAA;AAwBzB,IAAM,QAAA,EAAU,SAAA;AAmBhB,IAAM,SAAA,EAAW,UAAA;AAmBjB,IAAM,gBAAA,EAAkB,iBAAA;AAkBxB,IAAM,cAAA,EAAgB,eAAA;AAuBtB,IAAM,mBAAA,EAAqB,oBAAA;AAoB3B,IAAM,cAAA,EAAgB,eAAA;AAiBtB,IAAM,kBAAA,EAAoB,mBAAA;AAc1B,IAAM,YAAA,EAAc,aAAA;AAepB,IAAM,oBAAA,EAAsB,qBAAA;AAkF5B,IAAM,kBAAA,EAAgC;AAAA,EAC3C,CAAC,YAAY,CAAA,EAAG,KAAA,CAAA;AAAA,EAChB,CAAC,mBAAmB,CAAA,EAAG,KAAA;AAAA,EACvB,CAAC,gBAAgB,CAAA,EAAG,IAAA;AAAA,EACpB,CAAC,OAAO,CAAA,EAAG,KAAA,CAAA;AAAA,EACX,CAAC,QAAQ,CAAA,EAAG,KAAA;AAAA,EACZ,CAAC,eAAe,CAAA,EAAG,IAAA;AAAA,EACnB,CAAC,aAAa,CAAA,EAAG,CAAC,CAAA;AAAA,EAClB,CAAC,kBAAkB,CAAA,EAAG,CAAC,MAAA,EAAQ,OAAA,EAAS,MAAA,EAAQ,QAAA,EAAU,MAAA,EAAQ,QAAQ,CAAA;AAAA,EAC1E,CAAC,aAAa,CAAA,EAAG,IAAA;AAAA,EACjB,CAAC,iBAAiB,CAAA,EAAG,CAAC,OAAA,EAAS,MAAA,EAAQ,MAAA,EAAQ,KAAA,EAAO,QAAA,EAAU,MAAA,EAAQ,QAAQ,CAAA;AAAA,EAChF,CAAC,WAAW,CAAA,EAAG;AACjB,CAAA;AAMO,SAAS,gBAAA,CAAiB,SAAA,EAAsC,GAAA,EAA2B;AAChG,EAAA,OAAO,OAAA,CAAQ,IAAA,GAAO,UAAA,GAAa,GAAG,CAAA;AACxC;AAMO,SAAS,YAAA,CAAa,SAAA,EAAsC,GAAA,EAAkB,SAAA,EAA4B;AAC/G,EAAA,GAAA,CAAI,SAAA,EAAW;AACb,IAAA,GAAA,CAAI,SAAA,CAAU,YAAA,CAAa,UAAU,CAAA,EAAG;AACtC,MAAA,MAAM,KAAA,EAAO,SAAA,CAAU,YAAA,CAAa,UAAU,CAAA;AAC9C,MAAA,GAAA,CAAI,KAAA,GAAQ,OAAO,KAAA,IAAS,SAAA,GAAY,UAAA,GAAa,IAAA,EAAM;AACzD,QAAA,OAAO,IAAA,CAAK,SAA6B,CAAA;AAAA,MAC3C;AAAA,IACF;AAEA,IAAA,GAAA,CAAI,SAAA,CAAU,YAAA,CAAa,CAAA,EAAA,EAAK,SAAS,CAAA,CAAA;AACJ,MAAA;AACH,IAAA;AACO,MAAA;AACzC,IAAA;AACF,EAAA;AAIgC,EAAA;AACI,IAAA;AACpC,EAAA;AAEuC,EAAA;AACR,IAAA;AACW,IAAA;AACG,MAAA;AAC3C,IAAA;AACF,EAAA;AAE0C,EAAA;AACX,IAAA;AACW,EAAA;AAClB,IAAA;AACxB,EAAA;AAGoC,EAAA;AACoB,IAAA;AACxD,EAAA;AAEO,EAAA;AACT;AAUE;AAEe,EAAA;AACb,IAAA;AACF,EAAA;AAEuC,EAAA;AACH,EAAA;AACQ,EAAA;AAEJ,EAAA;AACL,IAAA;AACnC,EAAA;AAEqC,EAAA;AACO,EAAA;AACT,IAAA;AACnC,EAAA;AACF;ADjU8C;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA","file":"/Users/erunion/code/readme/oas/packages/oas/dist/chunk-AYA3UT4L.cjs","sourcesContent":[null,"import type { Operation } from './operation/index.js';\nimport type { OASDocument } from './types.js';\n\n/**\n * Enables custom-written code samples to be set for your operations. Use this if you have specific\n * formatting that may not be followed by the auto-generated code samples. Custom code samples are\n * treated as static content.\n *\n * This extension only be placed at the operation level.\n *\n * @defaultValue []\n * @see {@link https://docs.readme.com/main/docs/openapi-extensions#custom-code-samples}\n * @example\n * {\n *  \"x-readme\": {\n *    \"code-samples\": [\n *      {\n *        \"language\": \"curl\",\n *        \"code\": \"curl -X POST https://api.example.com/v2/alert\",\n *        \"name\": \"Custom cURL snippet\",\n *        \"install\": \"brew install curl\"\n *      },\n *      {\n *        \"language\": \"php\",\n *        \"code\": \"<?php echo \\\"This is our custom PHP code snippet.\\\"; ?>\",\n *        \"name\": \"Custom PHP snippet\"\n *      }\n *    ]\n *  }\n * }\n */\nexport const CODE_SAMPLES = 'code-samples';\n\n/**\n * Disables the API Explorer's \"Try It\" button, preventing users from making API requests from\n * within your docs. Users will still be able to fill out any entry fields (path or query\n * parameters, etc.), and code snippets will be auto-generated based on the user's input, however\n * to interact with your API the user will need to copy the code snippet and execute it outside of\n * your docs.\n *\n * This **does not** disable your API Reference documentation.\n *\n * @defaultValue true\n * @see {@link https://docs.readme.com/main/docs/openapi-extensions#disable-the-api-explorer}\n * @example\n * {\n *  \"x-readme\": {\n *    \"explorer-enabled\": true\n *  }\n * }\n */\nexport const EXPLORER_ENABLED = 'explorer-enabled';\n\n/**\n * Adds static headers to add to each request. Use this when there are specific headers unique to\n * your API.\n *\n * @defaultValue []\n * @see {@link https://docs.readme.com/main/docs/openapi-extensions#static-headers}\n * @example\n * {\n *  \"x-readme\": {\n *    \"headers\": [\n *      {\n *        \"key\": \"X-Static-Header-One\",\n *        \"value\": \"owlbert\"\n *      },\n *      {\n *        \"key\": \"X-Static-Header-Two\",\n *        \"value\": \"owlivia\"\n *      }\n *    ]\n *  }\n * }\n */\nexport const HEADERS = 'headers';\n\n/**\n * Allows you to mark an API endpoint, or _every_ API endpoint if defined in the root, as being\n * internal and hidden from your public API reference.\n *\n * @defaultValue false\n * @see {@link https://docs.readme.com/main/docs/openapi-extensions#internal}\n * @example\n * {\n *  \"x-internal\": true\n * }\n * @example\n * {\n *  \"x-readme\": {\n *    \"internal\": true\n *  }\n * }\n */\nexport const INTERNAL = 'internal';\n\n/**\n * Disables API requests from the API Explorer's \"Try It\" button from being sent into our [API\n * Metrics](https://readme.com/metrics) for you and your users. Additionally on any API endpoint\n * that this is disabled on your users will not see lists or graphs of previous requests they've\n * made against that API endpoint — either through the API Explorer's interactivity or through one\n * of our [Metrics SDKs](https://docs.readme.com/main/docs/api-metrics-setup) (if you have those\n * installed on your API).\n *\n * @defaultValue true\n * @see {@link https://docs.readme.com/main/docs/openapi-extensions#disable-api-metrics}\n * @example\n * {\n *  \"x-readme\": {\n *    \"metrics-defaults\": false\n *  }\n * }\n */\nexport const METRICS_ENABLED = 'metrics-enabled';\n\n/**\n * Configuration options for OAuth flows in the API Explorer.\n *\n * @defaultValue {}\n * @see {@link https://docs.readme.com/main/docs/openapi-extensions#oauth-configuration-options}\n * @example\n * {\n *  \"x-readme\": {\n *    \"oauth-options\": {\n *      \"scopeSeparator\": \",\",\n *      \"useInsecureClientAuthentication\": true,\n *      \"usePkce\": false\n *    }\n *  }\n * }\n */\nexport const OAUTH_OPTIONS = 'oauth-options';\n\n/**\n * Controls the order of parameters on your API Reference pages.\n *\n * Your custom ordering **must** contain all of our available parameter types:\n *\n *  - `path`: Path parameters\n *  - `query`: Query parameters\n *  - `body`: Non-`application/x-www-form-urlencoded` request body payloads\n *  - `cookie`: Cookie parameters\n *  - `form`: `application/x-www-form-urlencoded` request body payloads\n *  - `header`: Header parameters\n *\n * @defaultValue ['path', 'query', 'body', 'cookie', 'form', 'header']\n * @see {@link https://docs.readme.com/main/docs/openapi-extensions#parameter-ordering}\n * @example\n * {\n *  \"x-readme\": {\n *    \"parameter-ordering\": ['path', 'query', 'header', 'cookie', 'body', 'form']\n *  }\n * }\n */\nexport const PARAMETER_ORDERING = 'parameter-ordering';\n\n/**\n * Toggles the CORS proxy used when making API requests from within your docs (via the \"Try It\"\n * button). If your API is already set up to return CORS headers, you can safely disable this\n * feature.\n *\n * Disabling the CORS proxy will make the request directly from the user's browser and will prevent\n * [Metrics](https://docs.readme.com/main/docs/getting-started-with-metrics) data from being logged\n * by us unless [Metrics have already set up on your backend](https://docs.readme.com/main/docs/api-metrics-setup).\n *\n * @defaultValue true\n * @see {@link https://docs.readme.com/main/docs/openapi-extensions#cors-proxy-enabled}\n * @example\n * {\n *  \"x-readme\": {\n *    \"proxy-enabled\": true\n *  }\n * }\n */\nexport const PROXY_ENABLED = 'proxy-enabled';\n\n/**\n * Toggles what languages are shown by default for code samples in the API Explorer. This only\n * affects what languages are initially shown to the user; if the user picks another language from\n * the three-dot menu, that language and the respective auto-generated code snippet will also appear\n * as an option in the API Explorer.\n *\n * @defaultValue ['shell', 'node', 'ruby', 'php', 'python', 'java', 'csharp']\n * @see {@link https://docs.readme.com/main/docs/openapi-extensions#code-sample-languages}\n * @example\n * {\n *  \"x-readme\": {\n *    \"samples-languages\": [\"shell\", \"node\", \"ruby\", \"javascript\", \"python\"]\n *  }\n * }\n */\nexport const SAMPLES_LANGUAGES = 'samples-languages';\n\n/**\n * Toggles if you will see code snippets for ReadMe's SDK code generator tool `api`.\n *\n * @defaultValue true\n * @see {@link https://api.readme.dev}\n * @example\n * {\n *  \"x-readme\": {\n *    \"simple-mode\": false\n *  }\n * }\n */\nexport const SIMPLE_MODE = 'simple-mode';\n\n/**\n * If `true`, tags are generated from the file top-down. If `false`, we sort the tags\n * based off the `tags` array in the OAS file.\n *\n * @defaultValue false\n * @see {@link https://docs.readme.com/main/docs/openapi-extensions#disable-tag-sorting}\n * @example\n * {\n *  \"x-readme\": {\n *    \"disable-tag-sorting\": true\n *  }\n * }\n */\nexport const DISABLE_TAG_SORTING = 'disable-tag-sorting';\n\nexport interface Extensions {\n  [CODE_SAMPLES]:\n    | {\n        /**\n         * Custom code snippet\n         * @example \"curl -X POST https://api.example.com/v2/alert\"\n         */\n        code: string;\n        /**\n         * Corresponding response example\n         * @see {@link https://docs.readme.com/main/docs/openapi-extensions#corresponding-response-examples}\n         */\n        correspondingExample?: string;\n        /**\n         * Library installation instructions\n         * @example \"brew install httpie\"\n         * @example \"npm install node-fetch@2 --save\"\n         */\n        install?: string;\n        /**\n         * Language for syntax highlighting\n         * @example shell\n         */\n        language: string;\n        /**\n         * Optional title for code sample\n         * @example \"Custom cURL snippet\"\n         */\n        name?: string;\n      }[]\n    | undefined;\n  [DISABLE_TAG_SORTING]: boolean;\n  [EXPLORER_ENABLED]: boolean;\n  [HEADERS]: Record<string, number | string>[] | undefined;\n  [INTERNAL]: boolean;\n  [METRICS_ENABLED]: boolean;\n  [OAUTH_OPTIONS]: {\n    /**\n     * Scope separator for passing scopes. This value will be URL-encoded.\n     *\n     * @example \",\"\n     * @example \"+\"\n     * @default \" \"\n     * @see {@link https://datatracker.ietf.org/doc/html/rfc6749#section-3.3} Scope separators information from OAuth 2.0 specification\n     */\n    scopeSeparator?: string;\n\n    /**\n     * When enabled, the client credentials (i.e., `client_id` and `client_secret`) are sent in the request body (NOT recommended).\n     * When disabled (the default), client credentials are sent using the HTTP Basic Authentication scheme.\n     *\n     * This is applicable for all requests to the token endpoint.\n     *\n     * @see {@link https://datatracker.ietf.org/doc/html/rfc6749#section-2.3.1}\n     * @see {@link https://datatracker.ietf.org/doc/html/rfc6749#section-3.2}\n     *\n     * @example true\n     * @default false\n     */\n    useInsecureClientAuthentication?: boolean;\n\n    /**\n     * When enabled, uses PKCE (Proof Key for Code Exchange) for the authorization code flow.\n     * The client secret is replaced with an auto-generated code verifier and code challenge.\n     * When disabled, uses the standard OAuth 2.0 authorization code flow with client credentials.\n     *\n     * @see {@link https://datatracker.ietf.org/doc/html/rfc7636#section-4.1}\n     * @see {@link https://datatracker.ietf.org/doc/html/rfc7636#section-4.2}\n     *\n     * @example true\n     * @default false\n     */\n    usePkce?: boolean;\n  };\n  [PARAMETER_ORDERING]: ('body' | 'cookie' | 'form' | 'header' | 'path' | 'query')[];\n  [PROXY_ENABLED]: boolean;\n  [SAMPLES_LANGUAGES]: string[];\n  [SIMPLE_MODE]: boolean;\n}\n\nexport const extensionDefaults: Extensions = {\n  [CODE_SAMPLES]: undefined,\n  [DISABLE_TAG_SORTING]: false,\n  [EXPLORER_ENABLED]: true,\n  [HEADERS]: undefined,\n  [INTERNAL]: false,\n  [METRICS_ENABLED]: true,\n  [OAUTH_OPTIONS]: {},\n  [PARAMETER_ORDERING]: ['path', 'query', 'body', 'cookie', 'form', 'header'],\n  [PROXY_ENABLED]: true,\n  [SAMPLES_LANGUAGES]: ['shell', 'node', 'ruby', 'php', 'python', 'java', 'csharp'],\n  [SIMPLE_MODE]: true,\n};\n\n/**\n * Determing if an OpenAPI definition has an extension set in its root schema.\n *\n */\nexport function hasRootExtension(extension: string | keyof Extensions, api: OASDocument): boolean {\n  return Boolean(api && extension in api);\n}\n\n/**\n * Retrieve a custom specification extension off of the API definition.\n *\n */\nexport function getExtension(extension: string | keyof Extensions, api: OASDocument, operation?: Operation): any {\n  if (operation) {\n    if (operation.hasExtension('x-readme')) {\n      const data = operation.getExtension('x-readme') as Extensions;\n      if (data && typeof data === 'object' && extension in data) {\n        return data[extension as keyof Extensions];\n      }\n    }\n\n    if (operation.hasExtension(`x-${extension}`)) {\n      return operation.getExtension(`x-${extension}`);\n    } else if (operation.hasExtension(extension)) {\n      return operation.getExtension(extension);\n    }\n  }\n\n  // Because our `code-samples` extension is intended for operation-level use, if it's instead\n  // placed at the API definition root level then we should ignore it and return our set defaults.\n  if (extension === CODE_SAMPLES) {\n    return extensionDefaults[extension];\n  }\n\n  if (hasRootExtension('x-readme', api)) {\n    const data = api?.['x-readme'] as Extensions;\n    if (data && typeof data === 'object' && extension in data) {\n      return data[extension as keyof Extensions];\n    }\n  }\n\n  if (hasRootExtension(`x-${extension}`, api)) {\n    return api?.[`x-${extension}`];\n  } else if (hasRootExtension(extension, api)) {\n    return api?.[extension];\n  }\n\n  // If this is otherwise an extension of our own then we should return the default value for it.\n  if (extension in extensionDefaults) {\n    return extensionDefaults[extension as keyof Extensions];\n  }\n\n  return undefined;\n}\n\n/**\n * Validate that the data for an instanceof our `PARAMETER_ORDERING` extension is properly\n * configured.\n *\n * @private\n */\nexport function validateParameterOrdering(\n  ordering: (typeof extensionDefaults)[typeof PARAMETER_ORDERING] | undefined,\n  extension: string,\n): void {\n  if (!ordering) {\n    return;\n  }\n\n  const defaultValue = extensionDefaults[PARAMETER_ORDERING];\n  const requiredLength = defaultValue.length;\n  const defaultsHuman = `${defaultValue.slice(0, -1).join(', ')}, and ${defaultValue.slice(-1)}`;\n\n  if (ordering.length !== requiredLength) {\n    throw new TypeError(`\"${extension}\" must contain ${requiredLength} items comprised of: ${defaultsHuman}`);\n  }\n\n  const intersection = ordering.filter(value => defaultValue.includes(value.toLowerCase() as any));\n  if (intersection.length !== requiredLength) {\n    throw new TypeError(`\"${extension}\" must contain ${requiredLength} items comprised of: ${defaultsHuman}`);\n  }\n}\n"]}