@hono/zod-openapi 0.1.1 → 0.2.0

package/README.md

@@ -6,7 +6,6 @@ _Note: This is not standalone middleware but is hosted on the monorepo "[github.
 
 ## 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
@@ -63,7 +62,7 @@ import { createRoute } from '@hono/zod-openapi'
 
 const route = createRoute({
   method: 'get',
-  path: '/users/:id',
+  path: '/users/{id}',
   request: {
     params: ParamsSchema,
   },
@@ -134,7 +133,7 @@ Then, add the error response:
 ```ts
 const route = createRoute({
   method: 'get',
-  path: '/users/:id',
+  path: '/users/{id}',
   request: {
     params: ParamsSchema,
   },
@@ -159,7 +158,7 @@ app.openapi(
   (c) => {
     const { id } = c.req.valid('param')
     return c.jsonT({
-      id: Number(id),
+      id,
       age: 20,
       name: 'Ultra-man',
     })

package/dist/index.cjs

@@ -64,6 +64,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)) {

package/dist/index.d.cts

@@ -1,7 +1,7 @@
 import * as openapi3_ts_oas30 from 'openapi3-ts/oas30';
 import { RouteConfig, ZodRequestBody, ZodContentObject, ResponseConfig } from '@asteasolutions/zod-to-openapi';
 import { OpenAPIObjectConfig } from '@asteasolutions/zod-to-openapi/dist/v3.0/openapi-generator';
-import { Env, Hono, Input, Handler, Schema, Context, TypedResponse } from 'hono';
+import { Env, Schema, Hono, Input, Handler, ToSchema, Context, TypedResponse } from 'hono';
 import { AnyZodObject, z, ZodSchema, ZodError, ZodType } from 'zod';
 export { z } from 'zod';
 
@@ -48,10 +48,10 @@ 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;
-declare class OpenAPIHono<E extends Env = Env, S = {}, BasePath extends string = '/'> extends Hono<E, S, BasePath> {
+declare class OpenAPIHono<E extends Env = Env, S extends Schema = {}, BasePath extends string = '/'> extends Hono<E, S, BasePath> {
     #private;
     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, Schema<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, 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,7 +1,7 @@
 import * as openapi3_ts_oas30 from 'openapi3-ts/oas30';
 import { RouteConfig, ZodRequestBody, ZodContentObject, ResponseConfig } from '@asteasolutions/zod-to-openapi';
 import { OpenAPIObjectConfig } from '@asteasolutions/zod-to-openapi/dist/v3.0/openapi-generator';
-import { Env, Hono, Input, Handler, Schema, Context, TypedResponse } from 'hono';
+import { Env, Schema, Hono, Input, Handler, ToSchema, Context, TypedResponse } from 'hono';
 import { AnyZodObject, z, ZodSchema, ZodError, ZodType } from 'zod';
 export { z } from 'zod';
 
@@ -48,10 +48,10 @@ 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;
-declare class OpenAPIHono<E extends Env = Env, S = {}, BasePath extends string = '/'> extends Hono<E, S, BasePath> {
+declare class OpenAPIHono<E extends Env = Env, S extends Schema = {}, BasePath extends string = '/'> extends Hono<E, S, BasePath> {
     #private;
     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, Schema<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, 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

@@ -39,6 +39,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)) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hono/zod-openapi",
-  "version": "0.1.1",
+  "version": "0.2.0",
   "description": "A wrapper class of Hono which supports OpenAPI.",
   "type": "module",
   "main": "dist/index.js",
@@ -31,14 +31,14 @@
     "zod": "3.*"
   },
   "devDependencies": {
-    "hono": "^3.4.3",
+    "hono": "^3.5.4",
     "zod": "^3.22.1"
   },
   "dependencies": {
     "@asteasolutions/zod-to-openapi": "^5.5.0",
-    "@hono/zod-validator": "^0.1.7"
+    "@hono/zod-validator": "^0.1.8"
   },
   "engines": {
     "node": ">=16.0.0"
   }
-}
+}