@hono/zod-openapi 1.0.2 → 1.1.0

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @hono/zod-openapi
 
+## 1.1.0
+
+### Minor Changes
+
+- [#1353](https://github.com/honojs/middleware/pull/1353) [`f42a557f47f6e9cba1cbc40ad0cd8c0d798146c0`](https://github.com/honojs/middleware/commit/f42a557f47f6e9cba1cbc40ad0cd8c0d798146c0) Thanks [@yumuranaoki](https://github.com/yumuranaoki)! - Add optional generator options parameter to doc middleware
+
 ## 1.0.2
 
 ### Patch Changes

package/README.md

@@ -309,12 +309,19 @@ You can generate OpenAPI v3.1 spec using the following methods:
 
 ```ts
 app.doc31('/docs', { openapi: '3.1.0', info: { title: 'foo', version: '1' } }) // new endpoint
-app.getOpenAPI31Document({
-  openapi: '3.1.0',
-  info: { title: 'foo', version: '1' },
-}) // schema object
+app.getOpenAPI31Document(
+  {
+    openapi: '3.1.0',
+    info: { title: 'foo', version: '1' },
+  }, // OpenAPI object config
+  {
+    unionPreferredType: 'oneOf',
+  } // Generator options
+) // schema object
 ```
 
+The second parameter is optional and accepts generator options as supported by the `@asteasolutions/zod-to-openapi` library. Refer to their documentation for the complete list of available options and their usage.
+
 ### The Registry
 
 You can access the [`OpenAPIRegistry`](https://github.com/asteasolutions/zod-to-openapi#the-registry) object via `app.openAPIRegistry`:

package/dist/index.cjs

@@ -147,32 +147,34 @@ var OpenAPIHono = class _OpenAPIHono extends import_hono.Hono {
     );
     return this;
   };
-  getOpenAPIDocument = (config) => {
-    const generator = new import_zod_to_openapi.OpenApiGeneratorV3(this.openAPIRegistry.definitions);
-    const document = generator.generateDocument(config);
+  getOpenAPIDocument = (objectConfig, generatorConfig) => {
+    const generator = new import_zod_to_openapi.OpenApiGeneratorV3(this.openAPIRegistry.definitions, generatorConfig);
+    const document = generator.generateDocument(objectConfig);
     return this._basePath ? addBasePathToDocument(document, this._basePath) : document;
   };
-  getOpenAPI31Document = (config) => {
-    const generator = new import_zod_to_openapi.OpenApiGeneratorV31(this.openAPIRegistry.definitions);
-    const document = generator.generateDocument(config);
+  getOpenAPI31Document = (objectConfig, generatorConfig) => {
+    const generator = new import_zod_to_openapi.OpenApiGeneratorV31(this.openAPIRegistry.definitions, generatorConfig);
+    const document = generator.generateDocument(objectConfig);
     return this._basePath ? addBasePathToDocument(document, this._basePath) : document;
   };
-  doc = (path, configure) => {
+  doc = (path, configureObject, configureGenerator) => {
     return this.get(path, (c) => {
-      const config = typeof configure === "function" ? configure(c) : configure;
+      const objectConfig = typeof configureObject === "function" ? configureObject(c) : configureObject;
+      const generatorConfig = typeof configureGenerator === "function" ? configureGenerator(c) : configureGenerator;
       try {
-        const document = this.getOpenAPIDocument(config);
+        const document = this.getOpenAPIDocument(objectConfig, generatorConfig);
         return c.json(document);
       } catch (e) {
         return c.json(e, 500);
       }
     });
   };
-  doc31 = (path, configure) => {
+  doc31 = (path, configureObject, configureGenerator) => {
     return this.get(path, (c) => {
-      const config = typeof configure === "function" ? configure(c) : configure;
+      const objectConfig = typeof configureObject === "function" ? configureObject(c) : configureObject;
+      const generatorConfig = typeof configureGenerator === "function" ? configureGenerator(c) : configureGenerator;
       try {
-        const document = this.getOpenAPI31Document(config);
+        const document = this.getOpenAPI31Document(objectConfig, generatorConfig);
         return c.json(document);
       } catch (e) {
         return c.json(e, 500);

package/dist/index.d.cts

@@ -139,6 +139,8 @@ type RouteHandler<R extends RouteConfig, E extends Env = RouteConfigToEnv<R>, I
 type RouteHook<R extends RouteConfig, E extends Env = RouteConfigToEnv<R>, I extends Input = InputTypeParam<R> & InputTypeQuery<R> & InputTypeHeader<R> & InputTypeCookie<R> & InputTypeForm<R> & InputTypeJson<R>, P extends string = ConvertPathType<R['path']>> = Hook<I, E, P, RouteConfigToTypedResponse<R> | Response | Promise<Response> | void | Promise<void>>;
 type OpenAPIObjectConfig = Parameters<InstanceType<typeof OpenApiGeneratorV3>['generateDocument']>[0];
 type OpenAPIObjectConfigure<E extends Env, P extends string> = OpenAPIObjectConfig | ((context: Context<E, P>) => OpenAPIObjectConfig);
+type OpenAPIGeneratorOptions = ConstructorParameters<typeof OpenApiGeneratorV3>[1];
+type OpenAPIGeneratorConfigure<E extends Env, P extends string> = OpenAPIGeneratorOptions | ((context: Context<E, P>) => OpenAPIGeneratorOptions);
 declare class OpenAPIHono<E extends Env = Env, S extends Schema = {}, BasePath extends string = '/'> extends Hono<E, S, BasePath> {
     openAPIRegistry: OpenAPIRegistry;
     defaultHook?: OpenAPIHonoOptions<E>['defaultHook'];
@@ -191,10 +193,10 @@ 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) => 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>;
+    getOpenAPIDocument: (objectConfig: OpenAPIObjectConfig, generatorConfig?: OpenAPIGeneratorOptions) => OpenAPIObject;
+    getOpenAPI31Document: (objectConfig: OpenAPIObjectConfig, generatorConfig?: OpenAPIGeneratorOptions) => OpenAPIObject$1;
+    doc: <P extends string>(path: P, configureObject: OpenAPIObjectConfigure<E, P>, configureGenerator?: OpenAPIGeneratorConfigure<E, P>) => OpenAPIHono<E, S & ToSchema<"get", P, {}, {}>, BasePath>;
+    doc31: <P extends string>(path: P, configureObject: OpenAPIObjectConfigure<E, P>, configureGenerator?: OpenAPIGeneratorConfigure<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>;
     route<SubPath extends string>(path: SubPath): Hono<E, RemoveBlankRecord<S>, BasePath>;
     basePath<SubPath extends string>(path: SubPath): OpenAPIHono<E, S, MergePath<BasePath, SubPath>>;
@@ -206,4 +208,4 @@ declare const createRoute: <P extends string, R extends Omit<RouteConfig, "path"
     getRoutingPath(): RoutingPath<R["path"]>;
 };
 
-export { type DeepSimplify, type Hook, type MiddlewareToHandlerType, type OfHandlerType, OpenAPIHono, type OpenAPIHonoOptions, type OpenAPIObjectConfigure, type RouteConfig, type RouteConfigToEnv, type RouteConfigToTypedResponse, type RouteHandler, type RouteHook, createRoute };
+export { type DeepSimplify, type Hook, type MiddlewareToHandlerType, type OfHandlerType, type OpenAPIGeneratorConfigure, type OpenAPIGeneratorOptions, OpenAPIHono, type OpenAPIHonoOptions, type OpenAPIObjectConfigure, type RouteConfig, type RouteConfigToEnv, type RouteConfigToTypedResponse, type RouteHandler, type RouteHook, createRoute };

package/dist/index.d.ts

@@ -139,6 +139,8 @@ type RouteHandler<R extends RouteConfig, E extends Env = RouteConfigToEnv<R>, I
 type RouteHook<R extends RouteConfig, E extends Env = RouteConfigToEnv<R>, I extends Input = InputTypeParam<R> & InputTypeQuery<R> & InputTypeHeader<R> & InputTypeCookie<R> & InputTypeForm<R> & InputTypeJson<R>, P extends string = ConvertPathType<R['path']>> = Hook<I, E, P, RouteConfigToTypedResponse<R> | Response | Promise<Response> | void | Promise<void>>;
 type OpenAPIObjectConfig = Parameters<InstanceType<typeof OpenApiGeneratorV3>['generateDocument']>[0];
 type OpenAPIObjectConfigure<E extends Env, P extends string> = OpenAPIObjectConfig | ((context: Context<E, P>) => OpenAPIObjectConfig);
+type OpenAPIGeneratorOptions = ConstructorParameters<typeof OpenApiGeneratorV3>[1];
+type OpenAPIGeneratorConfigure<E extends Env, P extends string> = OpenAPIGeneratorOptions | ((context: Context<E, P>) => OpenAPIGeneratorOptions);
 declare class OpenAPIHono<E extends Env = Env, S extends Schema = {}, BasePath extends string = '/'> extends Hono<E, S, BasePath> {
     openAPIRegistry: OpenAPIRegistry;
     defaultHook?: OpenAPIHonoOptions<E>['defaultHook'];
@@ -191,10 +193,10 @@ 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) => 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>;
+    getOpenAPIDocument: (objectConfig: OpenAPIObjectConfig, generatorConfig?: OpenAPIGeneratorOptions) => OpenAPIObject;
+    getOpenAPI31Document: (objectConfig: OpenAPIObjectConfig, generatorConfig?: OpenAPIGeneratorOptions) => OpenAPIObject$1;
+    doc: <P extends string>(path: P, configureObject: OpenAPIObjectConfigure<E, P>, configureGenerator?: OpenAPIGeneratorConfigure<E, P>) => OpenAPIHono<E, S & ToSchema<"get", P, {}, {}>, BasePath>;
+    doc31: <P extends string>(path: P, configureObject: OpenAPIObjectConfigure<E, P>, configureGenerator?: OpenAPIGeneratorConfigure<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>;
     route<SubPath extends string>(path: SubPath): Hono<E, RemoveBlankRecord<S>, BasePath>;
     basePath<SubPath extends string>(path: SubPath): OpenAPIHono<E, S, MergePath<BasePath, SubPath>>;
@@ -206,4 +208,4 @@ declare const createRoute: <P extends string, R extends Omit<RouteConfig, "path"
     getRoutingPath(): RoutingPath<R["path"]>;
 };
 
-export { type DeepSimplify, type Hook, type MiddlewareToHandlerType, type OfHandlerType, OpenAPIHono, type OpenAPIHonoOptions, type OpenAPIObjectConfigure, type RouteConfig, type RouteConfigToEnv, type RouteConfigToTypedResponse, type RouteHandler, type RouteHook, createRoute };
+export { type DeepSimplify, type Hook, type MiddlewareToHandlerType, type OfHandlerType, type OpenAPIGeneratorConfigure, type OpenAPIGeneratorOptions, OpenAPIHono, type OpenAPIHonoOptions, type OpenAPIObjectConfigure, type RouteConfig, type RouteConfigToEnv, type RouteConfigToTypedResponse, type RouteHandler, type RouteHook, createRoute };

package/dist/index.js

@@ -126,32 +126,34 @@ var OpenAPIHono = class _OpenAPIHono extends Hono {
     );
     return this;
   };
-  getOpenAPIDocument = (config) => {
-    const generator = new OpenApiGeneratorV3(this.openAPIRegistry.definitions);
-    const document = generator.generateDocument(config);
+  getOpenAPIDocument = (objectConfig, generatorConfig) => {
+    const generator = new OpenApiGeneratorV3(this.openAPIRegistry.definitions, generatorConfig);
+    const document = generator.generateDocument(objectConfig);
     return this._basePath ? addBasePathToDocument(document, this._basePath) : document;
   };
-  getOpenAPI31Document = (config) => {
-    const generator = new OpenApiGeneratorV31(this.openAPIRegistry.definitions);
-    const document = generator.generateDocument(config);
+  getOpenAPI31Document = (objectConfig, generatorConfig) => {
+    const generator = new OpenApiGeneratorV31(this.openAPIRegistry.definitions, generatorConfig);
+    const document = generator.generateDocument(objectConfig);
     return this._basePath ? addBasePathToDocument(document, this._basePath) : document;
   };
-  doc = (path, configure) => {
+  doc = (path, configureObject, configureGenerator) => {
     return this.get(path, (c) => {
-      const config = typeof configure === "function" ? configure(c) : configure;
+      const objectConfig = typeof configureObject === "function" ? configureObject(c) : configureObject;
+      const generatorConfig = typeof configureGenerator === "function" ? configureGenerator(c) : configureGenerator;
       try {
-        const document = this.getOpenAPIDocument(config);
+        const document = this.getOpenAPIDocument(objectConfig, generatorConfig);
         return c.json(document);
       } catch (e) {
         return c.json(e, 500);
       }
     });
   };
-  doc31 = (path, configure) => {
+  doc31 = (path, configureObject, configureGenerator) => {
     return this.get(path, (c) => {
-      const config = typeof configure === "function" ? configure(c) : configure;
+      const objectConfig = typeof configureObject === "function" ? configureObject(c) : configureObject;
+      const generatorConfig = typeof configureGenerator === "function" ? configureGenerator(c) : configureGenerator;
       try {
-        const document = this.getOpenAPI31Document(config);
+        const document = this.getOpenAPI31Document(objectConfig, generatorConfig);
         return c.json(document);
       } catch (e) {
         return c.json(e, 500);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hono/zod-openapi",
-  "version": "1.0.2",
+  "version": "1.1.0",
   "description": "A wrapper class of Hono which supports OpenAPI.",
   "type": "module",
   "module": "dist/index.js",
@@ -54,7 +54,7 @@
     "zod": "^4.0.5"
   },
   "dependencies": {
-    "@asteasolutions/zod-to-openapi": "^8.0.0",
+    "@asteasolutions/zod-to-openapi": "^8.1.0",
     "@hono/zod-validator": "^0.7.2",
     "openapi3-ts": "^4.5.0"
   },