Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/zod-openapi-define-route-middleware-env.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@hono/zod-openapi': patch
---

`defineOpenAPIRoute` now infers handler `Env` (Variables/Bindings) from the route's `middleware`, matching `OpenAPIHono.openapi()` behavior.
40 changes: 39 additions & 1 deletion packages/zod-openapi/src/handler.test-d.ts
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import type { MiddlewareHandler } from 'hono'
import type { Equal, Expect } from 'hono/utils/types'
import type { MiddlewareToHandlerType, OfHandlerType, RouteHandler } from '.'
import { OpenAPIHono, createRoute, z } from '.'
import { OpenAPIHono, createRoute, defineOpenAPIRoute, z } from '.'

describe('supports async handler', () => {
const route = createRoute({
Expand Down Expand Up @@ -229,3 +229,41 @@ describe('supports async handler', () => {
hono.openapi(routeWithDefault, errorHandler)
})
})

describe('defineOpenAPIRoute', () => {
test('handler infers env type from route middleware', () => {
// https://github.com/honojs/middleware/issues/1879
type Identity = { id: string }
type CustomEnv = { Variables: { identity: Identity } }

const requireIdentity: MiddlewareHandler<CustomEnv> = async (c, next) => {
c.set('identity', { id: '123' })
await next()
}

const definition = defineOpenAPIRoute({
route: createRoute({
method: 'get',
path: '/me',
middleware: [requireIdentity] as const,
responses: {
200: {
content: {
'application/json': {
schema: z.object({ id: z.string() }),
},
},
description: 'ok',
},
},
}),
handler: (c) => {
type IdentityType = typeof c.var.identity
type Verify = Expect<Equal<IdentityType, Identity>>
return c.json({ id: c.var.identity.id }, 200)
},
})

new OpenAPIHono().openapiRoutes([definition])
})
})
11 changes: 9 additions & 2 deletions packages/zod-openapi/src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -404,9 +404,16 @@ type ComputeInput<R extends RouteConfig> = InputTypeParam<R> &
InputTypeForm<R> &
InputTypeJson<R>

// Helper: Merge env with route middleware env (if any)
type EnvFromRoute<R extends RouteConfig, E extends Env> = R['middleware'] extends
| MiddlewareHandler[]
| MiddlewareHandler
? RouteMiddlewareParams<R>['env'] & E
: E

// Helper: Calculate the expected Handler type for a specific RouteConfig
type HandlerFromRoute<R extends RouteConfig, E extends Env> = Handler<
E,
EnvFromRoute<R, E>,
ConvertPathType<R['path']>,
ComputeInput<R>,
R extends {
Expand All @@ -425,7 +432,7 @@ type HandlerFromRoute<R extends RouteConfig, E extends Env> = Handler<
type HookFromRoute<R extends RouteConfig, E extends Env> =
| Hook<
ComputeInput<R>,
E,
EnvFromRoute<R, E>,
ConvertPathType<R['path']>,
R extends {
responses: {
Expand Down
Loading