@hono/zod-openapi 0.9.3 → 0.9.5

package/README.md

@@ -51,6 +51,10 @@ const UserSchema = z
   .openapi('User')
 ```
 
+> [!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.
+
 Next, create a route:
 
 ```ts

package/dist/index.d.mts

@@ -2,10 +2,10 @@ import * as openapi3_ts_oas31 from 'openapi3-ts/oas31';
 import * as openapi3_ts_oas30 from 'openapi3-ts/oas30';
 import { RouteConfig, ZodMediaTypeObject, OpenAPIRegistry, ZodRequestBody, ZodContentObject, ResponseConfig } from '@asteasolutions/zod-to-openapi';
 import { OpenAPIObjectConfig } from '@asteasolutions/zod-to-openapi/dist/v3.0/openapi-generator';
-import { Env, Input, Handler, Context, Schema, Hono, ToSchema, TypedResponse } from 'hono';
+import { Env, Context, TypedResponse, Input, Handler, Schema, Hono, ToSchema } from 'hono';
 import { MergeSchemaPath, MergePath } from 'hono/types';
 import { RemoveBlankRecord } from 'hono/utils/types';
-import { AnyZodObject, z, ZodSchema, ZodError, ZodType } from 'zod';
+import { ZodError, AnyZodObject, z, ZodSchema, ZodType } from 'zod';
 export { z } from 'zod';
 
 type RequestTypes = {
@@ -100,4 +100,4 @@ declare const createRoute: <P extends string, R extends Omit<RouteConfig, "path"
     getRoutingPath(): RoutingPath<R["path"]>;
 };
 
-export { OpenAPIHono, OpenAPIHonoOptions, OpenAPIObjectConfigure, RouteHandler, RouteHook, createRoute };
+export { type Hook, OpenAPIHono, type OpenAPIHonoOptions, type OpenAPIObjectConfigure, type RouteHandler, type RouteHook, createRoute };

package/dist/index.d.ts

@@ -2,10 +2,10 @@ import * as openapi3_ts_oas31 from 'openapi3-ts/oas31';
 import * as openapi3_ts_oas30 from 'openapi3-ts/oas30';
 import { RouteConfig, ZodMediaTypeObject, OpenAPIRegistry, ZodRequestBody, ZodContentObject, ResponseConfig } from '@asteasolutions/zod-to-openapi';
 import { OpenAPIObjectConfig } from '@asteasolutions/zod-to-openapi/dist/v3.0/openapi-generator';
-import { Env, Input, Handler, Context, Schema, Hono, ToSchema, TypedResponse } from 'hono';
+import { Env, Context, TypedResponse, Input, Handler, Schema, Hono, ToSchema } from 'hono';
 import { MergeSchemaPath, MergePath } from 'hono/types';
 import { RemoveBlankRecord } from 'hono/utils/types';
-import { AnyZodObject, z, ZodSchema, ZodError, ZodType } from 'zod';
+import { ZodError, AnyZodObject, z, ZodSchema, ZodType } from 'zod';
 export { z } from 'zod';
 
 type RequestTypes = {
@@ -100,4 +100,4 @@ declare const createRoute: <P extends string, R extends Omit<RouteConfig, "path"
     getRoutingPath(): RoutingPath<R["path"]>;
 };
 
-export { OpenAPIHono, OpenAPIHonoOptions, OpenAPIObjectConfigure, RouteHandler, RouteHook, createRoute };
+export { type Hook, OpenAPIHono, type OpenAPIHonoOptions, type OpenAPIObjectConfigure, type RouteHandler, type RouteHook, createRoute };

package/dist/index.js

@@ -105,6 +105,7 @@ var OpenAPIHono = class _OpenAPIHono extends import_hono.Hono {
     });
   };
   route(path, app) {
+    const pathForOpenAPI = path.replaceAll(/:([^\/]+)/g, "{$1}");
     super.route(path, app);
     if (!(app instanceof _OpenAPIHono)) {
       return this;
@@ -116,12 +117,12 @@ var OpenAPIHono = class _OpenAPIHono extends import_hono.Hono {
         case "route":
           return this.openAPIRegistry.registerPath({
             ...def.route,
-            path: (0, import_url.mergePath)(path, def.route.path)
+            path: (0, import_url.mergePath)(pathForOpenAPI, def.route.path)
           });
         case "webhook":
           return this.openAPIRegistry.registerWebhook({
             ...def.webhook,
-            path: (0, import_url.mergePath)(path, def.webhook.path)
+            path: (0, import_url.mergePath)(pathForOpenAPI, def.webhook.path)
           });
         case "schema":
           return this.openAPIRegistry.register(def.schema._def.openapi._internal.refId, def.schema);

package/dist/index.mjs

@@ -83,6 +83,7 @@ var OpenAPIHono = class _OpenAPIHono extends Hono {
     });
   };
   route(path, app) {
+    const pathForOpenAPI = path.replaceAll(/:([^\/]+)/g, "{$1}");
     super.route(path, app);
     if (!(app instanceof _OpenAPIHono)) {
       return this;
@@ -94,12 +95,12 @@ var OpenAPIHono = class _OpenAPIHono extends Hono {
         case "route":
           return this.openAPIRegistry.registerPath({
             ...def.route,
-            path: mergePath(path, def.route.path)
+            path: mergePath(pathForOpenAPI, def.route.path)
           });
         case "webhook":
           return this.openAPIRegistry.registerWebhook({
             ...def.webhook,
-            path: mergePath(path, def.webhook.path)
+            path: mergePath(pathForOpenAPI, def.webhook.path)
           });
         case "schema":
           return this.openAPIRegistry.register(def.schema._def.openapi._internal.refId, def.schema);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hono/zod-openapi",
-  "version": "0.9.3",
+  "version": "0.9.5",
   "description": "A wrapper class of Hono which supports OpenAPI.",
   "main": "dist/index.js",
   "module": "dist/index.mjs",
@@ -27,7 +27,6 @@
     }
   },
   "license": "MIT",
-  "private": false,
   "publishConfig": {
     "registry": "https://registry.npmjs.org",
     "access": "public"
@@ -42,16 +41,18 @@
     "zod": "3.*"
   },
   "devDependencies": {
-    "@hono/zod-validator": "^0.1.11",
-    "hono": "^3.11.3",
+    "hono": "^3.11.7",
+    "jest": "^29.7.0",
+    "openapi3-ts": "^4.1.2",
+    "tsup": "^8.0.1",
     "vitest": "^1.0.1",
     "zod": "^3.22.1"
   },
   "dependencies": {
     "@asteasolutions/zod-to-openapi": "^5.5.0",
-    "@hono/zod-validator": "^0.1.9"
+    "@hono/zod-validator": "^0.1.11"
   },
   "engines": {
     "node": ">=16.0.0"
   }
-}
+}