@hono/zod-openapi 1.1.5 → 1.2.0

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @hono/zod-openapi
 
+## 1.2.0
+
+### Minor Changes
+
+- [#1639](https://github.com/honojs/middleware/pull/1639) [`32bc133a58c2a3a79fe386f542eb71fdc5722931`](https://github.com/honojs/middleware/commit/32bc133a58c2a3a79fe386f542eb71fdc5722931) Thanks [@yusukebe](https://github.com/yusukebe)! - feat: introduce `$` and `HonoToOpenAPIHono`
+
+## 1.1.6
+
+### Patch Changes
+
+- [#1637](https://github.com/honojs/middleware/pull/1637) [`64cc1d9b103194d826e8d559104c1191672741a1`](https://github.com/honojs/middleware/commit/64cc1d9b103194d826e8d559104c1191672741a1) Thanks [@yusukebe](https://github.com/yusukebe)! - fix: return `OpenAPIHono` from onError and onNotFound
+
 ## 1.1.5
 
 ### Patch Changes

package/README.md

@@ -400,6 +400,29 @@ const client = hc<typeof appRoutes>('http://localhost:8787/')
 
 ## Tips
 
+### Type utilities
+
+Methods like `get()`, `post()`, `use()`, etc. return `Hono` type instead of `OpenAPIHono`. This can cause issues when you need the `OpenAPIHono` type. Use the `$()` function to convert the instance back to `OpenAPIHono` type:
+
+```ts
+import { OpenAPIHono, $ } from '@hono/zod-openapi'
+
+const app = $(new OpenAPIHono().use(middleware))
+app.openapi(route, handler)
+```
+
+You can also use the `HonoToOpenAPIHono` utility type to convert the return type at the type level:
+
+```ts
+import type { HonoToOpenAPIHono } from '@hono/zod-openapi'
+
+const app = new OpenAPIHono()
+const result = app.get('/hello', (c) => c.json({ message: 'Hello' }))
+
+// `result` is Hono type, convert it to OpenAPIHono
+type MyApp = HonoToOpenAPIHono<typeof result>
+```
+
 ### How to register components
 
 You can register components to the registry as follows:

package/dist/index.cjs

@@ -1,284 +1,269 @@
-"use strict";
+//#region rolldown:runtime
+var __create = Object.create;
 var __defProp = Object.defineProperty;
 var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
 var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
 var __hasOwnProp = Object.prototype.hasOwnProperty;
-var __export = (target, all) => {
-  for (var name in all)
-    __defProp(target, name, { get: all[name], enumerable: true });
-};
 var __copyProps = (to, from, except, desc) => {
-  if (from && typeof from === "object" || typeof from === "function") {
-    for (let key of __getOwnPropNames(from))
-      if (!__hasOwnProp.call(to, key) && key !== except)
-        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
-  }
-  return to;
+	if (from && typeof from === "object" || typeof from === "function") for (var keys = __getOwnPropNames(from), i = 0, n = keys.length, key; i < n; i++) {
+		key = keys[i];
+		if (!__hasOwnProp.call(to, key) && key !== except) __defProp(to, key, {
+			get: ((k) => from[k]).bind(null, key),
+			enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable
+		});
+	}
+	return to;
 };
-var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", {
+	value: mod,
+	enumerable: true
+}) : target, mod));
 
-// src/index.ts
-var index_exports = {};
-__export(index_exports, {
-  OpenAPIHono: () => OpenAPIHono,
-  createRoute: () => createRoute,
-  extendZodWithOpenApi: () => import_zod_to_openapi.extendZodWithOpenApi,
-  z: () => import_zod.z
-});
-module.exports = __toCommonJS(index_exports);
-var import_zod_to_openapi = require("@asteasolutions/zod-to-openapi");
-var import_zod_validator = require("@hono/zod-validator");
-var import_hono = require("hono");
-var import_url = require("hono/utils/url");
-var import_zod = require("zod");
+//#endregion
+let __asteasolutions_zod_to_openapi = require("@asteasolutions/zod-to-openapi");
+__asteasolutions_zod_to_openapi = __toESM(__asteasolutions_zod_to_openapi);
+let __hono_zod_validator = require("@hono/zod-validator");
+__hono_zod_validator = __toESM(__hono_zod_validator);
+let hono = require("hono");
+hono = __toESM(hono);
+let hono_utils_url = require("hono/utils/url");
+hono_utils_url = __toESM(hono_utils_url);
+let zod = require("zod");
+zod = __toESM(zod);
 
-// src/zod-typeguard.ts
+//#region src/zod-typeguard.ts
 function isObject(x) {
-  return typeof x === "object" && x !== null;
+	return typeof x === "object" && x !== null;
 }
 function isZod(x) {
-  if (!x) return false;
-  if (!isObject(x)) return false;
-  return typeof x.parse === "function" && typeof x.safeParse === "function" && typeof x.parseAsync === "function" && typeof x.safeParseAsync === "function";
+	if (!x) return false;
+	if (!isObject(x)) return false;
+	return typeof x.parse === "function" && typeof x.safeParse === "function" && typeof x.parseAsync === "function" && typeof x.safeParseAsync === "function";
 }
 
-// src/index.ts
-var OpenAPIHono = class _OpenAPIHono extends import_hono.Hono {
-  openAPIRegistry;
-  defaultHook;
-  constructor(init) {
-    super(init);
-    this.openAPIRegistry = new import_zod_to_openapi.OpenAPIRegistry();
-    this.defaultHook = init?.defaultHook;
-  }
-  /**
-   *
-   * @param {RouteConfig} route - The route definition which you create with `createRoute()`.
-   * @param {Handler} handler - The handler. If you want to return a JSON object, you should specify the status code with `c.json()`.
-   * @param {Hook} hook - Optional. The hook method defines what it should do after validation.
-   * @example
-   * app.openapi(
-   *   route,
-   *   (c) => {
-   *     // ...
-   *     return c.json(
-   *       {
-   *         age: 20,
-   *         name: 'Young man',
-   *       },
-   *       200 // You should specify the status code even if it's 200.
-   *     )
-   *   },
-   *  (result, c) => {
-   *    if (!result.success) {
-   *      return c.json(
-   *        {
-   *          code: 400,
-   *          message: 'Custom Message',
-   *        },
-   *        400
-   *      )
-   *    }
-   *  }
-   *)
-   */
-  openapi = ({ middleware: routeMiddleware, hide, ...route }, handler, hook = this.defaultHook) => {
-    if (!hide) {
-      this.openAPIRegistry.registerPath(route);
-    }
-    const validators = [];
-    if (route.request?.query) {
-      const validator = (0, import_zod_validator.zValidator)("query", route.request.query, hook);
-      validators.push(validator);
-    }
-    if (route.request?.params) {
-      const validator = (0, import_zod_validator.zValidator)("param", route.request.params, hook);
-      validators.push(validator);
-    }
-    if (route.request?.headers) {
-      const validator = (0, import_zod_validator.zValidator)("header", route.request.headers, hook);
-      validators.push(validator);
-    }
-    if (route.request?.cookies) {
-      const validator = (0, import_zod_validator.zValidator)("cookie", route.request.cookies, hook);
-      validators.push(validator);
-    }
-    const bodyContent = route.request?.body?.content;
-    if (bodyContent) {
-      for (const mediaType of Object.keys(bodyContent)) {
-        if (!bodyContent[mediaType]) {
-          continue;
-        }
-        const schema = bodyContent[mediaType]["schema"];
-        if (!isZod(schema)) {
-          continue;
-        }
-        if (isJSONContentType(mediaType)) {
-          const validator = (0, import_zod_validator.zValidator)("json", schema, hook);
-          if (route.request?.body?.required) {
-            validators.push(validator);
-          } else {
-            const mw = async (c, next) => {
-              if (c.req.header("content-type")) {
-                if (isJSONContentType(c.req.header("content-type"))) {
-                  return await validator(c, next);
-                }
-              }
-              c.req.addValidatedData("json", {});
-              await next();
-            };
-            validators.push(mw);
-          }
-        }
-        if (isFormContentType(mediaType)) {
-          const validator = (0, import_zod_validator.zValidator)("form", schema, hook);
-          if (route.request?.body?.required) {
-            validators.push(validator);
-          } else {
-            const mw = async (c, next) => {
-              if (c.req.header("content-type")) {
-                if (isFormContentType(c.req.header("content-type"))) {
-                  return await validator(c, next);
-                }
-              }
-              c.req.addValidatedData("form", {});
-              await next();
-            };
-            validators.push(mw);
-          }
-        }
-      }
-    }
-    const middleware = routeMiddleware ? Array.isArray(routeMiddleware) ? routeMiddleware : [routeMiddleware] : [];
-    this.on(
-      [route.method],
-      route.path.replaceAll(/\/{(.+?)}/g, "/:$1"),
-      ...middleware,
-      ...validators,
-      handler
-    );
-    return this;
-  };
-  getOpenAPIDocument = (objectConfig, generatorConfig) => {
-    const generator = new import_zod_to_openapi.OpenApiGeneratorV3(this.openAPIRegistry.definitions, generatorConfig);
-    const document = generator.generateDocument(objectConfig);
-    return this._basePath ? addBasePathToDocument(document, this._basePath) : document;
-  };
-  getOpenAPI31Document = (objectConfig, generatorConfig) => {
-    const generator = new import_zod_to_openapi.OpenApiGeneratorV31(this.openAPIRegistry.definitions, generatorConfig);
-    const document = generator.generateDocument(objectConfig);
-    return this._basePath ? addBasePathToDocument(document, this._basePath) : document;
-  };
-  doc = (path, configureObject, configureGenerator) => {
-    return this.get(path, (c) => {
-      const objectConfig = typeof configureObject === "function" ? configureObject(c) : configureObject;
-      const generatorConfig = typeof configureGenerator === "function" ? configureGenerator(c) : configureGenerator;
-      try {
-        const document = this.getOpenAPIDocument(objectConfig, generatorConfig);
-        return c.json(document);
-      } catch (e) {
-        return c.json(e, 500);
-      }
-    });
-  };
-  doc31 = (path, configureObject, configureGenerator) => {
-    return this.get(path, (c) => {
-      const objectConfig = typeof configureObject === "function" ? configureObject(c) : configureObject;
-      const generatorConfig = typeof configureGenerator === "function" ? configureGenerator(c) : configureGenerator;
-      try {
-        const document = this.getOpenAPI31Document(objectConfig, generatorConfig);
-        return c.json(document);
-      } catch (e) {
-        return c.json(e, 500);
-      }
-    });
-  };
-  route(path, app) {
-    const pathForOpenAPI = path.replaceAll(/:([^\/]+)/g, "{$1}");
-    super.route(path, app);
-    if (!(app instanceof _OpenAPIHono)) {
-      return this;
-    }
-    app.openAPIRegistry.definitions.forEach((def) => {
-      switch (def.type) {
-        case "component":
-          return this.openAPIRegistry.registerComponent(def.componentType, def.name, def.component);
-        case "route": {
-          this.openAPIRegistry.registerPath({
-            ...def.route,
-            path: (0, import_url.mergePath)(
-              pathForOpenAPI,
-              // @ts-expect-error _basePath is private
-              app._basePath.replaceAll(/:([^\/]+)/g, "{$1}"),
-              def.route.path
-            )
-          });
-          return;
-        }
-        case "webhook": {
-          this.openAPIRegistry.registerWebhook({
-            ...def.webhook,
-            path: (0, import_url.mergePath)(
-              pathForOpenAPI,
-              // @ts-expect-error _basePath is private
-              app._basePath.replaceAll(/:([^\/]+)/g, "{$1}"),
-              def.webhook.path
-            )
-          });
-          return;
-        }
-        case "schema":
-          return this.openAPIRegistry.register(
-            (0, import_zod_to_openapi.getOpenApiMetadata)(def.schema)._internal?.refId,
-            def.schema
-          );
-        case "parameter":
-          return this.openAPIRegistry.registerParameter(
-            (0, import_zod_to_openapi.getOpenApiMetadata)(def.schema)._internal?.refId,
-            def.schema
-          );
-        default: {
-          const errorIfNotExhaustive = def;
-          throw new Error(`Unknown registry type: ${errorIfNotExhaustive}`);
-        }
-      }
-    });
-    return this;
-  }
-  basePath(path) {
-    return new _OpenAPIHono({ ...super.basePath(path), defaultHook: this.defaultHook });
-  }
+//#endregion
+//#region src/index.ts
+/**
+* Converts a Hono instance to OpenAPIHono type.
+* Use this function to restore the OpenAPIHono type after chaining methods like `get`, `post`, `use`, etc.
+* @example
+* ```ts
+* import { OpenAPIHono, $ } from '@hono/zod-openapi'
+*
+* const app = $(
+*   new OpenAPIHono().use(middleware)
+* )
+* app.openapi(route, handler)
+* ```
+*/
+const $ = (app) => {
+	return app;
+};
+var OpenAPIHono = class OpenAPIHono extends hono.Hono {
+	openAPIRegistry;
+	defaultHook;
+	constructor(init) {
+		super(init);
+		this.openAPIRegistry = new __asteasolutions_zod_to_openapi.OpenAPIRegistry();
+		this.defaultHook = init === null || init === void 0 ? void 0 : init.defaultHook;
+	}
+	/**
+	*
+	* @param {RouteConfig} route - The route definition which you create with `createRoute()`.
+	* @param {Handler} handler - The handler. If you want to return a JSON object, you should specify the status code with `c.json()`.
+	* @param {Hook} hook - Optional. The hook method defines what it should do after validation.
+	* @example
+	* app.openapi(
+	*   route,
+	*   (c) => {
+	*     // ...
+	*     return c.json(
+	*       {
+	*         age: 20,
+	*         name: 'Young man',
+	*       },
+	*       200 // You should specify the status code even if it's 200.
+	*     )
+	*   },
+	*  (result, c) => {
+	*    if (!result.success) {
+	*      return c.json(
+	*        {
+	*          code: 400,
+	*          message: 'Custom Message',
+	*        },
+	*        400
+	*      )
+	*    }
+	*  }
+	*)
+	*/
+	openapi = ({ middleware: routeMiddleware, hide,...route }, handler, hook = this.defaultHook) => {
+		var _route$request, _route$request2, _route$request3, _route$request4, _route$request5;
+		if (!hide) this.openAPIRegistry.registerPath(route);
+		const validators = [];
+		if ((_route$request = route.request) === null || _route$request === void 0 ? void 0 : _route$request.query) {
+			const validator = (0, __hono_zod_validator.zValidator)("query", route.request.query, hook);
+			validators.push(validator);
+		}
+		if ((_route$request2 = route.request) === null || _route$request2 === void 0 ? void 0 : _route$request2.params) {
+			const validator = (0, __hono_zod_validator.zValidator)("param", route.request.params, hook);
+			validators.push(validator);
+		}
+		if ((_route$request3 = route.request) === null || _route$request3 === void 0 ? void 0 : _route$request3.headers) {
+			const validator = (0, __hono_zod_validator.zValidator)("header", route.request.headers, hook);
+			validators.push(validator);
+		}
+		if ((_route$request4 = route.request) === null || _route$request4 === void 0 ? void 0 : _route$request4.cookies) {
+			const validator = (0, __hono_zod_validator.zValidator)("cookie", route.request.cookies, hook);
+			validators.push(validator);
+		}
+		const bodyContent = (_route$request5 = route.request) === null || _route$request5 === void 0 || (_route$request5 = _route$request5.body) === null || _route$request5 === void 0 ? void 0 : _route$request5.content;
+		if (bodyContent) for (const mediaType of Object.keys(bodyContent)) {
+			if (!bodyContent[mediaType]) continue;
+			const schema = bodyContent[mediaType]["schema"];
+			if (!isZod(schema)) continue;
+			if (isJSONContentType(mediaType)) {
+				var _route$request6;
+				const validator = (0, __hono_zod_validator.zValidator)("json", schema, hook);
+				if ((_route$request6 = route.request) === null || _route$request6 === void 0 || (_route$request6 = _route$request6.body) === null || _route$request6 === void 0 ? void 0 : _route$request6.required) validators.push(validator);
+				else {
+					const mw = async (c, next) => {
+						if (c.req.header("content-type")) {
+							if (isJSONContentType(c.req.header("content-type"))) return await validator(c, next);
+						}
+						c.req.addValidatedData("json", {});
+						await next();
+					};
+					validators.push(mw);
+				}
+			}
+			if (isFormContentType(mediaType)) {
+				var _route$request7;
+				const validator = (0, __hono_zod_validator.zValidator)("form", schema, hook);
+				if ((_route$request7 = route.request) === null || _route$request7 === void 0 || (_route$request7 = _route$request7.body) === null || _route$request7 === void 0 ? void 0 : _route$request7.required) validators.push(validator);
+				else {
+					const mw = async (c, next) => {
+						if (c.req.header("content-type")) {
+							if (isFormContentType(c.req.header("content-type"))) {
+								await validator(c, next);
+								return;
+							}
+						}
+						c.req.addValidatedData("form", {});
+						await next();
+					};
+					validators.push(mw);
+				}
+			}
+		}
+		const middleware = routeMiddleware ? Array.isArray(routeMiddleware) ? routeMiddleware : [routeMiddleware] : [];
+		this.on([route.method], [route.path.replaceAll(/\/{(.+?)}/g, "/:$1")], ...middleware, ...validators, handler);
+		return this;
+	};
+	getOpenAPIDocument = (objectConfig, generatorConfig) => {
+		const document = new __asteasolutions_zod_to_openapi.OpenApiGeneratorV3(this.openAPIRegistry.definitions, generatorConfig).generateDocument(objectConfig);
+		return this._basePath ? addBasePathToDocument(document, this._basePath) : document;
+	};
+	getOpenAPI31Document = (objectConfig, generatorConfig) => {
+		const document = new __asteasolutions_zod_to_openapi.OpenApiGeneratorV31(this.openAPIRegistry.definitions, generatorConfig).generateDocument(objectConfig);
+		return this._basePath ? addBasePathToDocument(document, this._basePath) : document;
+	};
+	doc = (path, configureObject, configureGenerator) => {
+		return this.get(path, (c) => {
+			const objectConfig = typeof configureObject === "function" ? configureObject(c) : configureObject;
+			const generatorConfig = typeof configureGenerator === "function" ? configureGenerator(c) : configureGenerator;
+			try {
+				const document = this.getOpenAPIDocument(objectConfig, generatorConfig);
+				return c.json(document);
+			} catch (e) {
+				return c.json(e, 500);
+			}
+		});
+	};
+	doc31 = (path, configureObject, configureGenerator) => {
+		return this.get(path, (c) => {
+			const objectConfig = typeof configureObject === "function" ? configureObject(c) : configureObject;
+			const generatorConfig = typeof configureGenerator === "function" ? configureGenerator(c) : configureGenerator;
+			try {
+				const document = this.getOpenAPI31Document(objectConfig, generatorConfig);
+				return c.json(document);
+			} catch (e) {
+				return c.json(e, 500);
+			}
+		});
+	};
+	route(path, app) {
+		const pathForOpenAPI = path.replaceAll(/:([^\/]+)/g, "{$1}");
+		super.route(path, app);
+		if (!(app instanceof OpenAPIHono)) return this;
+		app.openAPIRegistry.definitions.forEach((def) => {
+			switch (def.type) {
+				case "component": return this.openAPIRegistry.registerComponent(def.componentType, def.name, def.component);
+				case "route":
+					this.openAPIRegistry.registerPath({
+						...def.route,
+						path: (0, hono_utils_url.mergePath)(pathForOpenAPI, app._basePath.replaceAll(/:([^\/]+)/g, "{$1}"), def.route.path)
+					});
+					return;
+				case "webhook":
+					this.openAPIRegistry.registerWebhook({
+						...def.webhook,
+						path: (0, hono_utils_url.mergePath)(pathForOpenAPI, app._basePath.replaceAll(/:([^\/]+)/g, "{$1}"), def.webhook.path)
+					});
+					return;
+				case "schema":
+					var _getOpenApiMetadata$_;
+					return this.openAPIRegistry.register((_getOpenApiMetadata$_ = (0, __asteasolutions_zod_to_openapi.getOpenApiMetadata)(def.schema)._internal) === null || _getOpenApiMetadata$_ === void 0 ? void 0 : _getOpenApiMetadata$_.refId, def.schema);
+				case "parameter":
+					var _getOpenApiMetadata$_2;
+					return this.openAPIRegistry.registerParameter((_getOpenApiMetadata$_2 = (0, __asteasolutions_zod_to_openapi.getOpenApiMetadata)(def.schema)._internal) === null || _getOpenApiMetadata$_2 === void 0 ? void 0 : _getOpenApiMetadata$_2.refId, def.schema);
+				default: {
+					const errorIfNotExhaustive = def;
+					throw new Error(`Unknown registry type: ${errorIfNotExhaustive}`);
+				}
+			}
+		});
+		return this;
+	}
+	basePath(path) {
+		return new OpenAPIHono({
+			...super.basePath(path),
+			defaultHook: this.defaultHook
+		});
+	}
 };
-var createRoute = (routeConfig) => {
-  const route = {
-    ...routeConfig,
-    getRoutingPath() {
-      return routeConfig.path.replaceAll(/\/{(.+?)}/g, "/:$1");
-    }
-  };
-  return Object.defineProperty(route, "getRoutingPath", { enumerable: false });
+const createRoute = (routeConfig) => {
+	const route = {
+		...routeConfig,
+		getRoutingPath() {
+			return routeConfig.path.replaceAll(/\/{(.+?)}/g, "/:$1");
+		}
+	};
+	return Object.defineProperty(route, "getRoutingPath", { enumerable: false });
 };
-(0, import_zod_to_openapi.extendZodWithOpenApi)(import_zod.z);
+(0, __asteasolutions_zod_to_openapi.extendZodWithOpenApi)(zod.z);
 function addBasePathToDocument(document, basePath) {
-  const updatedPaths = {};
-  Object.keys(document.paths).forEach((path) => {
-    updatedPaths[(0, import_url.mergePath)(basePath.replaceAll(/:([^\/]+)/g, "{$1}"), path)] = document.paths[path];
-  });
-  return {
-    ...document,
-    paths: updatedPaths
-  };
+	const updatedPaths = {};
+	Object.keys(document.paths).forEach((path) => {
+		updatedPaths[(0, hono_utils_url.mergePath)(basePath.replaceAll(/:([^\/]+)/g, "{$1}"), path)] = document.paths[path];
+	});
+	return {
+		...document,
+		paths: updatedPaths
+	};
 }
 function isJSONContentType(contentType) {
-  return /^application\/([a-z-\.]+\+)?json/.test(contentType);
+	return /^application\/([a-z-\.]+\+)?json/.test(contentType);
 }
 function isFormContentType(contentType) {
-  return contentType.startsWith("multipart/form-data") || contentType.startsWith("application/x-www-form-urlencoded");
+	return contentType.startsWith("multipart/form-data") || contentType.startsWith("application/x-www-form-urlencoded");
 }
-// Annotate the CommonJS export names for ESM import in node:
-0 && (module.exports = {
-  OpenAPIHono,
-  createRoute,
-  extendZodWithOpenApi,
-  z
-});
+
+//#endregion
+exports.$ = $;
+exports.OpenAPIHono = OpenAPIHono;
+exports.createRoute = createRoute;
+exports.extendZodWithOpenApi = __asteasolutions_zod_to_openapi.extendZodWithOpenApi;
+exports.z = zod.z;