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

package/dist/index.d.cts

@@ -2,176 +2,10 @@ 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 * as json_schema from 'json-schema';
 import { Hook } from '@hono/standard-validator';
 import { StatusCode } from 'hono/utils/http-status';
 
-// ==================================================================================================
-// JSON Schema Draft 07
-// ==================================================================================================
-// https://tools.ietf.org/html/draft-handrews-json-schema-validation-01
-// --------------------------------------------------------------------------------------------------
-
-/**
- * Primitive type
- * @see https://tools.ietf.org/html/draft-handrews-json-schema-validation-01#section-6.1.1
- */
-type JSONSchema7TypeName =
-    | "string" //
-    | "number"
-    | "integer"
-    | "boolean"
-    | "object"
-    | "array"
-    | "null";
-
-/**
- * Primitive type
- * @see https://tools.ietf.org/html/draft-handrews-json-schema-validation-01#section-6.1.1
- */
-type JSONSchema7Type =
-    | string //
-    | number
-    | boolean
-    | JSONSchema7Object
-    | JSONSchema7Array
-    | null;
-
-// Workaround for infinite type recursion
-interface JSONSchema7Object {
-    [key: string]: JSONSchema7Type;
-}
-
-// Workaround for infinite type recursion
-// https://github.com/Microsoft/TypeScript/issues/3496#issuecomment-128553540
-interface JSONSchema7Array extends Array<JSONSchema7Type> {}
-
-/**
- * Meta schema
- *
- * Recommended values:
- * - 'http://json-schema.org/schema#'
- * - 'http://json-schema.org/hyper-schema#'
- * - 'http://json-schema.org/draft-07/schema#'
- * - 'http://json-schema.org/draft-07/hyper-schema#'
- *
- * @see https://tools.ietf.org/html/draft-handrews-json-schema-validation-01#section-5
- */
-type JSONSchema7Version = string;
-
-/**
- * JSON Schema v7
- * @see https://tools.ietf.org/html/draft-handrews-json-schema-validation-01
- */
-type JSONSchema7Definition = JSONSchema7 | boolean;
-interface JSONSchema7 {
-    $id?: string | undefined;
-    $ref?: string | undefined;
-    $schema?: JSONSchema7Version | undefined;
-    $comment?: string | undefined;
-
-    /**
-     * @see https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-00#section-8.2.4
-     * @see https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#appendix-A
-     */
-    $defs?: {
-        [key: string]: JSONSchema7Definition;
-    } | undefined;
-
-    /**
-     * @see https://tools.ietf.org/html/draft-handrews-json-schema-validation-01#section-6.1
-     */
-    type?: JSONSchema7TypeName | JSONSchema7TypeName[] | undefined;
-    enum?: JSONSchema7Type[] | undefined;
-    const?: JSONSchema7Type | undefined;
-
-    /**
-     * @see https://tools.ietf.org/html/draft-handrews-json-schema-validation-01#section-6.2
-     */
-    multipleOf?: number | undefined;
-    maximum?: number | undefined;
-    exclusiveMaximum?: number | undefined;
-    minimum?: number | undefined;
-    exclusiveMinimum?: number | undefined;
-
-    /**
-     * @see https://tools.ietf.org/html/draft-handrews-json-schema-validation-01#section-6.3
-     */
-    maxLength?: number | undefined;
-    minLength?: number | undefined;
-    pattern?: string | undefined;
-
-    /**
-     * @see https://tools.ietf.org/html/draft-handrews-json-schema-validation-01#section-6.4
-     */
-    items?: JSONSchema7Definition | JSONSchema7Definition[] | undefined;
-    additionalItems?: JSONSchema7Definition | undefined;
-    maxItems?: number | undefined;
-    minItems?: number | undefined;
-    uniqueItems?: boolean | undefined;
-    contains?: JSONSchema7Definition | undefined;
-
-    /**
-     * @see https://tools.ietf.org/html/draft-handrews-json-schema-validation-01#section-6.5
-     */
-    maxProperties?: number | undefined;
-    minProperties?: number | undefined;
-    required?: string[] | undefined;
-    properties?: {
-        [key: string]: JSONSchema7Definition;
-    } | undefined;
-    patternProperties?: {
-        [key: string]: JSONSchema7Definition;
-    } | undefined;
-    additionalProperties?: JSONSchema7Definition | undefined;
-    dependencies?: {
-        [key: string]: JSONSchema7Definition | string[];
-    } | undefined;
-    propertyNames?: JSONSchema7Definition | undefined;
-
-    /**
-     * @see https://tools.ietf.org/html/draft-handrews-json-schema-validation-01#section-6.6
-     */
-    if?: JSONSchema7Definition | undefined;
-    then?: JSONSchema7Definition | undefined;
-    else?: JSONSchema7Definition | undefined;
-
-    /**
-     * @see https://tools.ietf.org/html/draft-handrews-json-schema-validation-01#section-6.7
-     */
-    allOf?: JSONSchema7Definition[] | undefined;
-    anyOf?: JSONSchema7Definition[] | undefined;
-    oneOf?: JSONSchema7Definition[] | undefined;
-    not?: JSONSchema7Definition | undefined;
-
-    /**
-     * @see https://tools.ietf.org/html/draft-handrews-json-schema-validation-01#section-7
-     */
-    format?: string | undefined;
-
-    /**
-     * @see https://tools.ietf.org/html/draft-handrews-json-schema-validation-01#section-8
-     */
-    contentMediaType?: string | undefined;
-    contentEncoding?: string | undefined;
-
-    /**
-     * @see https://tools.ietf.org/html/draft-handrews-json-schema-validation-01#section-9
-     */
-    definitions?: {
-        [key: string]: JSONSchema7Definition;
-    } | undefined;
-
-    /**
-     * @see https://tools.ietf.org/html/draft-handrews-json-schema-validation-01#section-10
-     */
-    title?: string | undefined;
-    description?: string | undefined;
-    default?: JSONSchema7Type | undefined;
-    readOnly?: boolean | undefined;
-    writeOnly?: boolean | undefined;
-    examples?: JSONSchema7Type | undefined;
-}
-
 /** The Standard Schema interface. */
 interface StandardSchemaV1<Input = unknown, Output = Input> {
     /** The Standard Schema properties. */
@@ -234,11 +68,11 @@ declare namespace StandardSchemaV1 {
  * @param schema Validation schema
  * @returns Resolver result
  */
-declare function resolver<Schema extends StandardSchemaV1>(schema: Schema): {
+declare function resolver<Schema extends StandardSchemaV1>(schema: Schema, options?: Record<string, unknown>): {
     vendor: string;
     validate: (value: unknown) => StandardSchemaV1.Result<unknown> | Promise<StandardSchemaV1.Result<unknown>>;
-    toJSONSchema: (options?: Record<string, unknown>) => Promise<JSONSchema7>;
-    toOpenAPISchema: (options?: Record<string, unknown>) => Promise<{
+    toJSONSchema: () => Promise<json_schema.JSONSchema7>;
+    toOpenAPISchema: () => Promise<{
         schema: OpenAPIV3_1.SchemaObject;
         components: OpenAPIV3_1.ComponentsObject | undefined;
     }>;
@@ -264,7 +98,7 @@ declare function validator<Schema extends StandardSchemaV1, Target extends keyof
     out: {
         [K in Target]: Out;
     };
-}, V extends I = I>(target: Target, schema: Schema, hook?: Hook<StandardSchemaV1.InferOutput<Schema>, E, P, Target>, options?: Record<string, unknown>): MiddlewareHandler<E, P, V>;
+}, V extends I = I>(target: Target, schema: Schema, hook?: Hook<StandardSchemaV1.InferOutput<Schema>, E, P, Target>, options?: ResolverReturnType["options"]): MiddlewareHandler<E, P, V>;
 /**
  * Describe a route with OpenAPI specs.
  * @param spec Options for describing a route
@@ -285,7 +119,7 @@ type HandlerResponse<T extends Partial<Record<StatusCode, StandardSchemaV1>> = P
     [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>;
+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>;
 
 /**
  * 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.
@@ -294,15 +128,21 @@ 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 registerSchemaPath({ route, specs, paths, }: RegisterSchemaPathOptions): void;
-declare function removeExcludedPaths(paths: OpenAPIV3_1.PathsObject, ctx: {
-    options: SanitizedGenerateSpecOptions;
-}): OpenAPIV3_1.PathsObject<{}, {}>;
+declare function removeExcludedPaths(paths: OpenAPIV3_1.PathsObject, ctx: SpecContext): OpenAPIV3_1.PathsObject<{}, {}>;
 
 type PromiseOr<T> = T | Promise<T>;
-type ResolverReturnType = ReturnType<typeof resolver>;
+type ResolverReturnType = ReturnType<typeof resolver> & {
+    options?: {
+        /**
+         * 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;
+    };
+};
 type HandlerUniqueProperty = (ResolverReturnType & {
     target: keyof ValidationTargets$1;
-    options?: Record<string, unknown>;
 }) | {
     spec: DescribeRouteOptions;
 };
@@ -344,13 +184,15 @@ type GenerateSpecOptions = {
      */
     defaultOptions: Partial<Record<AllowedMethods | "ALL", DescribeRouteOptions>>;
 };
-type HaveDefaultValues = "documentation" | "excludeStaticFile" | "exclude" | "excludeMethods" | "excludeTags";
-type SanitizedGenerateSpecOptions = Pick<GenerateSpecOptions, HaveDefaultValues> & Omit<Partial<GenerateSpecOptions>, HaveDefaultValues>;
 type DescribeRouteOptions = Omit<OpenAPIV3_1.OperationObject, "responses" | "parameters"> & {
     /**
      * Pass `true` to hide route from OpenAPI/swagger document
      */
-    hide?: boolean | ((c: Context) => boolean);
+    hide?: boolean | ((props: {
+        c?: Context;
+        method: string;
+        path: string;
+    }) => boolean);
     /**
      * Responses of the request
      */
@@ -366,9 +208,17 @@ type DescribeRouteOptions = Omit<OpenAPIV3_1.OperationObject, "responses" | "par
 };
 type RegisterSchemaPathOptions = {
     route: RouterRoute;
-    specs?: DescribeRouteOptions | Pick<OpenAPIV3_1.OperationObject, "parameters" | "requestBody">;
+    specs?: DescribeRouteOptions & {
+        operationId?: string | ((route: RouterRoute) => string);
+    };
     paths: Partial<OpenAPIV3_1.PathsObject>;
 };
+type HaveDefaultValues = "documentation" | "excludeStaticFile" | "exclude" | "excludeMethods" | "excludeTags";
+type SanitizedGenerateSpecOptions = Pick<GenerateSpecOptions, HaveDefaultValues> & Omit<Partial<GenerateSpecOptions>, HaveDefaultValues>;
+type SpecContext = {
+    components: OpenAPIV3_1.ComponentsObject;
+    options: SanitizedGenerateSpecOptions;
+};
 
 /**
  * Route handler for OpenAPI specs
@@ -411,20 +261,7 @@ declare function generateSpecs<E extends Env = BlankEnv, P extends string = stri
             trace?: OpenAPIV3_1.OperationObject<{}>;
         };
     };
-    components: {
-        schemas: {
-            [x: string]: OpenAPIV3_1.SchemaObject;
-        };
-        responses?: Record<string, OpenAPIV3_1.ReferenceObject | OpenAPIV3_1.ResponseObject>;
-        parameters?: Record<string, OpenAPIV3_1.ReferenceObject | OpenAPIV3_1.ParameterObject>;
-        examples?: Record<string, OpenAPIV3_1.ReferenceObject | OpenAPIV3_1.ExampleObject>;
-        requestBodies?: Record<string, OpenAPIV3_1.ReferenceObject | OpenAPIV3_1.RequestBodyObject>;
-        headers?: Record<string, OpenAPIV3_1.ReferenceObject | OpenAPIV3_1.HeaderObject>;
-        securitySchemes?: Record<string, OpenAPIV3_1.ReferenceObject | OpenAPIV3_1.SecuritySchemeObject>;
-        links?: Record<string, OpenAPIV3_1.ReferenceObject | OpenAPIV3_1.LinkObject>;
-        callbacks?: Record<string, OpenAPIV3_1.ReferenceObject | OpenAPIV3_1.CallbackObject>;
-        pathItems?: Record<string, OpenAPIV3_1.ReferenceObject | OpenAPIV3_1.PathItemObject>;
-    };
+    components: OpenAPIV3_1.ComponentsObject;
     openapi: string;
     externalDocs?: openapi_types.OpenAPIV3.ExternalDocumentationObject;
     security?: openapi_types.OpenAPIV3.SecurityRequirementObject[];
@@ -433,4 +270,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, describeResponse, describeRoute, generateSpecs, 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, describeResponse, describeRoute, generateSpecs, openAPIRouteHandler, registerSchemaPath, removeExcludedPaths, resolver, uniqueSymbol, validator };

package/dist/index.d.ts

@@ -2,176 +2,10 @@ 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 * as json_schema from 'json-schema';
 import { Hook } from '@hono/standard-validator';
 import { StatusCode } from 'hono/utils/http-status';
 
-// ==================================================================================================
-// JSON Schema Draft 07
-// ==================================================================================================
-// https://tools.ietf.org/html/draft-handrews-json-schema-validation-01
-// --------------------------------------------------------------------------------------------------
-
-/**
- * Primitive type
- * @see https://tools.ietf.org/html/draft-handrews-json-schema-validation-01#section-6.1.1
- */
-type JSONSchema7TypeName =
-    | "string" //
-    | "number"
-    | "integer"
-    | "boolean"
-    | "object"
-    | "array"
-    | "null";
-
-/**
- * Primitive type
- * @see https://tools.ietf.org/html/draft-handrews-json-schema-validation-01#section-6.1.1
- */
-type JSONSchema7Type =
-    | string //
-    | number
-    | boolean
-    | JSONSchema7Object
-    | JSONSchema7Array
-    | null;
-
-// Workaround for infinite type recursion
-interface JSONSchema7Object {
-    [key: string]: JSONSchema7Type;
-}
-
-// Workaround for infinite type recursion
-// https://github.com/Microsoft/TypeScript/issues/3496#issuecomment-128553540
-interface JSONSchema7Array extends Array<JSONSchema7Type> {}
-
-/**
- * Meta schema
- *
- * Recommended values:
- * - 'http://json-schema.org/schema#'
- * - 'http://json-schema.org/hyper-schema#'
- * - 'http://json-schema.org/draft-07/schema#'
- * - 'http://json-schema.org/draft-07/hyper-schema#'
- *
- * @see https://tools.ietf.org/html/draft-handrews-json-schema-validation-01#section-5
- */
-type JSONSchema7Version = string;
-
-/**
- * JSON Schema v7
- * @see https://tools.ietf.org/html/draft-handrews-json-schema-validation-01
- */
-type JSONSchema7Definition = JSONSchema7 | boolean;
-interface JSONSchema7 {
-    $id?: string | undefined;
-    $ref?: string | undefined;
-    $schema?: JSONSchema7Version | undefined;
-    $comment?: string | undefined;
-
-    /**
-     * @see https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-00#section-8.2.4
-     * @see https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#appendix-A
-     */
-    $defs?: {
-        [key: string]: JSONSchema7Definition;
-    } | undefined;
-
-    /**
-     * @see https://tools.ietf.org/html/draft-handrews-json-schema-validation-01#section-6.1
-     */
-    type?: JSONSchema7TypeName | JSONSchema7TypeName[] | undefined;
-    enum?: JSONSchema7Type[] | undefined;
-    const?: JSONSchema7Type | undefined;
-
-    /**
-     * @see https://tools.ietf.org/html/draft-handrews-json-schema-validation-01#section-6.2
-     */
-    multipleOf?: number | undefined;
-    maximum?: number | undefined;
-    exclusiveMaximum?: number | undefined;
-    minimum?: number | undefined;
-    exclusiveMinimum?: number | undefined;
-
-    /**
-     * @see https://tools.ietf.org/html/draft-handrews-json-schema-validation-01#section-6.3
-     */
-    maxLength?: number | undefined;
-    minLength?: number | undefined;
-    pattern?: string | undefined;
-
-    /**
-     * @see https://tools.ietf.org/html/draft-handrews-json-schema-validation-01#section-6.4
-     */
-    items?: JSONSchema7Definition | JSONSchema7Definition[] | undefined;
-    additionalItems?: JSONSchema7Definition | undefined;
-    maxItems?: number | undefined;
-    minItems?: number | undefined;
-    uniqueItems?: boolean | undefined;
-    contains?: JSONSchema7Definition | undefined;
-
-    /**
-     * @see https://tools.ietf.org/html/draft-handrews-json-schema-validation-01#section-6.5
-     */
-    maxProperties?: number | undefined;
-    minProperties?: number | undefined;
-    required?: string[] | undefined;
-    properties?: {
-        [key: string]: JSONSchema7Definition;
-    } | undefined;
-    patternProperties?: {
-        [key: string]: JSONSchema7Definition;
-    } | undefined;
-    additionalProperties?: JSONSchema7Definition | undefined;
-    dependencies?: {
-        [key: string]: JSONSchema7Definition | string[];
-    } | undefined;
-    propertyNames?: JSONSchema7Definition | undefined;
-
-    /**
-     * @see https://tools.ietf.org/html/draft-handrews-json-schema-validation-01#section-6.6
-     */
-    if?: JSONSchema7Definition | undefined;
-    then?: JSONSchema7Definition | undefined;
-    else?: JSONSchema7Definition | undefined;
-
-    /**
-     * @see https://tools.ietf.org/html/draft-handrews-json-schema-validation-01#section-6.7
-     */
-    allOf?: JSONSchema7Definition[] | undefined;
-    anyOf?: JSONSchema7Definition[] | undefined;
-    oneOf?: JSONSchema7Definition[] | undefined;
-    not?: JSONSchema7Definition | undefined;
-
-    /**
-     * @see https://tools.ietf.org/html/draft-handrews-json-schema-validation-01#section-7
-     */
-    format?: string | undefined;
-
-    /**
-     * @see https://tools.ietf.org/html/draft-handrews-json-schema-validation-01#section-8
-     */
-    contentMediaType?: string | undefined;
-    contentEncoding?: string | undefined;
-
-    /**
-     * @see https://tools.ietf.org/html/draft-handrews-json-schema-validation-01#section-9
-     */
-    definitions?: {
-        [key: string]: JSONSchema7Definition;
-    } | undefined;
-
-    /**
-     * @see https://tools.ietf.org/html/draft-handrews-json-schema-validation-01#section-10
-     */
-    title?: string | undefined;
-    description?: string | undefined;
-    default?: JSONSchema7Type | undefined;
-    readOnly?: boolean | undefined;
-    writeOnly?: boolean | undefined;
-    examples?: JSONSchema7Type | undefined;
-}
-
 /** The Standard Schema interface. */
 interface StandardSchemaV1<Input = unknown, Output = Input> {
     /** The Standard Schema properties. */
@@ -234,11 +68,11 @@ declare namespace StandardSchemaV1 {
  * @param schema Validation schema
  * @returns Resolver result
  */
-declare function resolver<Schema extends StandardSchemaV1>(schema: Schema): {
+declare function resolver<Schema extends StandardSchemaV1>(schema: Schema, options?: Record<string, unknown>): {
     vendor: string;
     validate: (value: unknown) => StandardSchemaV1.Result<unknown> | Promise<StandardSchemaV1.Result<unknown>>;
-    toJSONSchema: (options?: Record<string, unknown>) => Promise<JSONSchema7>;
-    toOpenAPISchema: (options?: Record<string, unknown>) => Promise<{
+    toJSONSchema: () => Promise<json_schema.JSONSchema7>;
+    toOpenAPISchema: () => Promise<{
         schema: OpenAPIV3_1.SchemaObject;
         components: OpenAPIV3_1.ComponentsObject | undefined;
     }>;
@@ -264,7 +98,7 @@ declare function validator<Schema extends StandardSchemaV1, Target extends keyof
     out: {
         [K in Target]: Out;
     };
-}, V extends I = I>(target: Target, schema: Schema, hook?: Hook<StandardSchemaV1.InferOutput<Schema>, E, P, Target>, options?: Record<string, unknown>): MiddlewareHandler<E, P, V>;
+}, V extends I = I>(target: Target, schema: Schema, hook?: Hook<StandardSchemaV1.InferOutput<Schema>, E, P, Target>, options?: ResolverReturnType["options"]): MiddlewareHandler<E, P, V>;
 /**
  * Describe a route with OpenAPI specs.
  * @param spec Options for describing a route
@@ -285,7 +119,7 @@ type HandlerResponse<T extends Partial<Record<StatusCode, StandardSchemaV1>> = P
     [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>;
+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>;
 
 /**
  * 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.
@@ -294,15 +128,21 @@ 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 registerSchemaPath({ route, specs, paths, }: RegisterSchemaPathOptions): void;
-declare function removeExcludedPaths(paths: OpenAPIV3_1.PathsObject, ctx: {
-    options: SanitizedGenerateSpecOptions;
-}): OpenAPIV3_1.PathsObject<{}, {}>;
+declare function removeExcludedPaths(paths: OpenAPIV3_1.PathsObject, ctx: SpecContext): OpenAPIV3_1.PathsObject<{}, {}>;
 
 type PromiseOr<T> = T | Promise<T>;
-type ResolverReturnType = ReturnType<typeof resolver>;
+type ResolverReturnType = ReturnType<typeof resolver> & {
+    options?: {
+        /**
+         * 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;
+    };
+};
 type HandlerUniqueProperty = (ResolverReturnType & {
     target: keyof ValidationTargets$1;
-    options?: Record<string, unknown>;
 }) | {
     spec: DescribeRouteOptions;
 };
@@ -344,13 +184,15 @@ type GenerateSpecOptions = {
      */
     defaultOptions: Partial<Record<AllowedMethods | "ALL", DescribeRouteOptions>>;
 };
-type HaveDefaultValues = "documentation" | "excludeStaticFile" | "exclude" | "excludeMethods" | "excludeTags";
-type SanitizedGenerateSpecOptions = Pick<GenerateSpecOptions, HaveDefaultValues> & Omit<Partial<GenerateSpecOptions>, HaveDefaultValues>;
 type DescribeRouteOptions = Omit<OpenAPIV3_1.OperationObject, "responses" | "parameters"> & {
     /**
      * Pass `true` to hide route from OpenAPI/swagger document
      */
-    hide?: boolean | ((c: Context) => boolean);
+    hide?: boolean | ((props: {
+        c?: Context;
+        method: string;
+        path: string;
+    }) => boolean);
     /**
      * Responses of the request
      */
@@ -366,9 +208,17 @@ type DescribeRouteOptions = Omit<OpenAPIV3_1.OperationObject, "responses" | "par
 };
 type RegisterSchemaPathOptions = {
     route: RouterRoute;
-    specs?: DescribeRouteOptions | Pick<OpenAPIV3_1.OperationObject, "parameters" | "requestBody">;
+    specs?: DescribeRouteOptions & {
+        operationId?: string | ((route: RouterRoute) => string);
+    };
     paths: Partial<OpenAPIV3_1.PathsObject>;
 };
+type HaveDefaultValues = "documentation" | "excludeStaticFile" | "exclude" | "excludeMethods" | "excludeTags";
+type SanitizedGenerateSpecOptions = Pick<GenerateSpecOptions, HaveDefaultValues> & Omit<Partial<GenerateSpecOptions>, HaveDefaultValues>;
+type SpecContext = {
+    components: OpenAPIV3_1.ComponentsObject;
+    options: SanitizedGenerateSpecOptions;
+};
 
 /**
  * Route handler for OpenAPI specs
@@ -411,20 +261,7 @@ declare function generateSpecs<E extends Env = BlankEnv, P extends string = stri
             trace?: OpenAPIV3_1.OperationObject<{}>;
         };
     };
-    components: {
-        schemas: {
-            [x: string]: OpenAPIV3_1.SchemaObject;
-        };
-        responses?: Record<string, OpenAPIV3_1.ReferenceObject | OpenAPIV3_1.ResponseObject>;
-        parameters?: Record<string, OpenAPIV3_1.ReferenceObject | OpenAPIV3_1.ParameterObject>;
-        examples?: Record<string, OpenAPIV3_1.ReferenceObject | OpenAPIV3_1.ExampleObject>;
-        requestBodies?: Record<string, OpenAPIV3_1.ReferenceObject | OpenAPIV3_1.RequestBodyObject>;
-        headers?: Record<string, OpenAPIV3_1.ReferenceObject | OpenAPIV3_1.HeaderObject>;
-        securitySchemes?: Record<string, OpenAPIV3_1.ReferenceObject | OpenAPIV3_1.SecuritySchemeObject>;
-        links?: Record<string, OpenAPIV3_1.ReferenceObject | OpenAPIV3_1.LinkObject>;
-        callbacks?: Record<string, OpenAPIV3_1.ReferenceObject | OpenAPIV3_1.CallbackObject>;
-        pathItems?: Record<string, OpenAPIV3_1.ReferenceObject | OpenAPIV3_1.PathItemObject>;
-    };
+    components: OpenAPIV3_1.ComponentsObject;
     openapi: string;
     externalDocs?: openapi_types.OpenAPIV3.ExternalDocumentationObject;
     security?: openapi_types.OpenAPIV3.SecurityRequirementObject[];
@@ -433,4 +270,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, describeResponse, describeRoute, generateSpecs, 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, describeResponse, describeRoute, generateSpecs, openAPIRouteHandler, registerSchemaPath, removeExcludedPaths, resolver, uniqueSymbol, validator };