@hono/zod-openapi 0.18.4 → 0.19.1

package/README.md

@@ -451,6 +451,17 @@ app.doc('/doc', (c) => ({
 }))
 ```
 
+### How to exclude a specific route from OpenAPI docs
+
+You can use `hide` property as follows:
+
+```ts
+const route = createRoute({
+  // ...
+  hide: true,
+})
+```
+
 ## Limitations
 
 ### Combining with `Hono`

package/dist/index.d.mts

@@ -12,6 +12,7 @@ export { z } from 'zod';
 type MaybePromise<T> = Promise<T> | T;
 type RouteConfig = RouteConfig$1 & {
     middleware?: MiddlewareHandler | MiddlewareHandler[];
+    hide?: boolean;
 };
 type RequestTypes = {
     body?: ZodRequestBody;
@@ -169,7 +170,7 @@ declare class OpenAPIHono<E extends Env = Env, S extends Schema = {}, BasePath e
      *  }
      *)
      */
-    openapi: <R extends RouteConfig, I extends Input = InputTypeBase<R, "params", "param"> & InputTypeBase<R, "query", "query"> & InputTypeBase<R, "headers", "header"> & InputTypeBase<R, "cookies", "cookie"> & InputTypeForm<R> & InputTypeJson<R>, P extends string = ConvertPathType<R["path"]>>({ middleware: routeMiddleware, ...route }: R, handler: Handler<R['middleware'] extends MiddlewareHandler[] | MiddlewareHandler ? RouteMiddlewareParams<R>['env'] & E : E, P, I, R extends {
+    openapi: <R extends RouteConfig, I extends Input = InputTypeBase<R, "params", "param"> & InputTypeBase<R, "query", "query"> & InputTypeBase<R, "headers", "header"> & InputTypeBase<R, "cookies", "cookie"> & InputTypeForm<R> & InputTypeJson<R>, P extends string = ConvertPathType<R["path"]>>({ middleware: routeMiddleware, hide, ...route }: R, handler: Handler<R['middleware'] extends MiddlewareHandler[] | MiddlewareHandler ? RouteMiddlewareParams<R>['env'] & E : E, P, I, R extends {
         responses: {
             [statusCode: number]: {
                 content: {

package/dist/index.d.ts

@@ -12,6 +12,7 @@ export { z } from 'zod';
 type MaybePromise<T> = Promise<T> | T;
 type RouteConfig = RouteConfig$1 & {
     middleware?: MiddlewareHandler | MiddlewareHandler[];
+    hide?: boolean;
 };
 type RequestTypes = {
     body?: ZodRequestBody;
@@ -169,7 +170,7 @@ declare class OpenAPIHono<E extends Env = Env, S extends Schema = {}, BasePath e
      *  }
      *)
      */
-    openapi: <R extends RouteConfig, I extends Input = InputTypeBase<R, "params", "param"> & InputTypeBase<R, "query", "query"> & InputTypeBase<R, "headers", "header"> & InputTypeBase<R, "cookies", "cookie"> & InputTypeForm<R> & InputTypeJson<R>, P extends string = ConvertPathType<R["path"]>>({ middleware: routeMiddleware, ...route }: R, handler: Handler<R['middleware'] extends MiddlewareHandler[] | MiddlewareHandler ? RouteMiddlewareParams<R>['env'] & E : E, P, I, R extends {
+    openapi: <R extends RouteConfig, I extends Input = InputTypeBase<R, "params", "param"> & InputTypeBase<R, "query", "query"> & InputTypeBase<R, "headers", "header"> & InputTypeBase<R, "cookies", "cookie"> & InputTypeForm<R> & InputTypeJson<R>, P extends string = ConvertPathType<R["path"]>>({ middleware: routeMiddleware, hide, ...route }: R, handler: Handler<R['middleware'] extends MiddlewareHandler[] | MiddlewareHandler ? RouteMiddlewareParams<R>['env'] & E : E, P, I, R extends {
         responses: {
             [statusCode: number]: {
                 content: {

package/dist/index.js

@@ -70,8 +70,10 @@ var OpenAPIHono = class _OpenAPIHono extends import_hono.Hono {
    *  }
    *)
    */
-  openapi = ({ middleware: routeMiddleware, ...route }, handler, hook = this.defaultHook) => {
-    this.openAPIRegistry.registerPath(route);
+  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);
@@ -239,7 +241,7 @@ var createRoute = (routeConfig) => {
 function addBasePathToDocument(document, basePath) {
   const updatedPaths = {};
   Object.keys(document.paths).forEach((path) => {
-    updatedPaths[(0, import_url.mergePath)(basePath, path)] = document.paths[path];
+    updatedPaths[(0, import_url.mergePath)(basePath.replaceAll(/:([^\/]+)/g, "{$1}"), path)] = document.paths[path];
   });
   return {
     ...document,

package/dist/index.mjs

@@ -48,8 +48,10 @@ var OpenAPIHono = class _OpenAPIHono extends Hono {
    *  }
    *)
    */
-  openapi = ({ middleware: routeMiddleware, ...route }, handler, hook = this.defaultHook) => {
-    this.openAPIRegistry.registerPath(route);
+  openapi = ({ middleware: routeMiddleware, hide, ...route }, handler, hook = this.defaultHook) => {
+    if (!hide) {
+      this.openAPIRegistry.registerPath(route);
+    }
     const validators = [];
     if (route.request?.query) {
       const validator = zValidator("query", route.request.query, hook);
@@ -217,7 +219,7 @@ extendZodWithOpenApi(z);
 function addBasePathToDocument(document, basePath) {
   const updatedPaths = {};
   Object.keys(document.paths).forEach((path) => {
-    updatedPaths[mergePath(basePath, path)] = document.paths[path];
+    updatedPaths[mergePath(basePath.replaceAll(/:([^\/]+)/g, "{$1}"), path)] = document.paths[path];
   });
   return {
     ...document,

package/package.json

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