@sdk-it/spec 0.28.0 → 0.30.0

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

@@ -1,4 +1,4 @@
 import type { NavItem } from '../sidebar.js';
-import type { OurOpenAPIObject } from '../types.js';
-export declare function generateErrorsOverview(spec: OurOpenAPIObject): NavItem;
+import type { IR } from '../types.js';
+export declare function generateErrorsOverview(spec: IR): NavItem;
 //# sourceMappingURL=overview-errors.d.ts.map

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,EAAE,EAAE,MAAM,aAAa,CAAC;AAsGtC,wBAAgB,sBAAsB,CAAC,IAAI,EAAE,EAAE,GAAG,OAAO,CAwExD"}

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 { IR } 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: IR,\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: IR): 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,MAAmB;AACxD,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;
+import type { IR } from '../types.js';
+export declare function generateIntroOverview(spec: IR, 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,EAAE,EAAE,MAAM,aAAa,CAAC;AAOtC,wBAAgB,qBAAqB,CACnC,IAAI,EAAE,EAAE,EACR,aAAa,EAAE,MAAM,EAAE,GACtB,OAAO,CA2FT"}

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

@@ -1,13 +1,11 @@
-import { forEachOperation } from "../for-each-operation.js";
-function generateIntroOverview(spec, availablesdks = ["typescript"]) {
+import {
+  getClientIntroText,
+  getTextByCount,
+  presetDocs
+} from "./doc-text-utils.js";
+function generateIntroOverview(spec, availablesdks) {
   const info = spec.info;
   const markdown = [];
-  const tags = /* @__PURE__ */ new Set();
-  const methods = /* @__PURE__ */ new Set();
-  forEachOperation(spec, (entry) => {
-    tags.add(entry.tag);
-    methods.add(entry.method.toUpperCase());
-  });
   if (spec.info.title) {
     markdown.push(`# ${spec.info.title || "API Reference"}
 `);
@@ -18,11 +16,22 @@ function generateIntroOverview(spec, availablesdks = ["typescript"]) {
   }
   if (spec.info.version) {
     markdown.push(`**Version:** ${spec.info.version}
+`);
+  }
+  if (info.license) {
+    let licenseString = `**License:** ${info.license.name}`;
+    if (info.license.url) {
+      licenseString += ` ([${info.license.url}](${info.license.url}))`;
+    }
+    markdown.push(`${licenseString}
 `);
   }
   if (spec.servers && spec.servers.length > 0) {
-    markdown.push(`## API Servers`);
-    markdown.push(`The following servers are available for this API:`);
+    const serverCount = spec.servers.length;
+    markdown.push(
+      `## ${getTextByCount(serverCount, presetDocs.server.section)}`
+    );
+    markdown.push(getTextByCount(serverCount, presetDocs.server.description));
     markdown.push("");
     for (const server of spec.servers) {
       let serverLine = `- **${server.url}**`;
@@ -33,36 +42,32 @@ function generateIntroOverview(spec, availablesdks = ["typescript"]) {
     }
     markdown.push("");
   }
-  if (info.contact) {
-    markdown.push(`## Contact`);
-    if (info.contact.name) {
-      markdown.push(`**Name:** ${info.contact.name}`);
-    }
-    if (info.contact.email) {
-      markdown.push(`**Email:** ${info.contact.email}`);
-    }
-    if (info.contact.url) {
-      markdown.push(`**URL:** ${info.contact.url}`);
-    }
-  }
-  if (info.license) {
-    markdown.push(`## License`);
-    if (info.license.name) {
-      let licenseString = `**License:** ${info.license.name}`;
-      if (info.license.url) {
-        licenseString += ` ([${info.license.url}](${info.license.url}))`;
-      }
-      markdown.push(licenseString);
-    }
-  }
-  markdown.push(`## Official API Clients`);
-  markdown.push(
-    `${info.title || "This API"} provides official client SDKs for multiple programming languages. We recommend using these clients to interact with all stable endpoints. You can find them here:`
-  );
+  const sdkCount = availablesdks.length;
+  markdown.push(`## ${getTextByCount(sdkCount, presetDocs.client.section)}`);
+  markdown.push(getClientIntroText(info.title || "This API", sdkCount));
   for (const link of availablesdks) {
     const sdkName = link.replace("/", "").replace("-sdk", "").toUpperCase();
     markdown.push(`- [${sdkName} SDK](${link})`);
   }
+  const hasSupportInfo = info.contact?.email || info.contact?.url || spec.externalDocs?.url && spec.externalDocs?.description?.toLowerCase().includes("support");
+  if (hasSupportInfo) {
+    markdown.push(`## Need Help?`);
+    if (info.contact?.email) {
+      markdown.push(
+        `For support, reach out to us at [${info.contact.email}](mailto:${info.contact.email}).`
+      );
+    }
+    if (info.contact?.url) {
+      markdown.push(
+        `Visit our support page: [${info.contact.url}](${info.contact.url})`
+      );
+    }
+    if (spec.externalDocs?.url && spec.externalDocs?.description?.toLowerCase().includes("support")) {
+      markdown.push(
+        `For additional support, visit our [${spec.externalDocs.description}](${spec.externalDocs.url}).`
+      );
+    }
+  }
   return {
     id: "generated-introduction",
     title: "Introduction",

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

@@ -1,7 +1,7 @@
 {
   "version": 3,
   "sources": ["../../../src/lib/overview-docs/overview-intro.ts"],
-  "sourcesContent": ["import { forEachOperation } from '../for-each-operation.js';\nimport type { NavItem } from '../sidebar.js';\nimport type { OurOpenAPIObject } from '../types.js';\n\nexport function generateIntroOverview(\n  spec: OurOpenAPIObject,\n  availablesdks = ['typescript'],\n): NavItem {\n  const info = spec.info;\n  const markdown: string[] = [];\n\n  const tags = new Set<string>();\n  const methods = new Set<string>();\n\n  forEachOperation(spec, (entry) => {\n    tags.add(entry.tag);\n    methods.add(entry.method.toUpperCase());\n  });\n\n  if (spec.info.title) {\n    markdown.push(`# ${spec.info.title || 'API Reference'}\\n`);\n  }\n\n  if (spec.info.description) {\n    markdown.push(`${spec.info.description}\\n`);\n  }\n\n  if (spec.info.version) {\n    markdown.push(`**Version:** ${spec.info.version}\\n`);\n  }\n\n  if (spec.servers && spec.servers.length > 0) {\n    markdown.push(`## API Servers`);\n    markdown.push(`The following servers are available for this API:`);\n    markdown.push('');\n\n    for (const server of spec.servers) {\n      let serverLine = `- **${server.url}**`;\n      if (server.description) {\n        serverLine += ` - ${server.description}`;\n      }\n      markdown.push(serverLine);\n    }\n    markdown.push('');\n  }\n\n  if (info.contact) {\n    markdown.push(`## Contact`);\n    if (info.contact.name) {\n      markdown.push(`**Name:** ${info.contact.name}`);\n    }\n    if (info.contact.email) {\n      markdown.push(`**Email:** ${info.contact.email}`);\n    }\n    if (info.contact.url) {\n      markdown.push(`**URL:** ${info.contact.url}`);\n    }\n  }\n\n  if (info.license) {\n    markdown.push(`## License`);\n    if (info.license.name) {\n      let licenseString = `**License:** ${info.license.name}`;\n      if (info.license.url) {\n        licenseString += ` ([${info.license.url}](${info.license.url}))`;\n      }\n      markdown.push(licenseString);\n    }\n  }\n\n  markdown.push(`## Official API Clients`);\n  markdown.push(\n    `${info.title || 'This API'} provides official client SDKs for multiple programming languages. We recommend using these clients to interact with all stable endpoints. You can find them here:`,\n  );\n\n  for (const link of availablesdks) {\n    const sdkName = link.replace('/', '').replace('-sdk', '').toUpperCase();\n    markdown.push(`- [${sdkName} SDK](${link})`);\n  }\n\n  return {\n    id: 'generated-introduction',\n    title: 'Introduction',\n    url: '/introduction',\n    description: 'API overview and getting started guide',\n    content: markdown.join('\\n\\n'),\n  };\n}\n"],
-  "mappings": "AAAA,SAAS,wBAAwB;AAI1B,SAAS,sBACd,MACA,gBAAgB,CAAC,YAAY,GACpB;AACT,QAAM,OAAO,KAAK;AAClB,QAAM,WAAqB,CAAC;AAE5B,QAAM,OAAO,oBAAI,IAAY;AAC7B,QAAM,UAAU,oBAAI,IAAY;AAEhC,mBAAiB,MAAM,CAAC,UAAU;AAChC,SAAK,IAAI,MAAM,GAAG;AAClB,YAAQ,IAAI,MAAM,OAAO,YAAY,CAAC;AAAA,EACxC,CAAC;AAED,MAAI,KAAK,KAAK,OAAO;AACnB,aAAS,KAAK,KAAK,KAAK,KAAK,SAAS,eAAe;AAAA,CAAI;AAAA,EAC3D;AAEA,MAAI,KAAK,KAAK,aAAa;AACzB,aAAS,KAAK,GAAG,KAAK,KAAK,WAAW;AAAA,CAAI;AAAA,EAC5C;AAEA,MAAI,KAAK,KAAK,SAAS;AACrB,aAAS,KAAK,gBAAgB,KAAK,KAAK,OAAO;AAAA,CAAI;AAAA,EACrD;AAEA,MAAI,KAAK,WAAW,KAAK,QAAQ,SAAS,GAAG;AAC3C,aAAS,KAAK,gBAAgB;AAC9B,aAAS,KAAK,mDAAmD;AACjE,aAAS,KAAK,EAAE;AAEhB,eAAW,UAAU,KAAK,SAAS;AACjC,UAAI,aAAa,OAAO,OAAO,GAAG;AAClC,UAAI,OAAO,aAAa;AACtB,sBAAc,MAAM,OAAO,WAAW;AAAA,MACxC;AACA,eAAS,KAAK,UAAU;AAAA,IAC1B;AACA,aAAS,KAAK,EAAE;AAAA,EAClB;AAEA,MAAI,KAAK,SAAS;AAChB,aAAS,KAAK,YAAY;AAC1B,QAAI,KAAK,QAAQ,MAAM;AACrB,eAAS,KAAK,aAAa,KAAK,QAAQ,IAAI,EAAE;AAAA,IAChD;AACA,QAAI,KAAK,QAAQ,OAAO;AACtB,eAAS,KAAK,cAAc,KAAK,QAAQ,KAAK,EAAE;AAAA,IAClD;AACA,QAAI,KAAK,QAAQ,KAAK;AACpB,eAAS,KAAK,YAAY,KAAK,QAAQ,GAAG,EAAE;AAAA,IAC9C;AAAA,EACF;AAEA,MAAI,KAAK,SAAS;AAChB,aAAS,KAAK,YAAY;AAC1B,QAAI,KAAK,QAAQ,MAAM;AACrB,UAAI,gBAAgB,gBAAgB,KAAK,QAAQ,IAAI;AACrD,UAAI,KAAK,QAAQ,KAAK;AACpB,yBAAiB,MAAM,KAAK,QAAQ,GAAG,KAAK,KAAK,QAAQ,GAAG;AAAA,MAC9D;AACA,eAAS,KAAK,aAAa;AAAA,IAC7B;AAAA,EACF;AAEA,WAAS,KAAK,yBAAyB;AACvC,WAAS;AAAA,IACP,GAAG,KAAK,SAAS,UAAU;AAAA,EAC7B;AAEA,aAAW,QAAQ,eAAe;AAChC,UAAM,UAAU,KAAK,QAAQ,KAAK,EAAE,EAAE,QAAQ,QAAQ,EAAE,EAAE,YAAY;AACtE,aAAS,KAAK,MAAM,OAAO,SAAS,IAAI,GAAG;AAAA,EAC7C;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 { NavItem } from '../sidebar.js';\nimport type { IR } from '../types.js';\nimport {\n  getClientIntroText,\n  getTextByCount,\n  presetDocs,\n} from './doc-text-utils.js';\n\nexport function generateIntroOverview(\n  spec: IR,\n  availablesdks: string[],\n): NavItem {\n  const info = spec.info;\n  const markdown: string[] = [];\n\n  if (spec.info.title) {\n    markdown.push(`# ${spec.info.title || 'API Reference'}\\n`);\n  }\n\n  if (spec.info.description) {\n    markdown.push(`${spec.info.description}\\n`);\n  }\n\n  if (spec.info.version) {\n    markdown.push(`**Version:** ${spec.info.version}\\n`);\n  }\n\n  if (info.license) {\n    let licenseString = `**License:** ${info.license.name}`;\n    if (info.license.url) {\n      licenseString += ` ([${info.license.url}](${info.license.url}))`;\n    }\n    markdown.push(`${licenseString}\\n`);\n  }\n\n  if (spec.servers && spec.servers.length > 0) {\n    const serverCount = spec.servers.length;\n\n    markdown.push(\n      `## ${getTextByCount(serverCount, presetDocs.server.section)}`,\n    );\n    markdown.push(getTextByCount(serverCount, presetDocs.server.description));\n    markdown.push('');\n\n    for (const server of spec.servers) {\n      let serverLine = `- **${server.url}**`;\n      if (server.description) {\n        serverLine += ` - ${server.description}`;\n      }\n      markdown.push(serverLine);\n    }\n    markdown.push('');\n  }\n\n  const sdkCount = availablesdks.length;\n  markdown.push(`## ${getTextByCount(sdkCount, presetDocs.client.section)}`);\n  markdown.push(getClientIntroText(info.title || 'This API', sdkCount));\n\n  for (const link of availablesdks) {\n    const sdkName = link.replace('/', '').replace('-sdk', '').toUpperCase();\n    markdown.push(`- [${sdkName} SDK](${link})`);\n  }\n\n  // Add \"Need Help?\" section if support information is available\n  const hasSupportInfo =\n    info.contact?.email ||\n    info.contact?.url ||\n    (spec.externalDocs?.url &&\n      spec.externalDocs?.description?.toLowerCase().includes('support'));\n\n  if (hasSupportInfo) {\n    markdown.push(`## Need Help?`);\n\n    if (info.contact?.email) {\n      markdown.push(\n        `For support, reach out to us at [${info.contact.email}](mailto:${info.contact.email}).`,\n      );\n    }\n\n    if (info.contact?.url) {\n      markdown.push(\n        `Visit our support page: [${info.contact.url}](${info.contact.url})`,\n      );\n    }\n\n    if (\n      spec.externalDocs?.url &&\n      spec.externalDocs?.description?.toLowerCase().includes('support')\n    ) {\n      markdown.push(\n        `For additional support, visit our [${spec.externalDocs.description}](${spec.externalDocs.url}).`,\n      );\n    }\n  }\n\n  return {\n    id: 'generated-introduction',\n    title: 'Introduction',\n    url: '/introduction',\n    description: 'API overview and getting started guide',\n    content: markdown.join('\\n\\n'),\n  };\n}\n"],
+  "mappings": "AAEA;AAAA,EACE;AAAA,EACA;AAAA,EACA;AAAA,OACK;AAEA,SAAS,sBACd,MACA,eACS;AACT,QAAM,OAAO,KAAK;AAClB,QAAM,WAAqB,CAAC;AAE5B,MAAI,KAAK,KAAK,OAAO;AACnB,aAAS,KAAK,KAAK,KAAK,KAAK,SAAS,eAAe;AAAA,CAAI;AAAA,EAC3D;AAEA,MAAI,KAAK,KAAK,aAAa;AACzB,aAAS,KAAK,GAAG,KAAK,KAAK,WAAW;AAAA,CAAI;AAAA,EAC5C;AAEA,MAAI,KAAK,KAAK,SAAS;AACrB,aAAS,KAAK,gBAAgB,KAAK,KAAK,OAAO;AAAA,CAAI;AAAA,EACrD;AAEA,MAAI,KAAK,SAAS;AAChB,QAAI,gBAAgB,gBAAgB,KAAK,QAAQ,IAAI;AACrD,QAAI,KAAK,QAAQ,KAAK;AACpB,uBAAiB,MAAM,KAAK,QAAQ,GAAG,KAAK,KAAK,QAAQ,GAAG;AAAA,IAC9D;AACA,aAAS,KAAK,GAAG,aAAa;AAAA,CAAI;AAAA,EACpC;AAEA,MAAI,KAAK,WAAW,KAAK,QAAQ,SAAS,GAAG;AAC3C,UAAM,cAAc,KAAK,QAAQ;AAEjC,aAAS;AAAA,MACP,MAAM,eAAe,aAAa,WAAW,OAAO,OAAO,CAAC;AAAA,IAC9D;AACA,aAAS,KAAK,eAAe,aAAa,WAAW,OAAO,WAAW,CAAC;AACxE,aAAS,KAAK,EAAE;AAEhB,eAAW,UAAU,KAAK,SAAS;AACjC,UAAI,aAAa,OAAO,OAAO,GAAG;AAClC,UAAI,OAAO,aAAa;AACtB,sBAAc,MAAM,OAAO,WAAW;AAAA,MACxC;AACA,eAAS,KAAK,UAAU;AAAA,IAC1B;AACA,aAAS,KAAK,EAAE;AAAA,EAClB;AAEA,QAAM,WAAW,cAAc;AAC/B,WAAS,KAAK,MAAM,eAAe,UAAU,WAAW,OAAO,OAAO,CAAC,EAAE;AACzE,WAAS,KAAK,mBAAmB,KAAK,SAAS,YAAY,QAAQ,CAAC;AAEpE,aAAW,QAAQ,eAAe;AAChC,UAAM,UAAU,KAAK,QAAQ,KAAK,EAAE,EAAE,QAAQ,QAAQ,EAAE,EAAE,YAAY;AACtE,aAAS,KAAK,MAAM,OAAO,SAAS,IAAI,GAAG;AAAA,EAC7C;AAGA,QAAM,iBACJ,KAAK,SAAS,SACd,KAAK,SAAS,OACb,KAAK,cAAc,OAClB,KAAK,cAAc,aAAa,YAAY,EAAE,SAAS,SAAS;AAEpE,MAAI,gBAAgB;AAClB,aAAS,KAAK,eAAe;AAE7B,QAAI,KAAK,SAAS,OAAO;AACvB,eAAS;AAAA,QACP,oCAAoC,KAAK,QAAQ,KAAK,YAAY,KAAK,QAAQ,KAAK;AAAA,MACtF;AAAA,IACF;AAEA,QAAI,KAAK,SAAS,KAAK;AACrB,eAAS;AAAA,QACP,4BAA4B,KAAK,QAAQ,GAAG,KAAK,KAAK,QAAQ,GAAG;AAAA,MACnE;AAAA,IACF;AAEA,QACE,KAAK,cAAc,OACnB,KAAK,cAAc,aAAa,YAAY,EAAE,SAAS,SAAS,GAChE;AACA,eAAS;AAAA,QACP,sCAAsC,KAAK,aAAa,WAAW,KAAK,KAAK,aAAa,GAAG;AAAA,MAC/F;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-pagination.d.ts

@@ -1,4 +1,4 @@
 import type { NavItem } from '../sidebar.js';
-import type { OurOpenAPIObject } from '../types.js';
-export declare function generatePaginationOverview(spec: OurOpenAPIObject): NavItem;
+import type { IR } from '../types.js';
+export declare function generatePaginationOverview(spec: IR): NavItem;
 //# sourceMappingURL=overview-pagination.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"overview-pagination.d.ts","sourceRoot":"","sources":["../../../src/lib/overview-docs/overview-pagination.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,eAAe,CAAC;AAC7C,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAC;AAEpD,wBAAgB,0BAA0B,CAAC,IAAI,EAAE,gBAAgB,GAAG,OAAO,CAkF1E"}
+{"version":3,"file":"overview-pagination.d.ts","sourceRoot":"","sources":["../../../src/lib/overview-docs/overview-pagination.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,eAAe,CAAC;AAC7C,OAAO,KAAK,EAAE,EAAE,EAAE,MAAM,aAAa,CAAC;AAEtC,wBAAgB,0BAA0B,CAAC,IAAI,EAAE,EAAE,GAAG,OAAO,CAoG5D"}

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

@@ -1,12 +1,20 @@
 function generatePaginationOverview(spec) {
   const markdown = [];
   markdown.push(`# Pagination`);
-  markdown.push(`This API uses cursor-based pagination to efficiently navigate through large datasets.`);
+  markdown.push(
+    `This API uses cursor-based pagination to efficiently navigate through large datasets.`
+  );
   markdown.push(`## How Pagination Works`);
-  markdown.push(`When making requests to endpoints that return multiple items, you can control the number of results and navigate through pages using the following parameters:`);
+  markdown.push(
+    `When making requests to endpoints that return multiple items, you can control the number of results and navigate through pages using the following parameters:`
+  );
   markdown.push("");
-  markdown.push(`- **limit** - The maximum number of items to return per page (default: 20, max: 100)`);
-  markdown.push(`- **cursor** - A token representing the position in the dataset to start from`);
+  markdown.push(
+    `- **limit** - The maximum number of items to return per page (default: 20, max: 100)`
+  );
+  markdown.push(
+    `- **cursor** - A token representing the position in the dataset to start from`
+  );
   markdown.push("");
   markdown.push(`## Example Usage`);
   markdown.push("");
@@ -32,7 +40,9 @@ function generatePaginationOverview(spec) {
   markdown.push("```json");
   markdown.push("{");
   markdown.push('  "data": [...], // Array of items');
-  markdown.push('  "nextCursor": "eyJpZCI6MTAwfQ==", // Token for next page (null if last page)');
+  markdown.push(
+    '  "nextCursor": "eyJpZCI6MTAwfQ==", // Token for next page (null if last page)'
+  );
   markdown.push('  "hasMore": true, // Whether more pages exist');
   markdown.push('  "totalCount": 150 // Total number of items (if available)');
   markdown.push("}");
@@ -62,10 +72,18 @@ function generatePaginationOverview(spec) {
   markdown.push("");
   markdown.push(`## Best Practices`);
   markdown.push("");
-  markdown.push(`1. **Use appropriate page sizes** - Balance between number of requests and response size`);
-  markdown.push(`2. **Handle cursors securely** - Don't modify cursor values; treat them as opaque tokens`);
-  markdown.push(`3. **Implement retry logic** - Handle temporary failures when iterating through pages`);
-  markdown.push(`4. **Consider rate limits** - Be mindful of API rate limits when fetching multiple pages`);
+  markdown.push(
+    `1. **Use appropriate page sizes** - Balance between number of requests and response size`
+  );
+  markdown.push(
+    `2. **Handle cursors securely** - Don't modify cursor values; treat them as opaque tokens`
+  );
+  markdown.push(
+    `3. **Implement retry logic** - Handle temporary failures when iterating through pages`
+  );
+  markdown.push(
+    `4. **Consider rate limits** - Be mindful of API rate limits when fetching multiple pages`
+  );
   return {
     id: "generated-pagination",
     title: "Pagination",

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

@@ -1,7 +1,7 @@
 {
   "version": 3,
   "sources": ["../../../src/lib/overview-docs/overview-pagination.ts"],
-  "sourcesContent": ["import type { NavItem } from '../sidebar.js';\nimport type { OurOpenAPIObject } from '../types.js';\n\nexport function generatePaginationOverview(spec: OurOpenAPIObject): NavItem {\n  const markdown: string[] = [];\n\n  markdown.push(`# Pagination`);\n  markdown.push(`This API uses cursor-based pagination to efficiently navigate through large datasets.`);\n  \n  markdown.push(`## How Pagination Works`);\n  markdown.push(`When making requests to endpoints that return multiple items, you can control the number of results and navigate through pages using the following parameters:`);\n  markdown.push('');\n  markdown.push(`- **limit** - The maximum number of items to return per page (default: 20, max: 100)`);\n  markdown.push(`- **cursor** - A token representing the position in the dataset to start from`);\n  markdown.push('');\n\n  markdown.push(`## Example Usage`);\n  markdown.push('');\n  markdown.push('### TypeScript');\n  markdown.push('```typescript');\n  markdown.push('// First page');\n  markdown.push('const firstPage = await client.items.list({');\n  markdown.push('  limit: 25');\n  markdown.push('});');\n  markdown.push('');\n  markdown.push('// Next page');\n  markdown.push('if (firstPage.nextCursor) {');\n  markdown.push('  const secondPage = await client.items.list({');\n  markdown.push('    limit: 25,');\n  markdown.push('    cursor: firstPage.nextCursor');\n  markdown.push('  });');\n  markdown.push('}');\n  markdown.push('```');\n  markdown.push('');\n\n  markdown.push(`## Response Structure`);\n  markdown.push(`Paginated responses follow this structure:`);\n  markdown.push('');\n  markdown.push('```json');\n  markdown.push('{');\n  markdown.push('  \"data\": [...], // Array of items');\n  markdown.push('  \"nextCursor\": \"eyJpZCI6MTAwfQ==\", // Token for next page (null if last page)');\n  markdown.push('  \"hasMore\": true, // Whether more pages exist');\n  markdown.push('  \"totalCount\": 150 // Total number of items (if available)');\n  markdown.push('}');\n  markdown.push('```');\n  markdown.push('');\n\n  markdown.push(`## Iterating Through All Pages`);\n  markdown.push('');\n  markdown.push('### TypeScript');\n  markdown.push('```typescript');\n  markdown.push('async function getAllItems() {');\n  markdown.push('  const allItems = [];');\n  markdown.push('  let cursor = undefined;');\n  markdown.push('  ');\n  markdown.push('  do {');\n  markdown.push('    const page = await client.items.list({');\n  markdown.push('      limit: 100,');\n  markdown.push('      cursor');\n  markdown.push('    });');\n  markdown.push('    ');\n  markdown.push('    allItems.push(...page.data);');\n  markdown.push('    cursor = page.nextCursor;');\n  markdown.push('  } while (cursor);');\n  markdown.push('  ');\n  markdown.push('  return allItems;');\n  markdown.push('}');\n  markdown.push('```');\n  markdown.push('');\n\n  markdown.push(`## Best Practices`);\n  markdown.push('');\n  markdown.push(`1. **Use appropriate page sizes** - Balance between number of requests and response size`);\n  markdown.push(`2. **Handle cursors securely** - Don't modify cursor values; treat them as opaque tokens`);\n  markdown.push(`3. **Implement retry logic** - Handle temporary failures when iterating through pages`);\n  markdown.push(`4. **Consider rate limits** - Be mindful of API rate limits when fetching multiple pages`);\n\n  return {\n    id: 'generated-pagination',\n    title: 'Pagination',\n    url: '/pagination',\n    description: 'Learn how to navigate through paginated API responses',\n    content: markdown.join('\\n'),\n  };\n}"],
-  "mappings": "AAGO,SAAS,2BAA2B,MAAiC;AAC1E,QAAM,WAAqB,CAAC;AAE5B,WAAS,KAAK,cAAc;AAC5B,WAAS,KAAK,uFAAuF;AAErG,WAAS,KAAK,yBAAyB;AACvC,WAAS,KAAK,gKAAgK;AAC9K,WAAS,KAAK,EAAE;AAChB,WAAS,KAAK,sFAAsF;AACpG,WAAS,KAAK,+EAA+E;AAC7F,WAAS,KAAK,EAAE;AAEhB,WAAS,KAAK,kBAAkB;AAChC,WAAS,KAAK,EAAE;AAChB,WAAS,KAAK,gBAAgB;AAC9B,WAAS,KAAK,eAAe;AAC7B,WAAS,KAAK,eAAe;AAC7B,WAAS,KAAK,6CAA6C;AAC3D,WAAS,KAAK,aAAa;AAC3B,WAAS,KAAK,KAAK;AACnB,WAAS,KAAK,EAAE;AAChB,WAAS,KAAK,cAAc;AAC5B,WAAS,KAAK,6BAA6B;AAC3C,WAAS,KAAK,gDAAgD;AAC9D,WAAS,KAAK,gBAAgB;AAC9B,WAAS,KAAK,kCAAkC;AAChD,WAAS,KAAK,OAAO;AACrB,WAAS,KAAK,GAAG;AACjB,WAAS,KAAK,KAAK;AACnB,WAAS,KAAK,EAAE;AAEhB,WAAS,KAAK,uBAAuB;AACrC,WAAS,KAAK,4CAA4C;AAC1D,WAAS,KAAK,EAAE;AAChB,WAAS,KAAK,SAAS;AACvB,WAAS,KAAK,GAAG;AACjB,WAAS,KAAK,oCAAoC;AAClD,WAAS,KAAK,gFAAgF;AAC9F,WAAS,KAAK,gDAAgD;AAC9D,WAAS,KAAK,6DAA6D;AAC3E,WAAS,KAAK,GAAG;AACjB,WAAS,KAAK,KAAK;AACnB,WAAS,KAAK,EAAE;AAEhB,WAAS,KAAK,gCAAgC;AAC9C,WAAS,KAAK,EAAE;AAChB,WAAS,KAAK,gBAAgB;AAC9B,WAAS,KAAK,eAAe;AAC7B,WAAS,KAAK,gCAAgC;AAC9C,WAAS,KAAK,wBAAwB;AACtC,WAAS,KAAK,2BAA2B;AACzC,WAAS,KAAK,IAAI;AAClB,WAAS,KAAK,QAAQ;AACtB,WAAS,KAAK,4CAA4C;AAC1D,WAAS,KAAK,mBAAmB;AACjC,WAAS,KAAK,cAAc;AAC5B,WAAS,KAAK,SAAS;AACvB,WAAS,KAAK,MAAM;AACpB,WAAS,KAAK,kCAAkC;AAChD,WAAS,KAAK,+BAA+B;AAC7C,WAAS,KAAK,qBAAqB;AACnC,WAAS,KAAK,IAAI;AAClB,WAAS,KAAK,oBAAoB;AAClC,WAAS,KAAK,GAAG;AACjB,WAAS,KAAK,KAAK;AACnB,WAAS,KAAK,EAAE;AAEhB,WAAS,KAAK,mBAAmB;AACjC,WAAS,KAAK,EAAE;AAChB,WAAS,KAAK,0FAA0F;AACxG,WAAS,KAAK,0FAA0F;AACxG,WAAS,KAAK,uFAAuF;AACrG,WAAS,KAAK,0FAA0F;AAExG,SAAO;AAAA,IACL,IAAI;AAAA,IACJ,OAAO;AAAA,IACP,KAAK;AAAA,IACL,aAAa;AAAA,IACb,SAAS,SAAS,KAAK,IAAI;AAAA,EAC7B;AACF;",
+  "sourcesContent": ["import type { NavItem } from '../sidebar.js';\nimport type { IR } from '../types.js';\n\nexport function generatePaginationOverview(spec: IR): NavItem {\n  const markdown: string[] = [];\n\n  markdown.push(`# Pagination`);\n  markdown.push(\n    `This API uses cursor-based pagination to efficiently navigate through large datasets.`,\n  );\n\n  markdown.push(`## How Pagination Works`);\n  markdown.push(\n    `When making requests to endpoints that return multiple items, you can control the number of results and navigate through pages using the following parameters:`,\n  );\n  markdown.push('');\n  markdown.push(\n    `- **limit** - The maximum number of items to return per page (default: 20, max: 100)`,\n  );\n  markdown.push(\n    `- **cursor** - A token representing the position in the dataset to start from`,\n  );\n  markdown.push('');\n\n  markdown.push(`## Example Usage`);\n  markdown.push('');\n  markdown.push('### TypeScript');\n  markdown.push('```typescript');\n  markdown.push('// First page');\n  markdown.push('const firstPage = await client.items.list({');\n  markdown.push('  limit: 25');\n  markdown.push('});');\n  markdown.push('');\n  markdown.push('// Next page');\n  markdown.push('if (firstPage.nextCursor) {');\n  markdown.push('  const secondPage = await client.items.list({');\n  markdown.push('    limit: 25,');\n  markdown.push('    cursor: firstPage.nextCursor');\n  markdown.push('  });');\n  markdown.push('}');\n  markdown.push('```');\n  markdown.push('');\n\n  markdown.push(`## Response Structure`);\n  markdown.push(`Paginated responses follow this structure:`);\n  markdown.push('');\n  markdown.push('```json');\n  markdown.push('{');\n  markdown.push('  \"data\": [...], // Array of items');\n  markdown.push(\n    '  \"nextCursor\": \"eyJpZCI6MTAwfQ==\", // Token for next page (null if last page)',\n  );\n  markdown.push('  \"hasMore\": true, // Whether more pages exist');\n  markdown.push('  \"totalCount\": 150 // Total number of items (if available)');\n  markdown.push('}');\n  markdown.push('```');\n  markdown.push('');\n\n  markdown.push(`## Iterating Through All Pages`);\n  markdown.push('');\n  markdown.push('### TypeScript');\n  markdown.push('```typescript');\n  markdown.push('async function getAllItems() {');\n  markdown.push('  const allItems = [];');\n  markdown.push('  let cursor = undefined;');\n  markdown.push('  ');\n  markdown.push('  do {');\n  markdown.push('    const page = await client.items.list({');\n  markdown.push('      limit: 100,');\n  markdown.push('      cursor');\n  markdown.push('    });');\n  markdown.push('    ');\n  markdown.push('    allItems.push(...page.data);');\n  markdown.push('    cursor = page.nextCursor;');\n  markdown.push('  } while (cursor);');\n  markdown.push('  ');\n  markdown.push('  return allItems;');\n  markdown.push('}');\n  markdown.push('```');\n  markdown.push('');\n\n  markdown.push(`## Best Practices`);\n  markdown.push('');\n  markdown.push(\n    `1. **Use appropriate page sizes** - Balance between number of requests and response size`,\n  );\n  markdown.push(\n    `2. **Handle cursors securely** - Don't modify cursor values; treat them as opaque tokens`,\n  );\n  markdown.push(\n    `3. **Implement retry logic** - Handle temporary failures when iterating through pages`,\n  );\n  markdown.push(\n    `4. **Consider rate limits** - Be mindful of API rate limits when fetching multiple pages`,\n  );\n\n  return {\n    id: 'generated-pagination',\n    title: 'Pagination',\n    url: '/pagination',\n    description: 'Learn how to navigate through paginated API responses',\n    content: markdown.join('\\n'),\n  };\n}\n"],
+  "mappings": "AAGO,SAAS,2BAA2B,MAAmB;AAC5D,QAAM,WAAqB,CAAC;AAE5B,WAAS,KAAK,cAAc;AAC5B,WAAS;AAAA,IACP;AAAA,EACF;AAEA,WAAS,KAAK,yBAAyB;AACvC,WAAS;AAAA,IACP;AAAA,EACF;AACA,WAAS,KAAK,EAAE;AAChB,WAAS;AAAA,IACP;AAAA,EACF;AACA,WAAS;AAAA,IACP;AAAA,EACF;AACA,WAAS,KAAK,EAAE;AAEhB,WAAS,KAAK,kBAAkB;AAChC,WAAS,KAAK,EAAE;AAChB,WAAS,KAAK,gBAAgB;AAC9B,WAAS,KAAK,eAAe;AAC7B,WAAS,KAAK,eAAe;AAC7B,WAAS,KAAK,6CAA6C;AAC3D,WAAS,KAAK,aAAa;AAC3B,WAAS,KAAK,KAAK;AACnB,WAAS,KAAK,EAAE;AAChB,WAAS,KAAK,cAAc;AAC5B,WAAS,KAAK,6BAA6B;AAC3C,WAAS,KAAK,gDAAgD;AAC9D,WAAS,KAAK,gBAAgB;AAC9B,WAAS,KAAK,kCAAkC;AAChD,WAAS,KAAK,OAAO;AACrB,WAAS,KAAK,GAAG;AACjB,WAAS,KAAK,KAAK;AACnB,WAAS,KAAK,EAAE;AAEhB,WAAS,KAAK,uBAAuB;AACrC,WAAS,KAAK,4CAA4C;AAC1D,WAAS,KAAK,EAAE;AAChB,WAAS,KAAK,SAAS;AACvB,WAAS,KAAK,GAAG;AACjB,WAAS,KAAK,oCAAoC;AAClD,WAAS;AAAA,IACP;AAAA,EACF;AACA,WAAS,KAAK,gDAAgD;AAC9D,WAAS,KAAK,6DAA6D;AAC3E,WAAS,KAAK,GAAG;AACjB,WAAS,KAAK,KAAK;AACnB,WAAS,KAAK,EAAE;AAEhB,WAAS,KAAK,gCAAgC;AAC9C,WAAS,KAAK,EAAE;AAChB,WAAS,KAAK,gBAAgB;AAC9B,WAAS,KAAK,eAAe;AAC7B,WAAS,KAAK,gCAAgC;AAC9C,WAAS,KAAK,wBAAwB;AACtC,WAAS,KAAK,2BAA2B;AACzC,WAAS,KAAK,IAAI;AAClB,WAAS,KAAK,QAAQ;AACtB,WAAS,KAAK,4CAA4C;AAC1D,WAAS,KAAK,mBAAmB;AACjC,WAAS,KAAK,cAAc;AAC5B,WAAS,KAAK,SAAS;AACvB,WAAS,KAAK,MAAM;AACpB,WAAS,KAAK,kCAAkC;AAChD,WAAS,KAAK,+BAA+B;AAC7C,WAAS,KAAK,qBAAqB;AACnC,WAAS,KAAK,IAAI;AAClB,WAAS,KAAK,oBAAoB;AAClC,WAAS,KAAK,GAAG;AACjB,WAAS,KAAK,KAAK;AACnB,WAAS,KAAK,EAAE;AAEhB,WAAS,KAAK,mBAAmB;AACjC,WAAS,KAAK,EAAE;AAChB,WAAS;AAAA,IACP;AAAA,EACF;AACA,WAAS;AAAA,IACP;AAAA,EACF;AACA,WAAS;AAAA,IACP;AAAA,EACF;AACA,WAAS;AAAA,IACP;AAAA,EACF;AAEA,SAAO;AAAA,IACL,IAAI;AAAA,IACJ,OAAO;AAAA,IACP,KAAK;AAAA,IACL,aAAa;AAAA,IACb,SAAS,SAAS,KAAK,IAAI;AAAA,EAC7B;AACF;",
   "names": []
 }

package/dist/lib/pagination/pagination.d.ts

@@ -1,3 +1,3 @@
-import type { OurOpenAPIObject, TunedOperationObject } from '../types.js';
-export declare function toPagination(spec: OurOpenAPIObject, tunedOperation: TunedOperationObject): any;
+import type { IR, TunedOperationObject } from '../types.js';
+export declare function toPagination(spec: IR, tunedOperation: TunedOperationObject): any;
 //# sourceMappingURL=pagination.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"pagination.d.ts","sourceRoot":"","sources":["../../../src/lib/pagination/pagination.ts"],"names":[],"mappings":"AAQA,OAAO,KAAK,EAAE,gBAAgB,EAAE,oBAAoB,EAAE,MAAM,aAAa,CAAC;AAG1E,wBAAgB,YAAY,CAC1B,IAAI,EAAE,gBAAgB,EACtB,cAAc,EAAE,oBAAoB,OAyBrC"}
+{"version":3,"file":"pagination.d.ts","sourceRoot":"","sources":["../../../src/lib/pagination/pagination.ts"],"names":[],"mappings":"AAQA,OAAO,KAAK,EAAE,EAAE,EAAE,oBAAoB,EAAE,MAAM,aAAa,CAAC;AAG5D,wBAAgB,YAAY,CAAC,IAAI,EAAE,EAAE,EAAE,cAAc,EAAE,oBAAoB,OAwB1E"}

package/dist/lib/pagination/pagination.js.map

@@ -1,7 +1,7 @@
 {
   "version": 3,
   "sources": ["../../../src/lib/pagination/pagination.ts"],
-  "sourcesContent": ["import type {\n  RequestBodyObject,\n  ResponseObject,\n  SchemaObject,\n} from 'openapi3-ts/oas31';\n\nimport { followRef, isRef } from '@sdk-it/core/ref.js';\n\nimport type { OurOpenAPIObject, TunedOperationObject } from '../types.js';\nimport { guessPagination } from './guess-pagination.js';\n\nexport function toPagination(\n  spec: OurOpenAPIObject,\n  tunedOperation: TunedOperationObject,\n) {\n  if (tunedOperation['x-pagination']) {\n    return tunedOperation['x-pagination'];\n  }\n  const schema = getResponseContentSchema(\n    spec,\n    tunedOperation.responses['200'],\n    'application/json',\n  );\n  const pagination = guessPagination(\n    tunedOperation,\n    tunedOperation.requestBody\n      ? getRequestContentSchema(\n          spec,\n          tunedOperation.requestBody,\n          'application/json',\n        )\n      : undefined,\n    schema,\n  );\n  if (pagination && pagination.type !== 'none' && schema) {\n    return pagination;\n  }\n  return undefined;\n}\n\nfunction getResponseContentSchema(\n  spec: OurOpenAPIObject,\n  response: ResponseObject,\n  type: string,\n) {\n  if (!response) {\n    return undefined;\n  }\n  const content = response.content;\n  if (!content) {\n    return undefined;\n  }\n  for (const contentType in content) {\n    if (contentType.toLowerCase() === type.toLowerCase()) {\n      return isRef(content[contentType].schema)\n        ? followRef<SchemaObject>(spec, content[contentType].schema.$ref)\n        : content[contentType].schema;\n    }\n  }\n  return undefined;\n}\n\nfunction getRequestContentSchema(\n  spec: OurOpenAPIObject,\n  requestBody: RequestBodyObject,\n  type: string,\n) {\n  const content = requestBody.content;\n  if (!content) {\n    return undefined;\n  }\n  for (const contentType in content) {\n    if (contentType.toLowerCase() === type.toLowerCase()) {\n      return isRef(content[contentType].schema)\n        ? followRef<SchemaObject>(spec, content[contentType].schema.$ref)\n        : content[contentType].schema;\n    }\n  }\n  return undefined;\n}\n"],
-  "mappings": "AAMA,SAAS,WAAW,aAAa;AAGjC,SAAS,uBAAuB;AAEzB,SAAS,aACd,MACA,gBACA;AACA,MAAI,eAAe,cAAc,GAAG;AAClC,WAAO,eAAe,cAAc;AAAA,EACtC;AACA,QAAM,SAAS;AAAA,IACb;AAAA,IACA,eAAe,UAAU,KAAK;AAAA,IAC9B;AAAA,EACF;AACA,QAAM,aAAa;AAAA,IACjB;AAAA,IACA,eAAe,cACX;AAAA,MACE;AAAA,MACA,eAAe;AAAA,MACf;AAAA,IACF,IACA;AAAA,IACJ;AAAA,EACF;AACA,MAAI,cAAc,WAAW,SAAS,UAAU,QAAQ;AACtD,WAAO;AAAA,EACT;AACA,SAAO;AACT;AAEA,SAAS,yBACP,MACA,UACA,MACA;AACA,MAAI,CAAC,UAAU;AACb,WAAO;AAAA,EACT;AACA,QAAM,UAAU,SAAS;AACzB,MAAI,CAAC,SAAS;AACZ,WAAO;AAAA,EACT;AACA,aAAW,eAAe,SAAS;AACjC,QAAI,YAAY,YAAY,MAAM,KAAK,YAAY,GAAG;AACpD,aAAO,MAAM,QAAQ,WAAW,EAAE,MAAM,IACpC,UAAwB,MAAM,QAAQ,WAAW,EAAE,OAAO,IAAI,IAC9D,QAAQ,WAAW,EAAE;AAAA,IAC3B;AAAA,EACF;AACA,SAAO;AACT;AAEA,SAAS,wBACP,MACA,aACA,MACA;AACA,QAAM,UAAU,YAAY;AAC5B,MAAI,CAAC,SAAS;AACZ,WAAO;AAAA,EACT;AACA,aAAW,eAAe,SAAS;AACjC,QAAI,YAAY,YAAY,MAAM,KAAK,YAAY,GAAG;AACpD,aAAO,MAAM,QAAQ,WAAW,EAAE,MAAM,IACpC,UAAwB,MAAM,QAAQ,WAAW,EAAE,OAAO,IAAI,IAC9D,QAAQ,WAAW,EAAE;AAAA,IAC3B;AAAA,EACF;AACA,SAAO;AACT;",
+  "sourcesContent": ["import type {\n  RequestBodyObject,\n  ResponseObject,\n  SchemaObject,\n} from 'openapi3-ts/oas31';\n\nimport { followRef, isRef } from '@sdk-it/core/ref.js';\n\nimport type { IR, TunedOperationObject } from '../types.js';\nimport { guessPagination } from './guess-pagination.js';\n\nexport function toPagination(spec: IR, tunedOperation: TunedOperationObject) {\n  if (tunedOperation['x-pagination']) {\n    return tunedOperation['x-pagination'];\n  }\n  const schema = getResponseContentSchema(\n    spec,\n    tunedOperation.responses['200'],\n    'application/json',\n  );\n  const pagination = guessPagination(\n    tunedOperation,\n    tunedOperation.requestBody\n      ? getRequestContentSchema(\n          spec,\n          tunedOperation.requestBody,\n          'application/json',\n        )\n      : undefined,\n    schema,\n  );\n  if (pagination && pagination.type !== 'none' && schema) {\n    return pagination;\n  }\n  return undefined;\n}\n\nfunction getResponseContentSchema(\n  spec: IR,\n  response: ResponseObject,\n  type: string,\n) {\n  if (!response) {\n    return undefined;\n  }\n  const content = response.content;\n  if (!content) {\n    return undefined;\n  }\n  for (const contentType in content) {\n    if (contentType.toLowerCase() === type.toLowerCase()) {\n      return isRef(content[contentType].schema)\n        ? followRef<SchemaObject>(spec, content[contentType].schema.$ref)\n        : content[contentType].schema;\n    }\n  }\n  return undefined;\n}\n\nfunction getRequestContentSchema(\n  spec: IR,\n  requestBody: RequestBodyObject,\n  type: string,\n) {\n  const content = requestBody.content;\n  if (!content) {\n    return undefined;\n  }\n  for (const contentType in content) {\n    if (contentType.toLowerCase() === type.toLowerCase()) {\n      return isRef(content[contentType].schema)\n        ? followRef<SchemaObject>(spec, content[contentType].schema.$ref)\n        : content[contentType].schema;\n    }\n  }\n  return undefined;\n}\n"],
+  "mappings": "AAMA,SAAS,WAAW,aAAa;AAGjC,SAAS,uBAAuB;AAEzB,SAAS,aAAa,MAAU,gBAAsC;AAC3E,MAAI,eAAe,cAAc,GAAG;AAClC,WAAO,eAAe,cAAc;AAAA,EACtC;AACA,QAAM,SAAS;AAAA,IACb;AAAA,IACA,eAAe,UAAU,KAAK;AAAA,IAC9B;AAAA,EACF;AACA,QAAM,aAAa;AAAA,IACjB;AAAA,IACA,eAAe,cACX;AAAA,MACE;AAAA,MACA,eAAe;AAAA,MACf;AAAA,IACF,IACA;AAAA,IACJ;AAAA,EACF;AACA,MAAI,cAAc,WAAW,SAAS,UAAU,QAAQ;AACtD,WAAO;AAAA,EACT;AACA,SAAO;AACT;AAEA,SAAS,yBACP,MACA,UACA,MACA;AACA,MAAI,CAAC,UAAU;AACb,WAAO;AAAA,EACT;AACA,QAAM,UAAU,SAAS;AACzB,MAAI,CAAC,SAAS;AACZ,WAAO;AAAA,EACT;AACA,aAAW,eAAe,SAAS;AACjC,QAAI,YAAY,YAAY,MAAM,KAAK,YAAY,GAAG;AACpD,aAAO,MAAM,QAAQ,WAAW,EAAE,MAAM,IACpC,UAAwB,MAAM,QAAQ,WAAW,EAAE,OAAO,IAAI,IAC9D,QAAQ,WAAW,EAAE;AAAA,IAC3B;AAAA,EACF;AACA,SAAO;AACT;AAEA,SAAS,wBACP,MACA,aACA,MACA;AACA,QAAM,UAAU,YAAY;AAC5B,MAAI,CAAC,SAAS;AACZ,WAAO;AAAA,EACT;AACA,aAAW,eAAe,SAAS;AACjC,QAAI,YAAY,YAAY,MAAM,KAAK,YAAY,GAAG;AACpD,aAAO,MAAM,QAAQ,WAAW,EAAE,MAAM,IACpC,UAAwB,MAAM,QAAQ,WAAW,EAAE,OAAO,IAAI,IAC9D,QAAQ,WAAW,EAAE;AAAA,IAC3B;AAAA,EACF;AACA,SAAO;AACT;",
   "names": []
 }

package/dist/lib/security.d.ts

@@ -1,12 +1,12 @@
 import type { ParameterLocation, ParameterObject, ReferenceObject, SchemaObject, SecurityRequirementObject, SecuritySchemeObject } from 'openapi3-ts/oas31';
-import type { OurOpenAPIObject } from './types.js';
+import type { IR } from './types.js';
 type OIn = ParameterLocation | 'input';
 export type OurParameter = Omit<ParameterObject, 'in' | 'schema'> & {
     in: OIn;
     'x-optionName'?: string;
     schema: SchemaObject;
 };
-export declare function securityToOptions(spec: OurOpenAPIObject, security: SecurityRequirementObject[], securitySchemes: Record<string, SecuritySchemeObject | ReferenceObject>, staticIn?: OIn): OurParameter[];
-export declare function security(spec: OurOpenAPIObject): OurParameter[];
+export declare function securityToOptions(spec: IR, security: SecurityRequirementObject[], securitySchemes: Record<string, SecuritySchemeObject | ReferenceObject>, staticIn?: OIn): OurParameter[];
+export declare function security(spec: IR): OurParameter[];
 export {};
 //# sourceMappingURL=security.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"security.d.ts","sourceRoot":"","sources":["../../src/lib/security.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,iBAAiB,EACjB,eAAe,EACf,eAAe,EACf,YAAY,EACZ,yBAAyB,EACzB,oBAAoB,EACrB,MAAM,mBAAmB,CAAC;AAK3B,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,YAAY,CAAC;AAEnD,KAAK,GAAG,GAAG,iBAAiB,GAAG,OAAO,CAAC;AAEvC,MAAM,MAAM,YAAY,GAAG,IAAI,CAAC,eAAe,EAAE,IAAI,GAAG,QAAQ,CAAC,GAAG;IAClE,EAAE,EAAE,GAAG,CAAC;IACR,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,MAAM,EAAE,YAAY,CAAC;CACtB,CAAC;AAEF,wBAAgB,iBAAiB,CAC/B,IAAI,EAAE,gBAAgB,EACtB,QAAQ,EAAE,yBAAyB,EAAE,EACrC,eAAe,EAAE,MAAM,CAAC,MAAM,EAAE,oBAAoB,GAAG,eAAe,CAAC,EACvE,QAAQ,CAAC,EAAE,GAAG,kBA8Cf;AAED,wBAAgB,QAAQ,CAAC,IAAI,EAAE,gBAAgB,kBA4B9C"}
+{"version":3,"file":"security.d.ts","sourceRoot":"","sources":["../../src/lib/security.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,iBAAiB,EACjB,eAAe,EACf,eAAe,EACf,YAAY,EACZ,yBAAyB,EACzB,oBAAoB,EACrB,MAAM,mBAAmB,CAAC;AAK3B,OAAO,KAAK,EAAE,EAAE,EAAE,MAAM,YAAY,CAAC;AAErC,KAAK,GAAG,GAAG,iBAAiB,GAAG,OAAO,CAAC;AAEvC,MAAM,MAAM,YAAY,GAAG,IAAI,CAAC,eAAe,EAAE,IAAI,GAAG,QAAQ,CAAC,GAAG;IAClE,EAAE,EAAE,GAAG,CAAC;IACR,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,MAAM,EAAE,YAAY,CAAC;CACtB,CAAC;AAEF,wBAAgB,iBAAiB,CAC/B,IAAI,EAAE,EAAE,EACR,QAAQ,EAAE,yBAAyB,EAAE,EACrC,eAAe,EAAE,MAAM,CAAC,MAAM,EAAE,oBAAoB,GAAG,eAAe,CAAC,EACvE,QAAQ,CAAC,EAAE,GAAG,kBA8Cf;AAED,wBAAgB,QAAQ,CAAC,IAAI,EAAE,EAAE,kBA4BhC"}

package/dist/lib/security.js.map

@@ -1,7 +1,7 @@
 {
   "version": 3,
   "sources": ["../../src/lib/security.ts"],
-  "sourcesContent": ["import type {\n  ParameterLocation,\n  ParameterObject,\n  ReferenceObject,\n  SchemaObject,\n  SecurityRequirementObject,\n  SecuritySchemeObject,\n} from 'openapi3-ts/oas31';\n\nimport { methods } from '@sdk-it/core/paths.js';\nimport { resolveRef } from '@sdk-it/core/ref.js';\n\nimport type { OurOpenAPIObject } from './types.js';\n\ntype OIn = ParameterLocation | 'input';\n\nexport type OurParameter = Omit<ParameterObject, 'in' | 'schema'> & {\n  in: OIn;\n  'x-optionName'?: string;\n  schema: SchemaObject;\n};\n\nexport function securityToOptions(\n  spec: OurOpenAPIObject,\n  security: SecurityRequirementObject[],\n  securitySchemes: Record<string, SecuritySchemeObject | ReferenceObject>,\n  staticIn?: OIn,\n) {\n  const parameters: OurParameter[] = [];\n  for (const it of security) {\n    const [name] = Object.keys(it);\n    if (!name) {\n      // this means the operation doesn't necessarily require security\n      continue;\n    }\n\n    const schema = resolveRef<SecuritySchemeObject>(\n      spec,\n      securitySchemes[name],\n    );\n    if (schema.type === 'http') {\n      parameters.push({\n        in: staticIn ?? 'header',\n        name: 'authorization',\n        required: false,\n        schema: { type: 'string', 'x-prefix': 'Bearer ' },\n        'x-optionName': 'token',\n        example:\n          schema.scheme === 'bearer'\n            ? '\"<token>\"'\n            : `<${schema.scheme}> <token>`,\n      });\n      continue;\n    }\n    if (schema.type === 'apiKey') {\n      if (!schema.in) {\n        throw new Error(`apiKey security schema must have an \"in\" field`);\n      }\n      if (!schema.name) {\n        throw new Error(`apiKey security schema must have a \"name\" field`);\n      }\n      parameters.push({\n        in: staticIn ?? (schema.in as ParameterLocation),\n        name: schema.name,\n        required: false,\n        schema: { type: 'string' },\n        example: `\"proj-${crypto.randomUUID().slice(0, 12)}\"`,\n      });\n      continue;\n    }\n  }\n  return parameters;\n}\n\nexport function security(spec: OurOpenAPIObject) {\n  const security = spec.security || [];\n  const paths = Object.values(spec.paths ?? {});\n\n  const options = securityToOptions(\n    spec,\n    security,\n    spec.components.securitySchemes,\n  );\n\n  for (const it of paths) {\n    for (const method of methods) {\n      const operation = it[method];\n      if (!operation) {\n        continue;\n      }\n      Object.assign(\n        options,\n        securityToOptions(\n          spec,\n          operation.security || [],\n          spec.components.securitySchemes,\n          'input',\n        ),\n      );\n    }\n  }\n  return options;\n}\n"],
-  "mappings": "AASA,SAAS,eAAe;AACxB,SAAS,kBAAkB;AAYpB,SAAS,kBACd,MACAA,WACA,iBACA,UACA;AACA,QAAM,aAA6B,CAAC;AACpC,aAAW,MAAMA,WAAU;AACzB,UAAM,CAAC,IAAI,IAAI,OAAO,KAAK,EAAE;AAC7B,QAAI,CAAC,MAAM;AAET;AAAA,IACF;AAEA,UAAM,SAAS;AAAA,MACb;AAAA,MACA,gBAAgB,IAAI;AAAA,IACtB;AACA,QAAI,OAAO,SAAS,QAAQ;AAC1B,iBAAW,KAAK;AAAA,QACd,IAAI,YAAY;AAAA,QAChB,MAAM;AAAA,QACN,UAAU;AAAA,QACV,QAAQ,EAAE,MAAM,UAAU,YAAY,UAAU;AAAA,QAChD,gBAAgB;AAAA,QAChB,SACE,OAAO,WAAW,WACd,cACA,IAAI,OAAO,MAAM;AAAA,MACzB,CAAC;AACD;AAAA,IACF;AACA,QAAI,OAAO,SAAS,UAAU;AAC5B,UAAI,CAAC,OAAO,IAAI;AACd,cAAM,IAAI,MAAM,gDAAgD;AAAA,MAClE;AACA,UAAI,CAAC,OAAO,MAAM;AAChB,cAAM,IAAI,MAAM,iDAAiD;AAAA,MACnE;AACA,iBAAW,KAAK;AAAA,QACd,IAAI,YAAa,OAAO;AAAA,QACxB,MAAM,OAAO;AAAA,QACb,UAAU;AAAA,QACV,QAAQ,EAAE,MAAM,SAAS;AAAA,QACzB,SAAS,SAAS,OAAO,WAAW,EAAE,MAAM,GAAG,EAAE,CAAC;AAAA,MACpD,CAAC;AACD;AAAA,IACF;AAAA,EACF;AACA,SAAO;AACT;AAEO,SAAS,SAAS,MAAwB;AAC/C,QAAMA,YAAW,KAAK,YAAY,CAAC;AACnC,QAAM,QAAQ,OAAO,OAAO,KAAK,SAAS,CAAC,CAAC;AAE5C,QAAM,UAAU;AAAA,IACd;AAAA,IACAA;AAAA,IACA,KAAK,WAAW;AAAA,EAClB;AAEA,aAAW,MAAM,OAAO;AACtB,eAAW,UAAU,SAAS;AAC5B,YAAM,YAAY,GAAG,MAAM;AAC3B,UAAI,CAAC,WAAW;AACd;AAAA,MACF;AACA,aAAO;AAAA,QACL;AAAA,QACA;AAAA,UACE;AAAA,UACA,UAAU,YAAY,CAAC;AAAA,UACvB,KAAK,WAAW;AAAA,UAChB;AAAA,QACF;AAAA,MACF;AAAA,IACF;AAAA,EACF;AACA,SAAO;AACT;",
+  "sourcesContent": ["import type {\n  ParameterLocation,\n  ParameterObject,\n  ReferenceObject,\n  SchemaObject,\n  SecurityRequirementObject,\n  SecuritySchemeObject,\n} from 'openapi3-ts/oas31';\n\nimport { methods } from '@sdk-it/core/paths.js';\nimport { resolveRef } from '@sdk-it/core/ref.js';\n\nimport type { IR } from './types.js';\n\ntype OIn = ParameterLocation | 'input';\n\nexport type OurParameter = Omit<ParameterObject, 'in' | 'schema'> & {\n  in: OIn;\n  'x-optionName'?: string;\n  schema: SchemaObject;\n};\n\nexport function securityToOptions(\n  spec: IR,\n  security: SecurityRequirementObject[],\n  securitySchemes: Record<string, SecuritySchemeObject | ReferenceObject>,\n  staticIn?: OIn,\n) {\n  const parameters: OurParameter[] = [];\n  for (const it of security) {\n    const [name] = Object.keys(it);\n    if (!name) {\n      // this means the operation doesn't necessarily require security\n      continue;\n    }\n\n    const schema = resolveRef<SecuritySchemeObject>(\n      spec,\n      securitySchemes[name],\n    );\n    if (schema.type === 'http') {\n      parameters.push({\n        in: staticIn ?? 'header',\n        name: 'authorization',\n        required: false,\n        schema: { type: 'string', 'x-prefix': 'Bearer ' },\n        'x-optionName': 'token',\n        example:\n          schema.scheme === 'bearer'\n            ? '\"<token>\"'\n            : `<${schema.scheme}> <token>`,\n      });\n      continue;\n    }\n    if (schema.type === 'apiKey') {\n      if (!schema.in) {\n        throw new Error(`apiKey security schema must have an \"in\" field`);\n      }\n      if (!schema.name) {\n        throw new Error(`apiKey security schema must have a \"name\" field`);\n      }\n      parameters.push({\n        in: staticIn ?? (schema.in as ParameterLocation),\n        name: schema.name,\n        required: false,\n        schema: { type: 'string' },\n        example: `\"proj-${crypto.randomUUID().slice(0, 12)}\"`,\n      });\n      continue;\n    }\n  }\n  return parameters;\n}\n\nexport function security(spec: IR) {\n  const security = spec.security || [];\n  const paths = Object.values(spec.paths ?? {});\n\n  const options = securityToOptions(\n    spec,\n    security,\n    spec.components.securitySchemes,\n  );\n\n  for (const it of paths) {\n    for (const method of methods) {\n      const operation = it[method];\n      if (!operation) {\n        continue;\n      }\n      Object.assign(\n        options,\n        securityToOptions(\n          spec,\n          operation.security || [],\n          spec.components.securitySchemes,\n          'input',\n        ),\n      );\n    }\n  }\n  return options;\n}\n"],
+  "mappings": "AASA,SAAS,eAAe;AACxB,SAAS,kBAAkB;AAYpB,SAAS,kBACd,MACAA,WACA,iBACA,UACA;AACA,QAAM,aAA6B,CAAC;AACpC,aAAW,MAAMA,WAAU;AACzB,UAAM,CAAC,IAAI,IAAI,OAAO,KAAK,EAAE;AAC7B,QAAI,CAAC,MAAM;AAET;AAAA,IACF;AAEA,UAAM,SAAS;AAAA,MACb;AAAA,MACA,gBAAgB,IAAI;AAAA,IACtB;AACA,QAAI,OAAO,SAAS,QAAQ;AAC1B,iBAAW,KAAK;AAAA,QACd,IAAI,YAAY;AAAA,QAChB,MAAM;AAAA,QACN,UAAU;AAAA,QACV,QAAQ,EAAE,MAAM,UAAU,YAAY,UAAU;AAAA,QAChD,gBAAgB;AAAA,QAChB,SACE,OAAO,WAAW,WACd,cACA,IAAI,OAAO,MAAM;AAAA,MACzB,CAAC;AACD;AAAA,IACF;AACA,QAAI,OAAO,SAAS,UAAU;AAC5B,UAAI,CAAC,OAAO,IAAI;AACd,cAAM,IAAI,MAAM,gDAAgD;AAAA,MAClE;AACA,UAAI,CAAC,OAAO,MAAM;AAChB,cAAM,IAAI,MAAM,iDAAiD;AAAA,MACnE;AACA,iBAAW,KAAK;AAAA,QACd,IAAI,YAAa,OAAO;AAAA,QACxB,MAAM,OAAO;AAAA,QACb,UAAU;AAAA,QACV,QAAQ,EAAE,MAAM,SAAS;AAAA,QACzB,SAAS,SAAS,OAAO,WAAW,EAAE,MAAM,GAAG,EAAE,CAAC;AAAA,MACpD,CAAC;AACD;AAAA,IACF;AAAA,EACF;AACA,SAAO;AACT;AAEO,SAAS,SAAS,MAAU;AACjC,QAAMA,YAAW,KAAK,YAAY,CAAC;AACnC,QAAM,QAAQ,OAAO,OAAO,KAAK,SAAS,CAAC,CAAC;AAE5C,QAAM,UAAU;AAAA,IACd;AAAA,IACAA;AAAA,IACA,KAAK,WAAW;AAAA,EAClB;AAEA,aAAW,MAAM,OAAO;AACtB,eAAW,UAAU,SAAS;AAC5B,YAAM,YAAY,GAAG,MAAM;AAC3B,UAAI,CAAC,WAAW;AACd;AAAA,MACF;AACA,aAAO;AAAA,QACL;AAAA,QACA;AAAA,UACE;AAAA,UACA,UAAU,YAAY,CAAC;AAAA,UACvB,KAAK,WAAW;AAAA,UAChB;AAAA,QACF;AAAA,MACF;AAAA,IACF;AAAA,EACF;AACA,SAAO;AACT;",
   "names": ["security"]
 }

package/dist/lib/sidebar.d.ts

@@ -1,4 +1,4 @@
-import type { OurOpenAPIObject } from './types.js';
+import type { IR } from './types.js';
 export type ChildNavItem = {
     id: string;
     title: string;
@@ -23,5 +23,5 @@ export interface TagGroups {
     name: string;
     tags: string[];
 }
-export declare function toSidebar(spec: OurOpenAPIObject): SidebarData;
+export declare function toSidebar(spec: IR): SidebarData;
 //# sourceMappingURL=sidebar.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"sidebar.d.ts","sourceRoot":"","sources":["../../src/lib/sidebar.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,YAAY,CAAC;AAEnD,MAAM,MAAM,YAAY,GAAG;IACzB,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,MAAM,CAAC;IACd,GAAG,EAAE,MAAM,CAAC;CACb,CAAC;AAEF,MAAM,MAAM,OAAO,GAAG;IACpB,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,MAAM,CAAC;IACd,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,KAAK,CAAC,EAAE,YAAY,EAAE,CAAC;IACvB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF,MAAM,MAAM,YAAY,GAAG;IACzB,EAAE,EAAE,MAAM,CAAC;IACX,QAAQ,EAAE,MAAM,CAAC;IACjB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,KAAK,EAAE,OAAO,EAAE,CAAC;CAClB,CAAC;AAEF,MAAM,MAAM,WAAW,GAAG,YAAY,EAAE,CAAC;AAEzC,MAAM,WAAW,SAAS;IACxB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,EAAE,CAAC;CAChB;AAED,wBAAgB,SAAS,CAAC,IAAI,EAAE,gBAAgB,eA8B/C"}
+{"version":3,"file":"sidebar.d.ts","sourceRoot":"","sources":["../../src/lib/sidebar.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,EAAE,EAAE,MAAM,YAAY,CAAC;AAErC,MAAM,MAAM,YAAY,GAAG;IACzB,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,MAAM,CAAC;IACd,GAAG,EAAE,MAAM,CAAC;CACb,CAAC;AAEF,MAAM,MAAM,OAAO,GAAG;IACpB,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,MAAM,CAAC;IACd,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,KAAK,CAAC,EAAE,YAAY,EAAE,CAAC;IACvB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF,MAAM,MAAM,YAAY,GAAG;IACzB,EAAE,EAAE,MAAM,CAAC;IACX,QAAQ,EAAE,MAAM,CAAC;IACjB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,KAAK,EAAE,OAAO,EAAE,CAAC;CAClB,CAAC;AAEF,MAAM,MAAM,WAAW,GAAG,YAAY,EAAE,CAAC;AAEzC,MAAM,WAAW,SAAS;IACxB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,EAAE,CAAC;CAChB;AAED,wBAAgB,SAAS,CAAC,IAAI,EAAE,EAAE,eA8BjC"}

package/dist/lib/sidebar.js.map

@@ -1,7 +1,7 @@
 {
   "version": 3,
   "sources": ["../../src/lib/sidebar.ts"],
-  "sourcesContent": ["import { camelcase } from 'stringcase';\n\nimport { notNullOrUndefined } from '@sdk-it/core/file-system.js';\n\nimport { forEachOperation } from './for-each-operation.js';\nimport type { OurOpenAPIObject } from './types.js';\n\nexport type ChildNavItem = {\n  id: string;\n  title: string;\n  url: string;\n};\n\nexport type NavItem = {\n  id: string;\n  title: string;\n  description?: string;\n  url?: string;\n  items?: ChildNavItem[];\n  content?: string; // Markdown content\n};\n\nexport type CategoryItem = {\n  id: string;\n  category: string;\n  description?: string;\n  items: NavItem[];\n};\n\nexport type SidebarData = CategoryItem[];\n\nexport interface TagGroups {\n  name: string;\n  tags: string[];\n}\n\nexport function toSidebar(spec: OurOpenAPIObject) {\n  const sidebar: SidebarData = spec['x-docs'];\n  for (const tagGroup of spec['x-tagGroups']) {\n    sidebar.push({\n      id: camelcase(tagGroup.name),\n      category: tagGroup.name,\n      items: tagGroup.tags.map((tag) => {\n        const tagSpec = spec.tags?.find((t) => t.name === tag);\n        return {\n          id: crypto.randomUUID(),\n          description: tagSpec?.description,\n          title: tagSpec\n            ? tagSpec['x-displayName'] || tagSpec.name || tag\n            : tag,\n          items: forEachOperation(spec, (entry, operation) => {\n            if (operation.tags.includes(tag)) {\n              const title = operation.summary || operation.operationId;\n              return {\n                id: operation.operationId,\n                title,\n                url: `${camelcase(tag)}/${camelcase(operation.operationId)}`,\n              };\n            }\n            return null;\n          }).filter(notNullOrUndefined),\n        };\n      }),\n    });\n  }\n  return sidebar;\n}\n"],
-  "mappings": "AAAA,SAAS,iBAAiB;AAE1B,SAAS,0BAA0B;AAEnC,SAAS,wBAAwB;AAgC1B,SAAS,UAAU,MAAwB;AAChD,QAAM,UAAuB,KAAK,QAAQ;AAC1C,aAAW,YAAY,KAAK,aAAa,GAAG;AAC1C,YAAQ,KAAK;AAAA,MACX,IAAI,UAAU,SAAS,IAAI;AAAA,MAC3B,UAAU,SAAS;AAAA,MACnB,OAAO,SAAS,KAAK,IAAI,CAAC,QAAQ;AAChC,cAAM,UAAU,KAAK,MAAM,KAAK,CAAC,MAAM,EAAE,SAAS,GAAG;AACrD,eAAO;AAAA,UACL,IAAI,OAAO,WAAW;AAAA,UACtB,aAAa,SAAS;AAAA,UACtB,OAAO,UACH,QAAQ,eAAe,KAAK,QAAQ,QAAQ,MAC5C;AAAA,UACJ,OAAO,iBAAiB,MAAM,CAAC,OAAO,cAAc;AAClD,gBAAI,UAAU,KAAK,SAAS,GAAG,GAAG;AAChC,oBAAM,QAAQ,UAAU,WAAW,UAAU;AAC7C,qBAAO;AAAA,gBACL,IAAI,UAAU;AAAA,gBACd;AAAA,gBACA,KAAK,GAAG,UAAU,GAAG,CAAC,IAAI,UAAU,UAAU,WAAW,CAAC;AAAA,cAC5D;AAAA,YACF;AACA,mBAAO;AAAA,UACT,CAAC,EAAE,OAAO,kBAAkB;AAAA,QAC9B;AAAA,MACF,CAAC;AAAA,IACH,CAAC;AAAA,EACH;AACA,SAAO;AACT;",
+  "sourcesContent": ["import { camelcase } from 'stringcase';\n\nimport { notNullOrUndefined } from '@sdk-it/core/file-system.js';\n\nimport { forEachOperation } from './for-each-operation.js';\nimport type { IR } from './types.js';\n\nexport type ChildNavItem = {\n  id: string;\n  title: string;\n  url: string;\n};\n\nexport type NavItem = {\n  id: string;\n  title: string;\n  description?: string;\n  url?: string;\n  items?: ChildNavItem[];\n  content?: string; // Markdown content\n};\n\nexport type CategoryItem = {\n  id: string;\n  category: string;\n  description?: string;\n  items: NavItem[];\n};\n\nexport type SidebarData = CategoryItem[];\n\nexport interface TagGroups {\n  name: string;\n  tags: string[];\n}\n\nexport function toSidebar(spec: IR) {\n  const sidebar: SidebarData = spec['x-docs'];\n  for (const tagGroup of spec['x-tagGroups']) {\n    sidebar.push({\n      id: camelcase(tagGroup.name),\n      category: tagGroup.name,\n      items: tagGroup.tags.map((tag) => {\n        const tagSpec = spec.tags?.find((t) => t.name === tag);\n        return {\n          id: crypto.randomUUID(),\n          description: tagSpec?.description,\n          title: tagSpec\n            ? tagSpec['x-displayName'] || tagSpec.name || tag\n            : tag,\n          items: forEachOperation(spec, (entry, operation) => {\n            if (operation.tags.includes(tag)) {\n              const title = operation.summary || operation.operationId;\n              return {\n                id: operation.operationId,\n                title,\n                url: `${camelcase(tag)}/${camelcase(operation.operationId)}`,\n              };\n            }\n            return null;\n          }).filter(notNullOrUndefined),\n        };\n      }),\n    });\n  }\n  return sidebar;\n}\n"],
+  "mappings": "AAAA,SAAS,iBAAiB;AAE1B,SAAS,0BAA0B;AAEnC,SAAS,wBAAwB;AAgC1B,SAAS,UAAU,MAAU;AAClC,QAAM,UAAuB,KAAK,QAAQ;AAC1C,aAAW,YAAY,KAAK,aAAa,GAAG;AAC1C,YAAQ,KAAK;AAAA,MACX,IAAI,UAAU,SAAS,IAAI;AAAA,MAC3B,UAAU,SAAS;AAAA,MACnB,OAAO,SAAS,KAAK,IAAI,CAAC,QAAQ;AAChC,cAAM,UAAU,KAAK,MAAM,KAAK,CAAC,MAAM,EAAE,SAAS,GAAG;AACrD,eAAO;AAAA,UACL,IAAI,OAAO,WAAW;AAAA,UACtB,aAAa,SAAS;AAAA,UACtB,OAAO,UACH,QAAQ,eAAe,KAAK,QAAQ,QAAQ,MAC5C;AAAA,UACJ,OAAO,iBAAiB,MAAM,CAAC,OAAO,cAAc;AAClD,gBAAI,UAAU,KAAK,SAAS,GAAG,GAAG;AAChC,oBAAM,QAAQ,UAAU,WAAW,UAAU;AAC7C,qBAAO;AAAA,gBACL,IAAI,UAAU;AAAA,gBACd;AAAA,gBACA,KAAK,GAAG,UAAU,GAAG,CAAC,IAAI,UAAU,UAAU,WAAW,CAAC;AAAA,cAC5D;AAAA,YACF;AACA,mBAAO;AAAA,UACT,CAAC,EAAE,OAAO,kBAAkB;AAAA,QAC9B;AAAA,MACF,CAAC;AAAA,IACH,CAAC;AAAA,EACH;AACA,SAAO;AACT;",
   "names": []
 }

package/dist/lib/tune-request-body.d.ts

@@ -1,5 +1,5 @@
 import type { OperationObject, ParameterObject, SchemaObject, SecurityRequirementObject } from 'openapi3-ts/oas31';
-import type { OurOpenAPIObject, OurRequestBodyObject } from './types.js';
-export declare function patchParameters(spec: OurOpenAPIObject, schema: SchemaObject, parameters: ParameterObject[], security: SecurityRequirementObject[]): void;
-export declare function tuneRequestBody(spec: OurOpenAPIObject, operationId: string, operation: OperationObject, parameters: ParameterObject[], security: SecurityRequirementObject[]): OurRequestBodyObject;
+import type { IR, OurRequestBodyObject } from './types.js';
+export declare function patchParameters(spec: IR, schema: SchemaObject, parameters: ParameterObject[], security: SecurityRequirementObject[]): void;
+export declare function tuneRequestBody(spec: IR, operationId: string, operation: OperationObject, parameters: ParameterObject[], security: SecurityRequirementObject[]): OurRequestBodyObject;
 //# sourceMappingURL=tune-request-body.d.ts.map

package/dist/lib/tune-request-body.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"tune-request-body.d.ts","sourceRoot":"","sources":["../../src/lib/tune-request-body.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,eAAe,EACf,eAAe,EAEf,YAAY,EACZ,yBAAyB,EAC1B,MAAM,mBAAmB,CAAC;AAO3B,OAAO,KAAK,EAAE,gBAAgB,EAAE,oBAAoB,EAAE,MAAM,YAAY,CAAC;AAEzE,wBAAgB,eAAe,CAC7B,IAAI,EAAE,gBAAgB,EACtB,MAAM,EAAE,YAAY,EACpB,UAAU,EAAE,eAAe,EAAE,EAC7B,QAAQ,EAAE,yBAAyB,EAAE,QA+BtC;AAED,wBAAgB,eAAe,CAC7B,IAAI,EAAE,gBAAgB,EACtB,WAAW,EAAE,MAAM,EACnB,SAAS,EAAE,eAAe,EAC1B,UAAU,EAAE,eAAe,EAAE,EAC7B,QAAQ,EAAE,yBAAyB,EAAE,GACpC,oBAAoB,CA+DtB"}
+{"version":3,"file":"tune-request-body.d.ts","sourceRoot":"","sources":["../../src/lib/tune-request-body.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,eAAe,EACf,eAAe,EAEf,YAAY,EACZ,yBAAyB,EAC1B,MAAM,mBAAmB,CAAC;AAO3B,OAAO,KAAK,EAAE,EAAE,EAAE,oBAAoB,EAAE,MAAM,YAAY,CAAC;AAE3D,wBAAgB,eAAe,CAC7B,IAAI,EAAE,EAAE,EACR,MAAM,EAAE,YAAY,EACpB,UAAU,EAAE,eAAe,EAAE,EAC7B,QAAQ,EAAE,yBAAyB,EAAE,QA+BtC;AAED,wBAAgB,eAAe,CAC7B,IAAI,EAAE,EAAE,EACR,WAAW,EAAE,MAAM,EACnB,SAAS,EAAE,eAAe,EAC1B,UAAU,EAAE,eAAe,EAAE,EAC7B,QAAQ,EAAE,yBAAyB,EAAE,GACpC,oBAAoB,CA+DtB"}

package/dist/lib/tune-request-body.js.map

@@ -1,7 +1,7 @@
 {
   "version": 3,
   "sources": ["../../src/lib/tune-request-body.ts"],
-  "sourcesContent": ["import type {\n  OperationObject,\n  ParameterObject,\n  RequestBodyObject,\n  SchemaObject,\n  SecurityRequirementObject,\n} from 'openapi3-ts/oas31';\n\nimport { followRef, isRef } from '@sdk-it/core/ref.js';\nimport { isEmpty } from '@sdk-it/core/utils.js';\n\nimport { findUniqueSchemaName } from './find-unique-schema-name.js';\nimport { securityToOptions } from './security.js';\nimport type { OurOpenAPIObject, OurRequestBodyObject } from './types.js';\n\nexport function patchParameters(\n  spec: OurOpenAPIObject,\n  schema: SchemaObject,\n  parameters: ParameterObject[],\n  security: SecurityRequirementObject[],\n) {\n  const securityOptions = securityToOptions(\n    spec,\n    security,\n    spec.components.securitySchemes,\n  );\n\n  let required = Array.isArray(schema.required) ? schema.required : [];\n  schema['x-properties'] ??= {};\n  for (const param of parameters) {\n    if (param.required) {\n      required.push(param.name);\n    }\n    schema['x-properties'][param.name] = {\n      'x-in': param.in,\n      ...(isRef(param.schema)\n        ? followRef<SchemaObject>(spec, param.schema.$ref)\n        : (param.schema ?? { type: 'string' })),\n    };\n  }\n  for (const param of securityOptions) {\n    required = required.filter((name) => name !== param.name);\n    schema['x-properties'][param.name] = {\n      'x-in': 'header',\n      ...(isRef(param.schema)\n        ? followRef<SchemaObject>(spec, param.schema.$ref)\n        : (param.schema ?? { type: 'string' })),\n    };\n  }\n  schema['x-required'] = required;\n}\n\nexport function tuneRequestBody(\n  spec: OurOpenAPIObject,\n  operationId: string,\n  operation: OperationObject,\n  parameters: ParameterObject[],\n  security: SecurityRequirementObject[],\n): OurRequestBodyObject {\n  const inputName = findUniqueSchemaName(spec, operationId, [\n    'input',\n    'payload',\n    'request',\n  ]);\n  const requestBody = isRef(operation.requestBody)\n    ? followRef<RequestBodyObject>(spec, operation.requestBody.$ref)\n    : (operation.requestBody ?? {\n        content: {},\n        required: false,\n      });\n  if (isEmpty(requestBody.content)) {\n    const schema: SchemaObject = {\n      'x-inputname': inputName,\n      'x-requestbody': true,\n    };\n    patchParameters(spec, schema, parameters, security);\n    const tuned: OurRequestBodyObject = {\n      ...requestBody,\n      content: {\n        'application/empty': {\n          schema: { $ref: `#/components/schemas/${inputName}` },\n        },\n      },\n    };\n\n    spec.components.schemas[inputName] = schema;\n    return tuned;\n  }\n  for (const contentType in requestBody.content) {\n    const mediaType = requestBody.content[contentType];\n    let schema: SchemaObject | undefined;\n\n    switch (true) {\n      case isRef(mediaType.schema):\n        schema = followRef<SchemaObject>(spec, mediaType.schema.$ref);\n        // we cannot use the model name as inputName as it might be used in other places that are not request bodies\n        // inputName = parseRef(mediaType.schema.$ref).model;\n        break;\n      case isEmpty(mediaType.schema):\n        schema ??= {}; // default to empty schema if not defined\n        console.warn(\n          `Request body schema for content type \"${contentType}\" is empty.`,\n        );\n        break;\n      default:\n        schema = mediaType.schema;\n        break;\n    }\n\n    patchParameters(spec, schema, parameters, security);\n    spec.components.schemas[inputName] = {\n      ...schema,\n      'x-requestbody': true,\n      'x-inputname': inputName,\n    };\n\n    requestBody.content[contentType].schema = {\n      $ref: `#/components/schemas/${inputName}`,\n    };\n  }\n  return requestBody as OurRequestBodyObject;\n}\n"],
+  "sourcesContent": ["import type {\n  OperationObject,\n  ParameterObject,\n  RequestBodyObject,\n  SchemaObject,\n  SecurityRequirementObject,\n} from 'openapi3-ts/oas31';\n\nimport { followRef, isRef } from '@sdk-it/core/ref.js';\nimport { isEmpty } from '@sdk-it/core/utils.js';\n\nimport { findUniqueSchemaName } from './find-unique-schema-name.js';\nimport { securityToOptions } from './security.js';\nimport type { IR, OurRequestBodyObject } from './types.js';\n\nexport function patchParameters(\n  spec: IR,\n  schema: SchemaObject,\n  parameters: ParameterObject[],\n  security: SecurityRequirementObject[],\n) {\n  const securityOptions = securityToOptions(\n    spec,\n    security,\n    spec.components.securitySchemes,\n  );\n\n  let required = Array.isArray(schema.required) ? schema.required : [];\n  schema['x-properties'] ??= {};\n  for (const param of parameters) {\n    if (param.required) {\n      required.push(param.name);\n    }\n    schema['x-properties'][param.name] = {\n      'x-in': param.in,\n      ...(isRef(param.schema)\n        ? followRef<SchemaObject>(spec, param.schema.$ref)\n        : (param.schema ?? { type: 'string' })),\n    };\n  }\n  for (const param of securityOptions) {\n    required = required.filter((name) => name !== param.name);\n    schema['x-properties'][param.name] = {\n      'x-in': 'header',\n      ...(isRef(param.schema)\n        ? followRef<SchemaObject>(spec, param.schema.$ref)\n        : (param.schema ?? { type: 'string' })),\n    };\n  }\n  schema['x-required'] = required;\n}\n\nexport function tuneRequestBody(\n  spec: IR,\n  operationId: string,\n  operation: OperationObject,\n  parameters: ParameterObject[],\n  security: SecurityRequirementObject[],\n): OurRequestBodyObject {\n  const inputName = findUniqueSchemaName(spec, operationId, [\n    'input',\n    'payload',\n    'request',\n  ]);\n  const requestBody = isRef(operation.requestBody)\n    ? followRef<RequestBodyObject>(spec, operation.requestBody.$ref)\n    : (operation.requestBody ?? {\n        content: {},\n        required: false,\n      });\n  if (isEmpty(requestBody.content)) {\n    const schema: SchemaObject = {\n      'x-inputname': inputName,\n      'x-requestbody': true,\n    };\n    patchParameters(spec, schema, parameters, security);\n    const tuned: OurRequestBodyObject = {\n      ...requestBody,\n      content: {\n        'application/empty': {\n          schema: { $ref: `#/components/schemas/${inputName}` },\n        },\n      },\n    };\n\n    spec.components.schemas[inputName] = schema;\n    return tuned;\n  }\n  for (const contentType in requestBody.content) {\n    const mediaType = requestBody.content[contentType];\n    let schema: SchemaObject | undefined;\n\n    switch (true) {\n      case isRef(mediaType.schema):\n        schema = followRef<SchemaObject>(spec, mediaType.schema.$ref);\n        // we cannot use the model name as inputName as it might be used in other places that are not request bodies\n        // inputName = parseRef(mediaType.schema.$ref).model;\n        break;\n      case isEmpty(mediaType.schema):\n        schema ??= {}; // default to empty schema if not defined\n        console.warn(\n          `Request body schema for content type \"${contentType}\" is empty.`,\n        );\n        break;\n      default:\n        schema = mediaType.schema;\n        break;\n    }\n\n    patchParameters(spec, schema, parameters, security);\n    spec.components.schemas[inputName] = {\n      ...schema,\n      'x-requestbody': true,\n      'x-inputname': inputName,\n    };\n\n    requestBody.content[contentType].schema = {\n      $ref: `#/components/schemas/${inputName}`,\n    };\n  }\n  return requestBody as OurRequestBodyObject;\n}\n"],
   "mappings": "AAQA,SAAS,WAAW,aAAa;AACjC,SAAS,eAAe;AAExB,SAAS,4BAA4B;AACrC,SAAS,yBAAyB;AAG3B,SAAS,gBACd,MACA,QACA,YACA,UACA;AACA,QAAM,kBAAkB;AAAA,IACtB;AAAA,IACA;AAAA,IACA,KAAK,WAAW;AAAA,EAClB;AAEA,MAAI,WAAW,MAAM,QAAQ,OAAO,QAAQ,IAAI,OAAO,WAAW,CAAC;AACnE,SAAO,cAAc,MAAM,CAAC;AAC5B,aAAW,SAAS,YAAY;AAC9B,QAAI,MAAM,UAAU;AAClB,eAAS,KAAK,MAAM,IAAI;AAAA,IAC1B;AACA,WAAO,cAAc,EAAE,MAAM,IAAI,IAAI;AAAA,MACnC,QAAQ,MAAM;AAAA,MACd,GAAI,MAAM,MAAM,MAAM,IAClB,UAAwB,MAAM,MAAM,OAAO,IAAI,IAC9C,MAAM,UAAU,EAAE,MAAM,SAAS;AAAA,IACxC;AAAA,EACF;AACA,aAAW,SAAS,iBAAiB;AACnC,eAAW,SAAS,OAAO,CAAC,SAAS,SAAS,MAAM,IAAI;AACxD,WAAO,cAAc,EAAE,MAAM,IAAI,IAAI;AAAA,MACnC,QAAQ;AAAA,MACR,GAAI,MAAM,MAAM,MAAM,IAClB,UAAwB,MAAM,MAAM,OAAO,IAAI,IAC9C,MAAM,UAAU,EAAE,MAAM,SAAS;AAAA,IACxC;AAAA,EACF;AACA,SAAO,YAAY,IAAI;AACzB;AAEO,SAAS,gBACd,MACA,aACA,WACA,YACA,UACsB;AACtB,QAAM,YAAY,qBAAqB,MAAM,aAAa;AAAA,IACxD;AAAA,IACA;AAAA,IACA;AAAA,EACF,CAAC;AACD,QAAM,cAAc,MAAM,UAAU,WAAW,IAC3C,UAA6B,MAAM,UAAU,YAAY,IAAI,IAC5D,UAAU,eAAe;AAAA,IACxB,SAAS,CAAC;AAAA,IACV,UAAU;AAAA,EACZ;AACJ,MAAI,QAAQ,YAAY,OAAO,GAAG;AAChC,UAAM,SAAuB;AAAA,MAC3B,eAAe;AAAA,MACf,iBAAiB;AAAA,IACnB;AACA,oBAAgB,MAAM,QAAQ,YAAY,QAAQ;AAClD,UAAM,QAA8B;AAAA,MAClC,GAAG;AAAA,MACH,SAAS;AAAA,QACP,qBAAqB;AAAA,UACnB,QAAQ,EAAE,MAAM,wBAAwB,SAAS,GAAG;AAAA,QACtD;AAAA,MACF;AAAA,IACF;AAEA,SAAK,WAAW,QAAQ,SAAS,IAAI;AACrC,WAAO;AAAA,EACT;AACA,aAAW,eAAe,YAAY,SAAS;AAC7C,UAAM,YAAY,YAAY,QAAQ,WAAW;AACjD,QAAI;AAEJ,YAAQ,MAAM;AAAA,MACZ,KAAK,MAAM,UAAU,MAAM;AACzB,iBAAS,UAAwB,MAAM,UAAU,OAAO,IAAI;AAG5D;AAAA,MACF,KAAK,QAAQ,UAAU,MAAM;AAC3B,mBAAW,CAAC;AACZ,gBAAQ;AAAA,UACN,yCAAyC,WAAW;AAAA,QACtD;AACA;AAAA,MACF;AACE,iBAAS,UAAU;AACnB;AAAA,IACJ;AAEA,oBAAgB,MAAM,QAAQ,YAAY,QAAQ;AAClD,SAAK,WAAW,QAAQ,SAAS,IAAI;AAAA,MACnC,GAAG;AAAA,MACH,iBAAiB;AAAA,MACjB,eAAe;AAAA,IACjB;AAEA,gBAAY,QAAQ,WAAW,EAAE,SAAS;AAAA,MACxC,MAAM,wBAAwB,SAAS;AAAA,IACzC;AAAA,EACF;AACA,SAAO;AACT;",
   "names": []
 }