hono-openapi 1.2.0 → 1.3.0

package/dist/index.cjs

@@ -252,8 +252,10 @@ async function generateSpecs(hono, options = DEFAULT_OPTIONS, c) {
       }
     }
   }
+  const { components: resolvedDocComponents } = _documentation.components?.responses ? await resolveResponseSchemas(_documentation.components.responses) : { components: {} };
   const components = mergeComponentsObjects(
     _documentation.components,
+    resolvedDocComponents,
     ctx.components
   );
   return {
@@ -325,7 +327,6 @@ function getHiddenValue(options) {
 }
 async function getSpec(middlewareHandler, defaultOptions) {
   if ("spec" in middlewareHandler) {
-    let components = {};
     const tmp = {
       ...defaultOptions,
       ...middlewareHandler.spec,
@@ -334,25 +335,10 @@ async function getSpec(middlewareHandler, defaultOptions) {
         ...middlewareHandler.spec.responses
       }
     };
+    let components = {};
     if (tmp.responses) {
-      for (const key of Object.keys(tmp.responses)) {
-        const response = tmp.responses[key];
-        if (!response || !("content" in response)) continue;
-        for (const contentKey of Object.keys(response.content ?? {})) {
-          const raw = response.content?.[contentKey];
-          if (!raw) continue;
-          if (raw.schema && "toOpenAPISchema" in raw.schema) {
-            const result2 = await raw.schema.toOpenAPISchema();
-            raw.schema = result2.schema;
-            if (result2.components) {
-              components = mergeComponentsObjects(
-                components,
-                result2.components
-              );
-            }
-          }
-        }
-      }
+      const resolved = await resolveResponseSchemas(tmp.responses);
+      components = resolved.components;
     }
     return { schema: tmp, components };
   }
@@ -362,6 +348,7 @@ async function getSpec(middlewareHandler, defaultOptions) {
     const media = middlewareHandler.options?.media ?? middlewareHandler.target === "json" ? "application/json" : "multipart/form-data";
     if (!docs.requestBody || !("content" in docs.requestBody) || !docs.requestBody.content) {
       docs.requestBody = {
+        required: true,
         content: {
           [media]: {
             schema: result.schema
@@ -421,6 +408,25 @@ function generateParameters(target, schema) {
   }
   return parameters;
 }
+async function resolveResponseSchemas(responses) {
+  let components = {};
+  for (const key of Object.keys(responses)) {
+    const response = responses[key];
+    if (!response || !("content" in response)) continue;
+    for (const contentKey of Object.keys(response.content ?? {})) {
+      const raw = response.content?.[contentKey];
+      if (!raw) continue;
+      if (raw.schema && "toOpenAPISchema" in raw.schema) {
+        const result = await raw.schema.toOpenAPISchema();
+        raw.schema = result.schema;
+        if (result.components) {
+          components = mergeComponentsObjects(components, result.components);
+        }
+      }
+    }
+  }
+  return { responses, components };
+}
 function mergeComponentsObjects(...components) {
   return components.reduce(
     (prev, component, index) => {
@@ -451,12 +457,55 @@ function loadVendor(vendor, fn) {
     standardOpenapi.loadVendor(vendor, fn.toOpenAPISchema);
   }
 }
+const arktypeMorphFallback = (ctx) => ctx.base;
+const zodV4DateOverride = (ctx) => {
+  if (ctx.zodSchema._zod.def.type === "date") {
+    ctx.jsonSchema.type = "string";
+    ctx.jsonSchema.format = "date-time";
+  }
+};
 function resolver(schema, userDefinedOptions) {
+  const vendor = schema["~standard"].vendor;
   return {
-    vendor: schema["~standard"].vendor,
+    vendor,
     validate: schema["~standard"].validate,
     toJSONSchema: (customOptions) => standardJson.toJsonSchema(schema, { ...userDefinedOptions, ...customOptions }),
-    toOpenAPISchema: (customOptions) => standardOpenapi.toOpenAPISchema(schema, { ...userDefinedOptions, ...customOptions })
+    toOpenAPISchema: (customOptions) => standardOpenapi.toOpenAPISchema(schema, {
+      ...userDefinedOptions,
+      ...customOptions,
+      ...vendor === "arktype" ? injectArktypeFallback(userDefinedOptions, customOptions) : void 0,
+      ...vendor === "zod" ? injectZodV4DateOverride(schema, userDefinedOptions, customOptions) : void 0
+    })
+  };
+}
+function injectArktypeFallback(userDefined, custom) {
+  const userNested = userDefined?.options;
+  const customNested = custom?.options;
+  if (userDefined?.fallback || userNested?.fallback || custom?.fallback || customNested?.fallback) {
+    return void 0;
+  }
+  return {
+    options: {
+      fallback: arktypeMorphFallback,
+      ...userNested,
+      ...customNested
+    }
+  };
+}
+function injectZodV4DateOverride(schema, userDefined, custom) {
+  if (!("_zod" in schema)) return void 0;
+  const userNested = userDefined?.options;
+  const customNested = custom?.options;
+  if (userDefined?.override || userNested?.override || custom?.override || customNested?.override) {
+    return void 0;
+  }
+  return {
+    options: {
+      unrepresentable: "any",
+      override: zodV4DateOverride,
+      ...userNested,
+      ...customNested
+    }
   };
 }
 function validator(target, schema, hook, options) {

package/dist/index.d.cts

@@ -6,6 +6,7 @@ import { loadVendor as loadVendor$2, ToOpenAPISchemaContext } from '@standard-co
 import { Hook } from '@hono/standard-validator';
 import { loadVendor as loadVendor$1 } from '@standard-community/standard-json';
 import { StatusCode } from 'hono/utils/http-status';
+import { JSONParsed } from 'hono/utils/types';
 import { JSONSchema7 } from 'json-schema';
 
 /** The Standard Schema interface. */
@@ -122,7 +123,7 @@ type ResponseObject<T extends Partial<Record<StatusCode, StandardSchemaV1>>> = {
 };
 type Num<T> = T extends `${infer N extends number}` ? N : T;
 type HandlerResponse<T extends Partial<Record<StatusCode, StandardSchemaV1>> = Partial<Record<StatusCode, StandardSchemaV1>>> = PromiseOr<{
-    [K in keyof T]: T[K] extends StandardSchemaV1 ? TypedResponse<StandardSchemaV1.InferOutput<T[K]>, Num<K> extends StatusCode ? Num<K> : never> : never;
+    [K in keyof T]: T[K] extends StandardSchemaV1 ? TypedResponse<JSONParsed<StandardSchemaV1.InferOutput<T[K]>>, Num<K> extends StatusCode ? Num<K> : never> : never;
 }[keyof T]>;
 type Handler<E extends Env, P extends string, I extends Input, T extends Partial<Record<StatusCode, StandardSchemaV1>> = Partial<Record<StatusCode, StandardSchemaV1>>> = (c: Context<E, P, I>, next: Next) => HandlerResponse<T>;
 declare function describeResponse<E extends Env, P extends string, I extends Input, T extends Partial<Record<StatusCode, StandardSchemaV1>> = Partial<Record<StatusCode, StandardSchemaV1>>>(handler: Handler<E, P, I, T>, responses: ResponseObject<T>, options?: Record<string, unknown>): Handler<E, P, I, T>;
@@ -151,13 +152,41 @@ type HandlerUniqueProperty = (ResolverReturnType & {
 }) | {
     spec: DescribeRouteOptions;
 };
+/**
+ * A media type object that accepts resolver() output in addition to standard schema types.
+ */
+type MediaTypeObjectWithResolver = Omit<OpenAPIV3_1.MediaTypeObject, "schema"> & {
+    schema?: OpenAPIV3_1.ReferenceObject | OpenAPIV3_1.SchemaObject | ResolverReturnType;
+};
+/**
+ * A response object that accepts resolver() output in schema positions.
+ */
+type ResponseObjectWithResolver = (Omit<OpenAPIV3_1.ResponseObject, "content"> & {
+    content?: {
+        [media: string]: MediaTypeObjectWithResolver;
+    };
+}) | OpenAPIV3_1.ReferenceObject;
+/**
+ * A responses map that accepts resolver() output in schema positions.
+ */
+type ResponsesWithResolver = {
+    [key: string]: ResponseObjectWithResolver;
+};
+/**
+ * Extended document type that allows resolver() in documentation.components.responses
+ */
+type DocumentWithResolver = Omit<Partial<OpenAPIV3_1.Document>, "x-express-openapi-additional-middleware" | "x-express-openapi-validation-strict" | "components"> & {
+    components?: Omit<OpenAPIV3_1.ComponentsObject, "responses"> & {
+        responses?: ResponsesWithResolver;
+    };
+};
 type GenerateSpecOptions = {
     /**
      * Customize OpenAPI config, refers to Swagger 2.0 config
      *
      * @see https://swagger.io/specification/v2/
      */
-    documentation: Omit<Partial<OpenAPIV3_1.Document>, "x-express-openapi-additional-middleware" | "x-express-openapi-validation-strict">;
+    documentation: DocumentWithResolver;
     /**
      * Include paths which don't have the handlers.
      * This is useful when you want to document the
@@ -203,15 +232,7 @@ type DescribeRouteOptions = Omit<OpenAPIV3_1.OperationObject, "responses" | "ope
     /**
      * Responses of the request
      */
-    responses?: {
-        [key: string]: (OpenAPIV3_1.ResponseObject & {
-            content?: {
-                [key: string]: Omit<OpenAPIV3_1.MediaTypeObject, "schema"> & {
-                    schema?: OpenAPIV3_1.ReferenceObject | OpenAPIV3_1.SchemaObject | ResolverReturnType;
-                };
-            };
-        }) | OpenAPIV3_1.ReferenceObject;
-    };
+    responses?: ResponsesWithResolver;
 };
 type RegisterSchemaPathOptions = {
     route: RouterRoute;
@@ -277,4 +298,4 @@ declare function generateSpecs<E extends Env = BlankEnv, P extends string = stri
     jsonSchemaDialect?: string;
 }>;
 
-export { ALLOWED_METHODS, type AllowedMethods, type DescribeRouteOptions, type GenerateSpecOptions, type HandlerUniqueProperty, type PromiseOr, type RegisterSchemaPathOptions, type ResolverReturnType, type SpecContext, clearSpecsContext, describeResponse, describeRoute, generateSpecs, loadVendor, openAPIRouteHandler, registerSchemaPath, removeExcludedPaths, resolver, uniqueSymbol, validator };
+export { ALLOWED_METHODS, type AllowedMethods, type DescribeRouteOptions, type GenerateSpecOptions, type HandlerUniqueProperty, type PromiseOr, type RegisterSchemaPathOptions, type ResolverReturnType, type ResponsesWithResolver, type SpecContext, clearSpecsContext, describeResponse, describeRoute, generateSpecs, loadVendor, openAPIRouteHandler, registerSchemaPath, removeExcludedPaths, resolver, uniqueSymbol, validator };

package/dist/index.d.ts

@@ -6,6 +6,7 @@ import { loadVendor as loadVendor$2, ToOpenAPISchemaContext } from '@standard-co
 import { Hook } from '@hono/standard-validator';
 import { loadVendor as loadVendor$1 } from '@standard-community/standard-json';
 import { StatusCode } from 'hono/utils/http-status';
+import { JSONParsed } from 'hono/utils/types';
 import { JSONSchema7 } from 'json-schema';
 
 /** The Standard Schema interface. */
@@ -122,7 +123,7 @@ type ResponseObject<T extends Partial<Record<StatusCode, StandardSchemaV1>>> = {
 };
 type Num<T> = T extends `${infer N extends number}` ? N : T;
 type HandlerResponse<T extends Partial<Record<StatusCode, StandardSchemaV1>> = Partial<Record<StatusCode, StandardSchemaV1>>> = PromiseOr<{
-    [K in keyof T]: T[K] extends StandardSchemaV1 ? TypedResponse<StandardSchemaV1.InferOutput<T[K]>, Num<K> extends StatusCode ? Num<K> : never> : never;
+    [K in keyof T]: T[K] extends StandardSchemaV1 ? TypedResponse<JSONParsed<StandardSchemaV1.InferOutput<T[K]>>, Num<K> extends StatusCode ? Num<K> : never> : never;
 }[keyof T]>;
 type Handler<E extends Env, P extends string, I extends Input, T extends Partial<Record<StatusCode, StandardSchemaV1>> = Partial<Record<StatusCode, StandardSchemaV1>>> = (c: Context<E, P, I>, next: Next) => HandlerResponse<T>;
 declare function describeResponse<E extends Env, P extends string, I extends Input, T extends Partial<Record<StatusCode, StandardSchemaV1>> = Partial<Record<StatusCode, StandardSchemaV1>>>(handler: Handler<E, P, I, T>, responses: ResponseObject<T>, options?: Record<string, unknown>): Handler<E, P, I, T>;
@@ -151,13 +152,41 @@ type HandlerUniqueProperty = (ResolverReturnType & {
 }) | {
     spec: DescribeRouteOptions;
 };
+/**
+ * A media type object that accepts resolver() output in addition to standard schema types.
+ */
+type MediaTypeObjectWithResolver = Omit<OpenAPIV3_1.MediaTypeObject, "schema"> & {
+    schema?: OpenAPIV3_1.ReferenceObject | OpenAPIV3_1.SchemaObject | ResolverReturnType;
+};
+/**
+ * A response object that accepts resolver() output in schema positions.
+ */
+type ResponseObjectWithResolver = (Omit<OpenAPIV3_1.ResponseObject, "content"> & {
+    content?: {
+        [media: string]: MediaTypeObjectWithResolver;
+    };
+}) | OpenAPIV3_1.ReferenceObject;
+/**
+ * A responses map that accepts resolver() output in schema positions.
+ */
+type ResponsesWithResolver = {
+    [key: string]: ResponseObjectWithResolver;
+};
+/**
+ * Extended document type that allows resolver() in documentation.components.responses
+ */
+type DocumentWithResolver = Omit<Partial<OpenAPIV3_1.Document>, "x-express-openapi-additional-middleware" | "x-express-openapi-validation-strict" | "components"> & {
+    components?: Omit<OpenAPIV3_1.ComponentsObject, "responses"> & {
+        responses?: ResponsesWithResolver;
+    };
+};
 type GenerateSpecOptions = {
     /**
      * Customize OpenAPI config, refers to Swagger 2.0 config
      *
      * @see https://swagger.io/specification/v2/
      */
-    documentation: Omit<Partial<OpenAPIV3_1.Document>, "x-express-openapi-additional-middleware" | "x-express-openapi-validation-strict">;
+    documentation: DocumentWithResolver;
     /**
      * Include paths which don't have the handlers.
      * This is useful when you want to document the
@@ -203,15 +232,7 @@ type DescribeRouteOptions = Omit<OpenAPIV3_1.OperationObject, "responses" | "ope
     /**
      * Responses of the request
      */
-    responses?: {
-        [key: string]: (OpenAPIV3_1.ResponseObject & {
-            content?: {
-                [key: string]: Omit<OpenAPIV3_1.MediaTypeObject, "schema"> & {
-                    schema?: OpenAPIV3_1.ReferenceObject | OpenAPIV3_1.SchemaObject | ResolverReturnType;
-                };
-            };
-        }) | OpenAPIV3_1.ReferenceObject;
-    };
+    responses?: ResponsesWithResolver;
 };
 type RegisterSchemaPathOptions = {
     route: RouterRoute;
@@ -277,4 +298,4 @@ declare function generateSpecs<E extends Env = BlankEnv, P extends string = stri
     jsonSchemaDialect?: string;
 }>;
 
-export { ALLOWED_METHODS, type AllowedMethods, type DescribeRouteOptions, type GenerateSpecOptions, type HandlerUniqueProperty, type PromiseOr, type RegisterSchemaPathOptions, type ResolverReturnType, type SpecContext, clearSpecsContext, describeResponse, describeRoute, generateSpecs, loadVendor, openAPIRouteHandler, registerSchemaPath, removeExcludedPaths, resolver, uniqueSymbol, validator };
+export { ALLOWED_METHODS, type AllowedMethods, type DescribeRouteOptions, type GenerateSpecOptions, type HandlerUniqueProperty, type PromiseOr, type RegisterSchemaPathOptions, type ResolverReturnType, type ResponsesWithResolver, type SpecContext, clearSpecsContext, describeResponse, describeRoute, generateSpecs, loadVendor, openAPIRouteHandler, registerSchemaPath, removeExcludedPaths, resolver, uniqueSymbol, validator };

package/dist/index.js

@@ -250,8 +250,10 @@ async function generateSpecs(hono, options = DEFAULT_OPTIONS, c) {
       }
     }
   }
+  const { components: resolvedDocComponents } = _documentation.components?.responses ? await resolveResponseSchemas(_documentation.components.responses) : { components: {} };
   const components = mergeComponentsObjects(
     _documentation.components,
+    resolvedDocComponents,
     ctx.components
   );
   return {
@@ -323,7 +325,6 @@ function getHiddenValue(options) {
 }
 async function getSpec(middlewareHandler, defaultOptions) {
   if ("spec" in middlewareHandler) {
-    let components = {};
     const tmp = {
       ...defaultOptions,
       ...middlewareHandler.spec,
@@ -332,25 +333,10 @@ async function getSpec(middlewareHandler, defaultOptions) {
         ...middlewareHandler.spec.responses
       }
     };
+    let components = {};
     if (tmp.responses) {
-      for (const key of Object.keys(tmp.responses)) {
-        const response = tmp.responses[key];
-        if (!response || !("content" in response)) continue;
-        for (const contentKey of Object.keys(response.content ?? {})) {
-          const raw = response.content?.[contentKey];
-          if (!raw) continue;
-          if (raw.schema && "toOpenAPISchema" in raw.schema) {
-            const result2 = await raw.schema.toOpenAPISchema();
-            raw.schema = result2.schema;
-            if (result2.components) {
-              components = mergeComponentsObjects(
-                components,
-                result2.components
-              );
-            }
-          }
-        }
-      }
+      const resolved = await resolveResponseSchemas(tmp.responses);
+      components = resolved.components;
     }
     return { schema: tmp, components };
   }
@@ -360,6 +346,7 @@ async function getSpec(middlewareHandler, defaultOptions) {
     const media = middlewareHandler.options?.media ?? middlewareHandler.target === "json" ? "application/json" : "multipart/form-data";
     if (!docs.requestBody || !("content" in docs.requestBody) || !docs.requestBody.content) {
       docs.requestBody = {
+        required: true,
         content: {
           [media]: {
             schema: result.schema
@@ -419,6 +406,25 @@ function generateParameters(target, schema) {
   }
   return parameters;
 }
+async function resolveResponseSchemas(responses) {
+  let components = {};
+  for (const key of Object.keys(responses)) {
+    const response = responses[key];
+    if (!response || !("content" in response)) continue;
+    for (const contentKey of Object.keys(response.content ?? {})) {
+      const raw = response.content?.[contentKey];
+      if (!raw) continue;
+      if (raw.schema && "toOpenAPISchema" in raw.schema) {
+        const result = await raw.schema.toOpenAPISchema();
+        raw.schema = result.schema;
+        if (result.components) {
+          components = mergeComponentsObjects(components, result.components);
+        }
+      }
+    }
+  }
+  return { responses, components };
+}
 function mergeComponentsObjects(...components) {
   return components.reduce(
     (prev, component, index) => {
@@ -449,12 +455,55 @@ function loadVendor(vendor, fn) {
     loadVendor$2(vendor, fn.toOpenAPISchema);
   }
 }
+const arktypeMorphFallback = (ctx) => ctx.base;
+const zodV4DateOverride = (ctx) => {
+  if (ctx.zodSchema._zod.def.type === "date") {
+    ctx.jsonSchema.type = "string";
+    ctx.jsonSchema.format = "date-time";
+  }
+};
 function resolver(schema, userDefinedOptions) {
+  const vendor = schema["~standard"].vendor;
   return {
-    vendor: schema["~standard"].vendor,
+    vendor,
     validate: schema["~standard"].validate,
     toJSONSchema: (customOptions) => toJsonSchema(schema, { ...userDefinedOptions, ...customOptions }),
-    toOpenAPISchema: (customOptions) => toOpenAPISchema(schema, { ...userDefinedOptions, ...customOptions })
+    toOpenAPISchema: (customOptions) => toOpenAPISchema(schema, {
+      ...userDefinedOptions,
+      ...customOptions,
+      ...vendor === "arktype" ? injectArktypeFallback(userDefinedOptions, customOptions) : void 0,
+      ...vendor === "zod" ? injectZodV4DateOverride(schema, userDefinedOptions, customOptions) : void 0
+    })
+  };
+}
+function injectArktypeFallback(userDefined, custom) {
+  const userNested = userDefined?.options;
+  const customNested = custom?.options;
+  if (userDefined?.fallback || userNested?.fallback || custom?.fallback || customNested?.fallback) {
+    return void 0;
+  }
+  return {
+    options: {
+      fallback: arktypeMorphFallback,
+      ...userNested,
+      ...customNested
+    }
+  };
+}
+function injectZodV4DateOverride(schema, userDefined, custom) {
+  if (!("_zod" in schema)) return void 0;
+  const userNested = userDefined?.options;
+  const customNested = custom?.options;
+  if (userDefined?.override || userNested?.override || custom?.override || customNested?.override) {
+    return void 0;
+  }
+  return {
+    options: {
+      unrepresentable: "any",
+      override: zodV4DateOverride,
+      ...userNested,
+      ...customNested
+    }
   };
 }
 function validator(target, schema, hook, options) {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "hono-openapi",
   "description": "OpenAPI schema generator for Hono",
-  "version": "1.2.0",
+  "version": "1.3.0",
   "type": "module",
   "main": "dist/index.cjs",
   "module": "dist/index.js",