@hono/zod-openapi 0.4.0 → 0.5.0

package/README.md

@@ -203,6 +203,18 @@ import { prettyJSON } from 'hono/pretty-json'
 app.use('/doc/*', prettyJSON())
 ```
 
+### Configure middleware for each endpoint
+
+You can configure middleware for each endpoint from a route created by `createRoute` as follows.
+
+```ts
+import { prettyJSON } from 'hono/pretty-json'
+import { cache } from 'honoc/cache'
+
+app.use(route.getRoutingPath(), prettyJSON(), cache({ cacheName: "my-cache" }))
+app.openapi(route, handler)
+```
+
 ### RPC Mode
 
 Zod OpenAPI Hono supports Hono's RPC mode. You can define types for the Hono Client as follows:

package/dist/index.cjs

@@ -141,7 +141,14 @@ var OpenAPIHono = class _OpenAPIHono extends import_hono.Hono {
     return this;
   }
 };
-var createRoute = (routeConfig) => routeConfig;
+var createRoute = (routeConfig) => {
+  return {
+    ...routeConfig,
+    getRoutingPath() {
+      return routeConfig.path.replaceAll(/\/{(.+?)}/g, "/:$1");
+    }
+  };
+};
 (0, import_zod_to_openapi2.extendZodWithOpenApi)(import_zod.z);
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {

package/dist/index.d.cts

@@ -64,8 +64,11 @@ declare class OpenAPIHono<E extends Env = Env, S extends Schema = {}, BasePath e
     route<SubPath extends string, SubEnv extends Env, SubSchema extends Schema, SubBasePath extends string>(path: SubPath, app: Hono<SubEnv, SubSchema, SubBasePath>): OpenAPIHono<E, MergeSchemaPath<SubSchema, MergePath<BasePath, SubPath>> & S, BasePath>;
     route<SubPath extends string>(path: SubPath): Hono<E, RemoveBlankRecord<S>, BasePath>;
 }
+type RoutingPath<P extends string> = P extends `${infer Head}/{${infer Param}}${infer Tail}` ? `${Head}/:${Param}${RoutingPath<Tail>}` : P;
 declare const createRoute: <P extends string, R extends Omit<RouteConfig, "path"> & {
     path: P;
-}>(routeConfig: R) => R;
+}>(routeConfig: R) => R & {
+    getRoutingPath(): RoutingPath<R["path"]>;
+};
 
 export { OpenAPIHono, createRoute };

package/dist/index.d.ts

@@ -64,8 +64,11 @@ declare class OpenAPIHono<E extends Env = Env, S extends Schema = {}, BasePath e
     route<SubPath extends string, SubEnv extends Env, SubSchema extends Schema, SubBasePath extends string>(path: SubPath, app: Hono<SubEnv, SubSchema, SubBasePath>): OpenAPIHono<E, MergeSchemaPath<SubSchema, MergePath<BasePath, SubPath>> & S, BasePath>;
     route<SubPath extends string>(path: SubPath): Hono<E, RemoveBlankRecord<S>, BasePath>;
 }
+type RoutingPath<P extends string> = P extends `${infer Head}/{${infer Param}}${infer Tail}` ? `${Head}/:${Param}${RoutingPath<Tail>}` : P;
 declare const createRoute: <P extends string, R extends Omit<RouteConfig, "path"> & {
     path: P;
-}>(routeConfig: R) => R;
+}>(routeConfig: R) => R & {
+    getRoutingPath(): RoutingPath<R["path"]>;
+};
 
 export { OpenAPIHono, createRoute };

package/dist/index.js

@@ -115,7 +115,14 @@ var OpenAPIHono = class _OpenAPIHono extends Hono {
     return this;
   }
 };
-var createRoute = (routeConfig) => routeConfig;
+var createRoute = (routeConfig) => {
+  return {
+    ...routeConfig,
+    getRoutingPath() {
+      return routeConfig.path.replaceAll(/\/{(.+?)}/g, "/:$1");
+    }
+  };
+};
 extendZodWithOpenApi(z);
 export {
   OpenAPIHono,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hono/zod-openapi",
-  "version": "0.4.0",
+  "version": "0.5.0",
   "description": "A wrapper class of Hono which supports OpenAPI.",
   "type": "module",
   "main": "dist/index.js",