@hono/zod-openapi 0.9.5 → 0.9.7

package/README.md

@@ -53,7 +53,7 @@ const UserSchema = z
 
 > [!TIP]
 > `UserSchema` schema will be registered as `"#/components/schemas/User"` refs in the OpenAPI document.
-> If you want to register the schema as referenced components, use `.opanapi()` method.
+> If you want to register the schema as referenced components, use `.openapi()` method.
 
 Next, create a route:
 
@@ -88,7 +88,7 @@ const app = new OpenAPIHono()
 
 app.openapi(route, (c) => {
   const { id } = c.req.valid('param')
-  return c.jsonT({
+  return c.json({
     id,
     age: 20,
     name: 'Ultra-man',
@@ -157,7 +157,7 @@ app.openapi(
   route,
   (c) => {
     const { id } = c.req.valid('param')
-    return c.jsonT({
+    return c.json({
       id,
       age: 20,
       name: 'Ultra-man',
@@ -166,7 +166,7 @@ app.openapi(
   // Hook
   (result, c) => {
     if (!result.success) {
-      return c.jsonT(
+      return c.json(
         {
           code: 400,
           message: 'Validation Error',
@@ -186,7 +186,7 @@ In the case that you have a common error formatter, you can initialize the `Open
 const app = new OpenAPIHono({
   defaultHook: (result, c) => {
     if (!result.success) {
-      return c.jsonT(
+      return c.json(
         {
           ok: false,
           errors: formatZodErrors(result),
@@ -205,7 +205,7 @@ You can still override the `defaultHook` by providing the hook at the call site
 // uses the defaultHook
 app.openapi(createPostRoute, (c) => {
   const { title } = c.req.valid('json')
-  return c.jsonT({ title })
+  return c.json({ title })
 })
 
 // override the defaultHook by passing in a hook
@@ -213,11 +213,11 @@ app.openapi(
   createBookRoute,
   (c) => {
     const { title } = c.req.valid('json')
-    return c.jsonT({ title })
+    return c.json({ title })
   },
   (result, c) => {
     if (!result.success) {
-      return c.jsonT(
+      return c.json(
         {
           ok: false,
           source: 'routeHook' as const,
@@ -279,7 +279,7 @@ import { hc } from 'hono/client'
 
 const appRoutes = app.openapi(route, (c) => {
   const data = c.req.valid('json')
-  return c.jsonT({
+  return c.json({
     id: data.id,
     message: 'Success',
   })
@@ -311,11 +311,9 @@ eg. Bearer Auth
 Register the security scheme:
 
 ```ts
-app.openAPIRegistry.registerComponent('securitySchema', {
-  Bearer: {
-    type: 'http',
-    scheme: 'bearer',
-  },
+app.openAPIRegistry.registerComponent("securitySchemes", "Bearer", {
+  type: "http",
+  scheme: "bearer",
 })
 ```
 

package/dist/index.js

@@ -93,15 +93,23 @@ var OpenAPIHono = class _OpenAPIHono extends import_hono.Hono {
   doc = (path, configure) => {
     return this.get(path, (c) => {
       const config = typeof configure === "function" ? configure(c) : configure;
-      const document = this.getOpenAPIDocument(config);
-      return c.json(document);
+      try {
+        const document = this.getOpenAPIDocument(config);
+        return c.json(document);
+      } catch (e) {
+        return c.json(e, 500);
+      }
     });
   };
   doc31 = (path, configure) => {
     return this.get(path, (c) => {
       const config = typeof configure === "function" ? configure(c) : configure;
-      const document = this.getOpenAPI31Document(config);
-      return c.json(document);
+      try {
+        const document = this.getOpenAPI31Document(config);
+        return c.json(document);
+      } catch (e) {
+        return c.json(e, 500);
+      }
     });
   };
   route(path, app) {
@@ -140,7 +148,7 @@ var OpenAPIHono = class _OpenAPIHono extends import_hono.Hono {
     return this;
   }
   basePath(path) {
-    return new _OpenAPIHono(super.basePath(path));
+    return new _OpenAPIHono({ ...super.basePath(path), defaultHook: this.defaultHook });
   }
 };
 var createRoute = (routeConfig) => {

package/dist/index.mjs

@@ -71,15 +71,23 @@ var OpenAPIHono = class _OpenAPIHono extends Hono {
   doc = (path, configure) => {
     return this.get(path, (c) => {
       const config = typeof configure === "function" ? configure(c) : configure;
-      const document = this.getOpenAPIDocument(config);
-      return c.json(document);
+      try {
+        const document = this.getOpenAPIDocument(config);
+        return c.json(document);
+      } catch (e) {
+        return c.json(e, 500);
+      }
     });
   };
   doc31 = (path, configure) => {
     return this.get(path, (c) => {
       const config = typeof configure === "function" ? configure(c) : configure;
-      const document = this.getOpenAPI31Document(config);
-      return c.json(document);
+      try {
+        const document = this.getOpenAPI31Document(config);
+        return c.json(document);
+      } catch (e) {
+        return c.json(e, 500);
+      }
     });
   };
   route(path, app) {
@@ -118,7 +126,7 @@ var OpenAPIHono = class _OpenAPIHono extends Hono {
     return this;
   }
   basePath(path) {
-    return new _OpenAPIHono(super.basePath(path));
+    return new _OpenAPIHono({ ...super.basePath(path), defaultHook: this.defaultHook });
   }
 };
 var createRoute = (routeConfig) => {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hono/zod-openapi",
-  "version": "0.9.5",
+  "version": "0.9.7",
   "description": "A wrapper class of Hono which supports OpenAPI.",
   "main": "dist/index.js",
   "module": "dist/index.mjs",
@@ -41,16 +41,18 @@
     "zod": "3.*"
   },
   "devDependencies": {
+    "@cloudflare/workers-types": "^4.20240117.0",
     "hono": "^3.11.7",
     "jest": "^29.7.0",
     "openapi3-ts": "^4.1.2",
     "tsup": "^8.0.1",
+    "typescript": "^5.3.3",
     "vitest": "^1.0.1",
     "zod": "^3.22.1"
   },
   "dependencies": {
     "@asteasolutions/zod-to-openapi": "^5.5.0",
-    "@hono/zod-validator": "^0.1.11"
+    "@hono/zod-validator": "0.1.11"
   },
   "engines": {
     "node": ">=16.0.0"