hono 4.13.13 → 5.0.0-rc.1

package/dist/context.js

@@ -1,3 +1,4 @@
+import { GET_RESPONSE } from "./context/constants.js";
 import { HonoRequest } from "./request.js";
 import { HtmlEscapedCallbackPhase, resolveCallback } from "./utils/html.js";
 //#region src/context.ts
@@ -12,37 +13,9 @@ const createResponseInstance = (body, init) => new Response(body, init);
 var Context = class {
 	#rawRequest;
 	#req;
-	/**
-	* `.env` can get bindings (environment variables, secrets, KV namespaces, D1 database, R2 bucket etc.) in Cloudflare Workers.
-	*
-	* @see {@link https://hono.dev/docs/api/context#env}
-	*
-	* @example
-	* ```ts
-	* // Environment object for Cloudflare Workers
-	* app.get('*', async c => {
-	*   const counter = c.env.COUNTER
-	* })
-	* ```
-	*/
 	env = {};
 	#var;
 	finalized = false;
-	/**
-	* `.error` can get the error object from the middleware if the Handler throws an error.
-	*
-	* @see {@link https://hono.dev/docs/api/context#error}
-	*
-	* @example
-	* ```ts
-	* app.use('*', async (c, next) => {
-	*   await next()
-	*   if (c.error) {
-	*     // do something...
-	*   }
-	* })
-	* ```
-	*/
 	error;
 	#status;
 	#executionCtx;
@@ -53,12 +26,6 @@ var Context = class {
 	#preparedHeaders;
 	#matchResult;
 	#path;
-	/**
-	* Creates an instance of the Context class.
-	*
-	* @param req - The Request object.
-	* @param options - Optional configuration options for the context.
-	*/
 	constructor(req, options) {
 		this.#rawRequest = req;
 		if (options) {
@@ -69,45 +36,21 @@ var Context = class {
 			this.#matchResult = options.matchResult;
 		}
 	}
-	/**
-	* `.req` is the instance of {@link HonoRequest}.
-	*/
 	get req() {
 		this.#req ??= new HonoRequest(this.#rawRequest, this.#path, this.#matchResult);
 		return this.#req;
 	}
-	/**
-	* @see {@link https://hono.dev/docs/api/context#event}
-	* The FetchEvent associated with the current request.
-	*
-	* @throws Will throw an error if the context does not have a FetchEvent.
-	*/
 	get event() {
 		if (this.#executionCtx && "respondWith" in this.#executionCtx) return this.#executionCtx;
 		else throw Error("This context has no FetchEvent");
 	}
-	/**
-	* @see {@link https://hono.dev/docs/api/context#executionctx}
-	* The ExecutionContext associated with the current request.
-	*
-	* @throws Will throw an error if the context does not have an ExecutionContext.
-	*/
 	get executionCtx() {
 		if (this.#executionCtx) return this.#executionCtx;
 		else throw Error("This context has no ExecutionContext");
 	}
-	/**
-	* @see {@link https://hono.dev/docs/api/context#res}
-	* The Response object for the current request.
-	*/
 	get res() {
 		return this.#res ||= createResponseInstance(null, { headers: this.#preparedHeaders ??= new Headers() });
 	}
-	/**
-	* Sets the Response object for the current request.
-	*
-	* @param _res - The Response object to set.
-	*/
 	set res(_res) {
 		if (this.#res && _res) {
 			_res = createResponseInstance(_res.body, _res);
@@ -123,132 +66,51 @@ var Context = class {
 		this.#res = _res;
 		this.finalized = true;
 	}
-	/**
-	* `.render()` can create a response within a layout.
-	*
-	* @see {@link https://hono.dev/docs/api/context#render-setrenderer}
-	*
-	* @example
-	* ```ts
-	* app.get('/', (c) => {
-	*   return c.render('Hello!')
-	* })
-	* ```
-	*/
-	render = (...args) => {
-		this.#renderer ??= (content) => this.html(content);
-		return this.#renderer(...args);
-	};
-	/**
-	* Sets the layout for the response.
-	*
-	* @param layout - The layout to set.
-	* @returns The layout function.
-	*/
-	setLayout = (layout) => this.#layout = layout;
-	/**
-	* Gets the current layout for the response.
-	*
-	* @returns The current layout function.
-	*/
-	getLayout = () => this.#layout;
-	/**
-	* `.setRenderer()` can set the layout in the custom middleware.
-	*
-	* @see {@link https://hono.dev/docs/api/context#render-setrenderer}
-	*
-	* @example
-	* ```tsx
-	* app.use('*', async (c, next) => {
-	*   c.setRenderer((content) => {
-	*     return c.html(
-	*       <html>
-	*         <body>
-	*           <p>{content}</p>
-	*         </body>
-	*       </html>
-	*     )
-	*   })
-	*   await next()
-	* })
-	* ```
-	*/
-	setRenderer = (renderer) => {
-		this.#renderer = renderer;
-	};
-	/**
-	* `.header()` can set headers.
-	*
-	* @see {@link https://hono.dev/docs/api/context#header}
-	*
-	* @example
-	* ```ts
-	* app.get('/welcome', (c) => {
-	*   // Set headers
-	*   c.header('X-Message', 'Hello!')
-	*   c.header('Content-Type', 'text/plain')
-	*
-	*   // Append multiple headers using the append option (e.g. Vary)
-	*   c.header('Vary', 'Accept-Encoding', { append: true })
-	*   c.header('Vary', 'User-Agent', { append: true })
-	*
-	*   return c.body('Thank you for coming')
-	* })
-	* ```
-	*/
-	header = (name, value, options) => {
-		if (this.finalized) this.#res = createResponseInstance(this.#res.body, this.#res);
-		const headers = this.#res ? this.#res.headers : this.#preparedHeaders ??= new Headers();
-		if (value === void 0) headers.delete(name);
-		else if (options?.append) headers.append(name, value);
-		else headers.set(name, value);
-	};
-	status = (status) => {
-		this.#status = status;
-	};
-	/**
-	* `.set()` can set the value specified by the key.
-	*
-	* @see {@link https://hono.dev/docs/api/context#set-get}
-	*
-	* @example
-	* ```ts
-	* app.use('*', async (c, next) => {
-	*   c.set('message', 'Hono is hot!!')
-	*   await next()
-	* })
-	* ```
-	*/
-	set = (key, value) => {
-		this.#var ??= /* @__PURE__ */ new Map();
-		this.#var.set(key, value);
-	};
-	/**
-	* `.get()` can use the value specified by the key.
-	*
-	* @see {@link https://hono.dev/docs/api/context#set-get}
-	*
-	* @example
-	* ```ts
-	* app.get('/', (c) => {
-	*   const message = c.get('message')
-	*   return c.text(`The message is "${message}"`)
-	* })
-	* ```
-	*/
-	get = (key) => {
-		return this.#var ? this.#var.get(key) : void 0;
-	};
-	/**
-	* `.var` can access the value of a variable.
-	*
-	* @see {@link https://hono.dev/docs/api/context#var}
-	*
-	* @example
-	* ```ts
-	* const result = c.var.client.oneMethod()
-	* ```
-	*/
+	get [GET_RESPONSE]() {
+		return this.#res;
+	}
+	get render() {
+		return (...args) => {
+			this.#renderer ??= (content) => this.html(content);
+			return this.#renderer(...args);
+		};
+	}
+	get setLayout() {
+		return (layout) => this.#layout = layout;
+	}
+	get getLayout() {
+		return () => this.#layout;
+	}
+	get setRenderer() {
+		return (renderer) => {
+			this.#renderer = renderer;
+		};
+	}
+	get header() {
+		return (name, value, options) => {
+			if (this.finalized) this.#res = createResponseInstance(this.#res.body, this.#res);
+			const headers = this.#res ? this.#res.headers : this.#preparedHeaders ??= new Headers();
+			if (value === void 0) headers.delete(name);
+			else if (options?.append) headers.append(name, value);
+			else headers.set(name, value);
+		};
+	}
+	get status() {
+		return (status) => {
+			this.#status = status;
+		};
+	}
+	get set() {
+		return (key, value) => {
+			this.#var ??= /* @__PURE__ */ new Map();
+			this.#var.set(key, value);
+		};
+	}
+	get get() {
+		return (key) => {
+			return this.#var ? this.#var.get(key) : void 0;
+		};
+	}
 	get var() {
 		if (!this.#var) return {};
 		return Object.fromEntries(this.#var);
@@ -283,99 +145,43 @@ var Context = class {
 			headers: responseHeaders ?? headers
 		});
 	}
-	newResponse = (...args) => this.#newResponse(...args);
-	/**
-	* `.body()` can return the HTTP response.
-	* You can set headers with `.header()` and set HTTP status code with `.status`.
-	* This can also be set in `.text()`, `.json()` and so on.
-	*
-	* @see {@link https://hono.dev/docs/api/context#body}
-	*
-	* @example
-	* ```ts
-	* app.get('/welcome', (c) => {
-	*   // Set headers
-	*   c.header('X-Message', 'Hello!')
-	*   c.header('Content-Type', 'text/plain')
-	*   // Set HTTP status code
-	*   c.status(201)
-	*
-	*   // Return the response body
-	*   return c.body('Thank you for coming')
-	* })
-	* ```
-	*/
-	body = (data, arg, headers) => this.#newResponse(data, arg, headers);
-	/**
-	* `.text()` can render text as `Content-Type:text/plain`.
-	*
-	* @see {@link https://hono.dev/docs/api/context#text}
-	*
-	* @example
-	* ```ts
-	* app.get('/say', (c) => {
-	*   return c.text('Hello!')
-	* })
-	* ```
-	*/
-	text = (text, arg, headers) => {
-		return !this.#preparedHeaders && !this.#status && !arg && !headers && !this.finalized ? new Response(text) : this.#newResponse(text, arg, setDefaultContentType(TEXT_PLAIN, headers));
-	};
-	/**
-	* `.json()` can render JSON as `Content-Type:application/json`.
-	*
-	* @see {@link https://hono.dev/docs/api/context#json}
-	*
-	* @example
-	* ```ts
-	* app.get('/api', (c) => {
-	*   return c.json({ message: 'Hello!' })
-	* })
-	* ```
-	*/
-	json = (object, arg, headers) => {
-		return this.#newResponse(JSON.stringify(object), arg, setDefaultContentType("application/json", headers));
-	};
-	html = (html, arg, headers) => {
-		const res = (html) => this.#newResponse(html, arg, setDefaultContentType("text/html; charset=UTF-8", headers));
-		return typeof html === "object" ? resolveCallback(html, HtmlEscapedCallbackPhase.Stringify, false, {}).then(res) : res(html);
-	};
-	/**
-	* `.redirect()` can Redirect, default status code is 302.
-	*
-	* @see {@link https://hono.dev/docs/api/context#redirect}
-	*
-	* @example
-	* ```ts
-	* app.get('/redirect', (c) => {
-	*   return c.redirect('/')
-	* })
-	* app.get('/redirect-permanently', (c) => {
-	*   return c.redirect('/', 301)
-	* })
-	* ```
-	*/
-	redirect = (location, status) => {
-		const locationString = String(location);
-		this.header("Location", !/[^\x00-\xFF]/.test(locationString) ? locationString : encodeURI(locationString));
-		return this.newResponse(null, status ?? 302);
-	};
-	/**
-	* `.notFound()` can return the Not Found Response.
-	*
-	* @see {@link https://hono.dev/docs/api/context#notfound}
-	*
-	* @example
-	* ```ts
-	* app.get('/notfound', (c) => {
-	*   return c.notFound()
-	* })
-	* ```
-	*/
-	notFound = () => {
-		this.#notFoundHandler ??= () => createResponseInstance();
-		return this.#notFoundHandler(this);
-	};
+	get newResponse() {
+		return (...args) => this.#newResponse(...args);
+	}
+	get body() {
+		return (data, arg, headers) => this.#newResponse(data, arg, headers);
+	}
+	get text() {
+		return (text, arg, headers) => {
+			return !this.#preparedHeaders && !this.#status && !arg && !headers && !this.finalized ? new Response(text) : this.#newResponse(text, arg, setDefaultContentType(TEXT_PLAIN, headers));
+		};
+	}
+	get json() {
+		return (object, arg, headers) => {
+			const body = JSON.stringify(object);
+			if (body === void 0) throw new TypeError("Value is not JSON serializable");
+			return this.#newResponse(body, arg, setDefaultContentType("application/json", headers));
+		};
+	}
+	get html() {
+		return (html, arg, headers) => {
+			const res = (html) => this.#newResponse(html, arg, setDefaultContentType("text/html; charset=UTF-8", headers));
+			return typeof html === "object" ? resolveCallback(html, HtmlEscapedCallbackPhase.Stringify, false, {}).then(res) : res(html);
+		};
+	}
+	get redirect() {
+		return (location, status) => {
+			const locationString = String(location);
+			this.header("Location", !/[^\x00-\xFF]/.test(locationString) ? locationString : encodeURI(locationString));
+			return this.newResponse(null, status ?? 302);
+		};
+	}
+	get notFound() {
+		return () => {
+			this.#notFoundHandler ??= () => createResponseInstance();
+			return this.#notFoundHandler(this);
+		};
+	}
 };
 //#endregion
 export { Context, TEXT_PLAIN };

package/dist/helper/accepts/accepts.js

@@ -29,19 +29,6 @@ const defaultMatch = (accepts, config) => {
 	}
 	return defaultSupport;
 };
-/**
-* Match the accept header with the given options.
-* @example
-* ```ts
-* app.get('/users', (c) => {
-*   const lang = accepts(c, {
-*     header: 'Accept-Language',
-*     supports: ['en', 'zh'],
-*     default: 'en',
-*   })
-* })
-* ```
-*/
 const accepts = (c, options) => {
 	const acceptHeader = c.req.header(options.header);
 	if (!acceptHeader) return options.default;

package/dist/helper/css/common.js

@@ -9,19 +9,9 @@ const SELECTORS = Symbol();
 const EXTERNAL_CLASS_NAMES = Symbol();
 const CSS_ESCAPED = Symbol();
 const IS_CSS_ESCAPED = Symbol();
-/**
-* @experimental
-* `rawCssString` is an experimental feature.
-* The API might be changed.
-*/
 const rawCssString = (value) => {
 	return { [CSS_ESCAPED]: value };
 };
-/**
-* Used the goober'code as a reference:
-* https://github.com/cristianbote/goober/blob/master/src/core/to-hash.js
-* MIT License, Copyright (c) 2019 Cristian Bote
-*/
 const toHash = (str) => {
 	let i = 0, out = 11;
 	while (i < str.length) out = 101 * out + str.charCodeAt(i++) >>> 0;

package/dist/helper/css/index.js

@@ -3,19 +3,6 @@ import { DOM_RENDERER } from "../../jsx/constants.js";
 import { CLASS_NAME, DEFAULT_STYLE_ID, SELECTOR, SELECTORS, STYLE_STRING, cssCommon, cxCommon, keyframesCommon, rawCssString, viewTransitionCommon } from "./common.js";
 import { createCssJsxDomObjects } from "../../jsx/dom/css.js";
 //#region src/helper/css/index.ts
-/**
-* @module
-* css Helper for Hono.
-*/
-/**
-* @experimental
-* `createCssContext` is an experimental feature.
-* The API might be changed.
-*
-* @param options.id - The ID for the style element
-* @param options.classNameSlug - Optional function to customize generated CSS class names
-* @param options.onInvalidSlug - Optional callback function called when an invalid slug is returned from ClassNameSlug
-*/
 const createCssContext = ({ id, classNameSlug, onInvalidSlug }) => {
 	const [cssJsxDomObject, StyleRenderToDom] = createCssJsxDomObjects({ id });
 	const contextMap = /* @__PURE__ */ new WeakMap();
@@ -101,35 +88,10 @@ const createCssContext = ({ id, classNameSlug, onInvalidSlug }) => {
 	};
 };
 const defaultContext = createCssContext({ id: DEFAULT_STYLE_ID });
-/**
-* @experimental
-* `css` is an experimental feature.
-* The API might be changed.
-*/
 const css = defaultContext.css;
-/**
-* @experimental
-* `cx` is an experimental feature.
-* The API might be changed.
-*/
 const cx = defaultContext.cx;
-/**
-* @experimental
-* `keyframes` is an experimental feature.
-* The API might be changed.
-*/
 const keyframes = defaultContext.keyframes;
-/**
-* @experimental
-* `viewTransition` is an experimental feature.
-* The API might be changed.
-*/
 const viewTransition = defaultContext.viewTransition;
-/**
-* @experimental
-* `Style` is an experimental feature.
-* The API might be changed.
-*/
 const Style = defaultContext.Style;
 //#endregion
 export { Style, createCssContext, css, cx, keyframes, rawCssString, viewTransition };

package/dist/{types/helper → helper}/dev/index.d.ts

@@ -1,7 +1,10 @@
 import { Env } from "../../types.js";
 import { Hono } from "../../hono.js";
 //#region src/helper/dev/index.d.ts
-interface ShowRoutesOptions {
+interface InspectRoutesOptions {
+  includeInternal?: boolean;
+}
+interface ShowRoutesOptions extends InspectRoutesOptions {
   verbose?: boolean;
   colorize?: boolean;
 }
@@ -11,7 +14,7 @@ interface RouteData {
   name: string;
   isMiddleware: boolean;
 }
-export declare const inspectRoutes: <E extends Env>(hono: Hono<E>) => RouteData[];
+export declare const inspectRoutes: <E extends Env>(hono: Hono<E>, opts?: InspectRoutesOptions) => RouteData[];
 export declare const showRoutes: <E extends Env>(hono: Hono<E>, opts?: ShowRoutesOptions) => void;
 export declare const getRouterName: <E extends Env>(app: Hono<E>) => string;
 //#endregion

package/dist/helper/dev/index.js

@@ -4,8 +4,8 @@ import { findTargetHandler, isMiddleware } from "../../utils/handler.js";
 const handlerName = (handler) => {
 	return handler.name || (isMiddleware(handler) ? "[middleware]" : "[handler]");
 };
-const inspectRoutes = (hono) => {
-	return hono.routes.map(({ path, method, handler }) => {
+const inspectRoutes = (hono, opts) => {
+	return hono.routes.filter(({ method }) => opts?.includeInternal || method[0] !== "@").map(({ path, method, handler }) => {
 		const targetHandler = findTargetHandler(handler);
 		return {
 			path,
@@ -20,7 +20,7 @@ const showRoutes = (hono, opts) => {
 	const routeData = {};
 	let maxMethodLength = 0;
 	let maxPathLength = 0;
-	inspectRoutes(hono).filter(({ isMiddleware }) => opts?.verbose || !isMiddleware).map((route) => {
+	inspectRoutes(hono, opts).filter(({ method, isMiddleware }) => opts?.verbose || !isMiddleware || opts?.includeInternal && method[0] === "@").map((route) => {
 		const key = `${route.method}-${route.path}`;
 		(routeData[key] ||= []).push(route);
 		if (routeData[key].length > 1) return;