@sdk-it/spec 0.25.0 → 0.27.0

package/dist/lib/tune-response.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../src/lib/tune-response.ts"],
+  "sourcesContent": ["import type {\n  MediaTypeObject,\n  OperationObject,\n  ResponseObject,\n} from 'openapi3-ts/oas31';\n\nimport { isRef, parseRef, resolveRef } from '@sdk-it/core/ref.js';\nimport { isEmpty, pascalcase } from '@sdk-it/core/utils.js';\n\nimport { findUniqueSchemaName } from './find-unique-schema-name.js';\nimport {\n  isSseContentType,\n  isSuccessStatusCode,\n  isTextContentType,\n  parseJsonContentType,\n} from './is.js';\nimport { type ResponsesConfig } from './options.js';\nimport type { OurOpenAPIObject } from './types.js';\n\nexport function resolveResponses(\n  spec: OurOpenAPIObject,\n  operationId: string,\n  operation: OperationObject,\n  responsesConfig?: ResponsesConfig,\n) {\n  const responses = operation.responses ?? {};\n  operation.responses ??= {};\n  let foundSuccessResponse = false;\n  for (const status in responses) {\n    if (status === 'default') {\n      delete responses[status]; // Skip default response\n      continue;\n    }\n    // use structuredClone to avoid mutating a response object\n    // that is referenced by multiple operations\n    operation.responses[status] = structuredClone(\n      resolveRef<ResponseObject>(spec, responses[status]),\n    );\n\n    if (isSuccessStatusCode(status)) {\n      foundSuccessResponse = true;\n    }\n  }\n\n  if (!foundSuccessResponse) {\n    operation.responses['200'] = {\n      description: 'OK',\n      content: {\n        'application/json': {\n          schema: {},\n        },\n      },\n    };\n  }\n\n  for (const status in operation.responses) {\n    const response = operation.responses[status] as ResponseObject;\n    const statusCode = +status;\n\n    const outputName =\n      statusCode !== 200\n        ? pascalcase(operationId) + status\n        : findUniqueSchemaName(spec, operationId, [\n            'output',\n            'payload',\n            'result',\n          ]);\n\n    if (!responsesConfig?.flattenErrorResponses) {\n      if (!isSuccessStatusCode(status)) {\n        continue;\n      }\n    }\n\n    if (isEmpty(response.content)) {\n      response.content = {\n        'application/octet-stream': {},\n      };\n    }\n\n    response['x-response-name'] = outputName;\n\n    // if (isErrorStatusCode(status)) {\n    //   const mediaType = response.content?.['application/json'];\n    //   if (mediaType && isRef(mediaType.schema)) {\n    //     const { model } = parseRef(mediaType.schema.$ref);\n    //     Object.assign(config.spec.components.schemas[model], {\n    //       'x-responsebody': true,\n    //       // do not assign response ref to a group\n    //       // because they are supposed to be in a separate file only inlined\n    //       // schemas are grouped by operationId\n    //     });\n    //     response['x-response-name'] = model;\n    //   }\n    //   continue;\n    // }\n\n    for (const [contentType, mediaType] of Object.entries(\n      response.content as Record<string, MediaTypeObject>,\n    )) {\n      if (isRef(mediaType.schema)) {\n        const { model } = parseRef(mediaType.schema.$ref);\n        Object.assign(spec.components.schemas[model], {\n          'x-responsebody': true,\n          // do not assign response ref to a group\n          // because they are supposed to be in a separate file only inlined\n          // schemas are grouped by operationId\n        });\n        response['x-response-name'] = model;\n        continue;\n      }\n      if (isSseContentType(contentType)) {\n        continue; // Skip SSE content types\n      }\n      if (parseJsonContentType(contentType)) {\n        if (isEmpty(mediaType.schema)) {\n          // add \"additionalProperties\" because we're certain this is a response body is of json type\n          spec.components.schemas[outputName] = {\n            type: 'object',\n            additionalProperties: true,\n          };\n        }\n      } else {\n        spec.components.schemas[outputName] = {\n          ...spec.components.schemas[outputName],\n          'x-stream': !isTextContentType(contentType),\n        };\n      }\n\n      spec.components.schemas[outputName] = {\n        ...spec.components.schemas[outputName],\n        ...mediaType.schema,\n        'x-responsebody': true,\n        'x-response-group': operationId,\n      };\n      operation.responses[status].content[contentType].schema = {\n        $ref: `#/components/schemas/${outputName}`,\n      };\n    }\n  }\n\n  return operation.responses;\n}\n"],
+  "mappings": "AAMA,SAAS,OAAO,UAAU,kBAAkB;AAC5C,SAAS,SAAS,kBAAkB;AAEpC,SAAS,4BAA4B;AACrC;AAAA,EACE;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,OACK;AACP,eAAqC;AAG9B,SAAS,iBACd,MACA,aACA,WACA,iBACA;AACA,QAAM,YAAY,UAAU,aAAa,CAAC;AAC1C,YAAU,cAAc,CAAC;AACzB,MAAI,uBAAuB;AAC3B,aAAW,UAAU,WAAW;AAC9B,QAAI,WAAW,WAAW;AACxB,aAAO,UAAU,MAAM;AACvB;AAAA,IACF;AAGA,cAAU,UAAU,MAAM,IAAI;AAAA,MAC5B,WAA2B,MAAM,UAAU,MAAM,CAAC;AAAA,IACpD;AAEA,QAAI,oBAAoB,MAAM,GAAG;AAC/B,6BAAuB;AAAA,IACzB;AAAA,EACF;AAEA,MAAI,CAAC,sBAAsB;AACzB,cAAU,UAAU,KAAK,IAAI;AAAA,MAC3B,aAAa;AAAA,MACb,SAAS;AAAA,QACP,oBAAoB;AAAA,UAClB,QAAQ,CAAC;AAAA,QACX;AAAA,MACF;AAAA,IACF;AAAA,EACF;AAEA,aAAW,UAAU,UAAU,WAAW;AACxC,UAAM,WAAW,UAAU,UAAU,MAAM;AAC3C,UAAM,aAAa,CAAC;AAEpB,UAAM,aACJ,eAAe,MACX,WAAW,WAAW,IAAI,SAC1B,qBAAqB,MAAM,aAAa;AAAA,MACtC;AAAA,MACA;AAAA,MACA;AAAA,IACF,CAAC;AAEP,QAAI,CAAC,iBAAiB,uBAAuB;AAC3C,UAAI,CAAC,oBAAoB,MAAM,GAAG;AAChC;AAAA,MACF;AAAA,IACF;AAEA,QAAI,QAAQ,SAAS,OAAO,GAAG;AAC7B,eAAS,UAAU;AAAA,QACjB,4BAA4B,CAAC;AAAA,MAC/B;AAAA,IACF;AAEA,aAAS,iBAAiB,IAAI;AAiB9B,eAAW,CAAC,aAAa,SAAS,KAAK,OAAO;AAAA,MAC5C,SAAS;AAAA,IACX,GAAG;AACD,UAAI,MAAM,UAAU,MAAM,GAAG;AAC3B,cAAM,EAAE,MAAM,IAAI,SAAS,UAAU,OAAO,IAAI;AAChD,eAAO,OAAO,KAAK,WAAW,QAAQ,KAAK,GAAG;AAAA,UAC5C,kBAAkB;AAAA;AAAA;AAAA;AAAA,QAIpB,CAAC;AACD,iBAAS,iBAAiB,IAAI;AAC9B;AAAA,MACF;AACA,UAAI,iBAAiB,WAAW,GAAG;AACjC;AAAA,MACF;AACA,UAAI,qBAAqB,WAAW,GAAG;AACrC,YAAI,QAAQ,UAAU,MAAM,GAAG;AAE7B,eAAK,WAAW,QAAQ,UAAU,IAAI;AAAA,YACpC,MAAM;AAAA,YACN,sBAAsB;AAAA,UACxB;AAAA,QACF;AAAA,MACF,OAAO;AACL,aAAK,WAAW,QAAQ,UAAU,IAAI;AAAA,UACpC,GAAG,KAAK,WAAW,QAAQ,UAAU;AAAA,UACrC,YAAY,CAAC,kBAAkB,WAAW;AAAA,QAC5C;AAAA,MACF;AAEA,WAAK,WAAW,QAAQ,UAAU,IAAI;AAAA,QACpC,GAAG,KAAK,WAAW,QAAQ,UAAU;AAAA,QACrC,GAAG,UAAU;AAAA,QACb,kBAAkB;AAAA,QAClB,oBAAoB;AAAA,MACtB;AACA,gBAAU,UAAU,MAAM,EAAE,QAAQ,WAAW,EAAE,SAAS;AAAA,QACxD,MAAM,wBAAwB,UAAU;AAAA,MAC1C;AAAA,IACF;AAAA,EACF;AAEA,SAAO,UAAU;AACnB;",
+  "names": []
+}

package/dist/lib/types.d.ts

@@ -1,11 +1,13 @@
 import type { ComponentsObject, MediaTypeObject, OpenAPIObject, OperationObject, ParameterObject, PathsObject, ReferenceObject, RequestBodyObject, ResponseObject, SchemaObject, SecuritySchemeObject } from 'openapi3-ts/oas31';
-import type { SidebarData } from './sidebar.js';
+import type { PaginationGuess } from './pagination/guess-pagination.js';
+import type { SidebarData, TagGroups } from './sidebar.js';
 export interface OurOpenAPIObject extends OpenAPIObject {
     'x-sdk-augmented'?: boolean;
     'x-docs': SidebarData;
+    'x-tagGroups': TagGroups[];
     components: Omit<ComponentsObject, 'schemas'> & {
         schemas: Record<string, SchemaObject | ReferenceObject>;
-        securitySchemes: Record<string, SecuritySchemeObject | ReferenceObject>;
+        securitySchemes: Record<string, SecuritySchemeObject>;
     };
     paths: PathsObject;
 }
@@ -18,20 +20,23 @@ export type TunedOperationObject = Omit<OperationObject, 'operationId' | 'tags'
     tags: string[];
     operationId: string;
     parameters: ParameterObject[];
+    ['x-fn-name']: string;
+    ['x-fn-group']?: string;
     responses: Record<string, Omit<ResponseObject, 'content'> & {
         content: Record<string, MediaTypeObject>;
     }>;
     requestBody: OurRequestBodyObject;
 };
 export interface OperationEntry {
-    name?: string;
     method: string;
     path: string;
-    groupName: string;
     tag: string;
 }
 export type Operation = {
     entry: OperationEntry;
     operation: TunedOperationObject;
 };
+export type OperationPagination = PaginationGuess & {
+    items: string;
+};
 //# sourceMappingURL=types.d.ts.map

package/dist/lib/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/lib/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,gBAAgB,EAChB,eAAe,EACf,aAAa,EACb,eAAe,EACf,eAAe,EACf,WAAW,EACX,eAAe,EACf,iBAAiB,EACjB,cAAc,EACd,YAAY,EACZ,oBAAoB,EACrB,MAAM,mBAAmB,CAAC;AAE3B,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,cAAc,CAAC;AAEhD,MAAM,WAAW,gBAAiB,SAAQ,aAAa;IACrD,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B,QAAQ,EAAE,WAAW,CAAC;IACtB,UAAU,EAAE,IAAI,CAAC,gBAAgB,EAAE,SAAS,CAAC,GAAG;QAC9C,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,YAAY,GAAG,eAAe,CAAC,CAAC;QACxD,eAAe,EAAE,MAAM,CAAC,MAAM,EAAE,oBAAoB,GAAG,eAAe,CAAC,CAAC;KACzE,CAAC;IACF,KAAK,EAAE,WAAW,CAAC;CACpB;AAED,MAAM,WAAW,oBAAqB,SAAQ,iBAAiB;IAC7D,OAAO,EAAE,MAAM,CACb,MAAM,EACN,IAAI,CAAC,eAAe,EAAE,QAAQ,CAAC,GAAG;QAAE,MAAM,EAAE,eAAe,CAAA;KAAE,CAC9D,CAAC;CACH;AAED,MAAM,MAAM,oBAAoB,GAAG,IAAI,CACrC,eAAe,EACf,aAAa,GAAG,MAAM,GAAG,YAAY,GAAG,WAAW,GAAG,aAAa,CACpE,GAAG;IACF,IAAI,EAAE,MAAM,EAAE,CAAC;IACf,WAAW,EAAE,MAAM,CAAC;IACpB,UAAU,EAAE,eAAe,EAAE,CAAC;IAC9B,SAAS,EAAE,MAAM,CACf,MAAM,EACN,IAAI,CAAC,cAAc,EAAE,SAAS,CAAC,GAAG;QAChC,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,eAAe,CAAC,CAAC;KAC1C,CACF,CAAC;IACF,WAAW,EAAE,oBAAoB,CAAC;CACnC,CAAC;AAEF,MAAM,WAAW,cAAc;IAC7B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,EAAE,MAAM,CAAC;IAClB,GAAG,EAAE,MAAM,CAAC;CACb;AACD,MAAM,MAAM,SAAS,GAAG;IACtB,KAAK,EAAE,cAAc,CAAC;IACtB,SAAS,EAAE,oBAAoB,CAAC;CACjC,CAAC"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/lib/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,gBAAgB,EAChB,eAAe,EACf,aAAa,EACb,eAAe,EACf,eAAe,EACf,WAAW,EACX,eAAe,EACf,iBAAiB,EACjB,cAAc,EACd,YAAY,EACZ,oBAAoB,EACrB,MAAM,mBAAmB,CAAC;AAE3B,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,kCAAkC,CAAC;AACxE,OAAO,KAAK,EAAE,WAAW,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AAE3D,MAAM,WAAW,gBAAiB,SAAQ,aAAa;IACrD,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B,QAAQ,EAAE,WAAW,CAAC;IACtB,aAAa,EAAE,SAAS,EAAE,CAAC;IAC3B,UAAU,EAAE,IAAI,CAAC,gBAAgB,EAAE,SAAS,CAAC,GAAG;QAC9C,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,YAAY,GAAG,eAAe,CAAC,CAAC;QACxD,eAAe,EAAE,MAAM,CAAC,MAAM,EAAE,oBAAoB,CAAC,CAAC;KACvD,CAAC;IACF,KAAK,EAAE,WAAW,CAAC;CACpB;AAED,MAAM,WAAW,oBAAqB,SAAQ,iBAAiB;IAC7D,OAAO,EAAE,MAAM,CACb,MAAM,EACN,IAAI,CAAC,eAAe,EAAE,QAAQ,CAAC,GAAG;QAAE,MAAM,EAAE,eAAe,CAAA;KAAE,CAC9D,CAAC;CACH;AAED,MAAM,MAAM,oBAAoB,GAAG,IAAI,CACrC,eAAe,EACf,aAAa,GAAG,MAAM,GAAG,YAAY,GAAG,WAAW,GAAG,aAAa,CACpE,GAAG;IACF,IAAI,EAAE,MAAM,EAAE,CAAC;IACf,WAAW,EAAE,MAAM,CAAC;IACpB,UAAU,EAAE,eAAe,EAAE,CAAC;IAC9B,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;IACtB,CAAC,YAAY,CAAC,CAAC,EAAE,MAAM,CAAC;IACxB,SAAS,EAAE,MAAM,CACf,MAAM,EACN,IAAI,CAAC,cAAc,EAAE,SAAS,CAAC,GAAG;QAChC,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,eAAe,CAAC,CAAC;KAC1C,CACF,CAAC;IACF,WAAW,EAAE,oBAAoB,CAAC;CACnC,CAAC;AAEF,MAAM,WAAW,cAAc;IAC7B,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,EAAE,MAAM,CAAC;CACb;AACD,MAAM,MAAM,SAAS,GAAG;IACtB,KAAK,EAAE,cAAc,CAAC;IACtB,SAAS,EAAE,oBAAoB,CAAC;CACjC,CAAC;AAEF,MAAM,MAAM,mBAAmB,GAAG,eAAe,GAAG;IAClD,KAAK,EAAE,MAAM,CAAC;CACf,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sdk-it/spec",
-  "version": "0.25.0",
+  "version": "0.27.0",
   "type": "module",
   "main": "./dist/index.js",
   "module": "./dist/index.js",
@@ -26,7 +26,7 @@
     "!**/*.tsbuildinfo"
   ],
   "dependencies": {
-    "@sdk-it/core": "0.25.0",
+    "@sdk-it/core": "0.27.0",
     "openapi3-ts": "4.4.0",
     "pluralize": "^8.0.0",
     "stringcase": "^4.3.1",

package/dist/lib/overview-docs.js

@@ -1,276 +0,0 @@
-import { resolveRef } from "@sdk-it/core/ref.js";
-import { forEachOperation } from "./for-each-operation.js";
-import { isErrorStatusCode } from "./is.js";
-function generateIntroductionMarkdown(spec) {
-  const info = spec.info;
-  let markdown = "";
-  if (info.title) {
-    markdown += `# ${info.title}
-
-`;
-  }
-  if (info.description) {
-    markdown += `${info.description}
-
-`;
-  }
-  if (info.version) {
-    markdown += `**Version:** ${info.version}
-
-`;
-  }
-  if (info.contact) {
-    markdown += `## Contact
-
-`;
-    if (info.contact.name) {
-      markdown += `**Name:** ${info.contact.name}
-
-`;
-    }
-    if (info.contact.email) {
-      markdown += `**Email:** ${info.contact.email}
-
-`;
-    }
-    if (info.contact.url) {
-      markdown += `**URL:** ${info.contact.url}
-
-`;
-    }
-  }
-  if (info.license) {
-    markdown += `## License
-
-`;
-    if (info.license.name) {
-      markdown += `**License:** ${info.license.name}`;
-      if (info.license.url) {
-        markdown += ` ([${info.license.url}](${info.license.url}))`;
-      }
-      markdown += `
-
-`;
-    }
-  }
-  markdown += `## Available SDKs
-
-`;
-  const sdkLinks = [
-    "/typescript-sdk",
-    "/python-sdk",
-    "/go-sdk",
-    "/java-sdk",
-    "/php-sdk",
-    "/ruby-sdk",
-    "/dart-sdk"
-  ];
-  for (const link of sdkLinks) {
-    const sdkName = link.replace("/", "").replace("-sdk", "").toUpperCase();
-    markdown += `- [${sdkName} SDK](${link})
-`;
-  }
-  return markdown;
-}
-function getStatusDescription(statusCode) {
-  const descriptions = {
-    "400": "Bad Request - The request was invalid or cannot be served.",
-    "401": "Unauthorized - Authentication is required and has failed or has not been provided.",
-    "403": "Forbidden - The request was valid, but the server is refusing action.",
-    "404": "Not Found - The requested resource could not be found.",
-    "422": "Unprocessable Entity - The request was well-formed but contains semantic errors.",
-    "429": "Too Many Requests - The user has sent too many requests in a given amount of time.",
-    "500": "Internal Server Error - The server encountered an unexpected condition.",
-    "502": "Bad Gateway - The server received an invalid response from the upstream server.",
-    "503": "Service Unavailable - The server is currently unavailable."
-  };
-  return descriptions[statusCode] || "An error occurred while processing the request.";
-}
-function generateErrorsMarkdown(errorSchemas) {
-  let markdown = `# Error Handling
-
-`;
-  markdown += `This API uses conventional HTTP response codes to indicate the success or failure of an API request.
-
-`;
-  markdown += `## HTTP Status Codes
-
-`;
-  const errors = Array.from(errorSchemas.values()).sort(
-    (a, b) => parseInt(a.statusCode) - parseInt(b.statusCode)
-  );
-  for (const error of errors) {
-    markdown += `### ${error.statusCode} - ${error.title}
-
-`;
-    const description = error.description || getStatusDescription(error.statusCode);
-    if (description) {
-      markdown += `${description}
-
-`;
-    }
-    if (error.schema) {
-      markdown += `**Response Schema:**
-
-`;
-      markdown += `\`\`\`json
-${JSON.stringify(
-        error.schema,
-        null,
-        2
-      )}
-\`\`\`
-
-`;
-    }
-  }
-  return markdown;
-}
-function getSecuritySchemeDescription(scheme) {
-  switch (scheme.type.toLowerCase()) {
-    case "apikey":
-      return `This API uses an API key for authentication. The key should be sent in the \`${scheme.in}\` named \`${scheme.name}\`.`;
-    case "http":
-      if (scheme.scheme === "bearer") {
-        return `This API uses HTTP Bearer authentication. A token should be included in the Authorization header.`;
-      }
-      return `This API uses HTTP ${scheme.scheme} authentication.`;
-    case "oauth2": {
-      const flows = Object.keys(scheme.flows || {});
-      return `This API uses OAuth 2.0 for authentication with the following flow(s): ${flows.join(
-        ", "
-      )}.`;
-    }
-    case "openidconnect":
-      return `This API uses OpenID Connect for authentication. The OpenID Connect URL is: ${scheme.openIdConnectUrl}`;
-    default:
-      return "This API uses a custom authentication scheme.";
-  }
-}
-function generateAuthorizationMarkdown(spec) {
-  let markdown = `# Authorization
-
-`;
-  const securitySchemes = spec.components?.securitySchemes || {};
-  const globalSecurity = spec.security || [];
-  if (Object.keys(securitySchemes).length > 0) {
-    markdown += `This API uses the following authentication schemes:
-
-`;
-    markdown += `## Security Schemes
-
-`;
-    for (const [name, scheme] of Object.entries(securitySchemes)) {
-      const schemeObj = resolveRef(spec, scheme);
-      markdown += `### ${name}
-
-`;
-      const description = schemeObj.description || getSecuritySchemeDescription(schemeObj);
-      markdown += `${description}
-
-`;
-      markdown += `**Type:** \`${schemeObj.type}\`
-
-`;
-      if (schemeObj.type === "http") {
-        markdown += `**Scheme:** \`${schemeObj.scheme}\`
-
-`;
-        if (schemeObj.bearerFormat) {
-          markdown += `**Bearer Format:** \`${schemeObj.bearerFormat}\`
-
-`;
-        }
-      } else if (schemeObj.type === "oauth2") {
-        markdown += `**Flows:**
-
-`;
-        markdown += `\`\`\`json
-${JSON.stringify(
-          schemeObj.flows,
-          null,
-          2
-        )}
-\`\`\`
-
-`;
-      }
-    }
-  }
-  if (globalSecurity.length > 0) {
-    markdown += `## Global Security Requirements
-
-`;
-    markdown += `These security schemes are required for all operations.
-
-`;
-    markdown += `\`\`\`json
-${JSON.stringify(
-      globalSecurity,
-      null,
-      2
-    )}
-\`\`\`
-
-`;
-  }
-  return markdown;
-}
-function extractOverviewDocs(spec) {
-  const introduction = {
-    id: "introduction",
-    title: "Introduction",
-    url: "/introduction",
-    description: "API overview and getting started guide",
-    content: generateIntroductionMarkdown(spec)
-  };
-  const errorSchemas = /* @__PURE__ */ new Map();
-  forEachOperation(spec, (entry, operation) => {
-    if (operation.responses) {
-      for (const [statusCode, response] of Object.entries(
-        operation.responses
-      )) {
-        if (isErrorStatusCode(statusCode)) {
-          const content = response.content;
-          if (content?.["application/json"]?.schema) {
-            const key = `${statusCode}`;
-            if (!errorSchemas.has(key)) {
-              errorSchemas.set(key, {
-                statusCode,
-                title: response.description || `${statusCode} Error`,
-                description: response.description,
-                schema: content["application/json"].schema
-              });
-            }
-          }
-        }
-      }
-    }
-  });
-  const errors = {
-    id: "errors",
-    title: "Errors",
-    url: "/errors",
-    description: "Error handling and HTTP status codes",
-    content: generateErrorsMarkdown(errorSchemas)
-  };
-  const authorization = {
-    id: "authorization",
-    url: "/authorization",
-    title: "Authorization",
-    description: "Authentication methods and security schemes",
-    content: generateAuthorizationMarkdown(spec)
-  };
-  const docs = [introduction, errors, authorization];
-  return [
-    {
-      id: "overview",
-      category: "Overview",
-      items: docs
-    }
-  ];
-}
-export {
-  extractOverviewDocs
-};
-//# sourceMappingURL=overview-docs.js.map

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

@@ -1,7 +0,0 @@
-{
-  "version": 3,
-  "sources": ["../../src/lib/overview-docs.ts"],
-  "sourcesContent": ["import type { SchemaObject, SecuritySchemeObject } from 'openapi3-ts/oas31';\n\nimport { resolveRef } from '@sdk-it/core/ref.js';\n\nimport { forEachOperation } from './for-each-operation.js';\nimport { isErrorStatusCode } from './is.js';\nimport type { NavItem, SidebarData } from './sidebar.js';\nimport type { OurOpenAPIObject } from './types.js';\n\ninterface ErrorSchema {\n  statusCode: string;\n  title: string;\n  description?: string;\n  schema: SchemaObject;\n}\n\nfunction generateIntroductionMarkdown(spec: OurOpenAPIObject): string {\n  const info = spec.info;\n  let markdown = '';\n\n  if (info.title) {\n    markdown += `# ${info.title}\\n\\n`;\n  }\n\n  if (info.description) {\n    markdown += `${info.description}\\n\\n`;\n  }\n\n  if (info.version) {\n    markdown += `**Version:** ${info.version}\\n\\n`;\n  }\n\n  if (info.contact) {\n    markdown += `## Contact\\n\\n`;\n    if (info.contact.name) {\n      markdown += `**Name:** ${info.contact.name}\\n\\n`;\n    }\n    if (info.contact.email) {\n      markdown += `**Email:** ${info.contact.email}\\n\\n`;\n    }\n    if (info.contact.url) {\n      markdown += `**URL:** ${info.contact.url}\\n\\n`;\n    }\n  }\n\n  if (info.license) {\n    markdown += `## License\\n\\n`;\n    if (info.license.name) {\n      markdown += `**License:** ${info.license.name}`;\n      if (info.license.url) {\n        markdown += ` ([${info.license.url}](${info.license.url}))`;\n      }\n      markdown += `\\n\\n`;\n    }\n  }\n\n  // Add SDK links\n  markdown += `## Available SDKs\\n\\n`;\n  const sdkLinks = [\n    '/typescript-sdk',\n    '/python-sdk',\n    '/go-sdk',\n    '/java-sdk',\n    '/php-sdk',\n    '/ruby-sdk',\n    '/dart-sdk',\n  ];\n\n  for (const link of sdkLinks) {\n    const sdkName = link.replace('/', '').replace('-sdk', '').toUpperCase();\n    markdown += `- [${sdkName} SDK](${link})\\n`;\n  }\n\n  return markdown;\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    '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    '422':\n      'Unprocessable Entity - The request was well-formed but contains semantic errors.',\n    '429':\n      'Too Many Requests - The user has sent too many requests in a given amount of time.',\n    '500':\n      'Internal Server Error - The server encountered an unexpected condition.',\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  };\n  return (\n    descriptions[statusCode] ||\n    'An error occurred while processing the request.'\n  );\n}\n\nfunction generateErrorsMarkdown(\n  errorSchemas: Map<string, ErrorSchema>,\n): string {\n  let markdown = `# Error Handling\\n\\n`;\n  markdown += `This API uses conventional HTTP response codes to indicate the success or failure of an API request.\\n\\n`;\n  markdown += `## HTTP Status Codes\\n\\n`;\n\n  const errors = Array.from(errorSchemas.values()).sort(\n    (a, b) => parseInt(a.statusCode) - parseInt(b.statusCode),\n  );\n\n  for (const error of errors) {\n    markdown += `### ${error.statusCode} - ${error.title}\\n\\n`;\n    const description =\n      error.description || getStatusDescription(error.statusCode);\n    if (description) {\n      markdown += `${description}\\n\\n`;\n    }\n    if (error.schema) {\n      markdown += `**Response Schema:**\\n\\n`;\n      markdown += `\\`\\`\\`json\\n${JSON.stringify(\n        error.schema,\n        null,\n        2,\n      )}\\n\\`\\`\\`\\n\\n`;\n    }\n  }\n\n  return markdown;\n}\n\nfunction getSecuritySchemeDescription(scheme: SecuritySchemeObject): string {\n  switch (scheme.type.toLowerCase()) {\n    case 'apikey':\n      return `This API uses an API key for authentication. The key should be sent in the \\`${scheme.in}\\` named \\`${scheme.name}\\`.`;\n    case 'http':\n      if (scheme.scheme === 'bearer') {\n        return `This API uses HTTP Bearer authentication. A token should be included in the Authorization header.`;\n      }\n      return `This API uses HTTP ${scheme.scheme} authentication.`;\n    case 'oauth2': {\n      const flows = Object.keys(scheme.flows || {});\n      return `This API uses OAuth 2.0 for authentication with the following flow(s): ${flows.join(\n        ', ',\n      )}.`;\n    }\n    case 'openidconnect':\n      return `This API uses OpenID Connect for authentication. The OpenID Connect URL is: ${scheme.openIdConnectUrl}`;\n    default:\n      return 'This API uses a custom authentication scheme.';\n  }\n}\n\nfunction generateAuthorizationMarkdown(spec: OurOpenAPIObject): string {\n  let markdown = `# Authorization\\n\\n`;\n\n  const securitySchemes = spec.components?.securitySchemes || {};\n  const globalSecurity = spec.security || [];\n\n  if (Object.keys(securitySchemes).length > 0) {\n    markdown += `This API uses the following authentication schemes:\\n\\n`;\n    markdown += `## Security Schemes\\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      markdown += `**Type:** \\`${schemeObj.type}\\`\\n\\n`;\n\n      if (schemeObj.type === 'http') {\n        markdown += `**Scheme:** \\`${schemeObj.scheme}\\`\\n\\n`;\n        if (schemeObj.bearerFormat) {\n          markdown += `**Bearer Format:** \\`${schemeObj.bearerFormat}\\`\\n\\n`;\n        }\n      } else if (schemeObj.type === 'oauth2') {\n        markdown += `**Flows:**\\n\\n`;\n        markdown += `\\`\\`\\`json\\n${JSON.stringify(\n          schemeObj.flows,\n          null,\n          2,\n        )}\\n\\`\\`\\`\\n\\n`;\n      }\n    }\n  }\n\n  if (globalSecurity.length > 0) {\n    markdown += `## Global Security Requirements\\n\\n`;\n    markdown += `These security schemes are required for all operations.\\n\\n`;\n    markdown += `\\`\\`\\`json\\n${JSON.stringify(\n      globalSecurity,\n      null,\n      2,\n    )}\\n\\`\\`\\`\\n\\n`;\n  }\n\n  return markdown;\n}\n\nexport function extractOverviewDocs(spec: OurOpenAPIObject): SidebarData {\n  const introduction: NavItem = {\n    id: 'introduction',\n    title: 'Introduction',\n    url: '/introduction',\n    description: 'API overview and getting started guide',\n    content: generateIntroductionMarkdown(spec),\n  };\n\n  const errorSchemas = new Map<string, ErrorSchema>();\n\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              errorSchemas.set(key, {\n                statusCode,\n                title: response.description || `${statusCode} Error`,\n                description: response.description,\n                schema: content['application/json'].schema as SchemaObject,\n              });\n            }\n          }\n        }\n      }\n    }\n  });\n\n  const errors: NavItem = {\n    id: 'errors',\n    title: 'Errors',\n    url: '/errors',\n    description: 'Error handling and HTTP status codes',\n    content: generateErrorsMarkdown(errorSchemas),\n  };\n\n  const authorization: NavItem = {\n    id: 'authorization',\n    url: '/authorization',\n    title: 'Authorization',\n    description: 'Authentication methods and security schemes',\n    content: generateAuthorizationMarkdown(spec),\n  };\n  const docs: NavItem[] = [introduction, errors, authorization];\n\n  return [\n    {\n      id: 'overview',\n      category: 'Overview',\n      items: docs,\n    },\n  ];\n}\n"],
-  "mappings": "AAEA,SAAS,kBAAkB;AAE3B,SAAS,wBAAwB;AACjC,SAAS,yBAAyB;AAWlC,SAAS,6BAA6B,MAAgC;AACpE,QAAM,OAAO,KAAK;AAClB,MAAI,WAAW;AAEf,MAAI,KAAK,OAAO;AACd,gBAAY,KAAK,KAAK,KAAK;AAAA;AAAA;AAAA,EAC7B;AAEA,MAAI,KAAK,aAAa;AACpB,gBAAY,GAAG,KAAK,WAAW;AAAA;AAAA;AAAA,EACjC;AAEA,MAAI,KAAK,SAAS;AAChB,gBAAY,gBAAgB,KAAK,OAAO;AAAA;AAAA;AAAA,EAC1C;AAEA,MAAI,KAAK,SAAS;AAChB,gBAAY;AAAA;AAAA;AACZ,QAAI,KAAK,QAAQ,MAAM;AACrB,kBAAY,aAAa,KAAK,QAAQ,IAAI;AAAA;AAAA;AAAA,IAC5C;AACA,QAAI,KAAK,QAAQ,OAAO;AACtB,kBAAY,cAAc,KAAK,QAAQ,KAAK;AAAA;AAAA;AAAA,IAC9C;AACA,QAAI,KAAK,QAAQ,KAAK;AACpB,kBAAY,YAAY,KAAK,QAAQ,GAAG;AAAA;AAAA;AAAA,IAC1C;AAAA,EACF;AAEA,MAAI,KAAK,SAAS;AAChB,gBAAY;AAAA;AAAA;AACZ,QAAI,KAAK,QAAQ,MAAM;AACrB,kBAAY,gBAAgB,KAAK,QAAQ,IAAI;AAC7C,UAAI,KAAK,QAAQ,KAAK;AACpB,oBAAY,MAAM,KAAK,QAAQ,GAAG,KAAK,KAAK,QAAQ,GAAG;AAAA,MACzD;AACA,kBAAY;AAAA;AAAA;AAAA,IACd;AAAA,EACF;AAGA,cAAY;AAAA;AAAA;AACZ,QAAM,WAAW;AAAA,IACf;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,EACF;AAEA,aAAW,QAAQ,UAAU;AAC3B,UAAM,UAAU,KAAK,QAAQ,KAAK,EAAE,EAAE,QAAQ,QAAQ,EAAE,EAAE,YAAY;AACtE,gBAAY,MAAM,OAAO,SAAS,IAAI;AAAA;AAAA,EACxC;AAEA,SAAO;AACT;AAEA,SAAS,qBAAqB,YAA4B;AACxD,QAAM,eAAuC;AAAA,IAC3C,OAAO;AAAA,IACP,OACE;AAAA,IACF,OACE;AAAA,IACF,OAAO;AAAA,IACP,OACE;AAAA,IACF,OACE;AAAA,IACF,OACE;AAAA,IACF,OACE;AAAA,IACF,OAAO;AAAA,EACT;AACA,SACE,aAAa,UAAU,KACvB;AAEJ;AAEA,SAAS,uBACP,cACQ;AACR,MAAI,WAAW;AAAA;AAAA;AACf,cAAY;AAAA;AAAA;AACZ,cAAY;AAAA;AAAA;AAEZ,QAAM,SAAS,MAAM,KAAK,aAAa,OAAO,CAAC,EAAE;AAAA,IAC/C,CAAC,GAAG,MAAM,SAAS,EAAE,UAAU,IAAI,SAAS,EAAE,UAAU;AAAA,EAC1D;AAEA,aAAW,SAAS,QAAQ;AAC1B,gBAAY,OAAO,MAAM,UAAU,MAAM,MAAM,KAAK;AAAA;AAAA;AACpD,UAAM,cACJ,MAAM,eAAe,qBAAqB,MAAM,UAAU;AAC5D,QAAI,aAAa;AACf,kBAAY,GAAG,WAAW;AAAA;AAAA;AAAA,IAC5B;AACA,QAAI,MAAM,QAAQ;AAChB,kBAAY;AAAA;AAAA;AACZ,kBAAY;AAAA,EAAe,KAAK;AAAA,QAC9B,MAAM;AAAA,QACN;AAAA,QACA;AAAA,MACF,CAAC;AAAA;AAAA;AAAA;AAAA,IACH;AAAA,EACF;AAEA,SAAO;AACT;AAEA,SAAS,6BAA6B,QAAsC;AAC1E,UAAQ,OAAO,KAAK,YAAY,GAAG;AAAA,IACjC,KAAK;AACH,aAAO,gFAAgF,OAAO,EAAE,cAAc,OAAO,IAAI;AAAA,IAC3H,KAAK;AACH,UAAI,OAAO,WAAW,UAAU;AAC9B,eAAO;AAAA,MACT;AACA,aAAO,sBAAsB,OAAO,MAAM;AAAA,IAC5C,KAAK,UAAU;AACb,YAAM,QAAQ,OAAO,KAAK,OAAO,SAAS,CAAC,CAAC;AAC5C,aAAO,0EAA0E,MAAM;AAAA,QACrF;AAAA,MACF,CAAC;AAAA,IACH;AAAA,IACA,KAAK;AACH,aAAO,+EAA+E,OAAO,gBAAgB;AAAA,IAC/G;AACE,aAAO;AAAA,EACX;AACF;AAEA,SAAS,8BAA8B,MAAgC;AACrE,MAAI,WAAW;AAAA;AAAA;AAEf,QAAM,kBAAkB,KAAK,YAAY,mBAAmB,CAAC;AAC7D,QAAM,iBAAiB,KAAK,YAAY,CAAC;AAEzC,MAAI,OAAO,KAAK,eAAe,EAAE,SAAS,GAAG;AAC3C,gBAAY;AAAA;AAAA;AACZ,gBAAY;AAAA;AAAA;AAEZ,eAAW,CAAC,MAAM,MAAM,KAAK,OAAO,QAAQ,eAAe,GAAG;AAC5D,YAAM,YAAY,WAAiC,MAAM,MAAM;AAC/D,kBAAY,OAAO,IAAI;AAAA;AAAA;AAEvB,YAAM,cACJ,UAAU,eAAe,6BAA6B,SAAS;AACjE,kBAAY,GAAG,WAAW;AAAA;AAAA;AAE1B,kBAAY,eAAe,UAAU,IAAI;AAAA;AAAA;AAEzC,UAAI,UAAU,SAAS,QAAQ;AAC7B,oBAAY,iBAAiB,UAAU,MAAM;AAAA;AAAA;AAC7C,YAAI,UAAU,cAAc;AAC1B,sBAAY,wBAAwB,UAAU,YAAY;AAAA;AAAA;AAAA,QAC5D;AAAA,MACF,WAAW,UAAU,SAAS,UAAU;AACtC,oBAAY;AAAA;AAAA;AACZ,oBAAY;AAAA,EAAe,KAAK;AAAA,UAC9B,UAAU;AAAA,UACV;AAAA,UACA;AAAA,QACF,CAAC;AAAA;AAAA;AAAA;AAAA,MACH;AAAA,IACF;AAAA,EACF;AAEA,MAAI,eAAe,SAAS,GAAG;AAC7B,gBAAY;AAAA;AAAA;AACZ,gBAAY;AAAA;AAAA;AACZ,gBAAY;AAAA,EAAe,KAAK;AAAA,MAC9B;AAAA,MACA;AAAA,MACA;AAAA,IACF,CAAC;AAAA;AAAA;AAAA;AAAA,EACH;AAEA,SAAO;AACT;AAEO,SAAS,oBAAoB,MAAqC;AACvE,QAAM,eAAwB;AAAA,IAC5B,IAAI;AAAA,IACJ,OAAO;AAAA,IACP,KAAK;AAAA,IACL,aAAa;AAAA,IACb,SAAS,6BAA6B,IAAI;AAAA,EAC5C;AAEA,QAAM,eAAe,oBAAI,IAAyB;AAElD,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,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,cACtC,CAAC;AAAA,YACH;AAAA,UACF;AAAA,QACF;AAAA,MACF;AAAA,IACF;AAAA,EACF,CAAC;AAED,QAAM,SAAkB;AAAA,IACtB,IAAI;AAAA,IACJ,OAAO;AAAA,IACP,KAAK;AAAA,IACL,aAAa;AAAA,IACb,SAAS,uBAAuB,YAAY;AAAA,EAC9C;AAEA,QAAM,gBAAyB;AAAA,IAC7B,IAAI;AAAA,IACJ,KAAK;AAAA,IACL,OAAO;AAAA,IACP,aAAa;AAAA,IACb,SAAS,8BAA8B,IAAI;AAAA,EAC7C;AACA,QAAM,OAAkB,CAAC,cAAc,QAAQ,aAAa;AAE5D,SAAO;AAAA,IACL;AAAA,MACE,IAAI;AAAA,MACJ,UAAU;AAAA,MACV,OAAO;AAAA,IACT;AAAA,EACF;AACF;",
-  "names": []
-}