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

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: {},
@@ -403,6 +411,7 @@ function describeRoute(spec) {
 exports.ALLOWED_METHODS = ALLOWED_METHODS;
 exports.describeRoute = describeRoute;
 exports.generateSpecs = generateSpecs;
+exports.openAPIRouteHandler = openAPIRouteHandler;
 exports.registerSchemaPath = registerSchemaPath;
 exports.removeExcludedPaths = removeExcludedPaths;
 exports.resolver = resolver;

package/dist/index.d.cts

@@ -1,7 +1,7 @@
 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 { ValidationTargets as ValidationTargets$1, RouterRoute, BlankEnv, Input as Input$1, BlankInput, Schema, BlankSchema, MiddlewareHandler as MiddlewareHandler$1 } from 'hono/types';
 import { Hook } from '@hono/standard-validator';
 
 // ==================================================================================================
@@ -354,6 +354,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?: GenerateSpecOptions): MiddlewareHandler$1<E, P, I>;
 /**
  * Generate OpenAPI specs for the given Hono instance
  * @param hono Instance of Hono
@@ -410,4 +417,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, describeRoute, generateSpecs, openAPIRouteHandler, registerSchemaPath, removeExcludedPaths, resolver, uniqueSymbol, validator };

package/dist/index.d.ts

@@ -1,7 +1,7 @@
 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 { ValidationTargets as ValidationTargets$1, RouterRoute, BlankEnv, Input as Input$1, BlankInput, Schema, BlankSchema, MiddlewareHandler as MiddlewareHandler$1 } from 'hono/types';
 import { Hook } from '@hono/standard-validator';
 
 // ==================================================================================================
@@ -354,6 +354,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?: GenerateSpecOptions): MiddlewareHandler$1<E, P, I>;
 /**
  * Generate OpenAPI specs for the given Hono instance
  * @param hono Instance of Hono
@@ -410,4 +417,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, 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: {},
@@ -398,4 +406,4 @@ function describeRoute(spec) {
   });
 }
 
-export { ALLOWED_METHODS, describeRoute, generateSpecs, registerSchemaPath, removeExcludedPaths, resolver, uniqueSymbol, validator };
+export { ALLOWED_METHODS, 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.1",
   "type": "module",
   "main": "dist/index.cjs",
   "module": "dist/index.js",