hono-openapi 1.3.2 → 1.3.3

package/dist/index.cjs

@@ -56,9 +56,9 @@ function mergeParameters(...params) {
   return Array.from(merged.values());
 }
 const specsByPathContext = /* @__PURE__ */ new Map();
-function getPathContext(path) {
+function getPathContext(path, pathContext) {
   const context = [];
-  for (const [key, data] of specsByPathContext) {
+  for (const [key, data] of pathContext) {
     if (!data) continue;
     const prefix = key.endsWith("/*") ? key.slice(0, -2) : key;
     if (path === prefix || path.startsWith(`${prefix}/`)) {
@@ -70,6 +70,19 @@ function getPathContext(path) {
 function clearSpecsContext() {
   specsByPathContext.clear();
 }
+function mergeRequestBodies(previous, current) {
+  if (!previous || !current || "$ref" in previous || "$ref" in current) {
+    return current;
+  }
+  return {
+    ...previous,
+    ...current,
+    content: {
+      ...previous.content,
+      ...current.content
+    }
+  };
+}
 function mergeSpecs(route, ...specs) {
   return specs.reduce(
     (prev, spec) => {
@@ -91,6 +104,11 @@ function mergeSpecs(route, ...specs) {
           } else {
             if (key === "parameters") {
               prev[key] = mergeParameters(prev[key], value);
+            } else if (key === "requestBody") {
+              prev.requestBody = mergeRequestBodies(
+                prev.requestBody,
+                value
+              );
             } else {
               prev[key] = {
                 ...prev[key],
@@ -109,30 +127,26 @@ function mergeSpecs(route, ...specs) {
     }
   );
 }
-function registerSchemaPath({
-  route,
-  specs,
-  paths
-}) {
+function registerSchemaPath({ route, specs, paths }, pathContext = specsByPathContext) {
   const path = toOpenAPIPath(route.path);
   const method = route.method.toLowerCase();
   if (method === "all") {
     if (!specs) return;
-    if (specsByPathContext.has(path)) {
-      const prev = specsByPathContext.get(path) ?? {};
-      specsByPathContext.set(path, mergeSpecs(route, prev, specs));
+    if (pathContext.has(path)) {
+      const prev = pathContext.get(path) ?? {};
+      pathContext.set(path, mergeSpecs(route, prev, specs));
     } else {
-      specsByPathContext.set(path, specs);
+      pathContext.set(path, specs);
     }
   } else {
-    const pathContext = getPathContext(path);
+    const context = getPathContext(path, pathContext);
     if (!(path in paths)) {
       paths[path] = {};
     }
     if (paths[path]) {
       paths[path][method] = mergeSpecs(
         route,
-        ...pathContext,
+        ...context,
         paths[path]?.[method],
         specs
       );
@@ -277,7 +291,6 @@ async function generateSpecs(hono, options = DEFAULT_OPTIONS, c) {
     ..._documentation,
     components: _documentation.components && { ..._documentation.components }
   };
-  clearSpecsContext();
   const paths = await generatePaths(hono, ctx);
   for (const path in paths) {
     for (const method in paths[path]) {
@@ -322,14 +335,18 @@ async function generateSpecs(hono, options = DEFAULT_OPTIONS, c) {
 }
 async function generatePaths(hono, ctx) {
   const paths = {};
+  const pathContext = /* @__PURE__ */ new Map();
   for (const route of hono.routes) {
     const middlewareHandler = handler.findTargetHandler(route.handler)[uniqueSymbol];
     if (!middlewareHandler) {
       if (ctx.options.includeEmptyPaths) {
-        registerSchemaPath({
-          route,
-          paths
-        });
+        registerSchemaPath(
+          {
+            route,
+            paths
+          },
+          pathContext
+        );
       }
       continue;
     }
@@ -345,14 +362,18 @@ async function generatePaths(hono, ctx) {
     const defaultOptionsForThisMethod = ctx.options.defaultOptions?.[routeMethod] && { ...ctx.options.defaultOptions[routeMethod] };
     const { schema: routeSpecs, components = {} } = await getSpec(
       middlewareHandler,
-      defaultOptionsForThisMethod
+      defaultOptionsForThisMethod,
+      ctx.components.parameters
     );
     ctx.components = mergeComponentsObjects(ctx.components, components);
-    registerSchemaPath({
-      route,
-      specs: routeSpecs,
-      paths
-    });
+    registerSchemaPath(
+      {
+        route,
+        specs: routeSpecs,
+        paths
+      },
+      pathContext
+    );
   }
   return paths;
 }
@@ -368,7 +389,7 @@ function getHiddenValue(options) {
   }
   return false;
 }
-async function getSpec(middlewareHandler, defaultOptions) {
+async function getSpec(middlewareHandler, defaultOptions, parameterComponents) {
   if ("spec" in middlewareHandler) {
     const tmp = {
       ...defaultOptions,
@@ -403,7 +424,7 @@ async function getSpec(middlewareHandler, defaultOptions) {
     [VALIDATION_MARKER]: true
   };
   if (middlewareHandler.target === "form" || middlewareHandler.target === "json") {
-    const media = middlewareHandler.options?.media ?? middlewareHandler.target === "json" ? "application/json" : "multipart/form-data";
+    const media = middlewareHandler.options?.media ?? (middlewareHandler.target === "json" ? "application/json" : "multipart/form-data");
     if (!docs.requestBody || !("content" in docs.requestBody) || !docs.requestBody.content) {
       docs.requestBody = {
         required: true,
@@ -425,18 +446,21 @@ async function getSpec(middlewareHandler, defaultOptions) {
       const pos = ref.split("/").pop();
       if (pos && result.components?.schemas?.[pos]) {
         const schema = result.components.schemas[pos];
-        const newParameters = generateParameters(
+        const generatedParameters = generateParameters(
           middlewareHandler.target,
-          schema
-        )[0];
-        if (!result.components.parameters) {
-          result.components.parameters = {};
+          schema,
+          result.components.schemas
+        );
+        const singleParameter = generatedParameters.length === 1 ? generatedParameters[0] : void 0;
+        const existingParameter = parameterComponents?.[pos];
+        if (singleParameter && (!existingParameter || "in" in existingParameter && existingParameter.in === singleParameter.in && existingParameter.name === singleParameter.name)) {
+          result.components.parameters ??= {};
+          result.components.parameters[pos] = singleParameter;
+          parameters.push({ $ref: `#/components/parameters/${pos}` });
+          delete result.components.schemas[pos];
+        } else {
+          parameters = generatedParameters;
         }
-        result.components.parameters[pos] = newParameters;
-        delete result.components.schemas[pos];
-        parameters.push({
-          $ref: `#/components/parameters/${pos}`
-        });
       }
     } else {
       parameters = generateParameters(

package/dist/index.d.cts

@@ -1,5 +1,6 @@
 import * as openapi_types from 'openapi-types';
 import { OpenAPIV3_1 } from 'openapi-types';
+import * as hono from 'hono';
 import { Env, Input, Context, Next, MiddlewareHandler, ValidationTargets, Hono } from 'hono';
 import { TypedResponse, RouterRoute, ValidationTargets as ValidationTargets$1, BlankEnv, Input as Input$1, BlankInput, Schema, BlankSchema, MiddlewareHandler as MiddlewareHandler$1 } from 'hono/types';
 import { loadVendor as loadVendor$2, ToOpenAPISchemaContext } from '@standard-community/standard-openapi';
@@ -84,7 +85,20 @@ declare const VALIDATION_MARKER = "__HonoOpenAPIValidator__";
 declare const ALLOWED_METHODS: readonly ["GET", "PUT", "POST", "DELETE", "OPTIONS", "HEAD", "PATCH", "TRACE"];
 type AllowedMethods = (typeof ALLOWED_METHODS)[number];
 declare function clearSpecsContext(): void;
-declare function registerSchemaPath({ route, specs, paths, }: RegisterSchemaPathOptions): void;
+declare function registerSchemaPath({ route, specs, paths }: RegisterSchemaPathOptions, pathContext?: Map<string, Omit<OpenAPIV3_1.OperationObject<{}>, "operationId" | "requestBody" | "responses"> & {
+    operationId?: string | ((route: RouterRoute) => string);
+    requestBody?: OpenAPIV3_1.ReferenceObject | (Omit<OpenAPIV3_1.RequestBodyObject, "content"> & {
+        content: ContentWithResolver;
+    });
+    hide?: boolean | ((props: {
+        c?: hono.Context;
+        method: string;
+        path: string;
+    }) => boolean);
+    responses?: ResponsesWithResolver;
+} & {
+    operationId?: string | ((route: RouterRoute) => string);
+}>): void;
 declare function removeExcludedPaths(paths: OpenAPIV3_1.PathsObject, ctx: SpecContext): OpenAPIV3_1.PathsObject<{}, {}>;
 
 type PromiseOr<T> = T | Promise<T>;

package/dist/index.d.ts

@@ -1,5 +1,6 @@
 import * as openapi_types from 'openapi-types';
 import { OpenAPIV3_1 } from 'openapi-types';
+import * as hono from 'hono';
 import { Env, Input, Context, Next, MiddlewareHandler, ValidationTargets, Hono } from 'hono';
 import { TypedResponse, RouterRoute, ValidationTargets as ValidationTargets$1, BlankEnv, Input as Input$1, BlankInput, Schema, BlankSchema, MiddlewareHandler as MiddlewareHandler$1 } from 'hono/types';
 import { loadVendor as loadVendor$2, ToOpenAPISchemaContext } from '@standard-community/standard-openapi';
@@ -84,7 +85,20 @@ declare const VALIDATION_MARKER = "__HonoOpenAPIValidator__";
 declare const ALLOWED_METHODS: readonly ["GET", "PUT", "POST", "DELETE", "OPTIONS", "HEAD", "PATCH", "TRACE"];
 type AllowedMethods = (typeof ALLOWED_METHODS)[number];
 declare function clearSpecsContext(): void;
-declare function registerSchemaPath({ route, specs, paths, }: RegisterSchemaPathOptions): void;
+declare function registerSchemaPath({ route, specs, paths }: RegisterSchemaPathOptions, pathContext?: Map<string, Omit<OpenAPIV3_1.OperationObject<{}>, "operationId" | "requestBody" | "responses"> & {
+    operationId?: string | ((route: RouterRoute) => string);
+    requestBody?: OpenAPIV3_1.ReferenceObject | (Omit<OpenAPIV3_1.RequestBodyObject, "content"> & {
+        content: ContentWithResolver;
+    });
+    hide?: boolean | ((props: {
+        c?: hono.Context;
+        method: string;
+        path: string;
+    }) => boolean);
+    responses?: ResponsesWithResolver;
+} & {
+    operationId?: string | ((route: RouterRoute) => string);
+}>): void;
 declare function removeExcludedPaths(paths: OpenAPIV3_1.PathsObject, ctx: SpecContext): OpenAPIV3_1.PathsObject<{}, {}>;
 
 type PromiseOr<T> = T | Promise<T>;

package/dist/index.js

@@ -54,9 +54,9 @@ function mergeParameters(...params) {
   return Array.from(merged.values());
 }
 const specsByPathContext = /* @__PURE__ */ new Map();
-function getPathContext(path) {
+function getPathContext(path, pathContext) {
   const context = [];
-  for (const [key, data] of specsByPathContext) {
+  for (const [key, data] of pathContext) {
     if (!data) continue;
     const prefix = key.endsWith("/*") ? key.slice(0, -2) : key;
     if (path === prefix || path.startsWith(`${prefix}/`)) {
@@ -68,6 +68,19 @@ function getPathContext(path) {
 function clearSpecsContext() {
   specsByPathContext.clear();
 }
+function mergeRequestBodies(previous, current) {
+  if (!previous || !current || "$ref" in previous || "$ref" in current) {
+    return current;
+  }
+  return {
+    ...previous,
+    ...current,
+    content: {
+      ...previous.content,
+      ...current.content
+    }
+  };
+}
 function mergeSpecs(route, ...specs) {
   return specs.reduce(
     (prev, spec) => {
@@ -89,6 +102,11 @@ function mergeSpecs(route, ...specs) {
           } else {
             if (key === "parameters") {
               prev[key] = mergeParameters(prev[key], value);
+            } else if (key === "requestBody") {
+              prev.requestBody = mergeRequestBodies(
+                prev.requestBody,
+                value
+              );
             } else {
               prev[key] = {
                 ...prev[key],
@@ -107,30 +125,26 @@ function mergeSpecs(route, ...specs) {
     }
   );
 }
-function registerSchemaPath({
-  route,
-  specs,
-  paths
-}) {
+function registerSchemaPath({ route, specs, paths }, pathContext = specsByPathContext) {
   const path = toOpenAPIPath(route.path);
   const method = route.method.toLowerCase();
   if (method === "all") {
     if (!specs) return;
-    if (specsByPathContext.has(path)) {
-      const prev = specsByPathContext.get(path) ?? {};
-      specsByPathContext.set(path, mergeSpecs(route, prev, specs));
+    if (pathContext.has(path)) {
+      const prev = pathContext.get(path) ?? {};
+      pathContext.set(path, mergeSpecs(route, prev, specs));
     } else {
-      specsByPathContext.set(path, specs);
+      pathContext.set(path, specs);
     }
   } else {
-    const pathContext = getPathContext(path);
+    const context = getPathContext(path, pathContext);
     if (!(path in paths)) {
       paths[path] = {};
     }
     if (paths[path]) {
       paths[path][method] = mergeSpecs(
         route,
-        ...pathContext,
+        ...context,
         paths[path]?.[method],
         specs
       );
@@ -275,7 +289,6 @@ async function generateSpecs(hono, options = DEFAULT_OPTIONS, c) {
     ..._documentation,
     components: _documentation.components && { ..._documentation.components }
   };
-  clearSpecsContext();
   const paths = await generatePaths(hono, ctx);
   for (const path in paths) {
     for (const method in paths[path]) {
@@ -320,14 +333,18 @@ async function generateSpecs(hono, options = DEFAULT_OPTIONS, c) {
 }
 async function generatePaths(hono, ctx) {
   const paths = {};
+  const pathContext = /* @__PURE__ */ new Map();
   for (const route of hono.routes) {
     const middlewareHandler = findTargetHandler(route.handler)[uniqueSymbol];
     if (!middlewareHandler) {
       if (ctx.options.includeEmptyPaths) {
-        registerSchemaPath({
-          route,
-          paths
-        });
+        registerSchemaPath(
+          {
+            route,
+            paths
+          },
+          pathContext
+        );
       }
       continue;
     }
@@ -343,14 +360,18 @@ async function generatePaths(hono, ctx) {
     const defaultOptionsForThisMethod = ctx.options.defaultOptions?.[routeMethod] && { ...ctx.options.defaultOptions[routeMethod] };
     const { schema: routeSpecs, components = {} } = await getSpec(
       middlewareHandler,
-      defaultOptionsForThisMethod
+      defaultOptionsForThisMethod,
+      ctx.components.parameters
     );
     ctx.components = mergeComponentsObjects(ctx.components, components);
-    registerSchemaPath({
-      route,
-      specs: routeSpecs,
-      paths
-    });
+    registerSchemaPath(
+      {
+        route,
+        specs: routeSpecs,
+        paths
+      },
+      pathContext
+    );
   }
   return paths;
 }
@@ -366,7 +387,7 @@ function getHiddenValue(options) {
   }
   return false;
 }
-async function getSpec(middlewareHandler, defaultOptions) {
+async function getSpec(middlewareHandler, defaultOptions, parameterComponents) {
   if ("spec" in middlewareHandler) {
     const tmp = {
       ...defaultOptions,
@@ -401,7 +422,7 @@ async function getSpec(middlewareHandler, defaultOptions) {
     [VALIDATION_MARKER]: true
   };
   if (middlewareHandler.target === "form" || middlewareHandler.target === "json") {
-    const media = middlewareHandler.options?.media ?? middlewareHandler.target === "json" ? "application/json" : "multipart/form-data";
+    const media = middlewareHandler.options?.media ?? (middlewareHandler.target === "json" ? "application/json" : "multipart/form-data");
     if (!docs.requestBody || !("content" in docs.requestBody) || !docs.requestBody.content) {
       docs.requestBody = {
         required: true,
@@ -423,18 +444,21 @@ async function getSpec(middlewareHandler, defaultOptions) {
       const pos = ref.split("/").pop();
       if (pos && result.components?.schemas?.[pos]) {
         const schema = result.components.schemas[pos];
-        const newParameters = generateParameters(
+        const generatedParameters = generateParameters(
           middlewareHandler.target,
-          schema
-        )[0];
-        if (!result.components.parameters) {
-          result.components.parameters = {};
+          schema,
+          result.components.schemas
+        );
+        const singleParameter = generatedParameters.length === 1 ? generatedParameters[0] : void 0;
+        const existingParameter = parameterComponents?.[pos];
+        if (singleParameter && (!existingParameter || "in" in existingParameter && existingParameter.in === singleParameter.in && existingParameter.name === singleParameter.name)) {
+          result.components.parameters ??= {};
+          result.components.parameters[pos] = singleParameter;
+          parameters.push({ $ref: `#/components/parameters/${pos}` });
+          delete result.components.schemas[pos];
+        } else {
+          parameters = generatedParameters;
         }
-        result.components.parameters[pos] = newParameters;
-        delete result.components.schemas[pos];
-        parameters.push({
-          $ref: `#/components/parameters/${pos}`
-        });
       }
     } else {
       parameters = generateParameters(

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "hono-openapi",
   "description": "OpenAPI schema generator for Hono",
-  "version": "1.3.2",
+  "version": "1.3.3",
   "type": "module",
   "main": "dist/index.cjs",
   "module": "dist/index.js",