hono 4.3.11 → 4.4.0

package/dist/types/middleware/secure-headers/index.d.ts

@@ -1,66 +1,8 @@
-import type { Context } from '../../context';
-import type { MiddlewareHandler } from '../../types';
-declare module '../../context' {
-    interface ContextVariableMap {
-        secureHeadersNonce?: string;
+export type { ContentSecurityPolicyOptionHandler } from './secure-headers';
+export { NONCE, secureHeaders } from './secure-headers';
+import type { SecureHeadersVariables } from './secure-headers';
+export type { SecureHeadersVariables };
+declare module '../..' {
+    interface ContextVariableMap extends SecureHeadersVariables {
     }
 }
-export type ContentSecurityPolicyOptionHandler = (ctx: Context, directive: string) => string;
-type ContentSecurityPolicyOptionValue = (string | ContentSecurityPolicyOptionHandler)[];
-interface ContentSecurityPolicyOptions {
-    defaultSrc?: ContentSecurityPolicyOptionValue;
-    baseUri?: ContentSecurityPolicyOptionValue;
-    childSrc?: ContentSecurityPolicyOptionValue;
-    connectSrc?: ContentSecurityPolicyOptionValue;
-    fontSrc?: ContentSecurityPolicyOptionValue;
-    formAction?: ContentSecurityPolicyOptionValue;
-    frameAncestors?: ContentSecurityPolicyOptionValue;
-    frameSrc?: ContentSecurityPolicyOptionValue;
-    imgSrc?: ContentSecurityPolicyOptionValue;
-    manifestSrc?: ContentSecurityPolicyOptionValue;
-    mediaSrc?: ContentSecurityPolicyOptionValue;
-    objectSrc?: ContentSecurityPolicyOptionValue;
-    reportTo?: string;
-    sandbox?: ContentSecurityPolicyOptionValue;
-    scriptSrc?: ContentSecurityPolicyOptionValue;
-    scriptSrcAttr?: ContentSecurityPolicyOptionValue;
-    scriptSrcElem?: ContentSecurityPolicyOptionValue;
-    styleSrc?: ContentSecurityPolicyOptionValue;
-    styleSrcAttr?: ContentSecurityPolicyOptionValue;
-    styleSrcElem?: ContentSecurityPolicyOptionValue;
-    upgradeInsecureRequests?: ContentSecurityPolicyOptionValue;
-    workerSrc?: ContentSecurityPolicyOptionValue;
-}
-interface ReportToOptions {
-    group: string;
-    max_age: number;
-    endpoints: ReportToEndpoint[];
-}
-interface ReportToEndpoint {
-    url: string;
-}
-interface ReportingEndpointOptions {
-    name: string;
-    url: string;
-}
-type overridableHeader = boolean | string;
-interface SecureHeadersOptions {
-    contentSecurityPolicy?: ContentSecurityPolicyOptions;
-    crossOriginEmbedderPolicy?: overridableHeader;
-    crossOriginResourcePolicy?: overridableHeader;
-    crossOriginOpenerPolicy?: overridableHeader;
-    originAgentCluster?: overridableHeader;
-    referrerPolicy?: overridableHeader;
-    reportingEndpoints?: ReportingEndpointOptions[];
-    reportTo?: ReportToOptions[];
-    strictTransportSecurity?: overridableHeader;
-    xContentTypeOptions?: overridableHeader;
-    xDnsPrefetchControl?: overridableHeader;
-    xDownloadOptions?: overridableHeader;
-    xFrameOptions?: overridableHeader;
-    xPermittedCrossDomainPolicies?: overridableHeader;
-    xXssProtection?: overridableHeader;
-}
-export declare const NONCE: ContentSecurityPolicyOptionHandler;
-export declare const secureHeaders: (customOptions?: SecureHeadersOptions) => MiddlewareHandler;
-export {};

package/dist/types/middleware/secure-headers/secure-headers.d.ts

@@ -0,0 +1,97 @@
+/**
+ * @module
+ * Secure Headers Middleware for Hono.
+ */
+import type { Context } from '../../context';
+import type { MiddlewareHandler } from '../../types';
+export type SecureHeadersVariables = {
+    secureHeadersNonce?: string;
+};
+export type ContentSecurityPolicyOptionHandler = (ctx: Context, directive: string) => string;
+type ContentSecurityPolicyOptionValue = (string | ContentSecurityPolicyOptionHandler)[];
+interface ContentSecurityPolicyOptions {
+    defaultSrc?: ContentSecurityPolicyOptionValue;
+    baseUri?: ContentSecurityPolicyOptionValue;
+    childSrc?: ContentSecurityPolicyOptionValue;
+    connectSrc?: ContentSecurityPolicyOptionValue;
+    fontSrc?: ContentSecurityPolicyOptionValue;
+    formAction?: ContentSecurityPolicyOptionValue;
+    frameAncestors?: ContentSecurityPolicyOptionValue;
+    frameSrc?: ContentSecurityPolicyOptionValue;
+    imgSrc?: ContentSecurityPolicyOptionValue;
+    manifestSrc?: ContentSecurityPolicyOptionValue;
+    mediaSrc?: ContentSecurityPolicyOptionValue;
+    objectSrc?: ContentSecurityPolicyOptionValue;
+    reportTo?: string;
+    sandbox?: ContentSecurityPolicyOptionValue;
+    scriptSrc?: ContentSecurityPolicyOptionValue;
+    scriptSrcAttr?: ContentSecurityPolicyOptionValue;
+    scriptSrcElem?: ContentSecurityPolicyOptionValue;
+    styleSrc?: ContentSecurityPolicyOptionValue;
+    styleSrcAttr?: ContentSecurityPolicyOptionValue;
+    styleSrcElem?: ContentSecurityPolicyOptionValue;
+    upgradeInsecureRequests?: ContentSecurityPolicyOptionValue;
+    workerSrc?: ContentSecurityPolicyOptionValue;
+}
+interface ReportToOptions {
+    group: string;
+    max_age: number;
+    endpoints: ReportToEndpoint[];
+}
+interface ReportToEndpoint {
+    url: string;
+}
+interface ReportingEndpointOptions {
+    name: string;
+    url: string;
+}
+type overridableHeader = boolean | string;
+interface SecureHeadersOptions {
+    contentSecurityPolicy?: ContentSecurityPolicyOptions;
+    crossOriginEmbedderPolicy?: overridableHeader;
+    crossOriginResourcePolicy?: overridableHeader;
+    crossOriginOpenerPolicy?: overridableHeader;
+    originAgentCluster?: overridableHeader;
+    referrerPolicy?: overridableHeader;
+    reportingEndpoints?: ReportingEndpointOptions[];
+    reportTo?: ReportToOptions[];
+    strictTransportSecurity?: overridableHeader;
+    xContentTypeOptions?: overridableHeader;
+    xDnsPrefetchControl?: overridableHeader;
+    xDownloadOptions?: overridableHeader;
+    xFrameOptions?: overridableHeader;
+    xPermittedCrossDomainPolicies?: overridableHeader;
+    xXssProtection?: overridableHeader;
+}
+export declare const NONCE: ContentSecurityPolicyOptionHandler;
+/**
+ * Secure Headers Middleware for Hono.
+ *
+ * @see {@link https://hono.dev/middleware/builtin/secure-headers}
+ *
+ * @param {Partial<SecureHeadersOptions>} [customOptions] - The options for the secure headers middleware.
+ * @param {ContentSecurityPolicyOptions} [customOptions.contentSecurityPolicy] - Settings for the Content-Security-Policy header.
+ * @param {overridableHeader} [customOptions.crossOriginEmbedderPolicy=false] - Settings for the Cross-Origin-Embedder-Policy header.
+ * @param {overridableHeader} [customOptions.crossOriginResourcePolicy=true] - Settings for the Cross-Origin-Resource-Policy header.
+ * @param {overridableHeader} [customOptions.crossOriginOpenerPolicy=true] - Settings for the Cross-Origin-Opener-Policy header.
+ * @param {overridableHeader} [customOptions.originAgentCluster=true] - Settings for the Origin-Agent-Cluster header.
+ * @param {overridableHeader} [customOptions.referrerPolicy=true] - Settings for the Referrer-Policy header.
+ * @param {ReportingEndpointOptions[]} [customOptions.reportingEndpoints] - Settings for the Reporting-Endpoints header.
+ * @param {ReportToOptions[]} [customOptions.reportTo] - Settings for the Report-To header.
+ * @param {overridableHeader} [customOptions.strictTransportSecurity=true] - Settings for the Strict-Transport-Security header.
+ * @param {overridableHeader} [customOptions.xContentTypeOptions=true] - Settings for the X-Content-Type-Options header.
+ * @param {overridableHeader} [customOptions.xDnsPrefetchControl=true] - Settings for the X-DNS-Prefetch-Control header.
+ * @param {overridableHeader} [customOptions.xDownloadOptions=true] - Settings for the X-Download-Options header.
+ * @param {overridableHeader} [customOptions.xFrameOptions=true] - Settings for the X-Frame-Options header.
+ * @param {overridableHeader} [customOptions.xPermittedCrossDomainPolicies=true] - Settings for the X-Permitted-Cross-Domain-Policies header.
+ * @param {overridableHeader} [customOptions.xXssProtection=true] - Settings for the X-XSS-Protection header.
+ * @returns {MiddlewareHandler} The middleware handler function.
+ *
+ * @example
+ * ```ts
+ * const app = new Hono()
+ * app.use(secureHeaders())
+ * ```
+ */
+export declare const secureHeaders: (customOptions?: SecureHeadersOptions) => MiddlewareHandler;
+export {};

package/dist/types/middleware/serve-static/index.d.ts

@@ -1,3 +1,7 @@
+/**
+ * @module
+ * Serve Static Middleware for Hono.
+ */
 import type { Context, Data } from '../../context';
 import type { Env, MiddlewareHandler } from '../../types';
 export type ServeStaticOptions<E extends Env = Env> = {

package/dist/types/middleware/timeout/index.d.ts

@@ -0,0 +1,31 @@
+/**
+ * @module
+ * Timeout Middleware for Hono.
+ */
+import type { Context } from '../../context';
+import { HTTPException } from '../../http-exception';
+import type { MiddlewareHandler } from '../../types';
+export type HTTPExceptionFunction = (context: Context) => HTTPException;
+/**
+ * Timeout Middleware for Hono.
+ *
+ * @param {number} duration - The timeout duration in milliseconds.
+ * @param {HTTPExceptionFunction | HTTPException} [exception=defaultTimeoutException] - The exception to throw when the timeout occurs. Can be a function that returns an HTTPException or an HTTPException object.
+ * @returns {MiddlewareHandler} The middleware handler function.
+ *
+ * @example
+ * ```ts
+ * const app = new Hono()
+ *
+ * app.use(
+ *   '/long-request',
+ *   timeout(5000) // Set timeout to 5 seconds
+ * )
+ *
+ * app.get('/long-request', async (c) => {
+ *   await someLongRunningFunction()
+ *   return c.text('Completed within time limit')
+ * })
+ * ```
+ */
+export declare const timeout: (duration: number, exception?: HTTPExceptionFunction | HTTPException) => MiddlewareHandler;

package/dist/types/middleware/timing/index.d.ts

@@ -1,31 +1,7 @@
-import type { Context } from '../../context';
-import type { MiddlewareHandler } from '../../types';
-import '../../context';
-declare module '../../context' {
-    interface ContextVariableMap {
-        metric?: {
-            headers: string[];
-            timers: Map<string, Timer>;
-        };
+import type { TimingVariables } from './timing';
+export { TimingVariables };
+export { timing, setMetric, startTime, endTime } from './timing';
+declare module '../..' {
+    interface ContextVariableMap extends TimingVariables {
     }
 }
-interface Timer {
-    description?: string;
-    start: number;
-}
-interface TimingOptions {
-    total?: boolean;
-    enabled?: boolean | ((c: Context) => boolean);
-    totalDescription?: string;
-    autoEnd?: boolean;
-    crossOrigin?: boolean | string | ((c: Context) => boolean | string);
-}
-export declare const timing: (config?: TimingOptions) => MiddlewareHandler;
-interface SetMetric {
-    (c: Context, name: string, value: number, description?: string, precision?: number): void;
-    (c: Context, name: string, description?: string): void;
-}
-export declare const setMetric: SetMetric;
-export declare const startTime: (c: Context, name: string, description?: string) => void;
-export declare const endTime: (c: Context, name: string, precision?: number) => void;
-export {};

package/dist/types/middleware/timing/timing.d.ts

@@ -0,0 +1,111 @@
+/**
+ * @module
+ * Server-Timing Middleware for Hono.
+ */
+import type { Context } from '../../context';
+import type { MiddlewareHandler } from '../../types';
+import '../../context';
+export type TimingVariables = {
+    metric?: {
+        headers: string[];
+        timers: Map<string, Timer>;
+    };
+};
+interface Timer {
+    description?: string;
+    start: number;
+}
+interface TimingOptions {
+    total?: boolean;
+    enabled?: boolean | ((c: Context) => boolean);
+    totalDescription?: string;
+    autoEnd?: boolean;
+    crossOrigin?: boolean | string | ((c: Context) => boolean | string);
+}
+/**
+ * Server-Timing Middleware for Hono.
+ *
+ * @see {@link https://hono.dev/middleware/builtin/timing}
+ *
+ * @param {TimingOptions} [config] - The options for the timing middleware.
+ * @param {boolean} [config.total=true] - Show the total response time.
+ * @param {boolean | ((c: Context) => boolean)} [config.enabled=true] - Whether timings should be added to the headers or not.
+ * @param {string} [config.totalDescription=Total Response Time] - Description for the total response time.
+ * @param {boolean} [config.autoEnd=true] - If `startTime()` should end automatically at the end of the request.
+ * @param {boolean | string | ((c: Context) => boolean | string)} [config.crossOrigin=false] - The origin this timings header should be readable.
+ * @returns {MiddlewareHandler} The middleware handler function.
+ *
+ * @example
+ * ```ts
+ * const app = new Hono()
+ *
+ * // add the middleware to your router
+ * app.use(timing());
+ *
+ * app.get('/', async (c) => {
+ *   // add custom metrics
+ *   setMetric(c, 'region', 'europe-west3')
+ *
+ *   // add custom metrics with timing, must be in milliseconds
+ *   setMetric(c, 'custom', 23.8, 'My custom Metric')
+ *
+ *   // start a new timer
+ *   startTime(c, 'db');
+ *
+ *   const data = await db.findMany(...);
+ *
+ *   // end the timer
+ *   endTime(c, 'db');
+ *
+ *   return c.json({ response: data });
+ * });
+ * ```
+ */
+export declare const timing: (config?: TimingOptions) => MiddlewareHandler;
+interface SetMetric {
+    (c: Context, name: string, value: number, description?: string, precision?: number): void;
+    (c: Context, name: string, description?: string): void;
+}
+/**
+ * Set a metric for the timing middleware.
+ *
+ * @param {Context} c - The context of the request.
+ * @param {string} name - The name of the metric.
+ * @param {number | string} [valueDescription] - The value or description of the metric.
+ * @param {string} [description] - The description of the metric.
+ * @param {number} [precision] - The precision of the metric value.
+ *
+ * @example
+ * ```ts
+ * setMetric(c, 'region', 'europe-west3')
+ * setMetric(c, 'custom', 23.8, 'My custom Metric')
+ * ```
+ */
+export declare const setMetric: SetMetric;
+/**
+ * Start a timer for the timing middleware.
+ *
+ * @param {Context} c - The context of the request.
+ * @param {string} name - The name of the timer.
+ * @param {string} [description] - The description of the timer.
+ *
+ * @example
+ * ```ts
+ * startTime(c, 'db')
+ * ```
+ */
+export declare const startTime: (c: Context, name: string, description?: string) => void;
+/**
+ * End a timer for the timing middleware.
+ *
+ * @param {Context} c - The context of the request.
+ * @param {string} name - The name of the timer.
+ * @param {number} [precision] - The precision of the timer value.
+ *
+ * @example
+ * ```ts
+ * endTime(c, 'db')
+ * ```
+ */
+export declare const endTime: (c: Context, name: string, precision?: number) => void;
+export {};

package/dist/types/middleware/trailing-slash/index.d.ts

@@ -1,13 +1,37 @@
+/**
+ * @module
+ * Trailing Slash Middleware for Hono.
+ */
 import type { MiddlewareHandler } from '../../types';
 /**
- * Trim the trailing slash from the URL if it does have one. For example, `/path/to/page/` will be redirected to `/path/to/page`.
- * @access public
- * @example app.use(trimTrailingSlash())
+ * Trailing Slash Middleware for Hono.
+ *
+ * @see {@link https://hono.dev/middleware/builtin/trailing-slash}
+ *
+ * @returns {MiddlewareHandler} The middleware handler function.
+ *
+ * @example
+ * ```ts
+ * const app = new Hono()
+ *
+ * app.use(trimTrailingSlash())
+ * app.get('/about/me/', (c) => c.text('With Trailing Slash'))
+ * ```
  */
 export declare const trimTrailingSlash: () => MiddlewareHandler;
 /**
+ * Append trailing slash middleware for Hono.
  * Append a trailing slash to the URL if it doesn't have one. For example, `/path/to/page` will be redirected to `/path/to/page/`.
- * @access public
- * @example app.use(appendTrailingSlash())
+ *
+ * @see {@link https://hono.dev/middleware/builtin/trailing-slash}
+ *
+ * @returns {MiddlewareHandler} The middleware handler function.
+ *
+ * @example
+ * ```ts
+ * const app = new Hono()
+ *
+ * app.use(appendTrailingSlash())
+ * ```
  */
 export declare const appendTrailingSlash: () => MiddlewareHandler;

package/dist/types/preset/quick.d.ts

@@ -1,3 +1,7 @@
+/**
+ * @module
+ * The preset that uses `LinearRouter`.
+ */
 import { HonoBase } from '../hono-base';
 import type { HonoOptions } from '../hono-base';
 import type { BlankSchema, Env, Schema } from '../types';

package/dist/types/preset/tiny.d.ts

@@ -1,3 +1,7 @@
+/**
+ * @module
+ * The preset that uses `PatternRouter`.
+ */
 import { HonoBase } from '../hono-base';
 import type { HonoOptions } from '../hono-base';
 import type { BlankSchema, Env, Schema } from '../types';

package/dist/types/request.d.ts

@@ -1,7 +1,7 @@
 import type { Result } from './router';
-import type { Input, InputToDataByTarget, ParamKeys, ParamKeyToRecord, RemoveQuestion, ValidationTargets, RouterRoute } from './types';
+import type { Input, InputToDataByTarget, ParamKeyToRecord, ParamKeys, RemoveQuestion, RouterRoute, ValidationTargets } from './types';
 import type { BodyData, ParseBodyOptions } from './utils/body';
-import type { UnionToIntersection } from './utils/types';
+import type { Simplify, UnionToIntersection } from './utils/types';
 type Body = {
     json: any;
     text: string;
@@ -54,7 +54,7 @@ export declare class HonoRequest<P extends string = '/', I extends Input['out']
     param<P2 extends ParamKeys<P> = ParamKeys<P>>(key: P2 extends `${infer _}?` ? never : P2): string;
     param<P2 extends RemoveQuestion<ParamKeys<P>> = RemoveQuestion<ParamKeys<P>>>(key: P2): string | undefined;
     param(key: string): string | undefined;
-    param<P2 extends string = P>(): UnionToIntersection<ParamKeyToRecord<ParamKeys<P2>>>;
+    param<P2 extends string = P>(): Simplify<UnionToIntersection<ParamKeyToRecord<ParamKeys<P2>>>>;
     private getDecodedParam;
     private getAllDecodedParams;
     private getParamValue;
@@ -111,7 +111,8 @@ export declare class HonoRequest<P extends string = '/', I extends Input['out']
      * ```
      * @see https://hono.dev/api/request#parsebody
      */
-    parseBody<T extends BodyData = BodyData>(options?: ParseBodyOptions): Promise<T>;
+    parseBody<Options extends Partial<ParseBodyOptions>, T extends BodyData<Options>>(options?: Options): Promise<T>;
+    parseBody<T extends BodyData>(options?: Partial<ParseBodyOptions>): Promise<T>;
     private cachedBody;
     /**
      * `.json()` can parse Request body of type `application/json`

package/dist/types/router/linear-router/index.d.ts

@@ -1 +1,5 @@
+/**
+ * @module
+ * LinearRouter for Hono.
+ */
 export { LinearRouter } from './router';

package/dist/types/router/linear-router/router.d.ts

@@ -1,4 +1,4 @@
-import type { Router, Result } from '../../router';
+import type { Result, Router } from '../../router';
 export declare class LinearRouter<T> implements Router<T> {
     name: string;
     routes: [string, string, T][];

package/dist/types/router/pattern-router/index.d.ts

@@ -1 +1,5 @@
+/**
+ * @module
+ * PatternRouter for Hono.
+ */
 export { PatternRouter } from './router';

package/dist/types/router/reg-exp-router/index.d.ts

@@ -1 +1,5 @@
+/**
+ * @module
+ * RegExpRouter for Hono.
+ */
 export { RegExpRouter } from './router';

package/dist/types/router/reg-exp-router/router.d.ts

@@ -1,4 +1,4 @@
-import type { Router, Result } from '../../router';
+import type { Result, Router } from '../../router';
 type HandlerWithMetadata<T> = [T, number];
 export declare class RegExpRouter<T> implements Router<T> {
     name: string;

package/dist/types/router/reg-exp-router/trie.d.ts

@@ -1,4 +1,4 @@
-import type { ParamAssocArray, Context } from './node';
+import type { Context, ParamAssocArray } from './node';
 import { Node } from './node';
 export type ReplacementMap = number[];
 export declare class Trie {

package/dist/types/router/smart-router/index.d.ts

@@ -1 +1,5 @@
+/**
+ * @module
+ * SmartRouter for Hono.
+ */
 export { SmartRouter } from './router';

package/dist/types/router/smart-router/router.d.ts

@@ -1,4 +1,4 @@
-import type { Router, Result } from '../../router';
+import type { Result, Router } from '../../router';
 export declare class SmartRouter<T> implements Router<T> {
     name: string;
     routers: Router<T>[];

package/dist/types/router/trie-router/index.d.ts

@@ -1 +1,5 @@
+/**
+ * @module
+ * TrieRouter for Hono.
+ */
 export { TrieRouter } from './router';

package/dist/types/router.d.ts

@@ -1,3 +1,7 @@
+/**
+ * @module
+ * This module provides types definitions and variables for the routers.
+ */
 export declare const METHOD_NAME_ALL: "ALL";
 export declare const METHOD_NAME_ALL_LOWERCASE: "all";
 export declare const METHODS: readonly ["get", "post", "put", "delete", "options", "patch"];

package/dist/types/types.d.ts

@@ -1,3 +1,7 @@
+/**
+ * @module
+ * This module contains some type definitions for the Hono modules.
+ */
 import type { Context } from './context';
 import type { Hono } from './hono';
 import type { StatusCode } from './utils/http-status';

package/dist/types/utils/body.d.ts

@@ -1,5 +1,35 @@
+/**
+ * @module
+ * Body utility.
+ */
 import { HonoRequest } from '../request';
-export type BodyData = Record<string, string | File | (string | File)[]>;
+type BodyDataValueDot = {
+    [x: string]: string | File | BodyDataValueDot;
+} & {};
+type BodyDataValueDotAll = {
+    [x: string]: string | File | (string | File)[] | BodyDataValueDotAll;
+} & {};
+type SimplifyBodyData<T> = {
+    [K in keyof T]: string | File | (string | File)[] | BodyDataValueDotAll extends T[K] ? string | File | (string | File)[] | BodyDataValueDotAll : string | File | BodyDataValueDot extends T[K] ? string | File | BodyDataValueDot : string | File | (string | File)[] extends T[K] ? string | File | (string | File)[] : string | File;
+} & {};
+type BodyDataValueComponent<T> = string | File | (T extends {
+    all: false;
+} ? never : T extends {
+    all: true;
+} | {
+    all: boolean;
+} ? (string | File)[] : never);
+type BodyDataValueObject<T> = {
+    [key: string]: BodyDataValueComponent<T> | BodyDataValueObject<T>;
+};
+type BodyDataValue<T> = BodyDataValueComponent<T> | (T extends {
+    dot: false;
+} ? never : T extends {
+    dot: true;
+} | {
+    dot: boolean;
+} ? BodyDataValueObject<T> : never);
+export type BodyData<T extends Partial<ParseBodyOptions> = {}> = SimplifyBodyData<Record<string, BodyDataValue<T>>>;
 export type ParseBodyOptions = {
     /**
      * Determines whether all fields with multiple values should be parsed as arrays.
@@ -16,6 +46,34 @@ export type ParseBodyOptions = {
      * If all is true:
      * parseBody should return { file: ['aaa', 'bbb'], message: 'hello' }
      */
-    all?: boolean;
+    all: boolean;
+    /**
+     * Determines whether all fields with dot notation should be parsed as nested objects.
+     * @default false
+     * @example
+     * const data = new FormData()
+     * data.append('obj.key1', 'value1')
+     * data.append('obj.key2', 'value2')
+     *
+     * If dot is false:
+     * parseBody should return { 'obj.key1': 'value1', 'obj.key2': 'value2' }
+     *
+     * If dot is true:
+     * parseBody should return { obj: { key1: 'value1', key2: 'value2' } }
+     */
+    dot: boolean;
 };
-export declare const parseBody: <T extends BodyData = BodyData>(request: HonoRequest | Request, options?: ParseBodyOptions) => Promise<T>;
+/**
+ * Parses the body of a request based on the provided options.
+ *
+ * @template T - The type of the parsed body data.
+ * @param {HonoRequest | Request} request - The request object to parse.
+ * @param {Partial<ParseBodyOptions>} [options] - Options for parsing the body.
+ * @returns {Promise<T>} The parsed body data.
+ */
+interface ParseBody {
+    <Options extends Partial<ParseBodyOptions>, T extends BodyData<Options>>(request: HonoRequest | Request, options?: Options): Promise<T>;
+    <T extends BodyData>(request: HonoRequest | Request, options?: Partial<ParseBodyOptions>): Promise<T>;
+}
+export declare const parseBody: ParseBody;
+export {};

package/dist/types/utils/buffer.d.ts

@@ -1,3 +1,7 @@
+/**
+ * @module
+ * Buffer utility.
+ */
 export declare const equal: (a: ArrayBuffer, b: ArrayBuffer) => boolean;
 export declare const timingSafeEqual: (a: string | object | boolean, b: string | object | boolean, hashFunction?: Function) => Promise<boolean>;
 export declare const bufferToString: (buffer: ArrayBuffer) => string;

package/dist/types/utils/color.d.ts

@@ -1 +1,5 @@
+/**
+ * @module
+ * Color utility.
+ */
 export declare function getColorEnabled(): boolean;

package/dist/types/utils/concurrent.d.ts

@@ -1,3 +1,7 @@
+/**
+ * @module
+ * Concurrent utility.
+ */
 export interface Pool {
     run<T>(fn: () => T): Promise<T>;
 }

package/dist/types/utils/cookie.d.ts

@@ -1,3 +1,7 @@
+/**
+ * @module
+ * Cookie utility.
+ */
 export type Cookie = Record<string, string>;
 export type SignedCookie = Record<string, string | false>;
 type PartitionCookieConstraint = {

package/dist/types/utils/crypto.d.ts

@@ -1,3 +1,7 @@
+/**
+ * @module
+ * Crypto utility.
+ */
 type Algorithm = {
     name: string;
     alias: string;

package/dist/types/utils/encode.d.ts

@@ -1,3 +1,7 @@
+/**
+ * @module
+ * Encode utility.
+ */
 export declare const decodeBase64Url: (str: string) => Uint8Array;
 export declare const encodeBase64Url: (buf: ArrayBufferLike) => string;
 export declare const encodeBase64: (buf: ArrayBufferLike) => string;