hono-openapi 0.5.0-rc.0 → 0.5.0-rc.2

package/dist/index.cjs

@@ -184,6 +184,14 @@ const DEFAULT_OPTIONS = {
   excludeMethods: ["OPTIONS"],
   excludeTags: []
 };
+function openAPIRouteHandler(hono, options) {
+  let specs;
+  return async (c) => {
+    if (specs) return c.json(specs);
+    specs = await generateSpecs(hono, options, c);
+    return c.json(specs);
+  };
+}
 async function generateSpecs(hono, options = DEFAULT_OPTIONS, c) {
   const ctx = {
     components: {},
@@ -399,10 +407,44 @@ function describeRoute(spec) {
     }
   });
 }
+function describeResponse(handler, responses) {
+  const _responses = Object.entries(responses).reduce(
+    (acc, [statusCode, response]) => {
+      if (response.content) {
+        const content = Object.entries(response.content).reduce(
+          (contentAcc, [mediaType, media]) => {
+            if (media.vSchema) {
+              contentAcc[mediaType] = {
+                ...media,
+                schema: resolver(media.vSchema)
+              };
+            } else {
+              contentAcc[mediaType] = media;
+            }
+            return contentAcc;
+          },
+          {}
+        );
+        acc[statusCode] = { ...response, content };
+      } else {
+        acc[statusCode] = response;
+      }
+      return acc;
+    },
+    {}
+  );
+  return Object.assign(handler, {
+    [uniqueSymbol]: {
+      spec: { responses: _responses }
+    }
+  });
+}
 
 exports.ALLOWED_METHODS = ALLOWED_METHODS;
+exports.describeResponse = describeResponse;
 exports.describeRoute = describeRoute;
 exports.generateSpecs = generateSpecs;
+exports.openAPIRouteHandler = openAPIRouteHandler;
 exports.registerSchemaPath = registerSchemaPath;
 exports.removeExcludedPaths = removeExcludedPaths;
 exports.resolver = resolver;

package/dist/index.d.cts

@@ -1,8 +1,9 @@
 import * as openapi_types from 'openapi-types';
 import { OpenAPIV3_1 } from 'openapi-types';
-import { MiddlewareHandler, ValidationTargets, Env, Input, Context, Hono } from 'hono';
-import { ValidationTargets as ValidationTargets$1, RouterRoute, BlankEnv, Input as Input$1, BlankInput, Schema, BlankSchema } from 'hono/types';
+import { Env, Input, Context, Next, MiddlewareHandler, ValidationTargets, Hono } from 'hono';
+import { BlankInput, TypedResponse, ValidationTargets as ValidationTargets$1, RouterRoute, BlankEnv, Input as Input$1, Schema, BlankSchema, MiddlewareHandler as MiddlewareHandler$1 } from 'hono/types';
 import { Hook } from '@hono/standard-validator';
+import { StatusCode } from 'hono/utils/http-status';
 
 // ==================================================================================================
 // JSON Schema Draft 07
@@ -270,6 +271,21 @@ declare function validator<Schema extends StandardSchemaV1, Target extends keyof
  * @returns Middleware handler
  */
 declare function describeRoute(spec: DescribeRouteOptions): MiddlewareHandler;
+type ResponseObject<T extends Partial<Record<StatusCode, StandardSchemaV1>>> = {
+    [K in keyof T]: OpenAPIV3_1.ReferenceObject | (OpenAPIV3_1.ResponseObject & {
+        content?: {
+            [media: string]: OpenAPIV3_1.MediaTypeObject & {
+                vSchema?: T[K];
+            };
+        };
+    });
+};
+type Num<T> = T extends `${infer N extends number}` ? N : T;
+type HandlerResponse<T extends Partial<Record<StatusCode, StandardSchemaV1>> = Partial<Record<StatusCode, StandardSchemaV1>>> = {
+    [K in keyof T]: T[K] extends StandardSchemaV1 ? PromiseOr<TypedResponse<StandardSchemaV1.InferOutput<T[K]>, Num<K> extends StatusCode ? Num<K> : never>> : never;
+}[keyof T];
+type Handler<E extends Env = any, P extends string = any, I extends Input = BlankInput, 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 = any, P extends string = any, I extends Input = BlankInput, T extends Partial<Record<StatusCode, StandardSchemaV1>> = Partial<Record<StatusCode, StandardSchemaV1>>>(handler: Handler<E, P, I, T>, responses: ResponseObject<T>): Handler<E, P, I, T>;
 
 /**
  * The unique symbol for the middlewares, which makes it easier to identify them. Not meant to be used directly, unless you're creating a custom middleware.
@@ -354,6 +370,13 @@ type RegisterSchemaPathOptions = {
     paths: Partial<OpenAPIV3_1.PathsObject>;
 };
 
+/**
+ * Route handler for OpenAPI specs
+ * @param hono Instance of Hono
+ * @param options Options for generating OpenAPI specs
+ * @returns Middleware handler for OpenAPI specs
+ */
+declare function openAPIRouteHandler<E extends Env = BlankEnv, P extends string = string, I extends Input$1 = BlankInput, S extends Schema = BlankSchema>(hono: Hono<E, S, P>, options?: Partial<GenerateSpecOptions>): MiddlewareHandler$1<E, P, I>;
 /**
  * Generate OpenAPI specs for the given Hono instance
  * @param hono Instance of Hono
@@ -410,4 +433,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 SanitizedGenerateSpecOptions, describeRoute, generateSpecs, registerSchemaPath, removeExcludedPaths, resolver, uniqueSymbol, validator };
+export { ALLOWED_METHODS, type AllowedMethods, type DescribeRouteOptions, type GenerateSpecOptions, type HandlerUniqueProperty, type PromiseOr, type RegisterSchemaPathOptions, type ResolverReturnType, type SanitizedGenerateSpecOptions, describeResponse, describeRoute, generateSpecs, openAPIRouteHandler, registerSchemaPath, removeExcludedPaths, resolver, uniqueSymbol, validator };

package/dist/index.d.ts

@@ -1,8 +1,9 @@
 import * as openapi_types from 'openapi-types';
 import { OpenAPIV3_1 } from 'openapi-types';
-import { MiddlewareHandler, ValidationTargets, Env, Input, Context, Hono } from 'hono';
-import { ValidationTargets as ValidationTargets$1, RouterRoute, BlankEnv, Input as Input$1, BlankInput, Schema, BlankSchema } from 'hono/types';
+import { Env, Input, Context, Next, MiddlewareHandler, ValidationTargets, Hono } from 'hono';
+import { BlankInput, TypedResponse, ValidationTargets as ValidationTargets$1, RouterRoute, BlankEnv, Input as Input$1, Schema, BlankSchema, MiddlewareHandler as MiddlewareHandler$1 } from 'hono/types';
 import { Hook } from '@hono/standard-validator';
+import { StatusCode } from 'hono/utils/http-status';
 
 // ==================================================================================================
 // JSON Schema Draft 07
@@ -270,6 +271,21 @@ declare function validator<Schema extends StandardSchemaV1, Target extends keyof
  * @returns Middleware handler
  */
 declare function describeRoute(spec: DescribeRouteOptions): MiddlewareHandler;
+type ResponseObject<T extends Partial<Record<StatusCode, StandardSchemaV1>>> = {
+    [K in keyof T]: OpenAPIV3_1.ReferenceObject | (OpenAPIV3_1.ResponseObject & {
+        content?: {
+            [media: string]: OpenAPIV3_1.MediaTypeObject & {
+                vSchema?: T[K];
+            };
+        };
+    });
+};
+type Num<T> = T extends `${infer N extends number}` ? N : T;
+type HandlerResponse<T extends Partial<Record<StatusCode, StandardSchemaV1>> = Partial<Record<StatusCode, StandardSchemaV1>>> = {
+    [K in keyof T]: T[K] extends StandardSchemaV1 ? PromiseOr<TypedResponse<StandardSchemaV1.InferOutput<T[K]>, Num<K> extends StatusCode ? Num<K> : never>> : never;
+}[keyof T];
+type Handler<E extends Env = any, P extends string = any, I extends Input = BlankInput, 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 = any, P extends string = any, I extends Input = BlankInput, T extends Partial<Record<StatusCode, StandardSchemaV1>> = Partial<Record<StatusCode, StandardSchemaV1>>>(handler: Handler<E, P, I, T>, responses: ResponseObject<T>): Handler<E, P, I, T>;
 
 /**
  * The unique symbol for the middlewares, which makes it easier to identify them. Not meant to be used directly, unless you're creating a custom middleware.
@@ -354,6 +370,13 @@ type RegisterSchemaPathOptions = {
     paths: Partial<OpenAPIV3_1.PathsObject>;
 };
 
+/**
+ * Route handler for OpenAPI specs
+ * @param hono Instance of Hono
+ * @param options Options for generating OpenAPI specs
+ * @returns Middleware handler for OpenAPI specs
+ */
+declare function openAPIRouteHandler<E extends Env = BlankEnv, P extends string = string, I extends Input$1 = BlankInput, S extends Schema = BlankSchema>(hono: Hono<E, S, P>, options?: Partial<GenerateSpecOptions>): MiddlewareHandler$1<E, P, I>;
 /**
  * Generate OpenAPI specs for the given Hono instance
  * @param hono Instance of Hono
@@ -410,4 +433,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 SanitizedGenerateSpecOptions, describeRoute, generateSpecs, registerSchemaPath, removeExcludedPaths, resolver, uniqueSymbol, validator };
+export { ALLOWED_METHODS, type AllowedMethods, type DescribeRouteOptions, type GenerateSpecOptions, type HandlerUniqueProperty, type PromiseOr, type RegisterSchemaPathOptions, type ResolverReturnType, type SanitizedGenerateSpecOptions, describeResponse, describeRoute, generateSpecs, openAPIRouteHandler, registerSchemaPath, removeExcludedPaths, resolver, uniqueSymbol, validator };

package/dist/index.js

@@ -182,6 +182,14 @@ const DEFAULT_OPTIONS = {
   excludeMethods: ["OPTIONS"],
   excludeTags: []
 };
+function openAPIRouteHandler(hono, options) {
+  let specs;
+  return async (c) => {
+    if (specs) return c.json(specs);
+    specs = await generateSpecs(hono, options, c);
+    return c.json(specs);
+  };
+}
 async function generateSpecs(hono, options = DEFAULT_OPTIONS, c) {
   const ctx = {
     components: {},
@@ -397,5 +405,37 @@ function describeRoute(spec) {
     }
   });
 }
+function describeResponse(handler, responses) {
+  const _responses = Object.entries(responses).reduce(
+    (acc, [statusCode, response]) => {
+      if (response.content) {
+        const content = Object.entries(response.content).reduce(
+          (contentAcc, [mediaType, media]) => {
+            if (media.vSchema) {
+              contentAcc[mediaType] = {
+                ...media,
+                schema: resolver(media.vSchema)
+              };
+            } else {
+              contentAcc[mediaType] = media;
+            }
+            return contentAcc;
+          },
+          {}
+        );
+        acc[statusCode] = { ...response, content };
+      } else {
+        acc[statusCode] = response;
+      }
+      return acc;
+    },
+    {}
+  );
+  return Object.assign(handler, {
+    [uniqueSymbol]: {
+      spec: { responses: _responses }
+    }
+  });
+}
 
-export { ALLOWED_METHODS, describeRoute, generateSpecs, registerSchemaPath, removeExcludedPaths, resolver, uniqueSymbol, validator };
+export { ALLOWED_METHODS, describeResponse, describeRoute, generateSpecs, openAPIRouteHandler, registerSchemaPath, removeExcludedPaths, resolver, uniqueSymbol, validator };

package/package.json

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