hono 4.13.8 → 4.13.10

package/dist/middleware/timing/timing.js

@@ -1,104 +1,184 @@
-// src/middleware/timing/timing.ts
-import "../../context.js";
-var getTime = () => {
-  try {
-    return performance.now();
-  } catch {
-  }
-  return Date.now();
+//#region src/middleware/timing/timing.ts
+const getTime = () => {
+	try {
+		return performance.now();
+	} catch {}
+	return Date.now();
 };
-var timing = (config) => {
-  const options = {
-    total: true,
-    enabled: true,
-    totalDescription: "Total Response Time",
-    autoEnd: true,
-    crossOrigin: false,
-    ...config
-  };
-  return async function timing2(c, next) {
-    const headers = [];
-    const timers = /* @__PURE__ */ new Map();
-    if (c.get("metric")) {
-      return await next();
-    }
-    c.set("metric", { headers, timers });
-    if (options.total) {
-      startTime(c, "total", options.totalDescription);
-    }
-    await next();
-    if (options.total) {
-      endTime(c, "total");
-    }
-    if (options.autoEnd) {
-      timers.forEach((_, key) => {
-        endTime(c, key);
-      });
-    }
-    const enabled = typeof options.enabled === "function" ? options.enabled(c) : options.enabled;
-    if (enabled) {
-      c.res.headers.append("Server-Timing", headers.join(","));
-      const crossOrigin = typeof options.crossOrigin === "function" ? options.crossOrigin(c) : options.crossOrigin;
-      if (crossOrigin) {
-        c.res.headers.append(
-          "Timing-Allow-Origin",
-          typeof crossOrigin === "string" ? crossOrigin : "*"
-        );
-      }
-    }
-  };
+/**
+* Server-Timing Middleware for Hono.
+*
+* @see {@link https://hono.dev/docs/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 });
+* });
+* ```
+*/
+const timing = (config) => {
+	const options = {
+		total: true,
+		enabled: true,
+		totalDescription: "Total Response Time",
+		autoEnd: true,
+		crossOrigin: false,
+		...config
+	};
+	return async function timing(c, next) {
+		const headers = [];
+		const timers = /* @__PURE__ */ new Map();
+		if (c.get("metric")) return await next();
+		c.set("metric", {
+			headers,
+			timers
+		});
+		if (options.total) startTime(c, "total", options.totalDescription);
+		await next();
+		if (options.total) endTime(c, "total");
+		if (options.autoEnd) timers.forEach((_, key) => {
+			endTime(c, key);
+		});
+		if (typeof options.enabled === "function" ? options.enabled(c) : options.enabled) {
+			c.res.headers.append("Server-Timing", headers.join(","));
+			const crossOrigin = typeof options.crossOrigin === "function" ? options.crossOrigin(c) : options.crossOrigin;
+			if (crossOrigin) c.res.headers.append("Timing-Allow-Origin", typeof crossOrigin === "string" ? crossOrigin : "*");
+		}
+	};
 };
-var setMetric = (c, name, valueDescription, description, precision) => {
-  const metrics = c.get("metric");
-  if (!metrics) {
-    console.warn("Metrics not initialized! Please add the `timing()` middleware to this route!");
-    return;
-  }
-  if (typeof valueDescription === "number") {
-    const dur = valueDescription.toFixed(precision || 1);
-    const metric = description ? `${name};dur=${dur};desc="${description}"` : `${name};dur=${dur}`;
-    metrics.headers.push(metric);
-  } else {
-    const metric = valueDescription ? `${name};desc="${valueDescription}"` : `${name}`;
-    metrics.headers.push(metric);
-  }
+/**
+* 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')
+* ```
+*/
+const setMetric = (c, name, valueDescription, description, precision) => {
+	const metrics = c.get("metric");
+	if (!metrics) {
+		console.warn("Metrics not initialized! Please add the `timing()` middleware to this route!");
+		return;
+	}
+	if (typeof valueDescription === "number") {
+		const dur = valueDescription.toFixed(precision || 1);
+		const metric = description ? `${name};dur=${dur};desc="${description}"` : `${name};dur=${dur}`;
+		metrics.headers.push(metric);
+	} else {
+		const metric = valueDescription ? `${name};desc="${valueDescription}"` : `${name}`;
+		metrics.headers.push(metric);
+	}
 };
-var startTime = (c, name, description) => {
-  const metrics = c.get("metric");
-  if (!metrics) {
-    console.warn("Metrics not initialized! Please add the `timing()` middleware to this route!");
-    return;
-  }
-  metrics.timers.set(name, { description, start: getTime() });
+/**
+* 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')
+* ```
+*/
+const startTime = (c, name, description) => {
+	const metrics = c.get("metric");
+	if (!metrics) {
+		console.warn("Metrics not initialized! Please add the `timing()` middleware to this route!");
+		return;
+	}
+	metrics.timers.set(name, {
+		description,
+		start: getTime()
+	});
 };
-var endTime = (c, name, precision) => {
-  const metrics = c.get("metric");
-  if (!metrics) {
-    console.warn("Metrics not initialized! Please add the `timing()` middleware to this route!");
-    return;
-  }
-  const timer = metrics.timers.get(name);
-  if (!timer) {
-    console.warn(`Timer "${name}" does not exist!`);
-    return;
-  }
-  const { description, start } = timer;
-  const duration = getTime() - start;
-  setMetric(c, name, duration, description, precision);
-  metrics.timers.delete(name);
+/**
+* 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')
+* ```
+*/
+const endTime = (c, name, precision) => {
+	const metrics = c.get("metric");
+	if (!metrics) {
+		console.warn("Metrics not initialized! Please add the `timing()` middleware to this route!");
+		return;
+	}
+	const timer = metrics.timers.get(name);
+	if (!timer) {
+		console.warn(`Timer "${name}" does not exist!`);
+		return;
+	}
+	const { description, start } = timer;
+	const duration = getTime() - start;
+	setMetric(c, name, duration, description, precision);
+	metrics.timers.delete(name);
 };
+/**
+* Wrap a Promise to capture its duration.
+* @param {Context} c - The context of the request.
+* @param {string} name - The name of the timer.
+* @param {Promise<T>} callable - The Promise to time.
+* @param {string} [description] - The description of the timer.
+* @param {number} [precision] - The precision of the timer value.
+*
+* @example
+* ```ts
+*   // Instead of this:
+*   const data = await db.findMany(...);
+*
+*   // do this:
+*   const data = await wrapTime(c, 'query', db.findMany(...));
+* ```
+* */
 async function wrapTime(c, name, callable, description, precision) {
-  startTime(c, name, description);
-  try {
-    return await callable;
-  } finally {
-    endTime(c, name, precision);
-  }
+	startTime(c, name, description);
+	try {
+		return await callable;
+	} finally {
+		endTime(c, name, precision);
+	}
 }
-export {
-  endTime,
-  setMetric,
-  startTime,
-  timing,
-  wrapTime
-};
+//#endregion
+export { endTime, setMetric, startTime, timing, wrapTime };

package/dist/middleware/trailing-slash/index.js

@@ -1,39 +1,87 @@
-// src/middleware/trailing-slash/index.ts
-var trimTrailingSlash = (options) => {
-  return async function trimTrailingSlash2(c, next) {
-    if (options?.alwaysRedirect) {
-      if ((c.req.method === "GET" || c.req.method === "HEAD") && c.req.path !== "/" && c.req.path.at(-1) === "/") {
-        const url = new URL(c.req.url);
-        url.pathname = url.pathname.substring(0, url.pathname.length - 1);
-        return c.redirect(url.toString(), 301);
-      }
-    }
-    await next();
-    if (!options?.alwaysRedirect && c.res.status === 404 && (c.req.method === "GET" || c.req.method === "HEAD") && c.req.path !== "/" && c.req.path.at(-1) === "/") {
-      const url = new URL(c.req.url);
-      url.pathname = url.pathname.substring(0, url.pathname.length - 1);
-      c.res = c.redirect(url.toString(), 301);
-    }
-  };
+//#region src/middleware/trailing-slash/index.ts
+/**
+* Trailing Slash Middleware for Hono.
+*
+* @see {@link https://hono.dev/docs/middleware/builtin/trailing-slash}
+*
+* @param {TrimTrailingSlashOptions} options - The options for the middleware.
+* @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'))
+* ```
+*
+* @example
+* ```ts
+* // With alwaysRedirect option for wildcard routes
+* const app = new Hono()
+*
+* app.use(trimTrailingSlash({ alwaysRedirect: true }))
+* app.get('/my-path/*', (c) => c.text('Wildcard route'))
+* ```
+*/
+const trimTrailingSlash = (options) => {
+	return async function trimTrailingSlash(c, next) {
+		if (options?.alwaysRedirect) {
+			if ((c.req.method === "GET" || c.req.method === "HEAD") && c.req.path !== "/" && c.req.path.at(-1) === "/") {
+				const url = new URL(c.req.url);
+				url.pathname = url.pathname.substring(0, url.pathname.length - 1);
+				return c.redirect(url.toString(), 301);
+			}
+		}
+		await next();
+		if (!options?.alwaysRedirect && c.res.status === 404 && (c.req.method === "GET" || c.req.method === "HEAD") && c.req.path !== "/" && c.req.path.at(-1) === "/") {
+			const url = new URL(c.req.url);
+			url.pathname = url.pathname.substring(0, url.pathname.length - 1);
+			c.res = c.redirect(url.toString(), 301);
+		}
+	};
 };
-var appendTrailingSlash = (options) => {
-  return async function appendTrailingSlash2(c, next) {
-    if (options?.alwaysRedirect) {
-      if ((c.req.method === "GET" || c.req.method === "HEAD") && c.req.path.at(-1) !== "/" && !options.skip?.(c.req.path)) {
-        const url = new URL(c.req.url);
-        url.pathname += "/";
-        return c.redirect(url.toString(), 301);
-      }
-    }
-    await next();
-    if (!options?.alwaysRedirect && c.res.status === 404 && (c.req.method === "GET" || c.req.method === "HEAD") && c.req.path.at(-1) !== "/" && !options?.skip?.(c.req.path)) {
-      const url = new URL(c.req.url);
-      url.pathname += "/";
-      c.res = c.redirect(url.toString(), 301);
-    }
-  };
-};
-export {
-  appendTrailingSlash,
-  trimTrailingSlash
+/**
+* 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/`.
+*
+* @see {@link https://hono.dev/docs/middleware/builtin/trailing-slash}
+*
+* @param {AppendTrailingSlashOptions} options - The options for the middleware.
+* @returns {MiddlewareHandler} The middleware handler function.
+*
+* @example
+* ```ts
+* const app = new Hono()
+*
+* app.use(appendTrailingSlash())
+* ```
+*
+* @example
+* ```ts
+* // With alwaysRedirect option for wildcard routes
+* const app = new Hono()
+*
+* app.use(appendTrailingSlash({ alwaysRedirect: true }))
+* app.get('/my-path/*', (c) => c.text('Wildcard route'))
+* ```
+*/
+const appendTrailingSlash = (options) => {
+	return async function appendTrailingSlash(c, next) {
+		if (options?.alwaysRedirect) {
+			if ((c.req.method === "GET" || c.req.method === "HEAD") && c.req.path.at(-1) !== "/" && !options.skip?.(c.req.path)) {
+				const url = new URL(c.req.url);
+				url.pathname += "/";
+				return c.redirect(url.toString(), 301);
+			}
+		}
+		await next();
+		if (!options?.alwaysRedirect && c.res.status === 404 && (c.req.method === "GET" || c.req.method === "HEAD") && c.req.path.at(-1) !== "/" && !options?.skip?.(c.req.path)) {
+			const url = new URL(c.req.url);
+			url.pathname += "/";
+			c.res = c.redirect(url.toString(), 301);
+		}
+	};
 };
+//#endregion
+export { appendTrailingSlash, trimTrailingSlash };

package/dist/preset/quick.js

@@ -1,16 +1,18 @@
-// src/preset/quick.ts
-import { HonoBase } from "../hono-base.js";
-import { LinearRouter } from "../router/linear-router/index.js";
-import { SmartRouter } from "../router/smart-router/index.js";
-import { TrieRouter } from "../router/trie-router/index.js";
-var Hono = class extends HonoBase {
-  constructor(options = {}) {
-    super(options);
-    this.router = new SmartRouter({
-      routers: [new LinearRouter(), new TrieRouter()]
-    });
-  }
-};
-export {
-  Hono
+import { HonoBase as Hono$1 } from "../hono-base.js";
+import { SmartRouter } from "../router/smart-router/router.js";
+import { TrieRouter } from "../router/trie-router/router.js";
+import "../router/trie-router/index.js";
+import { LinearRouter } from "../router/linear-router/router.js";
+//#region src/preset/quick.ts
+/**
+* @module
+* The preset that uses `LinearRouter`.
+*/
+var Hono = class extends Hono$1 {
+	constructor(options = {}) {
+		super(options);
+		this.router = new SmartRouter({ routers: [new LinearRouter(), new TrieRouter()] });
+	}
 };
+//#endregion
+export { Hono };

package/dist/preset/tiny.js

@@ -1,12 +1,15 @@
-// src/preset/tiny.ts
-import { HonoBase } from "../hono-base.js";
-import { PatternRouter } from "../router/pattern-router/index.js";
-var Hono = class extends HonoBase {
-  constructor(options = {}) {
-    super(options);
-    this.router = new PatternRouter();
-  }
-};
-export {
-  Hono
+import { HonoBase as Hono$1 } from "../hono-base.js";
+import { PatternRouter } from "../router/pattern-router/router.js";
+//#region src/preset/tiny.ts
+/**
+* @module
+* The preset that uses `PatternRouter`.
+*/
+var Hono = class extends Hono$1 {
+	constructor(options = {}) {
+		super(options);
+		this.router = new PatternRouter();
+	}
 };
+//#endregion
+export { Hono };

package/dist/request/constants.js

@@ -1,5 +1,4 @@
-// src/request/constants.ts
-var GET_MATCH_RESULT = /* @__PURE__ */ Symbol();
-export {
-  GET_MATCH_RESULT
-};
+//#region src/request/constants.ts
+const GET_MATCH_RESULT = Symbol();
+//#endregion
+export { GET_MATCH_RESULT };