fumadocs-openapi 2.0.1 → 2.0.3

package/dist/index.js

@@ -11,8 +11,7 @@ function createElement(name, props, ...child) {
   return s.join("\n\n");
 }
 function p(child) {
-  if (!child)
-    return "";
+  if (!child) return "";
   return child.replace("<", "\\<").replace(">", "\\>");
 }
 function span(child) {
@@ -67,10 +66,8 @@ function noRef(v) {
   return v;
 }
 function getPreferredMedia(body) {
-  if (Object.keys(body).length === 0)
-    return void 0;
-  if ("application/json" in body)
-    return body["application/json"];
+  if (Object.keys(body).length === 0) return void 0;
+  if ("application/json" in body) return body["application/json"];
   return Object.values(body)[0];
 }
 function getValue(value) {
@@ -85,8 +82,7 @@ function createEndpoint(path, method, baseUrl = "https://example.com") {
     const schema = noRef(
       param.schema ?? getPreferredMedia(param.content ?? {})?.schema
     );
-    if (!schema)
-      continue;
+    if (!schema) continue;
     params.push({
       name: param.name,
       in: param.in,
@@ -98,8 +94,7 @@ function createEndpoint(path, method, baseUrl = "https://example.com") {
   for (const [code, value] of Object.entries(method.responses)) {
     const mediaTypes = noRef(value).content ?? {};
     const responseSchema = noRef(getPreferredMedia(mediaTypes)?.schema);
-    if (!responseSchema)
-      continue;
+    if (!responseSchema) continue;
     responses[code] = {
       schema: responseSchema
     };
@@ -108,8 +103,7 @@ function createEndpoint(path, method, baseUrl = "https://example.com") {
   const queryParams = new URLSearchParams();
   for (const param of params) {
     const value = generateSample(method.method, param.schema);
-    if (param.in === "query")
-      queryParams.append(param.name, getValue(value));
+    if (param.in === "query") queryParams.append(param.name, getValue(value));
     if (param.in === "path")
       pathWithParameters = pathWithParameters.replace(
         `{${param.name}}`,
@@ -169,8 +163,7 @@ function getSampleRequest(endpoint) {
       console.log("Request example for form data is not supported");
     }
   }
-  if (endpoint.body)
-    s.push(`-d '${getValue2(endpoint.body)}'`);
+  if (endpoint.body) s.push(`-d '${getValue2(endpoint.body)}'`);
   return s.join(" \\\n  ");
 }
 function getValue2(value) {
@@ -192,10 +185,8 @@ function isObject(schema) {
   return schema.type === "object" || schema.properties !== void 0;
 }
 function schemaElement(name, schema, { parseObject, ...ctx }) {
-  if (schema.readOnly && !ctx.readOnly)
-    return "";
-  if (schema.writeOnly && !ctx.writeOnly)
-    return "";
+  if (schema.readOnly && !ctx.readOnly) return "";
+  if (schema.writeOnly && !ctx.writeOnly) return "";
   const child = [];
   function field(key, value) {
     child.push(span(`${key}:  \`${value}\``));
@@ -269,14 +260,14 @@ function schemaElement(name, schema, { parseObject, ...ctx }) {
   );
 }
 function resolveObjectType(schema) {
-  if (isObject(schema))
-    return schema;
+  if (isObject(schema)) return schema;
   if (schema.type === "array") {
     return resolveObjectType(noRef(schema.items));
   }
 }
 function getSchemaType(schema) {
   if (schema.nullable) {
+    if (!schema.type) return "null";
     return `${getSchemaType({ ...schema, nullable: false })} | null`;
   }
   if (schema.type === "array")
@@ -287,10 +278,8 @@ function getSchemaType(schema) {
     return schema.allOf.map((one) => getSchemaType(noRef(one))).join(" & ");
   if (schema.anyOf)
     return `Any properties in ${schema.anyOf.map((one) => getSchemaType(noRef(one))).join(", ")}`;
-  if (schema.type)
-    return schema.type;
-  if (isObject(schema))
-    return "object";
+  if (schema.type) return schema.type;
+  if (isObject(schema)) return "object";
   throw new Error(`Cannot detect object type: ${JSON.stringify(schema)}`);
 }
 
@@ -299,15 +288,12 @@ async function renderOperation(path, method, baseUrl) {
   const info = [];
   const example = [];
   const title = method.summary ?? method.operationId;
-  if (title)
-    info.push(`## ${title}`);
-  if (method.description)
-    info.push(p(method.description));
+  if (title) info.push(`## ${title}`);
+  if (method.description) info.push(p(method.description));
   const body = noRef(method.requestBody);
   if (body) {
     const bodySchema = getPreferredMedia(body.content)?.schema;
-    if (!bodySchema)
-      throw new Error();
+    if (!bodySchema) throw new Error();
     info.push(
       `### Request Body${!body.required ? " (Optional)" : ""}`,
       p(body.description),
@@ -325,8 +311,7 @@ async function renderOperation(path, method, baseUrl) {
     const schema = noRef(
       param.schema ?? getPreferredMedia(param.content ?? {})?.schema
     );
-    if (!schema)
-      continue;
+    if (!schema) continue;
     const content = schemaElement(
       param.name,
       {
@@ -397,8 +382,7 @@ async function getResponseTabs(endpoint, operation) {
       );
     }
   }
-  if (items.length === 0)
-    return "";
+  if (items.length === 0) return "";
   return tabs(
     {
       items
@@ -416,16 +400,20 @@ async function generate(pathOrDocument, options = {}) {
   const tag = options.tag ? document.tags?.find((item) => item.name === options.tag) : void 0;
   const routes = Object.entries(document.paths).map(
     ([key, value]) => {
-      if (!value)
-        throw new Error("Invalid schema");
-      const methodKeys = ["get", "post", "patch", "delete", "head"];
+      if (!value) throw new Error("Invalid schema");
+      const methodKeys = [
+        "get",
+        "post",
+        "patch",
+        "delete",
+        "head",
+        "put"
+      ];
       const methods = [];
       for (const methodKey of methodKeys) {
         const operation = value[methodKey];
-        if (!operation)
-          continue;
-        if (tag && !operation.tags?.includes(tag.name))
-          continue;
+        if (!operation) continue;
+        if (tag && !operation.tags?.includes(tag.name)) continue;
         methods.push(buildOperation(methodKey, operation));
       }
       return {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "fumadocs-openapi",
-  "version": "2.0.1",
+  "version": "2.0.3",
   "description": "Generate MDX docs for your OpenAPI spec",
   "keywords": [
     "NextJs",
@@ -17,9 +17,9 @@
     "dist"
   ],
   "dependencies": {
-    "@apidevtools/json-schema-ref-parser": "^11.6.1",
+    "@apidevtools/json-schema-ref-parser": "^11.6.4",
     "fast-glob": "^3.3.1",
-    "json-schema-to-typescript": "^14.0.4",
+    "json-schema-to-typescript": "^14.0.5",
     "openapi-sampler": "^1.5.1"
   },
   "devDependencies": {