@sdk-it/spec 0.28.0 → 0.29.0

package/dist/lib/overview-docs/doc-text-utils.d.ts

@@ -0,0 +1,86 @@
+/**
+ * Preset documentation text templates for consistent singular/plural handling
+ */
+export declare const presetDocs: {
+    readonly auth: {
+        readonly section: {
+            readonly singular: "Available Authentication Method";
+            readonly plural: "Available Authentication Methods";
+        };
+        readonly description: {
+            readonly singular: "an authentication method";
+            readonly plural: "various authentication methods";
+        };
+        readonly scheme: {
+            readonly singular: "the available authentication scheme";
+            readonly plural: "each available authentication scheme";
+        };
+        readonly intro: {
+            readonly template: (count: number, methods: string, schemes: string, pronoun: string) => string;
+        };
+    };
+    readonly server: {
+        readonly section: {
+            readonly singular: "API Server";
+            readonly plural: "API Servers";
+        };
+        readonly description: {
+            readonly singular: "The following server is available for this API:";
+            readonly plural: "The following servers are available for this API:";
+        };
+    };
+    readonly client: {
+        readonly section: {
+            readonly singular: "Official API Client";
+            readonly plural: "Official API Clients";
+        };
+        readonly sdk: {
+            readonly singular: "SDK";
+            readonly plural: "SDKs";
+        };
+        readonly language: {
+            readonly singular: "a programming language";
+            readonly plural: "multiple programming languages";
+        };
+        readonly recommendation: {
+            readonly singular: "this client";
+            readonly plural: "these clients";
+        };
+        readonly location: {
+            readonly singular: "it";
+            readonly plural: "them";
+        };
+        readonly intro: {
+            readonly template: (apiTitle: string, count: number, sdks: string, languages: string, recommendation: string, location: string) => string;
+        };
+    };
+};
+/**
+ * Common pronouns and determiners based on count
+ */
+export declare const pronouns: {
+    readonly pronoun: (count: number) => "it" | "them";
+    readonly determiner: (count: number) => "this" | "these";
+    readonly article: (count: number) => "" | "a";
+};
+/**
+ * Get the appropriate text based on count (singular/plural)
+ */
+export declare function getTextByCount<T extends Record<'singular' | 'plural', string>>(count: number, textOptions: T): string;
+/**
+ * Automatically pluralize a word based on count using the pluralize library
+ */
+export declare function pluralizeWord(word: string, count: number): string;
+/**
+ * Helper function to get common text variations based on count
+ */
+export declare function getCommonText(count: number): {
+    pronoun: string;
+    determiner: string;
+    article: string;
+    isAre: string;
+    hasHave: string;
+};
+export declare function getAuthIntroText(count: number): string;
+export declare function getClientIntroText(apiTitle: string, count: number): string;
+//# sourceMappingURL=doc-text-utils.d.ts.map

package/dist/lib/overview-docs/doc-text-utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"doc-text-utils.d.ts","sourceRoot":"","sources":["../../../src/lib/overview-docs/doc-text-utils.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,eAAO,MAAM,UAAU;;;;;;;;;;;;;;;uCAgBR,MAAM,WACJ,MAAM,WACN,MAAM,WACN,MAAM;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;0CAsCL,MAAM,SACT,MAAM,QACP,MAAM,aACD,MAAM,kBACD,MAAM,YACZ,MAAM;;;CAKd,CAAC;AAEX;;GAEG;AACH,eAAO,MAAM,QAAQ;8BACF,MAAM;iCACH,MAAM;8BACT,MAAM;CACf,CAAC;AAEX;;GAEG;AACH,wBAAgB,cAAc,CAAC,CAAC,SAAS,MAAM,CAAC,UAAU,GAAG,QAAQ,EAAE,MAAM,CAAC,EAC5E,KAAK,EAAE,MAAM,EACb,WAAW,EAAE,CAAC,GACb,MAAM,CAER;AAED;;GAEG;AACH,wBAAgB,aAAa,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,MAAM,CAEjE;AAED;;GAEG;AACH,wBAAgB,aAAa,CAAC,KAAK,EAAE,MAAM;;;;;;EAQ1C;AAED,wBAAgB,gBAAgB,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAMtD;AAED,wBAAgB,kBAAkB,CAAC,QAAQ,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,MAAM,CAiB1E"}

package/dist/lib/overview-docs/doc-text-utils.js

@@ -0,0 +1,108 @@
+import pluralize from "pluralize";
+const presetDocs = {
+  auth: {
+    section: {
+      singular: "Available Authentication Method",
+      plural: "Available Authentication Methods"
+    },
+    description: {
+      singular: "an authentication method",
+      plural: "various authentication methods"
+    },
+    scheme: {
+      singular: "the available authentication scheme",
+      plural: "each available authentication scheme"
+    },
+    intro: {
+      template: (count, methods, schemes, pronoun) => `This API provides secure access through ${methods}. Below you'll find details about ${schemes} and how to use ${pronoun}.`
+    }
+  },
+  server: {
+    section: {
+      singular: "API Server",
+      plural: "API Servers"
+    },
+    description: {
+      singular: "The following server is available for this API:",
+      plural: "The following servers are available for this API:"
+    }
+  },
+  client: {
+    section: {
+      singular: "Official API Client",
+      plural: "Official API Clients"
+    },
+    sdk: {
+      singular: "SDK",
+      plural: "SDKs"
+    },
+    language: {
+      singular: "a programming language",
+      plural: "multiple programming languages"
+    },
+    recommendation: {
+      singular: "this client",
+      plural: "these clients"
+    },
+    location: {
+      singular: "it",
+      plural: "them"
+    },
+    intro: {
+      template: (apiTitle, count, sdks, languages, recommendation, location) => `${apiTitle} provides official client ${sdks} for ${languages}. We recommend using ${recommendation} to interact with all stable endpoints. You can find ${location} here:`
+    }
+  }
+};
+const pronouns = {
+  pronoun: (count) => count === 1 ? "it" : "them",
+  determiner: (count) => count === 1 ? "this" : "these",
+  article: (count) => count === 1 ? "a" : ""
+};
+function getTextByCount(count, textOptions) {
+  return count === 1 ? textOptions.singular : textOptions.plural;
+}
+function pluralizeWord(word, count) {
+  return pluralize(word, count);
+}
+function getCommonText(count) {
+  return {
+    pronoun: pronouns.pronoun(count),
+    determiner: pronouns.determiner(count),
+    article: pronouns.article(count),
+    isAre: count === 1 ? "is" : "are",
+    hasHave: count === 1 ? "has" : "have"
+  };
+}
+function getAuthIntroText(count) {
+  const methods = getTextByCount(count, presetDocs.auth.description);
+  const schemes = getTextByCount(count, presetDocs.auth.scheme);
+  const pronoun = pronouns.pronoun(count);
+  return presetDocs.auth.intro.template(count, methods, schemes, pronoun);
+}
+function getClientIntroText(apiTitle, count) {
+  const sdks = getTextByCount(count, presetDocs.client.sdk);
+  const languages = getTextByCount(count, presetDocs.client.language);
+  const recommendation = getTextByCount(
+    count,
+    presetDocs.client.recommendation
+  );
+  const location = getTextByCount(count, presetDocs.client.location);
+  return presetDocs.client.intro.template(
+    apiTitle,
+    count,
+    sdks,
+    languages,
+    recommendation,
+    location
+  );
+}
+export {
+  getAuthIntroText,
+  getClientIntroText,
+  getCommonText,
+  getTextByCount,
+  pluralizeWord,
+  presetDocs,
+  pronouns
+};
+//# sourceMappingURL=doc-text-utils.js.map

package/dist/lib/overview-docs/doc-text-utils.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../../src/lib/overview-docs/doc-text-utils.ts"],
+  "sourcesContent": ["import pluralize from 'pluralize';\n\n/**\n * Preset documentation text templates for consistent singular/plural handling\n */\nexport const presetDocs = {\n  auth: {\n    section: {\n      singular: 'Available Authentication Method',\n      plural: 'Available Authentication Methods',\n    },\n    description: {\n      singular: 'an authentication method',\n      plural: 'various authentication methods',\n    },\n    scheme: {\n      singular: 'the available authentication scheme',\n      plural: 'each available authentication scheme',\n    },\n    intro: {\n      template: (\n        count: number,\n        methods: string,\n        schemes: string,\n        pronoun: string,\n      ) =>\n        `This API provides secure access through ${methods}. Below you'll find details about ${schemes} and how to use ${pronoun}.`,\n    },\n  },\n  server: {\n    section: {\n      singular: 'API Server',\n      plural: 'API Servers',\n    },\n    description: {\n      singular: 'The following server is available for this API:',\n      plural: 'The following servers are available for this API:',\n    },\n  },\n  client: {\n    section: {\n      singular: 'Official API Client',\n      plural: 'Official API Clients',\n    },\n    sdk: {\n      singular: 'SDK',\n      plural: 'SDKs',\n    },\n    language: {\n      singular: 'a programming language',\n      plural: 'multiple programming languages',\n    },\n    recommendation: {\n      singular: 'this client',\n      plural: 'these clients',\n    },\n    location: {\n      singular: 'it',\n      plural: 'them',\n    },\n    intro: {\n      template: (\n        apiTitle: string,\n        count: number,\n        sdks: string,\n        languages: string,\n        recommendation: string,\n        location: string,\n      ) =>\n        `${apiTitle} provides official client ${sdks} for ${languages}. We recommend using ${recommendation} to interact with all stable endpoints. You can find ${location} here:`,\n    },\n  },\n} as const;\n\n/**\n * Common pronouns and determiners based on count\n */\nexport const pronouns = {\n  pronoun: (count: number) => (count === 1 ? 'it' : 'them'),\n  determiner: (count: number) => (count === 1 ? 'this' : 'these'),\n  article: (count: number) => (count === 1 ? 'a' : ''),\n} as const;\n\n/**\n * Get the appropriate text based on count (singular/plural)\n */\nexport function getTextByCount<T extends Record<'singular' | 'plural', string>>(\n  count: number,\n  textOptions: T,\n): string {\n  return count === 1 ? textOptions.singular : textOptions.plural;\n}\n\n/**\n * Automatically pluralize a word based on count using the pluralize library\n */\nexport function pluralizeWord(word: string, count: number): string {\n  return pluralize(word, count);\n}\n\n/**\n * Helper function to get common text variations based on count\n */\nexport function getCommonText(count: number) {\n  return {\n    pronoun: pronouns.pronoun(count),\n    determiner: pronouns.determiner(count),\n    article: pronouns.article(count),\n    isAre: count === 1 ? 'is' : 'are',\n    hasHave: count === 1 ? 'has' : 'have',\n  };\n}\n\nexport function getAuthIntroText(count: number): string {\n  const methods = getTextByCount(count, presetDocs.auth.description);\n  const schemes = getTextByCount(count, presetDocs.auth.scheme);\n  const pronoun = pronouns.pronoun(count);\n\n  return presetDocs.auth.intro.template(count, methods, schemes, pronoun);\n}\n\nexport function getClientIntroText(apiTitle: string, count: number): string {\n  const sdks = getTextByCount(count, presetDocs.client.sdk);\n  const languages = getTextByCount(count, presetDocs.client.language);\n  const recommendation = getTextByCount(\n    count,\n    presetDocs.client.recommendation,\n  );\n  const location = getTextByCount(count, presetDocs.client.location);\n\n  return presetDocs.client.intro.template(\n    apiTitle,\n    count,\n    sdks,\n    languages,\n    recommendation,\n    location,\n  );\n}\n"],
+  "mappings": "AAAA,OAAO,eAAe;AAKf,MAAM,aAAa;AAAA,EACxB,MAAM;AAAA,IACJ,SAAS;AAAA,MACP,UAAU;AAAA,MACV,QAAQ;AAAA,IACV;AAAA,IACA,aAAa;AAAA,MACX,UAAU;AAAA,MACV,QAAQ;AAAA,IACV;AAAA,IACA,QAAQ;AAAA,MACN,UAAU;AAAA,MACV,QAAQ;AAAA,IACV;AAAA,IACA,OAAO;AAAA,MACL,UAAU,CACR,OACA,SACA,SACA,YAEA,2CAA2C,OAAO,qCAAqC,OAAO,mBAAmB,OAAO;AAAA,IAC5H;AAAA,EACF;AAAA,EACA,QAAQ;AAAA,IACN,SAAS;AAAA,MACP,UAAU;AAAA,MACV,QAAQ;AAAA,IACV;AAAA,IACA,aAAa;AAAA,MACX,UAAU;AAAA,MACV,QAAQ;AAAA,IACV;AAAA,EACF;AAAA,EACA,QAAQ;AAAA,IACN,SAAS;AAAA,MACP,UAAU;AAAA,MACV,QAAQ;AAAA,IACV;AAAA,IACA,KAAK;AAAA,MACH,UAAU;AAAA,MACV,QAAQ;AAAA,IACV;AAAA,IACA,UAAU;AAAA,MACR,UAAU;AAAA,MACV,QAAQ;AAAA,IACV;AAAA,IACA,gBAAgB;AAAA,MACd,UAAU;AAAA,MACV,QAAQ;AAAA,IACV;AAAA,IACA,UAAU;AAAA,MACR,UAAU;AAAA,MACV,QAAQ;AAAA,IACV;AAAA,IACA,OAAO;AAAA,MACL,UAAU,CACR,UACA,OACA,MACA,WACA,gBACA,aAEA,GAAG,QAAQ,6BAA6B,IAAI,QAAQ,SAAS,wBAAwB,cAAc,wDAAwD,QAAQ;AAAA,IACvK;AAAA,EACF;AACF;AAKO,MAAM,WAAW;AAAA,EACtB,SAAS,CAAC,UAAmB,UAAU,IAAI,OAAO;AAAA,EAClD,YAAY,CAAC,UAAmB,UAAU,IAAI,SAAS;AAAA,EACvD,SAAS,CAAC,UAAmB,UAAU,IAAI,MAAM;AACnD;AAKO,SAAS,eACd,OACA,aACQ;AACR,SAAO,UAAU,IAAI,YAAY,WAAW,YAAY;AAC1D;AAKO,SAAS,cAAc,MAAc,OAAuB;AACjE,SAAO,UAAU,MAAM,KAAK;AAC9B;AAKO,SAAS,cAAc,OAAe;AAC3C,SAAO;AAAA,IACL,SAAS,SAAS,QAAQ,KAAK;AAAA,IAC/B,YAAY,SAAS,WAAW,KAAK;AAAA,IACrC,SAAS,SAAS,QAAQ,KAAK;AAAA,IAC/B,OAAO,UAAU,IAAI,OAAO;AAAA,IAC5B,SAAS,UAAU,IAAI,QAAQ;AAAA,EACjC;AACF;AAEO,SAAS,iBAAiB,OAAuB;AACtD,QAAM,UAAU,eAAe,OAAO,WAAW,KAAK,WAAW;AACjE,QAAM,UAAU,eAAe,OAAO,WAAW,KAAK,MAAM;AAC5D,QAAM,UAAU,SAAS,QAAQ,KAAK;AAEtC,SAAO,WAAW,KAAK,MAAM,SAAS,OAAO,SAAS,SAAS,OAAO;AACxE;AAEO,SAAS,mBAAmB,UAAkB,OAAuB;AAC1E,QAAM,OAAO,eAAe,OAAO,WAAW,OAAO,GAAG;AACxD,QAAM,YAAY,eAAe,OAAO,WAAW,OAAO,QAAQ;AAClE,QAAM,iBAAiB;AAAA,IACrB;AAAA,IACA,WAAW,OAAO;AAAA,EACpB;AACA,QAAM,WAAW,eAAe,OAAO,WAAW,OAAO,QAAQ;AAEjE,SAAO,WAAW,OAAO,MAAM;AAAA,IAC7B;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,EACF;AACF;",
+  "names": []
+}

package/dist/lib/overview-docs/overview-auth.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"overview-auth.d.ts","sourceRoot":"","sources":["../../../src/lib/overview-docs/overview-auth.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,eAAe,CAAC;AAC7C,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAC;AA+GpD,wBAAgB,oBAAoB,CAAC,IAAI,EAAE,gBAAgB,GAAG,OAAO,CAsDpE"}
+{"version":3,"file":"overview-auth.d.ts","sourceRoot":"","sources":["../../../src/lib/overview-docs/overview-auth.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,eAAe,CAAC;AAC7C,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAC;AA2FpD,wBAAgB,oBAAoB,CAAC,IAAI,EAAE,gBAAgB,GAAG,OAAO,CAmDpE"}

package/dist/lib/overview-docs/overview-auth.js

@@ -1,4 +1,9 @@
 import { resolveRef } from "@sdk-it/core";
+import {
+  getAuthIntroText,
+  getTextByCount,
+  presetDocs
+} from "./doc-text-utils.js";
 function getSecuritySchemeDescription(scheme) {
   switch (scheme.type) {
     case "apiKey": {
@@ -77,85 +82,62 @@ function getFlowDisplayName(flowType) {
   };
   return flowNames[flowType] || flowType;
 }
-function formatSecurityRequirements(requirements) {
-  if (!requirements || requirements.length === 0) return "";
-  let result = "";
-  requirements.forEach((req, index) => {
-    const schemes = Object.entries(req);
-    if (schemes.length === 0) {
-      result += `${index + 1}. No authentication required
-`;
-    } else {
-      result += `${index + 1}. Requires: `;
-      const schemeDescriptions = schemes.map(([scheme, scopes]) => {
-        const scopeArray = scopes;
-        if (scopeArray && scopeArray.length > 0) {
-          return `\`${scheme}\` with scopes: ${scopeArray.map((s) => `\`${s}\``).join(", ")}`;
-        }
-        return `\`${scheme}\``;
-      });
-      result += schemeDescriptions.join(" AND ") + "\n";
-    }
-  });
-  return result;
-}
 function generateAuthOverview(spec) {
-  let markdown = `# Authorization
+  let markdown = `# Authentication
 
 `;
-  const securitySchemes = spec.components?.securitySchemes || {};
+  const securitySchemes = spec.components.securitySchemes;
   const globalSecurity = spec.security || [];
-  if (Object.keys(securitySchemes).length === 0 && globalSecurity.length === 0) {
+  const authMethodCount = Object.keys(securitySchemes).length;
+  if (!authMethodCount && !globalSecurity.length) {
     markdown += `This API does not require authentication.
 
 `;
   } else {
-    markdown += `This API provides secure access through various authentication methods. Below you'll find details about each available authentication scheme and how to use them.
+    if (authMethodCount > 1) {
+      markdown += `${getAuthIntroText(authMethodCount)}
 
 `;
-    if (Object.keys(securitySchemes).length > 0) {
-      markdown += `## Available Authentication Methods
+      markdown += `## ${getTextByCount(authMethodCount, presetDocs.auth.section)}
 
 `;
-      for (const [name, scheme] of Object.entries(securitySchemes)) {
-        const schemeObj = resolveRef(spec, scheme);
+    }
+    for (const [name, scheme] of Object.entries(securitySchemes)) {
+      const schemeObj = resolveRef(spec, scheme);
+      if (authMethodCount > 1) {
         markdown += `### ${name}
 
 `;
-        const description = schemeObj.description || getSecuritySchemeDescription(schemeObj);
-        markdown += `${description}
+      }
+      const description = schemeObj.description || getSecuritySchemeDescription(schemeObj);
+      markdown += `${description}
 
 `;
-        if (schemeObj.type === "apiKey") {
-          markdown += `**Details:**
+      if (schemeObj.type === "apiKey") {
+        markdown += `**Details:**
 `;
-          markdown += `- Parameter Name: \`${schemeObj.name}\`
+        markdown += `- Parameter Name: \`${schemeObj.name}\`
 `;
-          markdown += `- Location: ${schemeObj.in === "header" ? "HTTP Header" : schemeObj.in === "query" ? "Query Parameter" : "Cookie"}
+        markdown += `- Location: ${schemeObj.in === "header" ? "HTTP Header" : schemeObj.in === "query" ? "Query Parameter" : "Cookie"}
 
 `;
-        } else if (schemeObj.type === "http") {
-          markdown += `**Details:**
-`;
-          markdown += `- Scheme: \`${schemeObj.scheme}\`
+      } else if (schemeObj.type === "http") {
+        if (schemeObj.bearerFormat) {
+          markdown += `- Token Format: \`${schemeObj.bearerFormat}\`
 `;
-          if (schemeObj.bearerFormat) {
-            markdown += `- Token Format: \`${schemeObj.bearerFormat}\`
-`;
-          }
-          markdown += "\n";
-        } else if (schemeObj.type === "oauth2" && schemeObj.flows) {
-          markdown += `**OAuth 2.0 Flows:**
+        }
+        markdown += "\n";
+      } else if (schemeObj.type === "oauth2" && schemeObj.flows) {
+        markdown += `**OAuth 2.0 Flows:**
 
 `;
-          markdown += formatOAuth2Flows(schemeObj.flows);
-        } else if (schemeObj.type === "openIdConnect") {
-          markdown += `**Details:**
+        markdown += formatOAuth2Flows(schemeObj.flows);
+      } else if (schemeObj.type === "openIdConnect") {
+        markdown += `**Details:**
 `;
-          markdown += `- Discovery URL: \`${schemeObj.openIdConnectUrl}\`
+        markdown += `- Discovery URL: \`${schemeObj.openIdConnectUrl}\`
 
 `;
-        }
       }
     }
   }

package/dist/lib/overview-docs/overview-auth.js.map

@@ -1,7 +1,7 @@
 {
   "version": 3,
   "sources": ["../../../src/lib/overview-docs/overview-auth.ts"],
-  "sourcesContent": ["import type { OAuthFlowsObject, SecuritySchemeObject } from 'openapi3-ts/oas31';\n\nimport { resolveRef } from '@sdk-it/core';\n\nimport type { NavItem } from '../sidebar.js';\nimport type { OurOpenAPIObject } from '../types.js';\n\nfunction getSecuritySchemeDescription(scheme: SecuritySchemeObject): string {\n  switch (scheme.type) {\n    case 'apiKey': {\n      const location =\n        scheme.in === 'header'\n          ? 'HTTP header'\n          : scheme.in === 'query'\n            ? 'query parameter'\n            : 'cookie';\n      return `API Key authentication requires you to provide an API key in the ${location} named \\`${scheme.name}\\`.`;\n    }\n    case 'http':\n      if (scheme.scheme === 'bearer') {\n        const format = scheme.bearerFormat\n          ? ` The expected token format is \\`${scheme.bearerFormat}\\`.`\n          : '';\n        return `Bearer token authentication requires you to include a bearer token in the \\`Authorization\\` header of your requests.${format}`;\n      }\n      if (scheme.scheme === 'basic') {\n        return `Basic authentication requires you to provide a username and password, encoded in base64 format in the \\`Authorization\\` header.`;\n      }\n      return `HTTP ${scheme.scheme} authentication is required for accessing this API.`;\n    case 'oauth2': {\n      const flows = Object.keys(scheme.flows || {});\n      const flowDescriptions = flows.map((flow) => {\n        switch (flow) {\n          case 'authorizationCode':\n            return 'Authorization Code (for server-side applications)';\n          case 'implicit':\n            return 'Implicit (for browser-based applications)';\n          case 'password':\n            return 'Resource Owner Password Credentials';\n          case 'clientCredentials':\n            return 'Client Credentials (for machine-to-machine authentication)';\n          default:\n            return flow;\n        }\n      });\n      return `OAuth 2.0 authentication is supported with the following grant type(s): ${flowDescriptions.join(', ')}.`;\n    }\n    case 'openIdConnect':\n      return `OpenID Connect authentication is used for this API. You will need to authenticate through the OpenID provider to obtain access tokens.`;\n    default:\n      return 'This API uses a custom authentication scheme. Please refer to the API documentation for specific details.';\n  }\n}\n\nfunction formatOAuth2Flows(flows: OAuthFlowsObject): string {\n  let result = '';\n\n  for (const [flowType, flow] of Object.entries(flows || {})) {\n    result += `#### ${getFlowDisplayName(flowType)}\\n\\n`;\n\n    if (flow.authorizationUrl) {\n      result += `- **Authorization URL:** \\`${flow.authorizationUrl}\\`\\n`;\n    }\n    if (flow.tokenUrl) {\n      result += `- **Token URL:** \\`${flow.tokenUrl}\\`\\n`;\n    }\n    if (flow.refreshUrl) {\n      result += `- **Refresh URL:** \\`${flow.refreshUrl}\\`\\n`;\n    }\n    if (flow.scopes && Object.keys(flow.scopes).length > 0) {\n      result += `- **Available Scopes:**\\n`;\n      for (const [scope, description] of Object.entries(flow.scopes)) {\n        result += `  - \\`${scope}\\`: ${description}\\n`;\n      }\n    }\n    result += '\\n';\n  }\n\n  return result;\n}\n\nfunction getFlowDisplayName(flowType: string): string {\n  const flowNames: Record<string, string> = {\n    authorizationCode: 'Authorization Code Flow',\n    implicit: 'Implicit Flow',\n    password: 'Resource Owner Password Flow',\n    clientCredentials: 'Client Credentials Flow',\n  };\n  return flowNames[flowType] || flowType;\n}\n\nfunction formatSecurityRequirements(\n  requirements: Array<Record<string, string[]>>,\n): string {\n  if (!requirements || requirements.length === 0) return '';\n\n  let result = '';\n  requirements.forEach((req, index) => {\n    const schemes = Object.entries(req);\n    if (schemes.length === 0) {\n      result += `${index + 1}. No authentication required\\n`;\n    } else {\n      result += `${index + 1}. Requires: `;\n      const schemeDescriptions = schemes.map(([scheme, scopes]) => {\n        const scopeArray = scopes as string[];\n        if (scopeArray && scopeArray.length > 0) {\n          return `\\`${scheme}\\` with scopes: ${scopeArray.map((s) => `\\`${s}\\``).join(', ')}`;\n        }\n        return `\\`${scheme}\\``;\n      });\n      result += schemeDescriptions.join(' AND ') + '\\n';\n    }\n  });\n  return result;\n}\n\nexport function generateAuthOverview(spec: OurOpenAPIObject): NavItem {\n  let markdown = `# Authorization\\n\\n`;\n\n  const securitySchemes = spec.components?.securitySchemes || {};\n  const globalSecurity = spec.security || [];\n\n  if (\n    Object.keys(securitySchemes).length === 0 &&\n    globalSecurity.length === 0\n  ) {\n    markdown += `This API does not require authentication.\\n\\n`;\n  } else {\n    markdown += `This API provides secure access through various authentication methods. Below you'll find details about each available authentication scheme and how to use them.\\n\\n`;\n\n    if (Object.keys(securitySchemes).length > 0) {\n      markdown += `## Available Authentication Methods\\n\\n`;\n\n      for (const [name, scheme] of Object.entries(securitySchemes)) {\n        const schemeObj = resolveRef<SecuritySchemeObject>(spec, scheme);\n        markdown += `### ${name}\\n\\n`;\n\n        const description =\n          schemeObj.description || getSecuritySchemeDescription(schemeObj);\n        markdown += `${description}\\n\\n`;\n\n        if (schemeObj.type === 'apiKey') {\n          markdown += `**Details:**\\n`;\n          markdown += `- Parameter Name: \\`${schemeObj.name}\\`\\n`;\n          markdown += `- Location: ${schemeObj.in === 'header' ? 'HTTP Header' : schemeObj.in === 'query' ? 'Query Parameter' : 'Cookie'}\\n\\n`;\n        } else if (schemeObj.type === 'http') {\n          markdown += `**Details:**\\n`;\n          markdown += `- Scheme: \\`${schemeObj.scheme}\\`\\n`;\n          if (schemeObj.bearerFormat) {\n            markdown += `- Token Format: \\`${schemeObj.bearerFormat}\\`\\n`;\n          }\n          markdown += '\\n';\n        } else if (schemeObj.type === 'oauth2' && schemeObj.flows) {\n          markdown += `**OAuth 2.0 Flows:**\\n\\n`;\n          markdown += formatOAuth2Flows(schemeObj.flows);\n        } else if (schemeObj.type === 'openIdConnect') {\n          markdown += `**Details:**\\n`;\n          markdown += `- Discovery URL: \\`${schemeObj.openIdConnectUrl}\\`\\n\\n`;\n        }\n      }\n    }\n  }\n\n  return {\n    id: 'authorization',\n    url: '/authorization',\n    title: 'Authorization',\n    description: 'Authentication methods and security schemes',\n    content: markdown,\n  };\n}\n"],
-  "mappings": "AAEA,SAAS,kBAAkB;AAK3B,SAAS,6BAA6B,QAAsC;AAC1E,UAAQ,OAAO,MAAM;AAAA,IACnB,KAAK,UAAU;AACb,YAAM,WACJ,OAAO,OAAO,WACV,gBACA,OAAO,OAAO,UACZ,oBACA;AACR,aAAO,oEAAoE,QAAQ,YAAY,OAAO,IAAI;AAAA,IAC5G;AAAA,IACA,KAAK;AACH,UAAI,OAAO,WAAW,UAAU;AAC9B,cAAM,SAAS,OAAO,eAClB,mCAAmC,OAAO,YAAY,QACtD;AACJ,eAAO,uHAAuH,MAAM;AAAA,MACtI;AACA,UAAI,OAAO,WAAW,SAAS;AAC7B,eAAO;AAAA,MACT;AACA,aAAO,QAAQ,OAAO,MAAM;AAAA,IAC9B,KAAK,UAAU;AACb,YAAM,QAAQ,OAAO,KAAK,OAAO,SAAS,CAAC,CAAC;AAC5C,YAAM,mBAAmB,MAAM,IAAI,CAAC,SAAS;AAC3C,gBAAQ,MAAM;AAAA,UACZ,KAAK;AACH,mBAAO;AAAA,UACT,KAAK;AACH,mBAAO;AAAA,UACT,KAAK;AACH,mBAAO;AAAA,UACT,KAAK;AACH,mBAAO;AAAA,UACT;AACE,mBAAO;AAAA,QACX;AAAA,MACF,CAAC;AACD,aAAO,2EAA2E,iBAAiB,KAAK,IAAI,CAAC;AAAA,IAC/G;AAAA,IACA,KAAK;AACH,aAAO;AAAA,IACT;AACE,aAAO;AAAA,EACX;AACF;AAEA,SAAS,kBAAkB,OAAiC;AAC1D,MAAI,SAAS;AAEb,aAAW,CAAC,UAAU,IAAI,KAAK,OAAO,QAAQ,SAAS,CAAC,CAAC,GAAG;AAC1D,cAAU,QAAQ,mBAAmB,QAAQ,CAAC;AAAA;AAAA;AAE9C,QAAI,KAAK,kBAAkB;AACzB,gBAAU,8BAA8B,KAAK,gBAAgB;AAAA;AAAA,IAC/D;AACA,QAAI,KAAK,UAAU;AACjB,gBAAU,sBAAsB,KAAK,QAAQ;AAAA;AAAA,IAC/C;AACA,QAAI,KAAK,YAAY;AACnB,gBAAU,wBAAwB,KAAK,UAAU;AAAA;AAAA,IACnD;AACA,QAAI,KAAK,UAAU,OAAO,KAAK,KAAK,MAAM,EAAE,SAAS,GAAG;AACtD,gBAAU;AAAA;AACV,iBAAW,CAAC,OAAO,WAAW,KAAK,OAAO,QAAQ,KAAK,MAAM,GAAG;AAC9D,kBAAU,SAAS,KAAK,OAAO,WAAW;AAAA;AAAA,MAC5C;AAAA,IACF;AACA,cAAU;AAAA,EACZ;AAEA,SAAO;AACT;AAEA,SAAS,mBAAmB,UAA0B;AACpD,QAAM,YAAoC;AAAA,IACxC,mBAAmB;AAAA,IACnB,UAAU;AAAA,IACV,UAAU;AAAA,IACV,mBAAmB;AAAA,EACrB;AACA,SAAO,UAAU,QAAQ,KAAK;AAChC;AAEA,SAAS,2BACP,cACQ;AACR,MAAI,CAAC,gBAAgB,aAAa,WAAW,EAAG,QAAO;AAEvD,MAAI,SAAS;AACb,eAAa,QAAQ,CAAC,KAAK,UAAU;AACnC,UAAM,UAAU,OAAO,QAAQ,GAAG;AAClC,QAAI,QAAQ,WAAW,GAAG;AACxB,gBAAU,GAAG,QAAQ,CAAC;AAAA;AAAA,IACxB,OAAO;AACL,gBAAU,GAAG,QAAQ,CAAC;AACtB,YAAM,qBAAqB,QAAQ,IAAI,CAAC,CAAC,QAAQ,MAAM,MAAM;AAC3D,cAAM,aAAa;AACnB,YAAI,cAAc,WAAW,SAAS,GAAG;AACvC,iBAAO,KAAK,MAAM,mBAAmB,WAAW,IAAI,CAAC,MAAM,KAAK,CAAC,IAAI,EAAE,KAAK,IAAI,CAAC;AAAA,QACnF;AACA,eAAO,KAAK,MAAM;AAAA,MACpB,CAAC;AACD,gBAAU,mBAAmB,KAAK,OAAO,IAAI;AAAA,IAC/C;AAAA,EACF,CAAC;AACD,SAAO;AACT;AAEO,SAAS,qBAAqB,MAAiC;AACpE,MAAI,WAAW;AAAA;AAAA;AAEf,QAAM,kBAAkB,KAAK,YAAY,mBAAmB,CAAC;AAC7D,QAAM,iBAAiB,KAAK,YAAY,CAAC;AAEzC,MACE,OAAO,KAAK,eAAe,EAAE,WAAW,KACxC,eAAe,WAAW,GAC1B;AACA,gBAAY;AAAA;AAAA;AAAA,EACd,OAAO;AACL,gBAAY;AAAA;AAAA;AAEZ,QAAI,OAAO,KAAK,eAAe,EAAE,SAAS,GAAG;AAC3C,kBAAY;AAAA;AAAA;AAEZ,iBAAW,CAAC,MAAM,MAAM,KAAK,OAAO,QAAQ,eAAe,GAAG;AAC5D,cAAM,YAAY,WAAiC,MAAM,MAAM;AAC/D,oBAAY,OAAO,IAAI;AAAA;AAAA;AAEvB,cAAM,cACJ,UAAU,eAAe,6BAA6B,SAAS;AACjE,oBAAY,GAAG,WAAW;AAAA;AAAA;AAE1B,YAAI,UAAU,SAAS,UAAU;AAC/B,sBAAY;AAAA;AACZ,sBAAY,uBAAuB,UAAU,IAAI;AAAA;AACjD,sBAAY,eAAe,UAAU,OAAO,WAAW,gBAAgB,UAAU,OAAO,UAAU,oBAAoB,QAAQ;AAAA;AAAA;AAAA,QAChI,WAAW,UAAU,SAAS,QAAQ;AACpC,sBAAY;AAAA;AACZ,sBAAY,eAAe,UAAU,MAAM;AAAA;AAC3C,cAAI,UAAU,cAAc;AAC1B,wBAAY,qBAAqB,UAAU,YAAY;AAAA;AAAA,UACzD;AACA,sBAAY;AAAA,QACd,WAAW,UAAU,SAAS,YAAY,UAAU,OAAO;AACzD,sBAAY;AAAA;AAAA;AACZ,sBAAY,kBAAkB,UAAU,KAAK;AAAA,QAC/C,WAAW,UAAU,SAAS,iBAAiB;AAC7C,sBAAY;AAAA;AACZ,sBAAY,sBAAsB,UAAU,gBAAgB;AAAA;AAAA;AAAA,QAC9D;AAAA,MACF;AAAA,IACF;AAAA,EACF;AAEA,SAAO;AAAA,IACL,IAAI;AAAA,IACJ,KAAK;AAAA,IACL,OAAO;AAAA,IACP,aAAa;AAAA,IACb,SAAS;AAAA,EACX;AACF;",
+  "sourcesContent": ["import type { OAuthFlowsObject, SecuritySchemeObject } from 'openapi3-ts/oas31';\n\nimport { resolveRef } from '@sdk-it/core';\n\nimport type { NavItem } from '../sidebar.js';\nimport type { OurOpenAPIObject } from '../types.js';\nimport {\n  getAuthIntroText,\n  getTextByCount,\n  presetDocs,\n} from './doc-text-utils.js';\n\nfunction getSecuritySchemeDescription(scheme: SecuritySchemeObject): string {\n  switch (scheme.type) {\n    case 'apiKey': {\n      const location =\n        scheme.in === 'header'\n          ? 'HTTP header'\n          : scheme.in === 'query'\n            ? 'query parameter'\n            : 'cookie';\n      return `API Key authentication requires you to provide an API key in the ${location} named \\`${scheme.name}\\`.`;\n    }\n    case 'http':\n      if (scheme.scheme === 'bearer') {\n        const format = scheme.bearerFormat\n          ? ` The expected token format is \\`${scheme.bearerFormat}\\`.`\n          : '';\n        return `Bearer token authentication requires you to include a bearer token in the \\`Authorization\\` header of your requests.${format}`;\n      }\n      if (scheme.scheme === 'basic') {\n        return `Basic authentication requires you to provide a username and password, encoded in base64 format in the \\`Authorization\\` header.`;\n      }\n      return `HTTP ${scheme.scheme} authentication is required for accessing this API.`;\n    case 'oauth2': {\n      const flows = Object.keys(scheme.flows || {});\n      const flowDescriptions = flows.map((flow) => {\n        switch (flow) {\n          case 'authorizationCode':\n            return 'Authorization Code (for server-side applications)';\n          case 'implicit':\n            return 'Implicit (for browser-based applications)';\n          case 'password':\n            return 'Resource Owner Password Credentials';\n          case 'clientCredentials':\n            return 'Client Credentials (for machine-to-machine authentication)';\n          default:\n            return flow;\n        }\n      });\n      return `OAuth 2.0 authentication is supported with the following grant type(s): ${flowDescriptions.join(', ')}.`;\n    }\n    case 'openIdConnect':\n      return `OpenID Connect authentication is used for this API. You will need to authenticate through the OpenID provider to obtain access tokens.`;\n    default:\n      return 'This API uses a custom authentication scheme. Please refer to the API documentation for specific details.';\n  }\n}\n\nfunction formatOAuth2Flows(flows: OAuthFlowsObject): string {\n  let result = '';\n\n  for (const [flowType, flow] of Object.entries(flows || {})) {\n    result += `#### ${getFlowDisplayName(flowType)}\\n\\n`;\n\n    if (flow.authorizationUrl) {\n      result += `- **Authorization URL:** \\`${flow.authorizationUrl}\\`\\n`;\n    }\n    if (flow.tokenUrl) {\n      result += `- **Token URL:** \\`${flow.tokenUrl}\\`\\n`;\n    }\n    if (flow.refreshUrl) {\n      result += `- **Refresh URL:** \\`${flow.refreshUrl}\\`\\n`;\n    }\n    if (flow.scopes && Object.keys(flow.scopes).length > 0) {\n      result += `- **Available Scopes:**\\n`;\n      for (const [scope, description] of Object.entries(flow.scopes)) {\n        result += `  - \\`${scope}\\`: ${description}\\n`;\n      }\n    }\n    result += '\\n';\n  }\n\n  return result;\n}\n\nfunction getFlowDisplayName(flowType: string): string {\n  const flowNames: Record<string, string> = {\n    authorizationCode: 'Authorization Code Flow',\n    implicit: 'Implicit Flow',\n    password: 'Resource Owner Password Flow',\n    clientCredentials: 'Client Credentials Flow',\n  };\n  return flowNames[flowType] || flowType;\n}\n\nexport function generateAuthOverview(spec: OurOpenAPIObject): NavItem {\n  let markdown = `# Authentication\\n\\n`;\n\n  const securitySchemes = spec.components.securitySchemes;\n  const globalSecurity = spec.security || [];\n\n  const authMethodCount = Object.keys(securitySchemes).length;\n  if (!authMethodCount && !globalSecurity.length) {\n    markdown += `This API does not require authentication.\\n\\n`;\n  } else {\n    if (authMethodCount > 1) {\n      markdown += `${getAuthIntroText(authMethodCount)}\\n\\n`;\n      markdown += `## ${getTextByCount(authMethodCount, presetDocs.auth.section)}\\n\\n`;\n    }\n\n    for (const [name, scheme] of Object.entries(securitySchemes)) {\n      const schemeObj = resolveRef<SecuritySchemeObject>(spec, scheme);\n      if (authMethodCount > 1) {\n        markdown += `### ${name}\\n\\n`;\n      }\n\n      const description =\n        schemeObj.description || getSecuritySchemeDescription(schemeObj);\n      markdown += `${description}\\n\\n`;\n\n      if (schemeObj.type === 'apiKey') {\n        markdown += `**Details:**\\n`;\n        markdown += `- Parameter Name: \\`${schemeObj.name}\\`\\n`;\n        markdown += `- Location: ${schemeObj.in === 'header' ? 'HTTP Header' : schemeObj.in === 'query' ? 'Query Parameter' : 'Cookie'}\\n\\n`;\n      } else if (schemeObj.type === 'http') {\n        if (schemeObj.bearerFormat) {\n          markdown += `- Token Format: \\`${schemeObj.bearerFormat}\\`\\n`;\n        }\n        markdown += '\\n';\n      } else if (schemeObj.type === 'oauth2' && schemeObj.flows) {\n        markdown += `**OAuth 2.0 Flows:**\\n\\n`;\n        markdown += formatOAuth2Flows(schemeObj.flows);\n      } else if (schemeObj.type === 'openIdConnect') {\n        markdown += `**Details:**\\n`;\n        markdown += `- Discovery URL: \\`${schemeObj.openIdConnectUrl}\\`\\n\\n`;\n      }\n    }\n  }\n\n  return {\n    id: 'authorization',\n    url: '/authorization',\n    title: 'Authorization',\n    description: 'Authentication methods and security schemes',\n    content: markdown,\n  };\n}\n"],
+  "mappings": "AAEA,SAAS,kBAAkB;AAI3B;AAAA,EACE;AAAA,EACA;AAAA,EACA;AAAA,OACK;AAEP,SAAS,6BAA6B,QAAsC;AAC1E,UAAQ,OAAO,MAAM;AAAA,IACnB,KAAK,UAAU;AACb,YAAM,WACJ,OAAO,OAAO,WACV,gBACA,OAAO,OAAO,UACZ,oBACA;AACR,aAAO,oEAAoE,QAAQ,YAAY,OAAO,IAAI;AAAA,IAC5G;AAAA,IACA,KAAK;AACH,UAAI,OAAO,WAAW,UAAU;AAC9B,cAAM,SAAS,OAAO,eAClB,mCAAmC,OAAO,YAAY,QACtD;AACJ,eAAO,uHAAuH,MAAM;AAAA,MACtI;AACA,UAAI,OAAO,WAAW,SAAS;AAC7B,eAAO;AAAA,MACT;AACA,aAAO,QAAQ,OAAO,MAAM;AAAA,IAC9B,KAAK,UAAU;AACb,YAAM,QAAQ,OAAO,KAAK,OAAO,SAAS,CAAC,CAAC;AAC5C,YAAM,mBAAmB,MAAM,IAAI,CAAC,SAAS;AAC3C,gBAAQ,MAAM;AAAA,UACZ,KAAK;AACH,mBAAO;AAAA,UACT,KAAK;AACH,mBAAO;AAAA,UACT,KAAK;AACH,mBAAO;AAAA,UACT,KAAK;AACH,mBAAO;AAAA,UACT;AACE,mBAAO;AAAA,QACX;AAAA,MACF,CAAC;AACD,aAAO,2EAA2E,iBAAiB,KAAK,IAAI,CAAC;AAAA,IAC/G;AAAA,IACA,KAAK;AACH,aAAO;AAAA,IACT;AACE,aAAO;AAAA,EACX;AACF;AAEA,SAAS,kBAAkB,OAAiC;AAC1D,MAAI,SAAS;AAEb,aAAW,CAAC,UAAU,IAAI,KAAK,OAAO,QAAQ,SAAS,CAAC,CAAC,GAAG;AAC1D,cAAU,QAAQ,mBAAmB,QAAQ,CAAC;AAAA;AAAA;AAE9C,QAAI,KAAK,kBAAkB;AACzB,gBAAU,8BAA8B,KAAK,gBAAgB;AAAA;AAAA,IAC/D;AACA,QAAI,KAAK,UAAU;AACjB,gBAAU,sBAAsB,KAAK,QAAQ;AAAA;AAAA,IAC/C;AACA,QAAI,KAAK,YAAY;AACnB,gBAAU,wBAAwB,KAAK,UAAU;AAAA;AAAA,IACnD;AACA,QAAI,KAAK,UAAU,OAAO,KAAK,KAAK,MAAM,EAAE,SAAS,GAAG;AACtD,gBAAU;AAAA;AACV,iBAAW,CAAC,OAAO,WAAW,KAAK,OAAO,QAAQ,KAAK,MAAM,GAAG;AAC9D,kBAAU,SAAS,KAAK,OAAO,WAAW;AAAA;AAAA,MAC5C;AAAA,IACF;AACA,cAAU;AAAA,EACZ;AAEA,SAAO;AACT;AAEA,SAAS,mBAAmB,UAA0B;AACpD,QAAM,YAAoC;AAAA,IACxC,mBAAmB;AAAA,IACnB,UAAU;AAAA,IACV,UAAU;AAAA,IACV,mBAAmB;AAAA,EACrB;AACA,SAAO,UAAU,QAAQ,KAAK;AAChC;AAEO,SAAS,qBAAqB,MAAiC;AACpE,MAAI,WAAW;AAAA;AAAA;AAEf,QAAM,kBAAkB,KAAK,WAAW;AACxC,QAAM,iBAAiB,KAAK,YAAY,CAAC;AAEzC,QAAM,kBAAkB,OAAO,KAAK,eAAe,EAAE;AACrD,MAAI,CAAC,mBAAmB,CAAC,eAAe,QAAQ;AAC9C,gBAAY;AAAA;AAAA;AAAA,EACd,OAAO;AACL,QAAI,kBAAkB,GAAG;AACvB,kBAAY,GAAG,iBAAiB,eAAe,CAAC;AAAA;AAAA;AAChD,kBAAY,MAAM,eAAe,iBAAiB,WAAW,KAAK,OAAO,CAAC;AAAA;AAAA;AAAA,IAC5E;AAEA,eAAW,CAAC,MAAM,MAAM,KAAK,OAAO,QAAQ,eAAe,GAAG;AAC5D,YAAM,YAAY,WAAiC,MAAM,MAAM;AAC/D,UAAI,kBAAkB,GAAG;AACvB,oBAAY,OAAO,IAAI;AAAA;AAAA;AAAA,MACzB;AAEA,YAAM,cACJ,UAAU,eAAe,6BAA6B,SAAS;AACjE,kBAAY,GAAG,WAAW;AAAA;AAAA;AAE1B,UAAI,UAAU,SAAS,UAAU;AAC/B,oBAAY;AAAA;AACZ,oBAAY,uBAAuB,UAAU,IAAI;AAAA;AACjD,oBAAY,eAAe,UAAU,OAAO,WAAW,gBAAgB,UAAU,OAAO,UAAU,oBAAoB,QAAQ;AAAA;AAAA;AAAA,MAChI,WAAW,UAAU,SAAS,QAAQ;AACpC,YAAI,UAAU,cAAc;AAC1B,sBAAY,qBAAqB,UAAU,YAAY;AAAA;AAAA,QACzD;AACA,oBAAY;AAAA,MACd,WAAW,UAAU,SAAS,YAAY,UAAU,OAAO;AACzD,oBAAY;AAAA;AAAA;AACZ,oBAAY,kBAAkB,UAAU,KAAK;AAAA,MAC/C,WAAW,UAAU,SAAS,iBAAiB;AAC7C,oBAAY;AAAA;AACZ,oBAAY,sBAAsB,UAAU,gBAAgB;AAAA;AAAA;AAAA,MAC9D;AAAA,IACF;AAAA,EACF;AAEA,SAAO;AAAA,IACL,IAAI;AAAA,IACJ,KAAK;AAAA,IACL,OAAO;AAAA,IACP,aAAa;AAAA,IACb,SAAS;AAAA,EACX;AACF;",
   "names": []
 }

package/dist/lib/overview-docs/overview-errors.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"overview-errors.d.ts","sourceRoot":"","sources":["../../../src/lib/overview-docs/overview-errors.ts"],"names":[],"mappings":"AAMA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,eAAe,CAAC;AAC7C,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAC;AA6GpD,wBAAgB,sBAAsB,CAAC,IAAI,EAAE,gBAAgB,GAAG,OAAO,CAyFtE"}
+{"version":3,"file":"overview-errors.d.ts","sourceRoot":"","sources":["../../../src/lib/overview-docs/overview-errors.ts"],"names":[],"mappings":"AAMA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,eAAe,CAAC;AAC7C,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAC;AAsGpD,wBAAgB,sBAAsB,CAAC,IAAI,EAAE,gBAAgB,GAAG,OAAO,CAwEtE"}

package/dist/lib/overview-docs/overview-errors.js

@@ -1,11 +1,8 @@
-import { resolveRef } from "@sdk-it/core";
+import { distillRef } from "@sdk-it/core";
 import { forEachOperation } from "../for-each-operation.js";
 import { isErrorStatusCode } from "../is.js";
-function resolveSchema(spec, schema) {
-  return resolveRef(spec, schema);
-}
 function formatSchemaForDisplay(spec, schema) {
-  const resolvedSchema = resolveSchema(spec, schema);
+  const resolvedSchema = distillRef(spec, schema);
   return `\`\`\`json
 ${JSON.stringify(resolvedSchema, null, 2)}
 \`\`\``;
@@ -62,10 +59,6 @@ function generateErrorsOverview(spec) {
   markdown.push(
     `This API uses conventional HTTP response codes to indicate the success or failure of an API request.`
   );
-  markdown.push(`## Official API Clients`);
-  markdown.push(
-    `Vellum maintains official API clients for Python, Node/Typescript, and Go. We recommend using these clients to interact with all stable endpoints. You can find them here:`
-  );
   markdown.push(`## HTTP Status Codes`);
   forEachOperation(spec, (entry, operation) => {
     if (operation.responses) {
@@ -76,20 +69,19 @@ function generateErrorsOverview(spec) {
           const content = response.content;
           if (content?.["application/json"]?.schema) {
             const key = `${statusCode}`;
-            const operationId = `${entry.method.toUpperCase()} ${entry.path}`;
-            if (!errorSchemas.has(key)) {
+            if (errorSchemas.has(key)) {
+              const existing = errorSchemas.get(key);
+              if (existing && !existing.operations.includes(operation.operationId)) {
+                existing.operations.push(operation.operationId);
+              }
+            } else {
               errorSchemas.set(key, {
                 statusCode,
                 title: response.description || `${statusCode} Error`,
                 description: response.description,
                 schema: content["application/json"].schema,
-                operations: [operationId]
+                operations: [operation.operationId]
               });
-            } else {
-              const existing = errorSchemas.get(key);
-              if (existing && !existing.operations.includes(operationId)) {
-                existing.operations.push(operationId);
-              }
             }
           }
         }
@@ -106,17 +98,8 @@ function generateErrorsOverview(spec) {
   } else {
     for (const error of errors) {
       markdown.push(`### ${error.statusCode} - ${error.title}`);
-      const description = error.description || getStatusDescription(error.statusCode);
-      if (description) {
-        markdown.push(description);
-      }
-      if (error.operations.length > 0) {
-        const operationsList = [`**Used by operations:**`];
-        for (const operation of error.operations) {
-          operationsList.push(`- \`${operation}\``);
-        }
-        markdown.push(operationsList.join("\n"));
-      }
+      const description = error.description || getStatusDescription(error.statusCode) || "";
+      markdown.push(description);
       if (error.schema) {
         markdown.push(`**Response Schema:**`);
         markdown.push(formatSchemaForDisplay(spec, error.schema));

package/dist/lib/overview-docs/overview-errors.js.map

@@ -1,7 +1,7 @@
 {
   "version": 3,
   "sources": ["../../../src/lib/overview-docs/overview-errors.ts"],
-  "sourcesContent": ["import type { ReferenceObject, SchemaObject } from 'openapi3-ts/oas31';\n\nimport { resolveRef } from '@sdk-it/core';\n\nimport { forEachOperation } from '../for-each-operation.js';\nimport { isErrorStatusCode } from '../is.js';\nimport type { NavItem } from '../sidebar.js';\nimport type { OurOpenAPIObject } from '../types.js';\n\ninterface ErrorSchema {\n  statusCode: string;\n  title: string;\n  description?: string;\n  schema: SchemaObject | ReferenceObject;\n  operations: string[]; // Track which operations use this error\n}\n\nfunction resolveSchema(\n  spec: OurOpenAPIObject,\n  schema: SchemaObject | ReferenceObject,\n): SchemaObject {\n  return resolveRef<SchemaObject>(spec, schema);\n}\n\nfunction formatSchemaForDisplay(\n  spec: OurOpenAPIObject,\n  schema: SchemaObject | ReferenceObject,\n): string {\n  const resolvedSchema = resolveSchema(spec, schema);\n\n  return `\\`\\`\\`json\n${JSON.stringify(resolvedSchema, null, 2)}\n\\`\\`\\``;\n}\n\nfunction getStatusDescription(statusCode: string): string {\n  const descriptions: Record<string, string> = {\n    '400': 'Bad Request - The request was invalid or cannot be served.',\n    '401':\n      'Unauthorized - Authentication is required and has failed or has not been provided.',\n    '402': 'Payment Required - Payment is required to access this resource.',\n    '403':\n      'Forbidden - The request was valid, but the server is refusing action.',\n    '404': 'Not Found - The requested resource could not be found.',\n    '405':\n      'Method Not Allowed - The request method is not supported for this resource.',\n    '406':\n      'Not Acceptable - The requested resource cannot generate content acceptable to the client.',\n    '407':\n      'Proxy Authentication Required - Authentication with the proxy is required.',\n    '408': 'Request Timeout - The server timed out waiting for the request.',\n    '409': 'Conflict - The request could not be completed due to a conflict.',\n    '410': 'Gone - The requested resource is no longer available.',\n    '411':\n      'Length Required - The request did not specify the length of its content.',\n    '412':\n      'Precondition Failed - The server does not meet one of the preconditions.',\n    '413':\n      'Payload Too Large - The request is larger than the server is willing to process.',\n    '414':\n      'URI Too Long - The URI provided was too long for the server to process.',\n    '415':\n      'Unsupported Media Type - The request entity has a media type which the server does not support.',\n    '416':\n      'Range Not Satisfiable - The client has asked for a portion of the file that the server cannot supply.',\n    '417':\n      'Expectation Failed - The server cannot meet the requirements of the Expect request-header field.',\n    '418':\n      \"I'm a teapot - The server refuses the attempt to brew coffee with a teapot.\",\n    '421':\n      'Misdirected Request - The request was directed at a server that is not able to produce a response.',\n    '422':\n      'Unprocessable Entity - The request was well-formed but contains semantic errors.',\n    '423': 'Locked - The resource that is being accessed is locked.',\n    '424':\n      'Failed Dependency - The request failed due to failure of a previous request.',\n    '425':\n      'Too Early - The server is unwilling to risk processing a request that might be replayed.',\n    '426':\n      'Upgrade Required - The client should switch to a different protocol.',\n    '428':\n      'Precondition Required - The origin server requires the request to be conditional.',\n    '429':\n      'Too Many Requests - The user has sent too many requests in a given amount of time.',\n    '431':\n      'Request Header Fields Too Large - The server is unwilling to process the request because header fields are too large.',\n    '451':\n      'Unavailable For Legal Reasons - The server is denying access to the resource for legal reasons.',\n    '500':\n      'Internal Server Error - The server encountered an unexpected condition.',\n    '501':\n      'Not Implemented - The server does not support the functionality required to fulfill the request.',\n    '502':\n      'Bad Gateway - The server received an invalid response from the upstream server.',\n    '503': 'Service Unavailable - The server is currently unavailable.',\n    '504':\n      'Gateway Timeout - The server did not receive a timely response from the upstream server.',\n    '505':\n      'HTTP Version Not Supported - The server does not support the HTTP protocol version used in the request.',\n    '506':\n      'Variant Also Negotiates - The server has an internal configuration error.',\n    '507':\n      'Insufficient Storage - The server is unable to store the representation needed to complete the request.',\n    '508':\n      'Loop Detected - The server detected an infinite loop while processing the request.',\n    '510':\n      'Not Extended - Further extensions to the request are required for the server to fulfill it.',\n    '511':\n      'Network Authentication Required - The client needs to authenticate to gain network access.',\n  };\n  return (\n    descriptions[statusCode] ||\n    'An error occurred while processing the request.'\n  );\n}\n\nexport function generateErrorsOverview(spec: OurOpenAPIObject): NavItem {\n  const errorSchemas: Map<string, ErrorSchema> = new Map();\n  const markdown: string[] = [];\n  markdown.push(`# Error Handling`);\n  markdown.push(\n    `This API uses conventional HTTP response codes to indicate the success or failure of an API request.`,\n  );\n  markdown.push(`## Official API Clients`);\n  markdown.push(\n    `Vellum maintains official API clients for Python, Node/Typescript, and Go. We recommend using these clients to interact with all stable endpoints. You can find them here:`,\n  );\n  markdown.push(`## HTTP Status Codes`);\n\n  // First, collect all error schemas from operations\n  forEachOperation(spec, (entry, operation) => {\n    if (operation.responses) {\n      for (const [statusCode, response] of Object.entries(\n        operation.responses,\n      )) {\n        if (isErrorStatusCode(statusCode)) {\n          const content = response.content;\n          if (content?.['application/json']?.schema) {\n            const key = `${statusCode}`;\n            const operationId = `${entry.method.toUpperCase()} ${entry.path}`;\n\n            if (!errorSchemas.has(key)) {\n              errorSchemas.set(key, {\n                statusCode,\n                title: response.description || `${statusCode} Error`,\n                description: response.description,\n                schema: content['application/json'].schema as\n                  | SchemaObject\n                  | ReferenceObject,\n                operations: [operationId],\n              });\n            } else {\n              // Add this operation to the existing error schema\n              const existing = errorSchemas.get(key);\n              if (existing && !existing.operations.includes(operationId)) {\n                existing.operations.push(operationId);\n              }\n            }\n          }\n        }\n      }\n    }\n  });\n\n  // Then sort and generate documentation\n  const errors = Array.from(errorSchemas.values()).sort(\n    (a, b) => parseInt(a.statusCode) - parseInt(b.statusCode),\n  );\n\n  if (errors.length === 0) {\n    markdown.push(\n      `No error responses are documented in this API specification.`,\n    );\n  } else {\n    for (const error of errors) {\n      markdown.push(`### ${error.statusCode} - ${error.title}`);\n      const description =\n        error.description || getStatusDescription(error.statusCode);\n      if (description) {\n        markdown.push(description);\n      }\n\n      // Show which operations return this error\n      if (error.operations.length > 0) {\n        const operationsList = [`**Used by operations:**`];\n        for (const operation of error.operations) {\n          operationsList.push(`- \\`${operation}\\``);\n        }\n        markdown.push(operationsList.join('\\n'));\n      }\n\n      if (error.schema) {\n        markdown.push(`**Response Schema:**`);\n        markdown.push(formatSchemaForDisplay(spec, error.schema));\n      }\n    }\n  }\n\n  return {\n    id: 'errors',\n    title: 'Errors',\n    url: '/errors',\n    description: 'Error handling and HTTP status codes',\n    content: markdown.join('\\n\\n'),\n  };\n}\n"],
-  "mappings": "AAEA,SAAS,kBAAkB;AAE3B,SAAS,wBAAwB;AACjC,SAAS,yBAAyB;AAYlC,SAAS,cACP,MACA,QACc;AACd,SAAO,WAAyB,MAAM,MAAM;AAC9C;AAEA,SAAS,uBACP,MACA,QACQ;AACR,QAAM,iBAAiB,cAAc,MAAM,MAAM;AAEjD,SAAO;AAAA,EACP,KAAK,UAAU,gBAAgB,MAAM,CAAC,CAAC;AAAA;AAEzC;AAEA,SAAS,qBAAqB,YAA4B;AACxD,QAAM,eAAuC;AAAA,IAC3C,OAAO;AAAA,IACP,OACE;AAAA,IACF,OAAO;AAAA,IACP,OACE;AAAA,IACF,OAAO;AAAA,IACP,OACE;AAAA,IACF,OACE;AAAA,IACF,OACE;AAAA,IACF,OAAO;AAAA,IACP,OAAO;AAAA,IACP,OAAO;AAAA,IACP,OACE;AAAA,IACF,OACE;AAAA,IACF,OACE;AAAA,IACF,OACE;AAAA,IACF,OACE;AAAA,IACF,OACE;AAAA,IACF,OACE;AAAA,IACF,OACE;AAAA,IACF,OACE;AAAA,IACF,OACE;AAAA,IACF,OAAO;AAAA,IACP,OACE;AAAA,IACF,OACE;AAAA,IACF,OACE;AAAA,IACF,OACE;AAAA,IACF,OACE;AAAA,IACF,OACE;AAAA,IACF,OACE;AAAA,IACF,OACE;AAAA,IACF,OACE;AAAA,IACF,OACE;AAAA,IACF,OAAO;AAAA,IACP,OACE;AAAA,IACF,OACE;AAAA,IACF,OACE;AAAA,IACF,OACE;AAAA,IACF,OACE;AAAA,IACF,OACE;AAAA,IACF,OACE;AAAA,EACJ;AACA,SACE,aAAa,UAAU,KACvB;AAEJ;AAEO,SAAS,uBAAuB,MAAiC;AACtE,QAAM,eAAyC,oBAAI,IAAI;AACvD,QAAM,WAAqB,CAAC;AAC5B,WAAS,KAAK,kBAAkB;AAChC,WAAS;AAAA,IACP;AAAA,EACF;AACA,WAAS,KAAK,yBAAyB;AACvC,WAAS;AAAA,IACP;AAAA,EACF;AACA,WAAS,KAAK,sBAAsB;AAGpC,mBAAiB,MAAM,CAAC,OAAO,cAAc;AAC3C,QAAI,UAAU,WAAW;AACvB,iBAAW,CAAC,YAAY,QAAQ,KAAK,OAAO;AAAA,QAC1C,UAAU;AAAA,MACZ,GAAG;AACD,YAAI,kBAAkB,UAAU,GAAG;AACjC,gBAAM,UAAU,SAAS;AACzB,cAAI,UAAU,kBAAkB,GAAG,QAAQ;AACzC,kBAAM,MAAM,GAAG,UAAU;AACzB,kBAAM,cAAc,GAAG,MAAM,OAAO,YAAY,CAAC,IAAI,MAAM,IAAI;AAE/D,gBAAI,CAAC,aAAa,IAAI,GAAG,GAAG;AAC1B,2BAAa,IAAI,KAAK;AAAA,gBACpB;AAAA,gBACA,OAAO,SAAS,eAAe,GAAG,UAAU;AAAA,gBAC5C,aAAa,SAAS;AAAA,gBACtB,QAAQ,QAAQ,kBAAkB,EAAE;AAAA,gBAGpC,YAAY,CAAC,WAAW;AAAA,cAC1B,CAAC;AAAA,YACH,OAAO;AAEL,oBAAM,WAAW,aAAa,IAAI,GAAG;AACrC,kBAAI,YAAY,CAAC,SAAS,WAAW,SAAS,WAAW,GAAG;AAC1D,yBAAS,WAAW,KAAK,WAAW;AAAA,cACtC;AAAA,YACF;AAAA,UACF;AAAA,QACF;AAAA,MACF;AAAA,IACF;AAAA,EACF,CAAC;AAGD,QAAM,SAAS,MAAM,KAAK,aAAa,OAAO,CAAC,EAAE;AAAA,IAC/C,CAAC,GAAG,MAAM,SAAS,EAAE,UAAU,IAAI,SAAS,EAAE,UAAU;AAAA,EAC1D;AAEA,MAAI,OAAO,WAAW,GAAG;AACvB,aAAS;AAAA,MACP;AAAA,IACF;AAAA,EACF,OAAO;AACL,eAAW,SAAS,QAAQ;AAC1B,eAAS,KAAK,OAAO,MAAM,UAAU,MAAM,MAAM,KAAK,EAAE;AACxD,YAAM,cACJ,MAAM,eAAe,qBAAqB,MAAM,UAAU;AAC5D,UAAI,aAAa;AACf,iBAAS,KAAK,WAAW;AAAA,MAC3B;AAGA,UAAI,MAAM,WAAW,SAAS,GAAG;AAC/B,cAAM,iBAAiB,CAAC,yBAAyB;AACjD,mBAAW,aAAa,MAAM,YAAY;AACxC,yBAAe,KAAK,OAAO,SAAS,IAAI;AAAA,QAC1C;AACA,iBAAS,KAAK,eAAe,KAAK,IAAI,CAAC;AAAA,MACzC;AAEA,UAAI,MAAM,QAAQ;AAChB,iBAAS,KAAK,sBAAsB;AACpC,iBAAS,KAAK,uBAAuB,MAAM,MAAM,MAAM,CAAC;AAAA,MAC1D;AAAA,IACF;AAAA,EACF;AAEA,SAAO;AAAA,IACL,IAAI;AAAA,IACJ,OAAO;AAAA,IACP,KAAK;AAAA,IACL,aAAa;AAAA,IACb,SAAS,SAAS,KAAK,MAAM;AAAA,EAC/B;AACF;",
+  "sourcesContent": ["import type { ReferenceObject, SchemaObject } from 'openapi3-ts/oas31';\n\nimport { distillRef } from '@sdk-it/core';\n\nimport { forEachOperation } from '../for-each-operation.js';\nimport { isErrorStatusCode } from '../is.js';\nimport type { NavItem } from '../sidebar.js';\nimport type { OurOpenAPIObject } from '../types.js';\n\ninterface ErrorSchema {\n  statusCode: string;\n  title: string;\n  description?: string;\n  schema: SchemaObject | ReferenceObject;\n  operations: string[]; // Track which operations use this error\n}\n\nfunction formatSchemaForDisplay(\n  spec: OurOpenAPIObject,\n  schema: SchemaObject | ReferenceObject,\n): string {\n  const resolvedSchema = distillRef(spec, schema);\n\n  return `\\`\\`\\`json\n${JSON.stringify(resolvedSchema, null, 2)}\n\\`\\`\\``;\n}\n\nfunction getStatusDescription(statusCode: string): string {\n  const descriptions: Record<string, string> = {\n    '400': 'Bad Request - The request was invalid or cannot be served.',\n    '401':\n      'Unauthorized - Authentication is required and has failed or has not been provided.',\n    '402': 'Payment Required - Payment is required to access this resource.',\n    '403':\n      'Forbidden - The request was valid, but the server is refusing action.',\n    '404': 'Not Found - The requested resource could not be found.',\n    '405':\n      'Method Not Allowed - The request method is not supported for this resource.',\n    '406':\n      'Not Acceptable - The requested resource cannot generate content acceptable to the client.',\n    '407':\n      'Proxy Authentication Required - Authentication with the proxy is required.',\n    '408': 'Request Timeout - The server timed out waiting for the request.',\n    '409': 'Conflict - The request could not be completed due to a conflict.',\n    '410': 'Gone - The requested resource is no longer available.',\n    '411':\n      'Length Required - The request did not specify the length of its content.',\n    '412':\n      'Precondition Failed - The server does not meet one of the preconditions.',\n    '413':\n      'Payload Too Large - The request is larger than the server is willing to process.',\n    '414':\n      'URI Too Long - The URI provided was too long for the server to process.',\n    '415':\n      'Unsupported Media Type - The request entity has a media type which the server does not support.',\n    '416':\n      'Range Not Satisfiable - The client has asked for a portion of the file that the server cannot supply.',\n    '417':\n      'Expectation Failed - The server cannot meet the requirements of the Expect request-header field.',\n    '418':\n      \"I'm a teapot - The server refuses the attempt to brew coffee with a teapot.\",\n    '421':\n      'Misdirected Request - The request was directed at a server that is not able to produce a response.',\n    '422':\n      'Unprocessable Entity - The request was well-formed but contains semantic errors.',\n    '423': 'Locked - The resource that is being accessed is locked.',\n    '424':\n      'Failed Dependency - The request failed due to failure of a previous request.',\n    '425':\n      'Too Early - The server is unwilling to risk processing a request that might be replayed.',\n    '426':\n      'Upgrade Required - The client should switch to a different protocol.',\n    '428':\n      'Precondition Required - The origin server requires the request to be conditional.',\n    '429':\n      'Too Many Requests - The user has sent too many requests in a given amount of time.',\n    '431':\n      'Request Header Fields Too Large - The server is unwilling to process the request because header fields are too large.',\n    '451':\n      'Unavailable For Legal Reasons - The server is denying access to the resource for legal reasons.',\n    '500':\n      'Internal Server Error - The server encountered an unexpected condition.',\n    '501':\n      'Not Implemented - The server does not support the functionality required to fulfill the request.',\n    '502':\n      'Bad Gateway - The server received an invalid response from the upstream server.',\n    '503': 'Service Unavailable - The server is currently unavailable.',\n    '504':\n      'Gateway Timeout - The server did not receive a timely response from the upstream server.',\n    '505':\n      'HTTP Version Not Supported - The server does not support the HTTP protocol version used in the request.',\n    '506':\n      'Variant Also Negotiates - The server has an internal configuration error.',\n    '507':\n      'Insufficient Storage - The server is unable to store the representation needed to complete the request.',\n    '508':\n      'Loop Detected - The server detected an infinite loop while processing the request.',\n    '510':\n      'Not Extended - Further extensions to the request are required for the server to fulfill it.',\n    '511':\n      'Network Authentication Required - The client needs to authenticate to gain network access.',\n  };\n  return (\n    descriptions[statusCode] ||\n    'An error occurred while processing the request.'\n  );\n}\n\nexport function generateErrorsOverview(spec: OurOpenAPIObject): NavItem {\n  const errorSchemas: Map<string, ErrorSchema> = new Map();\n  const markdown: string[] = [];\n  markdown.push(`# Error Handling`);\n  markdown.push(\n    `This API uses conventional HTTP response codes to indicate the success or failure of an API request.`,\n  );\n\n  markdown.push(`## HTTP Status Codes`);\n\n  // First, collect all error schemas from operations\n  forEachOperation(spec, (entry, operation) => {\n    if (operation.responses) {\n      for (const [statusCode, response] of Object.entries(\n        operation.responses,\n      )) {\n        if (isErrorStatusCode(statusCode)) {\n          const content = response.content;\n          if (content?.['application/json']?.schema) {\n            const key = `${statusCode}`;\n            if (errorSchemas.has(key)) {\n              const existing = errorSchemas.get(key);\n              if (\n                existing &&\n                !existing.operations.includes(operation.operationId)\n              ) {\n                existing.operations.push(operation.operationId);\n              }\n            } else {\n              errorSchemas.set(key, {\n                statusCode,\n                title: response.description || `${statusCode} Error`,\n                description: response.description,\n                schema: content['application/json'].schema,\n                operations: [operation.operationId],\n              });\n            }\n          }\n        }\n      }\n    }\n  });\n\n  const errors = Array.from(errorSchemas.values()).sort(\n    (a, b) => parseInt(a.statusCode) - parseInt(b.statusCode),\n  );\n\n  if (errors.length === 0) {\n    markdown.push(\n      `No error responses are documented in this API specification.`,\n    );\n  } else {\n    for (const error of errors) {\n      markdown.push(`### ${error.statusCode} - ${error.title}`);\n      const description =\n        error.description || getStatusDescription(error.statusCode) || '';\n      markdown.push(description);\n\n      if (error.schema) {\n        markdown.push(`**Response Schema:**`);\n        markdown.push(formatSchemaForDisplay(spec, error.schema));\n      }\n    }\n  }\n\n  return {\n    id: 'errors',\n    title: 'Errors',\n    url: '/errors',\n    description: 'Error handling and HTTP status codes',\n    content: markdown.join('\\n\\n'),\n  };\n}\n"],
+  "mappings": "AAEA,SAAS,kBAAkB;AAE3B,SAAS,wBAAwB;AACjC,SAAS,yBAAyB;AAYlC,SAAS,uBACP,MACA,QACQ;AACR,QAAM,iBAAiB,WAAW,MAAM,MAAM;AAE9C,SAAO;AAAA,EACP,KAAK,UAAU,gBAAgB,MAAM,CAAC,CAAC;AAAA;AAEzC;AAEA,SAAS,qBAAqB,YAA4B;AACxD,QAAM,eAAuC;AAAA,IAC3C,OAAO;AAAA,IACP,OACE;AAAA,IACF,OAAO;AAAA,IACP,OACE;AAAA,IACF,OAAO;AAAA,IACP,OACE;AAAA,IACF,OACE;AAAA,IACF,OACE;AAAA,IACF,OAAO;AAAA,IACP,OAAO;AAAA,IACP,OAAO;AAAA,IACP,OACE;AAAA,IACF,OACE;AAAA,IACF,OACE;AAAA,IACF,OACE;AAAA,IACF,OACE;AAAA,IACF,OACE;AAAA,IACF,OACE;AAAA,IACF,OACE;AAAA,IACF,OACE;AAAA,IACF,OACE;AAAA,IACF,OAAO;AAAA,IACP,OACE;AAAA,IACF,OACE;AAAA,IACF,OACE;AAAA,IACF,OACE;AAAA,IACF,OACE;AAAA,IACF,OACE;AAAA,IACF,OACE;AAAA,IACF,OACE;AAAA,IACF,OACE;AAAA,IACF,OACE;AAAA,IACF,OAAO;AAAA,IACP,OACE;AAAA,IACF,OACE;AAAA,IACF,OACE;AAAA,IACF,OACE;AAAA,IACF,OACE;AAAA,IACF,OACE;AAAA,IACF,OACE;AAAA,EACJ;AACA,SACE,aAAa,UAAU,KACvB;AAEJ;AAEO,SAAS,uBAAuB,MAAiC;AACtE,QAAM,eAAyC,oBAAI,IAAI;AACvD,QAAM,WAAqB,CAAC;AAC5B,WAAS,KAAK,kBAAkB;AAChC,WAAS;AAAA,IACP;AAAA,EACF;AAEA,WAAS,KAAK,sBAAsB;AAGpC,mBAAiB,MAAM,CAAC,OAAO,cAAc;AAC3C,QAAI,UAAU,WAAW;AACvB,iBAAW,CAAC,YAAY,QAAQ,KAAK,OAAO;AAAA,QAC1C,UAAU;AAAA,MACZ,GAAG;AACD,YAAI,kBAAkB,UAAU,GAAG;AACjC,gBAAM,UAAU,SAAS;AACzB,cAAI,UAAU,kBAAkB,GAAG,QAAQ;AACzC,kBAAM,MAAM,GAAG,UAAU;AACzB,gBAAI,aAAa,IAAI,GAAG,GAAG;AACzB,oBAAM,WAAW,aAAa,IAAI,GAAG;AACrC,kBACE,YACA,CAAC,SAAS,WAAW,SAAS,UAAU,WAAW,GACnD;AACA,yBAAS,WAAW,KAAK,UAAU,WAAW;AAAA,cAChD;AAAA,YACF,OAAO;AACL,2BAAa,IAAI,KAAK;AAAA,gBACpB;AAAA,gBACA,OAAO,SAAS,eAAe,GAAG,UAAU;AAAA,gBAC5C,aAAa,SAAS;AAAA,gBACtB,QAAQ,QAAQ,kBAAkB,EAAE;AAAA,gBACpC,YAAY,CAAC,UAAU,WAAW;AAAA,cACpC,CAAC;AAAA,YACH;AAAA,UACF;AAAA,QACF;AAAA,MACF;AAAA,IACF;AAAA,EACF,CAAC;AAED,QAAM,SAAS,MAAM,KAAK,aAAa,OAAO,CAAC,EAAE;AAAA,IAC/C,CAAC,GAAG,MAAM,SAAS,EAAE,UAAU,IAAI,SAAS,EAAE,UAAU;AAAA,EAC1D;AAEA,MAAI,OAAO,WAAW,GAAG;AACvB,aAAS;AAAA,MACP;AAAA,IACF;AAAA,EACF,OAAO;AACL,eAAW,SAAS,QAAQ;AAC1B,eAAS,KAAK,OAAO,MAAM,UAAU,MAAM,MAAM,KAAK,EAAE;AACxD,YAAM,cACJ,MAAM,eAAe,qBAAqB,MAAM,UAAU,KAAK;AACjE,eAAS,KAAK,WAAW;AAEzB,UAAI,MAAM,QAAQ;AAChB,iBAAS,KAAK,sBAAsB;AACpC,iBAAS,KAAK,uBAAuB,MAAM,MAAM,MAAM,CAAC;AAAA,MAC1D;AAAA,IACF;AAAA,EACF;AAEA,SAAO;AAAA,IACL,IAAI;AAAA,IACJ,OAAO;AAAA,IACP,KAAK;AAAA,IACL,aAAa;AAAA,IACb,SAAS,SAAS,KAAK,MAAM;AAAA,EAC/B;AACF;",
   "names": []
 }

package/dist/lib/overview-docs/overview-intro.d.ts

@@ -1,4 +1,4 @@
 import type { NavItem } from '../sidebar.js';
 import type { OurOpenAPIObject } from '../types.js';
-export declare function generateIntroOverview(spec: OurOpenAPIObject, availablesdks?: string[]): NavItem;
+export declare function generateIntroOverview(spec: OurOpenAPIObject, availablesdks: string[]): NavItem;
 //# sourceMappingURL=overview-intro.d.ts.map

package/dist/lib/overview-docs/overview-intro.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"overview-intro.d.ts","sourceRoot":"","sources":["../../../src/lib/overview-docs/overview-intro.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,eAAe,CAAC;AAC7C,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAC;AAEpD,wBAAgB,qBAAqB,CACnC,IAAI,EAAE,gBAAgB,EACtB,aAAa,WAAiB,GAC7B,OAAO,CAgFT"}
+{"version":3,"file":"overview-intro.d.ts","sourceRoot":"","sources":["../../../src/lib/overview-docs/overview-intro.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,eAAe,CAAC;AAC7C,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAC;AAOpD,wBAAgB,qBAAqB,CACnC,IAAI,EAAE,gBAAgB,EACtB,aAAa,EAAE,MAAM,EAAE,GACtB,OAAO,CA2FT"}