hono-openapi 1.0.7 → 1.1.0

package/README.md

@@ -4,7 +4,7 @@
 [![npm version](https://img.shields.io/npm/v/hono-openapi.svg)](https://npmjs.org/package/hono-openapi "View this project on NPM")
 [![npm downloads](https://img.shields.io/npm/dm/hono-openapi)](https://www.npmjs.com/package/hono-openapi)
 
-This can automatically generate the OpenAPI specification for the Hono API using your validation schema, which can be used to generate client libraries, documentation, and more.
+This can automatically generate the OpenAPI specification for the Hono App using your validation schema, which can be used to generate client libraries, documentation, and more.
 
 This lib supports all the validation libs which are [Standard Schema](https://standardschema.dev/) compliant.
 
@@ -19,5 +19,5 @@ Visit our [contributing docs](https://github.com/rhinobase/hono-openapi/blob/mai
 
 ## Credits
 
-- The idea for this project was inspired by [ElysiaJS](https://elysiajs.com/) and their amazing work on generating [OpenAPI](https://elysiajs.com/recipe/openapi.html) specifications.
+- The idea for this project was inspired by [ElysiaJS](https://elysiajs.com/) and their amazing work on generating [OpenAPI](https://elysiajs.com/patterns/openapi) specifications.
 - This project would not have been possible without the work of [Sam Chung](https://github.com/samchungy) and his [Zod OpenAPI](https://github.com/samchungy/zod-openapi) package.

package/dist/index.cjs

@@ -61,6 +61,9 @@ function getPathContext(path) {
   }
   return context;
 }
+function clearSpecsContext() {
+  specsByPathContext.clear();
+}
 function mergeSpecs(route, ...specs) {
   return specs.reduce(
     (prev, spec) => {
@@ -213,6 +216,7 @@ async function generateSpecs(hono, options = DEFAULT_OPTIONS, c) {
     }
   };
   const _documentation = ctx.options.documentation ?? {};
+  clearSpecsContext();
   const paths = await generatePaths(hono, ctx);
   for (const path in paths) {
     for (const method in paths[path]) {
@@ -273,7 +277,10 @@ async function generatePaths(hono, ctx) {
       }
     }
     const defaultOptionsForThisMethod = ctx.options.defaultOptions?.[routeMethod];
-    const { schema: routeSpecs, components = {} } = await getSpec(middlewareHandler, defaultOptionsForThisMethod);
+    const { schema: routeSpecs, components = {} } = await getSpec(
+      middlewareHandler,
+      defaultOptionsForThisMethod
+    );
     ctx.components = mergeComponentsObjects(ctx.components, components);
     registerSchemaPath({
       route,
@@ -423,12 +430,12 @@ function loadVendor(vendor, fn) {
     standardOpenapi.loadVendor(vendor, fn.toOpenAPISchema);
   }
 }
-function resolver(schema, options) {
+function resolver(schema, userDefinedOptions) {
   return {
     vendor: schema["~standard"].vendor,
     validate: schema["~standard"].validate,
-    toJSONSchema: () => standardJson.toJsonSchema(schema, options),
-    toOpenAPISchema: () => standardOpenapi.toOpenAPISchema(schema, options)
+    toJSONSchema: (customOptions) => standardJson.toJsonSchema(schema, { ...userDefinedOptions, ...customOptions }),
+    toOpenAPISchema: (customOptions) => standardOpenapi.toOpenAPISchema(schema, { ...userDefinedOptions, ...customOptions })
   };
 }
 function validator(target, schema, hook, options) {
@@ -486,6 +493,7 @@ function describeResponse(handler, responses, options) {
 }
 
 exports.ALLOWED_METHODS = ALLOWED_METHODS;
+exports.clearSpecsContext = clearSpecsContext;
 exports.describeResponse = describeResponse;
 exports.describeRoute = describeRoute;
 exports.generateSpecs = generateSpecs;

package/dist/index.d.cts

@@ -2,9 +2,9 @@ import * as openapi_types from 'openapi-types';
 import { OpenAPIV3_1 } from 'openapi-types';
 import { Env, Input, Context, Next, MiddlewareHandler, ValidationTargets, Hono } from 'hono';
 import { TypedResponse, RouterRoute, ValidationTargets as ValidationTargets$1, BlankEnv, Input as Input$1, BlankInput, Schema, BlankSchema, MiddlewareHandler as MiddlewareHandler$1 } from 'hono/types';
+import { loadVendor as loadVendor$2, ToOpenAPISchemaContext } from '@standard-community/standard-openapi';
 import { Hook } from '@hono/standard-validator';
 import { loadVendor as loadVendor$1 } from '@standard-community/standard-json';
-import { loadVendor as loadVendor$2 } from '@standard-community/standard-openapi';
 import { StatusCode } from 'hono/utils/http-status';
 import { JSONSchema7 } from 'json-schema';
 
@@ -74,11 +74,11 @@ declare function loadVendor(vendor: string, fn: {
  * @param schema Validation schema
  * @returns Resolver result
  */
-declare function resolver<Schema extends StandardSchemaV1>(schema: Schema, options?: Record<string, unknown>): {
+declare function resolver<Schema extends StandardSchemaV1>(schema: Schema, userDefinedOptions?: Record<string, unknown>): {
     vendor: string;
     validate: (value: unknown) => StandardSchemaV1.Result<unknown> | Promise<StandardSchemaV1.Result<unknown>>;
-    toJSONSchema: () => JSONSchema7 | Promise<JSONSchema7>;
-    toOpenAPISchema: () => Promise<{
+    toJSONSchema: (customOptions?: Record<string, unknown>) => JSONSchema7 | Promise<JSONSchema7>;
+    toOpenAPISchema: (customOptions?: Record<string, unknown>) => Promise<{
         schema: OpenAPIV3_1.SchemaObject;
         components: OpenAPIV3_1.ComponentsObject | undefined;
     }>;
@@ -133,6 +133,7 @@ declare function describeResponse<E extends Env, P extends string, I extends Inp
 declare const uniqueSymbol: unique symbol;
 declare const ALLOWED_METHODS: readonly ["GET", "PUT", "POST", "DELETE", "OPTIONS", "HEAD", "PATCH", "TRACE"];
 type AllowedMethods = (typeof ALLOWED_METHODS)[number];
+declare function clearSpecsContext(): void;
 declare function registerSchemaPath({ route, specs, paths, }: RegisterSchemaPathOptions): void;
 declare function removeExcludedPaths(paths: OpenAPIV3_1.PathsObject, ctx: SpecContext): OpenAPIV3_1.PathsObject<{}, {}>;
 
@@ -143,9 +144,7 @@ type ResolverReturnType = ReturnType<typeof resolver> & {
          * Override the media type of the request body, if not specified, it will be `application/json` for `json` target and `multipart/form-data` for `form` target.
          */
         media?: string;
-    } & {
-        [key: string]: unknown;
-    };
+    } & Partial<ToOpenAPISchemaContext>;
 };
 type HandlerUniqueProperty = (ResolverReturnType & {
     target: keyof ValidationTargets$1;
@@ -278,4 +277,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, 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 SpecContext, clearSpecsContext, describeResponse, describeRoute, generateSpecs, loadVendor, openAPIRouteHandler, registerSchemaPath, removeExcludedPaths, resolver, uniqueSymbol, validator };

package/dist/index.d.ts

@@ -2,9 +2,9 @@ import * as openapi_types from 'openapi-types';
 import { OpenAPIV3_1 } from 'openapi-types';
 import { Env, Input, Context, Next, MiddlewareHandler, ValidationTargets, Hono } from 'hono';
 import { TypedResponse, RouterRoute, ValidationTargets as ValidationTargets$1, BlankEnv, Input as Input$1, BlankInput, Schema, BlankSchema, MiddlewareHandler as MiddlewareHandler$1 } from 'hono/types';
+import { loadVendor as loadVendor$2, ToOpenAPISchemaContext } from '@standard-community/standard-openapi';
 import { Hook } from '@hono/standard-validator';
 import { loadVendor as loadVendor$1 } from '@standard-community/standard-json';
-import { loadVendor as loadVendor$2 } from '@standard-community/standard-openapi';
 import { StatusCode } from 'hono/utils/http-status';
 import { JSONSchema7 } from 'json-schema';
 
@@ -74,11 +74,11 @@ declare function loadVendor(vendor: string, fn: {
  * @param schema Validation schema
  * @returns Resolver result
  */
-declare function resolver<Schema extends StandardSchemaV1>(schema: Schema, options?: Record<string, unknown>): {
+declare function resolver<Schema extends StandardSchemaV1>(schema: Schema, userDefinedOptions?: Record<string, unknown>): {
     vendor: string;
     validate: (value: unknown) => StandardSchemaV1.Result<unknown> | Promise<StandardSchemaV1.Result<unknown>>;
-    toJSONSchema: () => JSONSchema7 | Promise<JSONSchema7>;
-    toOpenAPISchema: () => Promise<{
+    toJSONSchema: (customOptions?: Record<string, unknown>) => JSONSchema7 | Promise<JSONSchema7>;
+    toOpenAPISchema: (customOptions?: Record<string, unknown>) => Promise<{
         schema: OpenAPIV3_1.SchemaObject;
         components: OpenAPIV3_1.ComponentsObject | undefined;
     }>;
@@ -133,6 +133,7 @@ declare function describeResponse<E extends Env, P extends string, I extends Inp
 declare const uniqueSymbol: unique symbol;
 declare const ALLOWED_METHODS: readonly ["GET", "PUT", "POST", "DELETE", "OPTIONS", "HEAD", "PATCH", "TRACE"];
 type AllowedMethods = (typeof ALLOWED_METHODS)[number];
+declare function clearSpecsContext(): void;
 declare function registerSchemaPath({ route, specs, paths, }: RegisterSchemaPathOptions): void;
 declare function removeExcludedPaths(paths: OpenAPIV3_1.PathsObject, ctx: SpecContext): OpenAPIV3_1.PathsObject<{}, {}>;
 
@@ -143,9 +144,7 @@ type ResolverReturnType = ReturnType<typeof resolver> & {
          * Override the media type of the request body, if not specified, it will be `application/json` for `json` target and `multipart/form-data` for `form` target.
          */
         media?: string;
-    } & {
-        [key: string]: unknown;
-    };
+    } & Partial<ToOpenAPISchemaContext>;
 };
 type HandlerUniqueProperty = (ResolverReturnType & {
     target: keyof ValidationTargets$1;
@@ -278,4 +277,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, 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 SpecContext, clearSpecsContext, describeResponse, describeRoute, generateSpecs, loadVendor, openAPIRouteHandler, registerSchemaPath, removeExcludedPaths, resolver, uniqueSymbol, validator };

package/dist/index.js

@@ -59,6 +59,9 @@ function getPathContext(path) {
   }
   return context;
 }
+function clearSpecsContext() {
+  specsByPathContext.clear();
+}
 function mergeSpecs(route, ...specs) {
   return specs.reduce(
     (prev, spec) => {
@@ -211,6 +214,7 @@ async function generateSpecs(hono, options = DEFAULT_OPTIONS, c) {
     }
   };
   const _documentation = ctx.options.documentation ?? {};
+  clearSpecsContext();
   const paths = await generatePaths(hono, ctx);
   for (const path in paths) {
     for (const method in paths[path]) {
@@ -271,7 +275,10 @@ async function generatePaths(hono, ctx) {
       }
     }
     const defaultOptionsForThisMethod = ctx.options.defaultOptions?.[routeMethod];
-    const { schema: routeSpecs, components = {} } = await getSpec(middlewareHandler, defaultOptionsForThisMethod);
+    const { schema: routeSpecs, components = {} } = await getSpec(
+      middlewareHandler,
+      defaultOptionsForThisMethod
+    );
     ctx.components = mergeComponentsObjects(ctx.components, components);
     registerSchemaPath({
       route,
@@ -421,12 +428,12 @@ function loadVendor(vendor, fn) {
     loadVendor$2(vendor, fn.toOpenAPISchema);
   }
 }
-function resolver(schema, options) {
+function resolver(schema, userDefinedOptions) {
   return {
     vendor: schema["~standard"].vendor,
     validate: schema["~standard"].validate,
-    toJSONSchema: () => toJsonSchema(schema, options),
-    toOpenAPISchema: () => toOpenAPISchema(schema, options)
+    toJSONSchema: (customOptions) => toJsonSchema(schema, { ...userDefinedOptions, ...customOptions }),
+    toOpenAPISchema: (customOptions) => toOpenAPISchema(schema, { ...userDefinedOptions, ...customOptions })
   };
 }
 function validator(target, schema, hook, options) {
@@ -483,4 +490,4 @@ function describeResponse(handler, responses, options) {
   });
 }
 
-export { ALLOWED_METHODS, describeResponse, describeRoute, generateSpecs, loadVendor, openAPIRouteHandler, registerSchemaPath, removeExcludedPaths, resolver, uniqueSymbol, validator };
+export { ALLOWED_METHODS, clearSpecsContext, describeResponse, describeRoute, generateSpecs, loadVendor, openAPIRouteHandler, registerSchemaPath, removeExcludedPaths, resolver, uniqueSymbol, validator };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "hono-openapi",
   "description": "OpenAPI schema generator for Hono",
-  "version": "1.0.7",
+  "version": "1.1.0",
   "type": "module",
   "main": "dist/index.cjs",
   "module": "dist/index.js",
@@ -25,8 +25,7 @@
   },
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/rhinobase/hono-openapi.git",
-    "directory": "packages/core"
+    "url": "git+https://github.com/rhinobase/hono-openapi.git"
   },
   "bugs": {
     "url": "https://github.com/rhinobase/hono-openapi/issues"
@@ -43,8 +42,8 @@
   },
   "peerDependencies": {
     "@hono/standard-validator": "^0.1.2",
-    "@standard-community/standard-json": "^0.3.1",
-    "@standard-community/standard-openapi": "^0.2.4",
+    "@standard-community/standard-json": "^0.3.5",
+    "@standard-community/standard-openapi": "^0.2.8",
     "@types/json-schema": "^7.0.15",
     "hono": "^4.8.3",
     "openapi-types": "^12.1.3"
@@ -66,8 +65,11 @@
     "husky": "^9.1.7",
     "is-ci": "^4.1.0",
     "nano-staged": "^0.8.0",
+    "pkg-pr-new": "^0.0.60",
     "pkgroll": "^2.13.1",
+    "typebox": "^1.0.17",
     "typescript": "^5.8.3",
+    "sury": "^10.0.0",
     "valibot": "^1.1.0",
     "vitest": "^3.2.4",
     "zod": "^3.23.8",
@@ -75,6 +77,7 @@
   },
   "scripts": {
     "build": "pkgroll --clean-dist",
+    "lint": "biome check .",
     "format": "biome check --write .",
     "test": "vitest"
   }