hono-openapi 1.0.0 → 1.0.2

package/dist/index.cjs

@@ -331,7 +331,7 @@ async function getSpec(middlewareHandler, defaultOptions) {
     return { schema: tmp, components };
   }
   const result = await middlewareHandler.toOpenAPISchema();
-  const docs = {};
+  const docs = defaultOptions ?? {};
   if (middlewareHandler.target === "form" || middlewareHandler.target === "json") {
     const media = middlewareHandler.options?.media ?? middlewareHandler.target === "json" ? "application/json" : "multipart/form-data";
     if (!docs.requestBody || !("content" in docs.requestBody) || !docs.requestBody.content) {

package/dist/index.d.cts

@@ -1,7 +1,7 @@
 import * as openapi_types from 'openapi-types';
 import { OpenAPIV3_1 } from 'openapi-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 { TypedResponse, RouterRoute, ValidationTargets as ValidationTargets$1, BlankEnv, Input as Input$1, BlankInput, Schema, BlankSchema, MiddlewareHandler as MiddlewareHandler$1 } from 'hono/types';
 import * as json_schema from 'json-schema';
 import { Hook } from '@hono/standard-validator';
 import { StatusCode } from 'hono/utils/http-status';
@@ -118,8 +118,8 @@ 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>, options?: Record<string, unknown>): Handler<E, P, I, 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>;
 
 /**
  * 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.
@@ -184,7 +184,9 @@ type GenerateSpecOptions = {
      */
     defaultOptions: Partial<Record<AllowedMethods | "ALL", DescribeRouteOptions>>;
 };
-type DescribeRouteOptions = Omit<OpenAPIV3_1.OperationObject, "responses" | "parameters"> & {
+type OperationId = string | ((route: RouterRoute) => string);
+type DescribeRouteOptions = Omit<OpenAPIV3_1.OperationObject, "responses" | "parameters" | "operationId"> & {
+    operationId?: OperationId;
     /**
      * Pass `true` to hide route from OpenAPI/swagger document
      */
@@ -209,7 +211,7 @@ type DescribeRouteOptions = Omit<OpenAPIV3_1.OperationObject, "responses" | "par
 type RegisterSchemaPathOptions = {
     route: RouterRoute;
     specs?: DescribeRouteOptions & {
-        operationId?: string | ((route: RouterRoute) => string);
+        operationId?: OperationId;
     };
     paths: Partial<OpenAPIV3_1.PathsObject>;
 };

package/dist/index.d.ts

@@ -1,7 +1,7 @@
 import * as openapi_types from 'openapi-types';
 import { OpenAPIV3_1 } from 'openapi-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 { TypedResponse, RouterRoute, ValidationTargets as ValidationTargets$1, BlankEnv, Input as Input$1, BlankInput, Schema, BlankSchema, MiddlewareHandler as MiddlewareHandler$1 } from 'hono/types';
 import * as json_schema from 'json-schema';
 import { Hook } from '@hono/standard-validator';
 import { StatusCode } from 'hono/utils/http-status';
@@ -118,8 +118,8 @@ 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>, options?: Record<string, unknown>): Handler<E, P, I, 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>;
 
 /**
  * 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.
@@ -184,7 +184,9 @@ type GenerateSpecOptions = {
      */
     defaultOptions: Partial<Record<AllowedMethods | "ALL", DescribeRouteOptions>>;
 };
-type DescribeRouteOptions = Omit<OpenAPIV3_1.OperationObject, "responses" | "parameters"> & {
+type OperationId = string | ((route: RouterRoute) => string);
+type DescribeRouteOptions = Omit<OpenAPIV3_1.OperationObject, "responses" | "parameters" | "operationId"> & {
+    operationId?: OperationId;
     /**
      * Pass `true` to hide route from OpenAPI/swagger document
      */
@@ -209,7 +211,7 @@ type DescribeRouteOptions = Omit<OpenAPIV3_1.OperationObject, "responses" | "par
 type RegisterSchemaPathOptions = {
     route: RouterRoute;
     specs?: DescribeRouteOptions & {
-        operationId?: string | ((route: RouterRoute) => string);
+        operationId?: OperationId;
     };
     paths: Partial<OpenAPIV3_1.PathsObject>;
 };

package/dist/index.js

@@ -329,7 +329,7 @@ async function getSpec(middlewareHandler, defaultOptions) {
     return { schema: tmp, components };
   }
   const result = await middlewareHandler.toOpenAPISchema();
-  const docs = {};
+  const docs = defaultOptions ?? {};
   if (middlewareHandler.target === "form" || middlewareHandler.target === "json") {
     const media = middlewareHandler.options?.media ?? middlewareHandler.target === "json" ? "application/json" : "multipart/form-data";
     if (!docs.requestBody || !("content" in docs.requestBody) || !docs.requestBody.content) {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "hono-openapi",
   "description": "OpenAPI schema generator for Hono",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "type": "module",
   "main": "dist/index.cjs",
   "module": "dist/index.js",
@@ -43,48 +43,32 @@
   },
   "peerDependencies": {
     "@hono/standard-validator": "^0.1.2",
-    "@sinclair/typebox": "^0.34.9",
     "@standard-community/standard-json": "^0.3.0-rc.4",
     "@standard-community/standard-openapi": "^0.2.0-rc.1",
     "@types/json-schema": "^7.0.15",
-    "arktype": "^2.0.0",
-    "effect": "^3.16.12",
     "hono": "^4.8.3",
-    "openapi-types": "^12.1.3",
-    "valibot": "^1.0.0-beta.9",
-    "zod": "^3.23.8"
+    "openapi-types": "^12.1.3"
   },
   "peerDependenciesMeta": {
     "@hono/standard-validator": {
       "optional": true
     },
-    "@sinclair/typebox": {
-      "optional": true
-    },
-    "arktype": {
-      "optional": true
-    },
-    "effect": {
-      "optional": true
-    },
     "hono": {
       "optional": true
-    },
-    "valibot": {
-      "optional": true
-    },
-    "zod": {
-      "optional": true
     }
   },
   "devDependencies": {
     "@biomejs/biome": "^2.0.6",
     "@standard-schema/spec": "^1.0.0",
     "@valibot/to-json-schema": "^1.3.0",
+    "arktype": "^2.1.22",
+    "effect": "^3.17.13",
     "pkgroll": "^2.13.1",
     "typescript": "^5.8.3",
+    "valibot": "^1.1.0",
     "vitest": "^3.2.4",
-    "zod-openapi": "4"
+    "zod": "^3.23.8",
+    "zod-openapi": "^4"
   },
   "scripts": {
     "build": "pkgroll --clean-dist",