@hono/zod-openapi 0.19.8 → 0.19.9

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @hono/zod-openapi
 
+## 0.19.9
+
+### Patch Changes
+
+- [#1217](https://github.com/honojs/middleware/pull/1217) [`9f64138406a2c513462f2a4873b2ef8be36df9d8`](https://github.com/honojs/middleware/commit/9f64138406a2c513462f2a4873b2ef8be36df9d8) Thanks [@BarryThePenguin](https://github.com/BarryThePenguin)! - Add explicit return types
+
 ## 0.19.8
 
 ### Patch Changes

package/README.md

@@ -472,7 +472,7 @@ Be careful when combining `OpenAPIHono` instances with plain `Hono` instances. `
 
 If you're migrating from plain `Hono` to `OpenAPIHono`, we recommend porting your top-level app, then working your way down the router tree.
 
-When using the `.route()` method to mount a child OpenAPIHono app that uses path parameters, you should use the Hono *:param* syntax in the parent route path, rather than the OpenAPI *{param}* syntax:
+When using the `.route()` method to mount a child OpenAPIHono app that uses path parameters, you should use the Hono _:param_ syntax in the parent route path, rather than the OpenAPI _{param}_ syntax:
 
 ```
 const bookActionsApp = new OpenAPIHono()

package/dist/index.cjs

@@ -189,8 +189,8 @@ var OpenAPIHono = class _OpenAPIHono extends import_hono.Hono {
       switch (def.type) {
         case "component":
           return this.openAPIRegistry.registerComponent(def.componentType, def.name, def.component);
-        case "route":
-          return this.openAPIRegistry.registerPath({
+        case "route": {
+          this.openAPIRegistry.registerPath({
             ...def.route,
             path: (0, import_url.mergePath)(
               pathForOpenAPI,
@@ -199,8 +199,10 @@ var OpenAPIHono = class _OpenAPIHono extends import_hono.Hono {
               def.route.path
             )
           });
-        case "webhook":
-          return this.openAPIRegistry.registerWebhook({
+          return;
+        }
+        case "webhook": {
+          this.openAPIRegistry.registerWebhook({
             ...def.webhook,
             path: (0, import_url.mergePath)(
               pathForOpenAPI,
@@ -209,6 +211,8 @@ var OpenAPIHono = class _OpenAPIHono extends import_hono.Hono {
               def.webhook.path
             )
           });
+          return;
+        }
         case "schema":
           return this.openAPIRegistry.register(def.schema._def.openapi._internal.refId, def.schema);
         case "parameter":

package/dist/index.d.cts

@@ -1,13 +1,11 @@
-import * as openapi3_ts_oas31 from 'openapi3-ts/oas31';
-import * as _asteasolutions_zod_to_openapi_dist_v3_1_openapi_generator from '@asteasolutions/zod-to-openapi/dist/v3.1/openapi-generator';
-import * as openapi3_ts_oas30 from 'openapi3-ts/oas30';
-import * as _asteasolutions_zod_to_openapi_dist_v3_0_openapi_generator from '@asteasolutions/zod-to-openapi/dist/v3.0/openapi-generator';
 import { RouteConfig as RouteConfig$1, ZodRequestBody, ZodContentObject, ZodMediaTypeObject, OpenApiGeneratorV3, OpenAPIRegistry } from '@asteasolutions/zod-to-openapi';
 export { extendZodWithOpenApi } from '@asteasolutions/zod-to-openapi';
 import { MiddlewareHandler, TypedResponse, Env, ValidationTargets, Context, Input, Handler, Schema, Hono, ToSchema } from 'hono';
 import { MergePath, MergeSchemaPath } from 'hono/types';
 import { InfoStatusCode, SuccessStatusCode, RedirectStatusCode, ClientErrorStatusCode, ServerErrorStatusCode, StatusCode } from 'hono/utils/http-status';
 import { SimplifyDeepArray, JSONValue, JSONParsed, RemoveBlankRecord } from 'hono/utils/types';
+import { OpenAPIObject } from 'openapi3-ts/oas30';
+import { OpenAPIObject as OpenAPIObject$1 } from 'openapi3-ts/oas31';
 import { ZodSchema, z, ZodError, ZodType } from 'zod';
 export { z } from 'zod';
 
@@ -193,8 +191,8 @@ declare class OpenAPIHono<E extends Env = Env, S extends Schema = {}, BasePath e
             };
         };
     } ? MaybePromise<RouteConfigToTypedResponse<R>> | undefined : MaybePromise<RouteConfigToTypedResponse<R>> | MaybePromise<Response> | undefined> | undefined) => OpenAPIHono<E, S & ToSchema<R["method"], MergePath<BasePath, P>, I, RouteConfigToTypedResponse<R>>, BasePath>;
-    getOpenAPIDocument: (config: OpenAPIObjectConfig) => ReturnType<(config: _asteasolutions_zod_to_openapi_dist_v3_0_openapi_generator.OpenAPIObjectConfig) => openapi3_ts_oas30.OpenAPIObject>;
-    getOpenAPI31Document: (config: OpenAPIObjectConfig) => ReturnType<(config: _asteasolutions_zod_to_openapi_dist_v3_1_openapi_generator.OpenAPIObjectConfigV31) => openapi3_ts_oas31.OpenAPIObject>;
+    getOpenAPIDocument: (config: OpenAPIObjectConfig) => OpenAPIObject;
+    getOpenAPI31Document: (config: OpenAPIObjectConfig) => OpenAPIObject$1;
     doc: <P extends string>(path: P, configure: OpenAPIObjectConfigure<E, P>) => OpenAPIHono<E, S & ToSchema<"get", P, {}, {}>, BasePath>;
     doc31: <P extends string>(path: P, configure: OpenAPIObjectConfigure<E, P>) => OpenAPIHono<E, S & ToSchema<"get", P, {}, {}>, BasePath>;
     route<SubPath extends string, SubEnv extends Env, SubSchema extends Schema, SubBasePath extends string>(path: SubPath, app: Hono<SubEnv, SubSchema, SubBasePath>): OpenAPIHono<E, MergeSchemaPath<SubSchema, MergePath<BasePath, SubPath>> & S, BasePath>;

package/dist/index.d.ts

@@ -1,13 +1,11 @@
-import * as openapi3_ts_oas31 from 'openapi3-ts/oas31';
-import * as _asteasolutions_zod_to_openapi_dist_v3_1_openapi_generator from '@asteasolutions/zod-to-openapi/dist/v3.1/openapi-generator';
-import * as openapi3_ts_oas30 from 'openapi3-ts/oas30';
-import * as _asteasolutions_zod_to_openapi_dist_v3_0_openapi_generator from '@asteasolutions/zod-to-openapi/dist/v3.0/openapi-generator';
 import { RouteConfig as RouteConfig$1, ZodRequestBody, ZodContentObject, ZodMediaTypeObject, OpenApiGeneratorV3, OpenAPIRegistry } from '@asteasolutions/zod-to-openapi';
 export { extendZodWithOpenApi } from '@asteasolutions/zod-to-openapi';
 import { MiddlewareHandler, TypedResponse, Env, ValidationTargets, Context, Input, Handler, Schema, Hono, ToSchema } from 'hono';
 import { MergePath, MergeSchemaPath } from 'hono/types';
 import { InfoStatusCode, SuccessStatusCode, RedirectStatusCode, ClientErrorStatusCode, ServerErrorStatusCode, StatusCode } from 'hono/utils/http-status';
 import { SimplifyDeepArray, JSONValue, JSONParsed, RemoveBlankRecord } from 'hono/utils/types';
+import { OpenAPIObject } from 'openapi3-ts/oas30';
+import { OpenAPIObject as OpenAPIObject$1 } from 'openapi3-ts/oas31';
 import { ZodSchema, z, ZodError, ZodType } from 'zod';
 export { z } from 'zod';
 
@@ -193,8 +191,8 @@ declare class OpenAPIHono<E extends Env = Env, S extends Schema = {}, BasePath e
             };
         };
     } ? MaybePromise<RouteConfigToTypedResponse<R>> | undefined : MaybePromise<RouteConfigToTypedResponse<R>> | MaybePromise<Response> | undefined> | undefined) => OpenAPIHono<E, S & ToSchema<R["method"], MergePath<BasePath, P>, I, RouteConfigToTypedResponse<R>>, BasePath>;
-    getOpenAPIDocument: (config: OpenAPIObjectConfig) => ReturnType<(config: _asteasolutions_zod_to_openapi_dist_v3_0_openapi_generator.OpenAPIObjectConfig) => openapi3_ts_oas30.OpenAPIObject>;
-    getOpenAPI31Document: (config: OpenAPIObjectConfig) => ReturnType<(config: _asteasolutions_zod_to_openapi_dist_v3_1_openapi_generator.OpenAPIObjectConfigV31) => openapi3_ts_oas31.OpenAPIObject>;
+    getOpenAPIDocument: (config: OpenAPIObjectConfig) => OpenAPIObject;
+    getOpenAPI31Document: (config: OpenAPIObjectConfig) => OpenAPIObject$1;
     doc: <P extends string>(path: P, configure: OpenAPIObjectConfigure<E, P>) => OpenAPIHono<E, S & ToSchema<"get", P, {}, {}>, BasePath>;
     doc31: <P extends string>(path: P, configure: OpenAPIObjectConfigure<E, P>) => OpenAPIHono<E, S & ToSchema<"get", P, {}, {}>, BasePath>;
     route<SubPath extends string, SubEnv extends Env, SubSchema extends Schema, SubBasePath extends string>(path: SubPath, app: Hono<SubEnv, SubSchema, SubBasePath>): OpenAPIHono<E, MergeSchemaPath<SubSchema, MergePath<BasePath, SubPath>> & S, BasePath>;

package/dist/index.js

@@ -167,8 +167,8 @@ var OpenAPIHono = class _OpenAPIHono extends Hono {
       switch (def.type) {
         case "component":
           return this.openAPIRegistry.registerComponent(def.componentType, def.name, def.component);
-        case "route":
-          return this.openAPIRegistry.registerPath({
+        case "route": {
+          this.openAPIRegistry.registerPath({
             ...def.route,
             path: mergePath(
               pathForOpenAPI,
@@ -177,8 +177,10 @@ var OpenAPIHono = class _OpenAPIHono extends Hono {
               def.route.path
             )
           });
-        case "webhook":
-          return this.openAPIRegistry.registerWebhook({
+          return;
+        }
+        case "webhook": {
+          this.openAPIRegistry.registerWebhook({
             ...def.webhook,
             path: mergePath(
               pathForOpenAPI,
@@ -187,6 +189,8 @@ var OpenAPIHono = class _OpenAPIHono extends Hono {
               def.webhook.path
             )
           });
+          return;
+        }
         case "schema":
           return this.openAPIRegistry.register(def.schema._def.openapi._internal.refId, def.schema);
         case "parameter":

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hono/zod-openapi",
-  "version": "0.19.8",
+  "version": "0.19.9",
   "description": "A wrapper class of Hono which supports OpenAPI.",
   "type": "module",
   "module": "dist/index.js",
@@ -47,13 +47,14 @@
     "publint": "^0.3.9",
     "tsup": "^8.4.0",
     "typescript": "^5.8.2",
-    "vitest": "^3.0.8",
+    "vitest": "^3.2.4",
     "yaml": "^2.4.3",
     "zod": "^3.22.1"
   },
   "dependencies": {
     "@asteasolutions/zod-to-openapi": "^7.3.0",
-    "@hono/zod-validator": "^0.7.0"
+    "@hono/zod-validator": "^0.7.0",
+    "openapi3-ts": "^4.5.0"
   },
   "engines": {
     "node": ">=16.0.0"