@hono/zod-openapi 0.1.2 → 0.3.0

package/README.md

@@ -4,11 +4,6 @@
 
 _Note: This is not standalone middleware but is hosted on the monorepo "[github.com/honojs/middleware](https://github.com/honojs/middleware)"._
 
-## Limitations
-
-- Currently, it does not support validation of _headers_ and _cookies_.
-- An instance of Zod OpenAPI Hono cannot be used as a "subApp" in conjunction with `rootApp.route('/api', subApp)`.
-
 ## Usage
 
 ### Installation
@@ -179,6 +174,14 @@ app.openapi(
 )
 ```
 
+### The Registry
+
+You can access the [`OpenAPIRegistry`](https://github.com/asteasolutions/zod-to-openapi#the-registry) object via `app.openAPIRegistry`:
+
+```ts
+const registry = app.openAPIRegistry
+```
+
 ### Middleware
 
 Zod OpenAPI Hono is an extension of Hono, so you can use Hono's middleware in the same way:
@@ -209,6 +212,47 @@ const appRoutes = app.openapi(route, (c) => {
 const client = hc<typeof appRoutes>('http://localhost:8787/')
 ```
 
+## Limitations
+
+An instance of Zod OpenAPI Hono cannot be used as a "subApp" in conjunction with `rootApp.route('/api', subApp)`.
+Use `app.mount('/api', subApp.fetch)` instead.
+
+```ts
+const api = OpenAPIHono()
+
+// ...
+
+// Set the `/api` as a base path in the document.
+api.get('/doc', (c) => {
+  const url = new URL(c.req.url)
+  url.pathname = '/api'
+  url.search = ''
+
+  return c.json(
+    // `api.getOpenAPIDocument()` will return a JSON object of the docs.
+    api.getOpenAPIDocument({
+      openapi: '3.0.0',
+      info: {
+        version: '1.0.0',
+        title: 'My API',
+      },
+      servers: [
+        {
+          url: `${url.toString()}`,
+        },
+      ],
+    })
+  )
+})
+
+const app = new Hono()
+
+// Mount the Open API app to `/api` in the main app.
+app.mount('/api', api.fetch)
+
+export default app
+```
+
 ## References
 
 - [Hono](https://hono.dev/)

package/dist/index.cjs

@@ -16,24 +16,6 @@ var __copyProps = (to, from, except, desc) => {
   return to;
 };
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
-var __accessCheck = (obj, member, msg) => {
-  if (!member.has(obj))
-    throw TypeError("Cannot " + msg);
-};
-var __privateGet = (obj, member, getter) => {
-  __accessCheck(obj, member, "read from private field");
-  return getter ? getter.call(obj) : member.get(obj);
-};
-var __privateAdd = (obj, member, value) => {
-  if (member.has(obj))
-    throw TypeError("Cannot add the same private member more than once");
-  member instanceof WeakSet ? member.add(obj) : member.set(obj, value);
-};
-var __privateSet = (obj, member, value, setter) => {
-  __accessCheck(obj, member, "write to private field");
-  setter ? setter.call(obj, value) : member.set(obj, value);
-  return value;
-};
 
 // src/index.ts
 var src_exports = {};
@@ -48,13 +30,11 @@ var import_zod_to_openapi2 = require("@asteasolutions/zod-to-openapi");
 var import_zod_validator = require("@hono/zod-validator");
 var import_hono = require("hono");
 var import_zod = require("zod");
-var _registry;
 var OpenAPIHono = class extends import_hono.Hono {
   constructor() {
     super();
-    __privateAdd(this, _registry, void 0);
     this.openapi = (route, handler, hook) => {
-      __privateGet(this, _registry).registerPath(route);
+      this.openAPIRegistry.registerPath(route);
       const validators = [];
       if (route.request?.query) {
         const validator = (0, import_zod_validator.zValidator)("query", route.request.query, hook);
@@ -64,6 +44,14 @@ var OpenAPIHono = class extends import_hono.Hono {
         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)) {
@@ -87,7 +75,7 @@ var OpenAPIHono = class extends import_hono.Hono {
       return this;
     };
     this.getOpenAPIDocument = (config) => {
-      const generator = new import_zod_to_openapi.OpenApiGeneratorV3(__privateGet(this, _registry).definitions);
+      const generator = new import_zod_to_openapi.OpenApiGeneratorV3(this.openAPIRegistry.definitions);
       const document = generator.generateDocument(config);
       return document;
     };
@@ -97,10 +85,9 @@ var OpenAPIHono = class extends import_hono.Hono {
         return c.json(document);
       });
     };
-    __privateSet(this, _registry, new import_zod_to_openapi.OpenAPIRegistry());
+    this.openAPIRegistry = new import_zod_to_openapi.OpenAPIRegistry();
   }
 };
-_registry = new WeakMap();
 var createRoute = (routeConfig) => routeConfig;
 (0, import_zod_to_openapi2.extendZodWithOpenApi)(import_zod.z);
 // Annotate the CommonJS export names for ESM import in node:

package/dist/index.d.cts

@@ -1,5 +1,5 @@
 import * as openapi3_ts_oas30 from 'openapi3-ts/oas30';
-import { RouteConfig, ZodRequestBody, ZodContentObject, ResponseConfig } from '@asteasolutions/zod-to-openapi';
+import { OpenAPIRegistry, RouteConfig, ZodRequestBody, ZodContentObject, ResponseConfig } from '@asteasolutions/zod-to-openapi';
 import { OpenAPIObjectConfig } from '@asteasolutions/zod-to-openapi/dist/v3.0/openapi-generator';
 import { Env, Schema, Hono, Input, Handler, ToSchema, Context, TypedResponse } from 'hono';
 import { AnyZodObject, z, ZodSchema, ZodError, ZodType } from 'zod';
@@ -48,10 +48,11 @@ type Hook<T, E extends Env, P extends string, O> = (result: {
     error: ZodError;
 }, c: Context<E, P>) => TypedResponse<O> | Promise<TypedResponse<T>> | void;
 type ConvertPathType<T extends string> = T extends `${infer _}/{${infer Param}}${infer _}` ? `/:${Param}` : T;
+type HandlerResponse<O> = TypedResponse<O> | Promise<TypedResponse<O>>;
 declare class OpenAPIHono<E extends Env = Env, S extends Schema = {}, BasePath extends string = '/'> extends Hono<E, S, BasePath> {
-    #private;
+    openAPIRegistry: OpenAPIRegistry;
     constructor();
-    openapi: <R extends RouteConfig, I extends Input = InputTypeBase<R, "params", "param"> & InputTypeBase<R, "query", "query"> & InputTypeForm<R> & InputTypeJson<R>, P extends string = ConvertPathType<R["path"]>>(route: R, handler: Handler<E, P, I, OutputType<R>>, hook?: Hook<I, E, P, OutputType<R>> | undefined) => Hono<E, ToSchema<R["method"], P, I["in"], OutputType<R>>, BasePath>;
+    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"]>>(route: R, handler: Handler<E, P, I, HandlerResponse<OutputType<R>>>, hook?: Hook<I, E, P, OutputType<R>> | undefined) => Hono<E, ToSchema<R["method"], P, I["in"], OutputType<R>>, BasePath>;
     getOpenAPIDocument: (config: OpenAPIObjectConfig) => openapi3_ts_oas30.OpenAPIObject;
     doc: (path: string, config: OpenAPIObjectConfig) => void;
 }

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 import * as openapi3_ts_oas30 from 'openapi3-ts/oas30';
-import { RouteConfig, ZodRequestBody, ZodContentObject, ResponseConfig } from '@asteasolutions/zod-to-openapi';
+import { OpenAPIRegistry, RouteConfig, ZodRequestBody, ZodContentObject, ResponseConfig } from '@asteasolutions/zod-to-openapi';
 import { OpenAPIObjectConfig } from '@asteasolutions/zod-to-openapi/dist/v3.0/openapi-generator';
 import { Env, Schema, Hono, Input, Handler, ToSchema, Context, TypedResponse } from 'hono';
 import { AnyZodObject, z, ZodSchema, ZodError, ZodType } from 'zod';
@@ -48,10 +48,11 @@ type Hook<T, E extends Env, P extends string, O> = (result: {
     error: ZodError;
 }, c: Context<E, P>) => TypedResponse<O> | Promise<TypedResponse<T>> | void;
 type ConvertPathType<T extends string> = T extends `${infer _}/{${infer Param}}${infer _}` ? `/:${Param}` : T;
+type HandlerResponse<O> = TypedResponse<O> | Promise<TypedResponse<O>>;
 declare class OpenAPIHono<E extends Env = Env, S extends Schema = {}, BasePath extends string = '/'> extends Hono<E, S, BasePath> {
-    #private;
+    openAPIRegistry: OpenAPIRegistry;
     constructor();
-    openapi: <R extends RouteConfig, I extends Input = InputTypeBase<R, "params", "param"> & InputTypeBase<R, "query", "query"> & InputTypeForm<R> & InputTypeJson<R>, P extends string = ConvertPathType<R["path"]>>(route: R, handler: Handler<E, P, I, OutputType<R>>, hook?: Hook<I, E, P, OutputType<R>> | undefined) => Hono<E, ToSchema<R["method"], P, I["in"], OutputType<R>>, BasePath>;
+    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"]>>(route: R, handler: Handler<E, P, I, HandlerResponse<OutputType<R>>>, hook?: Hook<I, E, P, OutputType<R>> | undefined) => Hono<E, ToSchema<R["method"], P, I["in"], OutputType<R>>, BasePath>;
     getOpenAPIDocument: (config: OpenAPIObjectConfig) => openapi3_ts_oas30.OpenAPIObject;
     doc: (path: string, config: OpenAPIObjectConfig) => void;
 }

package/dist/index.js

@@ -1,35 +1,14 @@
-var __accessCheck = (obj, member, msg) => {
-  if (!member.has(obj))
-    throw TypeError("Cannot " + msg);
-};
-var __privateGet = (obj, member, getter) => {
-  __accessCheck(obj, member, "read from private field");
-  return getter ? getter.call(obj) : member.get(obj);
-};
-var __privateAdd = (obj, member, value) => {
-  if (member.has(obj))
-    throw TypeError("Cannot add the same private member more than once");
-  member instanceof WeakSet ? member.add(obj) : member.set(obj, value);
-};
-var __privateSet = (obj, member, value, setter) => {
-  __accessCheck(obj, member, "write to private field");
-  setter ? setter.call(obj, value) : member.set(obj, value);
-  return value;
-};
-
 // src/index.ts
 import { OpenApiGeneratorV3, OpenAPIRegistry } from "@asteasolutions/zod-to-openapi";
 import { extendZodWithOpenApi } from "@asteasolutions/zod-to-openapi";
 import { zValidator } from "@hono/zod-validator";
 import { Hono } from "hono";
 import { z, ZodType } from "zod";
-var _registry;
 var OpenAPIHono = class extends Hono {
   constructor() {
     super();
-    __privateAdd(this, _registry, void 0);
     this.openapi = (route, handler, hook) => {
-      __privateGet(this, _registry).registerPath(route);
+      this.openAPIRegistry.registerPath(route);
       const validators = [];
       if (route.request?.query) {
         const validator = zValidator("query", route.request.query, hook);
@@ -39,6 +18,14 @@ var OpenAPIHono = class extends Hono {
         const validator = zValidator("param", route.request.params, hook);
         validators.push(validator);
       }
+      if (route.request?.headers) {
+        const validator = zValidator("header", route.request.headers, hook);
+        validators.push(validator);
+      }
+      if (route.request?.cookies) {
+        const 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)) {
@@ -62,7 +49,7 @@ var OpenAPIHono = class extends Hono {
       return this;
     };
     this.getOpenAPIDocument = (config) => {
-      const generator = new OpenApiGeneratorV3(__privateGet(this, _registry).definitions);
+      const generator = new OpenApiGeneratorV3(this.openAPIRegistry.definitions);
       const document = generator.generateDocument(config);
       return document;
     };
@@ -72,10 +59,9 @@ var OpenAPIHono = class extends Hono {
         return c.json(document);
       });
     };
-    __privateSet(this, _registry, new OpenAPIRegistry());
+    this.openAPIRegistry = new OpenAPIRegistry();
   }
 };
-_registry = new WeakMap();
 var createRoute = (routeConfig) => routeConfig;
 extendZodWithOpenApi(z);
 export {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hono/zod-openapi",
-  "version": "0.1.2",
+  "version": "0.3.0",
   "description": "A wrapper class of Hono which supports OpenAPI.",
   "type": "module",
   "main": "dist/index.js",
@@ -31,7 +31,7 @@
     "zod": "3.*"
   },
   "devDependencies": {
-    "hono": "^3.5.4",
+    "hono": "^3.5.8",
     "zod": "^3.22.1"
   },
   "dependencies": {
@@ -41,4 +41,4 @@
   "engines": {
     "node": ">=16.0.0"
   }
-}
+}