fumadocs-openapi 5.11.1 → 5.11.3

package/dist/index.d.ts

@@ -73,7 +73,6 @@ interface ResponseProps {
 interface APIInfoProps {
     method: string;
     route: string;
-    baseUrls: string[];
     head: ReactNode;
     children: ReactNode;
 }
@@ -100,6 +99,7 @@ interface ResponseTypeProps {
 }
 interface RootProps {
     baseUrl?: string;
+    servers: ServerObject[];
     children: ReactNode;
 }
 interface Renderer {
@@ -178,12 +178,7 @@ type SecuritySchemeObject = OpenAPIV3_1.SecuritySchemeObject;
 type ReferenceObject = OpenAPIV3_1.ReferenceObject;
 type PathItemObject = OpenAPIV3_1.PathItemObject;
 type TagObject = OpenAPIV3_1.TagObject;
-interface RouteInformation {
-    path: string;
-    summary?: string;
-    description?: string;
-    methods: MethodInformation[];
-}
+type ServerObject = NoReference<OpenAPIV3_1.ServerObject>;
 type MethodInformation = NoReference<OperationObject> & {
     method: string;
 };
@@ -203,7 +198,7 @@ interface RenderContext {
      */
     document: NoReference<Document>;
     baseUrl: string;
-    baseUrls: string[];
+    servers: ServerObject[];
     slugger: Slugger;
     dereferenceMap: DereferenceMap;
     /**
@@ -322,4 +317,4 @@ interface Config extends GenerateOptions {
 }
 declare function generateFiles(options: Config): Promise<void>;
 
-export { type Config, type DereferenceMap, type Document, type GenerateOptions, type GeneratePageOutput, type GenerateTagOutput, type MethodInformation, type OperationObject, type ParameterObject, type PathItemObject, type ReferenceObject, type RenderContext, type RouteInformation, type SecurityRequirementObject, type SecuritySchemeObject, type TagObject, generateAll, generateFiles, generatePages, generateTags };
+export { type Config, type DereferenceMap, type Document, type GenerateOptions, type GeneratePageOutput, type GenerateTagOutput, type MethodInformation, type OperationObject, type ParameterObject, type PathItemObject, type ReferenceObject, type RenderContext, type SecurityRequirementObject, type SecuritySchemeObject, type ServerObject, type TagObject, generateAll, generateFiles, generatePages, generateTags };

package/dist/server/index.d.ts

@@ -75,7 +75,6 @@ interface ResponseProps {
 interface APIInfoProps {
     method: string;
     route: string;
-    baseUrls: string[];
     head: ReactNode;
     children: ReactNode;
 }
@@ -102,6 +101,7 @@ interface ResponseTypeProps {
 }
 interface RootProps {
     baseUrl?: string;
+    servers: ServerObject[];
     children: ReactNode;
 }
 interface Renderer {
@@ -174,6 +174,7 @@ interface CodeSample {
 
 type Document = OpenAPIV3_1.Document;
 type ReferenceObject = OpenAPIV3_1.ReferenceObject;
+type ServerObject = NoReference<OpenAPIV3_1.ServerObject>;
 type Awaitable<T> = T | Promise<T>;
 /**
  * Dereferenced value and its original `$ref` value
@@ -190,7 +191,7 @@ interface RenderContext {
      */
     document: NoReference<Document>;
     baseUrl: string;
-    baseUrls: string[];
+    servers: ServerObject[];
     slugger: Slugger;
     dereferenceMap: DereferenceMap;
     /**

package/dist/server/index.js

@@ -24,26 +24,6 @@ function getPreferredType(body) {
     if ('application/json' in body) return 'application/json';
     return Object.keys(body)[0];
 }
-/**
- * Convert input to string (with quotes)
- */ function inputToString(value, mediaType = 'application/json', multiLine = 'none') {
-    const getStr = (v)=>{
-        if (multiLine === 'none') return JSON.stringify(v);
-        const delimit = multiLine === 'backtick' ? `\`` : `'`;
-        return `${delimit}${v.replaceAll(delimit, `\\${delimit}`)}${delimit}`;
-    };
-    if (typeof value === 'string') return getStr(value);
-    if (mediaType === 'application/json' || mediaType === 'multipart/form-data') {
-        return getStr(JSON.stringify(value, null, 2));
-    }
-    if (mediaType === 'application/xml') {
-        return getStr(js2xml(value, {
-            compact: true,
-            spaces: 2
-        }));
-    }
-    throw new Error(`Unsupported media type: ${mediaType}`);
-}
 function isNullable(schema, includeOneOf = true) {
     if (Array.isArray(schema.type) && schema.type.includes('null')) return true;
     if (includeOneOf && (schema.anyOf || schema.oneOf)) {
@@ -159,6 +139,27 @@ function generateBody(method, schema) {
     });
 }
 
+/**
+ * Convert input value to hardcoded string (with quotes)
+ */ function inputToString(value, mediaType = 'application/json', multiLine = 'none') {
+    const getStr = (v)=>{
+        if (multiLine === 'none') return JSON.stringify(v);
+        const delimit = multiLine === 'backtick' ? `\`` : `'`;
+        return `${delimit}${v.replaceAll(delimit, `\\${delimit}`)}${delimit}`;
+    };
+    if (typeof value === 'string') return getStr(value);
+    if (mediaType === 'application/json' || mediaType === 'multipart/form-data') {
+        return getStr(JSON.stringify(value, null, 2));
+    }
+    if (mediaType === 'application/xml') {
+        return getStr(js2xml(value, {
+            compact: true,
+            spaces: 2
+        }));
+    }
+    throw new Error(`Unsupported media type: ${mediaType}`);
+}
+
 function getSampleRequest$3(endpoint) {
     const s = [];
     s.push(`curl -X ${endpoint.method} "${endpoint.url}"`);
@@ -791,7 +792,6 @@ const methodKeys = [
 ];
 
 function Operation({ type = 'operation', path, method, ctx, hasHead, headingLevel = 2 }) {
-    const { baseUrls } = ctx;
     const body = method.requestBody;
     const security = method.security ?? ctx.document.security;
     let headNode = null;
@@ -906,7 +906,6 @@ function Operation({ type = 'operation', path, method, ctx, hasHead, headingLeve
         head: headNode,
         method: method.method,
         route: path,
-        baseUrls: type === 'operation' ? baseUrls : [],
         children: [
             type === 'operation' ? /*#__PURE__*/ jsx(Playground, {
                 path: path,
@@ -1252,6 +1251,14 @@ const cache = new Map();
     return processed;
 }
 
+function getUrl(url, variables) {
+    let out = url;
+    for (const [key, value] of Object.entries(variables)){
+        out = out.replaceAll(`{${key}}`, value);
+    }
+    return out;
+}
+
 async function APIPage(props) {
     const { operations, hasHead = true, webhooks, disableCache = process.env.NODE_ENV === 'development' } = props;
     const processed = await processDocument(props.document, disableCache);
@@ -1259,6 +1266,7 @@ async function APIPage(props) {
     const { document } = processed;
     return /*#__PURE__*/ jsxs(ctx.renderer.Root, {
         baseUrl: ctx.baseUrl,
+        servers: ctx.servers,
         children: [
             operations?.map((item)=>{
                 const pathItem = document.paths?.[item.path];
@@ -1294,6 +1302,12 @@ async function APIPage(props) {
     });
 }
 async function getContext({ document, dereferenceMap }, options = {}) {
+    const servers = document.servers && document.servers.length > 0 ? document.servers : [
+        {
+            url: 'https://example.com'
+        }
+    ];
+    const server = servers[0];
     return {
         document: document,
         dereferenceMap,
@@ -1305,8 +1319,11 @@ async function getContext({ document, dereferenceMap }, options = {}) {
         shikiOptions: options.shikiOptions,
         generateTypeScriptSchema: options.generateTypeScriptSchema,
         generateCodeSamples: options.generateCodeSamples,
-        baseUrl: document.servers?.[0].url ?? 'https://example.com',
-        baseUrls: document.servers?.map((s)=>s.url) ?? [],
+        baseUrl: getUrl(server.url, server.variables ? Object.fromEntries(Object.entries(server.variables).map(([k, v])=>[
+                k,
+                v.default
+            ])) : {}),
+        servers,
         slugger: new Slugger()
     };
 }