@hono/zod-openapi 0.16.3 → 0.17.0

package/README.md

@@ -51,7 +51,8 @@ const UserSchema = z
   .openapi('User')
 ```
 
-> [!TIP] > `UserSchema` schema will be registered as `"#/components/schemas/User"` refs in the OpenAPI document.
+> [!TIP]
+> `UserSchema` schema will be registered as `"#/components/schemas/User"` refs in the OpenAPI document.
 > If you want to register the schema as referenced components, use `.openapi()` method.
 
 Next, create a route:

package/dist/index.d.mts

@@ -85,6 +85,39 @@ type OpenAPIHonoOptions<E extends Env> = {
     defaultHook?: Hook<any, E, any, any>;
 };
 type HonoInit<E extends Env> = ConstructorParameters<typeof Hono>[0] & OpenAPIHonoOptions<E>;
+/**
+ * Turns `T | T[] | undefined` into `T[]`
+ */
+type AsArray<T> = T extends undefined ? [] : T extends any[] ? T : [T];
+/**
+ * Like simplify but recursive
+ */
+type DeepSimplify<T> = {
+    [KeyType in keyof T]: T[KeyType] extends object ? DeepSimplify<T[KeyType]> : T[KeyType];
+} & {};
+/**
+ * Helper to infer generics from {@link MiddlewareHandler}
+ */
+type OfHandlerType<T extends MiddlewareHandler> = T extends MiddlewareHandler<infer E, infer P, infer I> ? {
+    env: E;
+    path: P;
+    input: I;
+} : never;
+/**
+ * Reduce a tuple of middleware handlers into a single
+ * handler representing the composition of all
+ * handlers.
+ */
+type MiddlewareToHandlerType<M extends MiddlewareHandler<any, any, any>[]> = M extends [
+    infer First,
+    infer Second,
+    ...infer Rest
+] ? First extends MiddlewareHandler<any, any, any> ? Second extends MiddlewareHandler<any, any, any> ? Rest extends MiddlewareHandler<any, any, any>[] ? MiddlewareToHandlerType<[
+    MiddlewareHandler<DeepSimplify<OfHandlerType<First>['env'] & OfHandlerType<Second>['env']>, // Combine envs
+    OfHandlerType<First>['path'], // Keep path from First
+    OfHandlerType<First>['input']>,
+    ...Rest
+]> : never : never : never : M extends [infer Last] ? Last : never;
 type RouteHandler<R extends RouteConfig, E extends Env = Env, I extends Input = InputTypeParam<R> & InputTypeQuery<R> & InputTypeHeader<R> & InputTypeCookie<R> & InputTypeForm<R> & InputTypeJson<R>, P extends string = ConvertPathType<R['path']>> = Handler<E, P, I, R extends {
     responses: {
         [statusCode: number]: {
@@ -132,7 +165,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<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, ...route }: R, handler: Handler<R['middleware'] extends MiddlewareHandler[] | MiddlewareHandler ? OfHandlerType<MiddlewareToHandlerType<AsArray<R['middleware']>>>['env'] & E : E, P, I, R extends {
         responses: {
             [statusCode: number]: {
                 content: {
@@ -164,4 +197,4 @@ declare const createRoute: <P extends string, R extends Omit<RouteConfig, "path"
     getRoutingPath(): RoutingPath<R['path']>;
 };
 
-export { type Hook, OpenAPIHono, type OpenAPIHonoOptions, type OpenAPIObjectConfigure, type RouteConfig, type RouteConfigToTypedResponse, type RouteHandler, type RouteHook, createRoute };
+export { type DeepSimplify, type Hook, type MiddlewareToHandlerType, type OfHandlerType, OpenAPIHono, type OpenAPIHonoOptions, type OpenAPIObjectConfigure, type RouteConfig, type RouteConfigToTypedResponse, type RouteHandler, type RouteHook, createRoute };

package/dist/index.d.ts

@@ -85,6 +85,39 @@ type OpenAPIHonoOptions<E extends Env> = {
     defaultHook?: Hook<any, E, any, any>;
 };
 type HonoInit<E extends Env> = ConstructorParameters<typeof Hono>[0] & OpenAPIHonoOptions<E>;
+/**
+ * Turns `T | T[] | undefined` into `T[]`
+ */
+type AsArray<T> = T extends undefined ? [] : T extends any[] ? T : [T];
+/**
+ * Like simplify but recursive
+ */
+type DeepSimplify<T> = {
+    [KeyType in keyof T]: T[KeyType] extends object ? DeepSimplify<T[KeyType]> : T[KeyType];
+} & {};
+/**
+ * Helper to infer generics from {@link MiddlewareHandler}
+ */
+type OfHandlerType<T extends MiddlewareHandler> = T extends MiddlewareHandler<infer E, infer P, infer I> ? {
+    env: E;
+    path: P;
+    input: I;
+} : never;
+/**
+ * Reduce a tuple of middleware handlers into a single
+ * handler representing the composition of all
+ * handlers.
+ */
+type MiddlewareToHandlerType<M extends MiddlewareHandler<any, any, any>[]> = M extends [
+    infer First,
+    infer Second,
+    ...infer Rest
+] ? First extends MiddlewareHandler<any, any, any> ? Second extends MiddlewareHandler<any, any, any> ? Rest extends MiddlewareHandler<any, any, any>[] ? MiddlewareToHandlerType<[
+    MiddlewareHandler<DeepSimplify<OfHandlerType<First>['env'] & OfHandlerType<Second>['env']>, // Combine envs
+    OfHandlerType<First>['path'], // Keep path from First
+    OfHandlerType<First>['input']>,
+    ...Rest
+]> : never : never : never : M extends [infer Last] ? Last : never;
 type RouteHandler<R extends RouteConfig, E extends Env = Env, I extends Input = InputTypeParam<R> & InputTypeQuery<R> & InputTypeHeader<R> & InputTypeCookie<R> & InputTypeForm<R> & InputTypeJson<R>, P extends string = ConvertPathType<R['path']>> = Handler<E, P, I, R extends {
     responses: {
         [statusCode: number]: {
@@ -132,7 +165,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<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, ...route }: R, handler: Handler<R['middleware'] extends MiddlewareHandler[] | MiddlewareHandler ? OfHandlerType<MiddlewareToHandlerType<AsArray<R['middleware']>>>['env'] & E : E, P, I, R extends {
         responses: {
             [statusCode: number]: {
                 content: {
@@ -164,4 +197,4 @@ declare const createRoute: <P extends string, R extends Omit<RouteConfig, "path"
     getRoutingPath(): RoutingPath<R['path']>;
 };
 
-export { type Hook, OpenAPIHono, type OpenAPIHonoOptions, type OpenAPIObjectConfigure, type RouteConfig, type RouteConfigToTypedResponse, type RouteHandler, type RouteHook, createRoute };
+export { type DeepSimplify, type Hook, type MiddlewareToHandlerType, type OfHandlerType, OpenAPIHono, type OpenAPIHonoOptions, type OpenAPIObjectConfigure, type RouteConfig, type RouteConfigToTypedResponse, type RouteHandler, type RouteHook, createRoute };

package/package.json

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