hono 4.13.9 → 4.13.11

package/dist/middleware/logger/index.js

@@ -1,44 +1,50 @@
-// src/middleware/logger/index.ts
 import { getColorEnabledAsync } from "../../utils/color.js";
-var humanize = (times) => {
-  const [delimiter, separator] = [",", "."];
-  const orderTimes = times.map((v) => v.replace(/(\d)(?=(\d\d\d)+(?!\d))/g, "$1" + delimiter));
-  return orderTimes.join(separator);
+//#region src/middleware/logger/index.ts
+const humanize = (times) => {
+	const [delimiter, separator] = [",", "."];
+	return times.map((v) => v.replace(/(\d)(?=(\d\d\d)+(?!\d))/g, "$1" + delimiter)).join(separator);
 };
-var time = (start) => {
-  const delta = Date.now() - start;
-  return humanize([delta < 1e3 ? delta + "ms" : Math.round(delta / 1e3) + "s"]);
+const time = (start) => {
+	const delta = Date.now() - start;
+	return humanize([delta < 1e3 ? delta + "ms" : Math.round(delta / 1e3) + "s"]);
 };
-var colorStatus = async (status) => {
-  const colorEnabled = await getColorEnabledAsync();
-  if (colorEnabled) {
-    switch (status / 100 | 0) {
-      case 5:
-        return `\x1B[31m${status}\x1B[0m`;
-      case 4:
-        return `\x1B[33m${status}\x1B[0m`;
-      case 3:
-        return `\x1B[36m${status}\x1B[0m`;
-      case 2:
-        return `\x1B[32m${status}\x1B[0m`;
-    }
-  }
-  return `${status}`;
+const colorStatus = async (status) => {
+	if (await getColorEnabledAsync()) switch (status / 100 | 0) {
+		case 5: return `\x1b[31m${status}\x1b[0m`;
+		case 4: return `\x1b[33m${status}\x1b[0m`;
+		case 3: return `\x1b[36m${status}\x1b[0m`;
+		case 2: return `\x1b[32m${status}\x1b[0m`;
+	}
+	return `${status}`;
 };
 async function log(fn, prefix, method, path, status = 0, elapsed) {
-  const out = prefix === "<--" /* Incoming */ ? `${prefix} ${method} ${path}` : `${prefix} ${method} ${path} ${await colorStatus(status)} ${elapsed}`;
-  fn(out);
+	fn(prefix === "<--" ? `${prefix} ${method} ${path}` : `${prefix} ${method} ${path} ${await colorStatus(status)} ${elapsed}`);
 }
-var logger = (fn = console.log) => {
-  return async function logger2(c, next) {
-    const { method, url } = c.req;
-    const path = url.slice(url.indexOf("/", 8));
-    await log(fn, "<--" /* Incoming */, method, path);
-    const start = Date.now();
-    await next();
-    await log(fn, "-->" /* Outgoing */, method, path, c.res.status, time(start));
-  };
-};
-export {
-  logger
+/**
+* Logger Middleware for Hono.
+*
+* @see {@link https://hono.dev/docs/middleware/builtin/logger}
+*
+* @param {PrintFunc} [fn=console.log] - Optional function for customized logging behavior.
+* @returns {MiddlewareHandler} The middleware handler function.
+*
+* @example
+* ```ts
+* const app = new Hono()
+*
+* app.use(logger())
+* app.get('/', (c) => c.text('Hello Hono!'))
+* ```
+*/
+const logger = (fn = console.log) => {
+	return async function logger(c, next) {
+		const { method, url } = c.req;
+		const path = url.slice(url.indexOf("/", 8));
+		await log(fn, "<--", method, path);
+		const start = Date.now();
+		await next();
+		await log(fn, "-->", method, path, c.res.status, time(start));
+	};
 };
+//#endregion
+export { logger };

package/dist/middleware/method-not-allowed/index.js

@@ -1,68 +1,83 @@
-// src/middleware/method-not-allowed/index.ts
+import "../../router.js";
+import { TrieRouter } from "../../router/trie-router/router.js";
+import "../../router/trie-router/index.js";
 import { basePath, matchedRoutes } from "../../helper/route/index.js";
-import { METHOD_NAME_ALL } from "../../router.js";
-import { TrieRouter } from "../../router/trie-router/index.js";
-var methodNotAllowed = (options) => {
-  let methodRouter;
-  return async function methodNotAllowed2(c, next) {
-    const routeIndex = c.req.routeIndex;
-    await next();
-    if (c.res.status !== 404) {
-      return;
-    }
-    if (c.error) {
-      return;
-    }
-    if (!methodRouter) {
-      const methodsByPath = /* @__PURE__ */ new Map();
-      for (const route of options.app.routes) {
-        if (route.method === METHOD_NAME_ALL || route.method === "HEAD") {
-          continue;
-        }
-        const methods2 = methodsByPath.get(route.path) ?? /* @__PURE__ */ new Set();
-        methods2.add(route.method);
-        if (route.method === "GET") {
-          methods2.add("HEAD");
-        }
-        methodsByPath.set(route.path, methods2);
-      }
-      methodRouter = new TrieRouter();
-      for (const [path, methods2] of methodsByPath) {
-        methodRouter.add(METHOD_NAME_ALL, path, [...methods2]);
-      }
-    }
-    let requestPath = c.req.path;
-    const routes = matchedRoutes(c);
-    const currentRoute = routes[routeIndex];
-    const sourceRoute = options.app.routes.find((route) => route.handler === methodNotAllowed2);
-    if (currentRoute && sourceRoute) {
-      const currentBasePathParts = basePath(c, routeIndex).split("/").filter(Boolean);
-      const sourceBasePathLength = sourceRoute.basePath.split("/").filter(Boolean).length;
-      const mountBasePathParts = currentBasePathParts.slice(
-        0,
-        currentBasePathParts.length - sourceBasePathLength
-      );
-      if (mountBasePathParts.length > 0) {
-        const mountBasePath = `/${mountBasePathParts.join("/")}`;
-        requestPath = c.req.path.slice(mountBasePath.length) || "/";
-      }
-    }
-    const allowedMethods = /* @__PURE__ */ new Set();
-    for (const [methods2] of methodRouter.match(METHOD_NAME_ALL, requestPath)[0]) {
-      for (const method of methods2) {
-        allowedMethods.add(method);
-      }
-    }
-    if (allowedMethods.size === 0 || allowedMethods.has(c.req.method)) {
-      return;
-    }
-    c.res.headers.delete("Allow");
-    c.res.headers.delete("Content-Length");
-    const methods = [...allowedMethods];
-    const allow = methods.join(", ");
-    c.res = options.onMethodNotAllowed ? await options.onMethodNotAllowed(c, methods) : c.text("Method Not Allowed", 405, { Allow: allow });
-  };
-};
-export {
-  methodNotAllowed
+//#region src/middleware/method-not-allowed/index.ts
+/**
+* Method Not Allowed Middleware for Hono.
+*
+* Returns a `405 Method Not Allowed` response with an `Allow` header when the request path
+* matches a registered route but the request method is not supported.
+*
+* @param {MethodNotAllowedOptions} options - The options for the middleware.
+* @param {Hono} options.app - The Hono instance used by the application.
+* @param {MethodNotAllowedHandler} [options.onMethodNotAllowed] - Generates the response, including its `Allow` header.
+* @returns {MiddlewareHandler} The middleware handler function.
+*
+* @example
+* ```ts
+* const app = new Hono()
+*
+* app.use(methodNotAllowed({ app }))
+*
+* app.get('/hello', (c) => c.text('Hello!'))
+* app.post('/hello', (c) => c.text('Posted!'))
+*
+* // PUT /hello -> 405 Method Not Allowed
+* // Allow: GET, HEAD, POST
+* ```
+*
+* @example
+* ```ts
+* app.use(
+*   methodNotAllowed({
+*     app,
+*     onMethodNotAllowed: (c, methods) =>
+*       c.json({ error: 'Method Not Allowed' }, 405, { Allow: methods.join(', ') }),
+*   })
+* )
+* ```
+*/
+const methodNotAllowed = (options) => {
+	let methodRouter;
+	return async function methodNotAllowed(c, next) {
+		const routeIndex = c.req.routeIndex;
+		await next();
+		if (c.res.status !== 404) return;
+		if (c.error) return;
+		if (!methodRouter) {
+			const methodsByPath = /* @__PURE__ */ new Map();
+			for (const route of options.app.routes) {
+				if (route.method === "ALL" || route.method === "HEAD") continue;
+				const methods = methodsByPath.get(route.path) ?? /* @__PURE__ */ new Set();
+				methods.add(route.method);
+				if (route.method === "GET") methods.add("HEAD");
+				methodsByPath.set(route.path, methods);
+			}
+			methodRouter = new TrieRouter();
+			for (const [path, methods] of methodsByPath) methodRouter.add("ALL", path, [...methods]);
+		}
+		let requestPath = c.req.path;
+		const currentRoute = matchedRoutes(c)[routeIndex];
+		const sourceRoute = options.app.routes.find((route) => route.handler === methodNotAllowed);
+		if (currentRoute && sourceRoute) {
+			const currentBasePathParts = basePath(c, routeIndex).split("/").filter(Boolean);
+			const sourceBasePathLength = sourceRoute.basePath.split("/").filter(Boolean).length;
+			const mountBasePathParts = currentBasePathParts.slice(0, currentBasePathParts.length - sourceBasePathLength);
+			if (mountBasePathParts.length > 0) {
+				const mountBasePath = `/${mountBasePathParts.join("/")}`;
+				requestPath = c.req.path.slice(mountBasePath.length) || "/";
+			}
+		}
+		const allowedMethods = /* @__PURE__ */ new Set();
+		for (const [methods] of methodRouter.match("ALL", requestPath)[0]) for (const method of methods) allowedMethods.add(method);
+		if (allowedMethods.size === 0 || allowedMethods.has(c.req.method)) return;
+		c.res.headers.delete("Allow");
+		c.res.headers.delete("Content-Length");
+		const methods = [...allowedMethods];
+		const allow = methods.join(", ");
+		c.res = options.onMethodNotAllowed ? await options.onMethodNotAllowed(c, methods) : c.text("Method Not Allowed", 405, { Allow: allow });
+	};
 };
+//#endregion
+export { methodNotAllowed };

package/dist/middleware/method-override/index.js

@@ -1,84 +1,104 @@
-// src/middleware/method-override/index.ts
 import { parseBody } from "../../utils/body.js";
-var DEFAULT_METHOD_FORM_NAME = "_method";
-var methodOverride = (options) => async function methodOverride2(c, next) {
-  if (c.req.method === "GET") {
-    return await next();
-  }
-  const app = options.app;
-  if (!(options.header || options.query)) {
-    const contentType = c.req.header("content-type");
-    const methodFormName = options.form || DEFAULT_METHOD_FORM_NAME;
-    const clonedRequest = c.req.raw.clone();
-    const newRequest = clonedRequest.clone();
-    if (contentType?.startsWith("multipart/form-data")) {
-      const form = await clonedRequest.formData();
-      const method = form.get(methodFormName);
-      if (method) {
-        const newForm = await newRequest.formData();
-        newForm.delete(methodFormName);
-        const newHeaders = new Headers(clonedRequest.headers);
-        newHeaders.delete("content-type");
-        newHeaders.delete("content-length");
-        const request = new Request(c.req.url, {
-          body: newForm,
-          headers: newHeaders,
-          method
-        });
-        return app.fetch(request, c.env, getExecutionCtx(c));
-      }
-    }
-    if (contentType?.startsWith("application/x-www-form-urlencoded")) {
-      const params = await parseBody(clonedRequest);
-      const method = params[methodFormName];
-      if (method) {
-        delete params[methodFormName];
-        const newParams = new URLSearchParams(params);
-        const request = new Request(newRequest, {
-          body: newParams,
-          method
-        });
-        return app.fetch(request, c.env, getExecutionCtx(c));
-      }
-    }
-  } else if (options.header) {
-    const headerName = options.header;
-    const method = c.req.header(headerName);
-    if (method) {
-      const newHeaders = new Headers(c.req.raw.headers);
-      newHeaders.delete(headerName);
-      const request = new Request(c.req.raw, {
-        headers: newHeaders,
-        method
-      });
-      return app.fetch(request, c.env, getExecutionCtx(c));
-    }
-  } else if (options.query) {
-    const queryName = options.query;
-    const method = c.req.query(queryName);
-    if (method) {
-      const url = new URL(c.req.url);
-      url.searchParams.delete(queryName);
-      const requestInit = {
-        body: c.req.raw.body,
-        headers: c.req.raw.headers,
-        method,
-        duplex: c.req.raw.body ? "half" : void 0
-      };
-      const request = new Request(url.toString(), requestInit);
-      return app.fetch(request, c.env, getExecutionCtx(c));
-    }
-  }
-  await next();
+//#region src/middleware/method-override/index.ts
+const DEFAULT_METHOD_FORM_NAME = "_method";
+/**
+* Method Override Middleware for Hono.
+*
+* @see {@link https://hono.dev/docs/middleware/builtin/method-override}
+*
+* @param {MethodOverrideOptions} options - The options for the method override middleware.
+* @param {Hono} options.app - The instance of Hono is used in your application.
+* @param {string} [options.form=_method] - Form key with a value containing the method name.
+* @param {string} [options.header] - Header name with a value containing the method name.
+* @param {string} [options.query] - Query parameter key with a value containing the method name.
+* @returns {MiddlewareHandler} The middleware handler function.
+*
+* @example
+* ```ts
+* const app = new Hono()
+*
+* // If no options are specified, the value of `_method` in the form,
+* // e.g. DELETE, is used as the method.
+* app.use('/posts', methodOverride({ app }))
+*
+* app.delete('/posts', (c) => {
+*   // ....
+* })
+* ```
+*/
+const methodOverride = (options) => async function methodOverride(c, next) {
+	if (c.req.method === "GET") return await next();
+	const app = options.app;
+	if (!(options.header || options.query)) {
+		const contentType = c.req.header("content-type");
+		const methodFormName = options.form || DEFAULT_METHOD_FORM_NAME;
+		const clonedRequest = c.req.raw.clone();
+		const newRequest = clonedRequest.clone();
+		if (contentType?.startsWith("multipart/form-data")) {
+			const method = (await clonedRequest.formData()).get(methodFormName);
+			if (method) {
+				const newForm = await newRequest.formData();
+				newForm.delete(methodFormName);
+				const newHeaders = new Headers(clonedRequest.headers);
+				newHeaders.delete("content-type");
+				newHeaders.delete("content-length");
+				const request = new Request(c.req.url, {
+					body: newForm,
+					headers: newHeaders,
+					method
+				});
+				return app.fetch(request, c.env, getExecutionCtx(c));
+			}
+		}
+		if (contentType?.startsWith("application/x-www-form-urlencoded")) {
+			const params = await parseBody(clonedRequest);
+			const method = params[methodFormName];
+			if (method) {
+				delete params[methodFormName];
+				const newParams = new URLSearchParams(params);
+				const request = new Request(newRequest, {
+					body: newParams,
+					method
+				});
+				return app.fetch(request, c.env, getExecutionCtx(c));
+			}
+		}
+	} else if (options.header) {
+		const headerName = options.header;
+		const method = c.req.header(headerName);
+		if (method) {
+			const newHeaders = new Headers(c.req.raw.headers);
+			newHeaders.delete(headerName);
+			const request = new Request(c.req.raw, {
+				headers: newHeaders,
+				method
+			});
+			return app.fetch(request, c.env, getExecutionCtx(c));
+		}
+	} else if (options.query) {
+		const queryName = options.query;
+		const method = c.req.query(queryName);
+		if (method) {
+			const url = new URL(c.req.url);
+			url.searchParams.delete(queryName);
+			const requestInit = {
+				body: c.req.raw.body,
+				headers: c.req.raw.headers,
+				method,
+				duplex: c.req.raw.body ? "half" : void 0
+			};
+			const request = new Request(url.toString(), requestInit);
+			return app.fetch(request, c.env, getExecutionCtx(c));
+		}
+	}
+	await next();
 };
-var getExecutionCtx = (c) => {
-  let executionCtx;
-  try {
-    executionCtx = c.executionCtx;
-  } catch {
-  }
-  return executionCtx;
-};
-export {
-  methodOverride
+const getExecutionCtx = (c) => {
+	let executionCtx;
+	try {
+		executionCtx = c.executionCtx;
+	} catch {}
+	return executionCtx;
 };
+//#endregion
+export { methodOverride };

package/dist/middleware/powered-by/index.js

@@ -1,10 +1,24 @@
-// src/middleware/powered-by/index.ts
-var poweredBy = (options) => {
-  return async function poweredBy2(c, next) {
-    await next();
-    c.res.headers.set("X-Powered-By", options?.serverName ?? "Hono");
-  };
-};
-export {
-  poweredBy
+//#region src/middleware/powered-by/index.ts
+/**
+* Powered By Middleware for Hono.
+*
+* @param options - The options for the Powered By Middleware.
+* @returns {MiddlewareHandler} The middleware handler function.
+*
+* @example
+* ```ts
+* import { poweredBy } from 'hono/powered-by'
+*
+* const app = new Hono()
+*
+* app.use(poweredBy()) // With options: poweredBy({ serverName: "My Server" })
+* ```
+*/
+const poweredBy = (options) => {
+	return async function poweredBy(c, next) {
+		await next();
+		c.res.headers.set("X-Powered-By", options?.serverName ?? "Hono");
+	};
 };
+//#endregion
+export { poweredBy };

package/dist/middleware/pretty-json/index.js

@@ -1,23 +1,40 @@
-// src/middleware/pretty-json/index.ts
-var jsonContentTypeRegex = /^application\/(?:[a-z0-9._-]+\+)?json(?=$|[;\s])/i;
-var prettyJSON = (options) => {
-  const targetQuery = options?.query ?? "pretty";
-  return async function prettyJSON2(c, next) {
-    const pretty = options?.force || c.req.query(targetQuery) || c.req.query(targetQuery) === "";
-    await next();
-    const contentType = c.res.headers.get("Content-Type");
-    if (pretty && contentType && jsonContentTypeRegex.test(contentType)) {
-      let obj;
-      try {
-        obj = await c.res.clone().json();
-      } catch {
-        return;
-      }
-      c.res = new Response(JSON.stringify(obj, null, options?.space ?? 2), c.res);
-      c.res.headers.delete("Content-Length");
-    }
-  };
-};
-export {
-  prettyJSON
+//#region src/middleware/pretty-json/index.ts
+const jsonContentTypeRegex = /^application\/(?:[a-z0-9._-]+\+)?json(?=$|[;\s])/i;
+/**
+* Pretty JSON Middleware for Hono.
+*
+* @see {@link https://hono.dev/docs/middleware/builtin/pretty-json}
+*
+* @param options - The options for the pretty JSON middleware.
+* @returns {MiddlewareHandler} The middleware handler function.
+*
+* @example
+* ```ts
+* const app = new Hono()
+*
+* app.use(prettyJSON()) // With options: prettyJSON({ space: 4 })
+* app.get('/', (c) => {
+*   return c.json({ message: 'Hono!' })
+* })
+* ```
+*/
+const prettyJSON = (options) => {
+	const targetQuery = options?.query ?? "pretty";
+	return async function prettyJSON(c, next) {
+		const pretty = options?.force || c.req.query(targetQuery) || c.req.query(targetQuery) === "";
+		await next();
+		const contentType = c.res.headers.get("Content-Type");
+		if (pretty && contentType && jsonContentTypeRegex.test(contentType)) {
+			let obj;
+			try {
+				obj = await c.res.clone().json();
+			} catch {
+				return;
+			}
+			c.res = new Response(JSON.stringify(obj, null, options?.space ?? 2), c.res);
+			c.res.headers.delete("Content-Length");
+		}
+	};
 };
+//#endregion
+export { prettyJSON };

package/dist/middleware/request-id/index.js

@@ -1,5 +1,2 @@
-// src/middleware/request-id/index.ts
 import { requestId } from "./request-id.js";
-export {
-  requestId
-};
+export { requestId };

package/dist/middleware/request-id/request-id.js

@@ -1,21 +1,34 @@
-// src/middleware/request-id/request-id.ts
-var requestId = ({
-  limitLength = 255,
-  headerName = "X-Request-Id",
-  generator = () => crypto.randomUUID()
-} = {}) => {
-  return async function requestId2(c, next) {
-    let reqId = headerName ? c.req.header(headerName) : void 0;
-    if (!reqId || reqId.length > limitLength || /[^\w\-=]/.test(reqId)) {
-      reqId = generator(c);
-    }
-    c.set("requestId", reqId);
-    if (headerName) {
-      c.header(headerName, reqId);
-    }
-    await next();
-  };
-};
-export {
-  requestId
+//#region src/middleware/request-id/request-id.ts
+/**
+* Request ID Middleware for Hono.
+*
+* @param {object} options - Options for Request ID middleware.
+* @param {number} [options.limitLength=255] - The maximum length of request id.
+* @param {string} [options.headerName=X-Request-Id] - The header name used in request id.
+* @param {generator} [options.generator=() => crypto.randomUUID()] - The request id generation function.
+*
+* @returns {MiddlewareHandler} The middleware handler function.
+*
+* @example
+* ```ts
+* type Variables = RequestIdVariables
+* const app = new Hono<{Variables: Variables}>()
+*
+* app.use(requestId())
+* app.get('/', (c) => {
+*   console.log(c.get('requestId')) // Debug
+*   return c.text('Hello World!')
+* })
+* ```
+*/
+const requestId = ({ limitLength = 255, headerName = "X-Request-Id", generator = () => crypto.randomUUID() } = {}) => {
+	return async function requestId(c, next) {
+		let reqId = headerName ? c.req.header(headerName) : void 0;
+		if (!reqId || reqId.length > limitLength || /[^\w\-=]/.test(reqId)) reqId = generator(c);
+		c.set("requestId", reqId);
+		if (headerName) c.header(headerName, reqId);
+		await next();
+	};
 };
+//#endregion
+export { requestId };

package/dist/middleware/secure-headers/index.js

@@ -1,6 +1,2 @@
-// src/middleware/secure-headers/index.ts
 import { NONCE, secureHeaders } from "./secure-headers.js";
-export {
-  NONCE,
-  secureHeaders
-};
+export { NONCE, secureHeaders };

package/dist/middleware/secure-headers/permissions-policy.js

@@ -0,0 +1 @@
+export {};