hono 5.0.0-rc.0 → 5.0.0-rc.1

package/dist/client/fetch-result-please.js

@@ -1,20 +1,10 @@
 //#region src/client/fetch-result-please.ts
-/**
-* @description This file is a modified version of `fetch-result-please` (`ofetch`), minimalized and adapted to Hono's custom needs.
-*
-* @link https://www.npmjs.com/package/fetch-result-please
-*/
 const nullBodyResponses = /* @__PURE__ */ new Set([
 	101,
 	204,
 	205,
 	304
 ]);
-/**
-* Smartly parses and return the consumable result from a fetch `Response`.
-*
-* Throwing a structured error if the response is not `ok`. ({@link DetailedError})
-*/
 async function fetchRP(fetchRes) {
 	const _fetchRes = await fetchRes;
 	if ((_fetchRes.body || _fetchRes._bodyInit) && !nullBodyResponses.has(_fetchRes.status)) _fetchRes._data = await _fetchRes[detectResponseType(_fetchRes)]();
@@ -28,21 +18,9 @@ async function fetchRP(fetchRes) {
 	return _fetchRes._data;
 }
 var DetailedError = class extends Error {
-	/**
-	* Additional `message` that will be logged AND returned to client
-	*/
 	detail;
-	/**
-	* Additional `code` that will be logged AND returned to client
-	*/
 	code;
-	/**
-	* Additional value that will be logged AND NOT returned to client
-	*/
 	log;
-	/**
-	* Optionally set the status code to return, in a web server context
-	*/
 	statusCode;
 	constructor(message, options = {}) {
 		super(message);

package/dist/client/utils.js

@@ -48,13 +48,6 @@ function deepMerge(target, source) {
 	}
 	return merged;
 }
-/**
-* Shortcut to get a consumable response from `hc`'s fetch calls (Response), with types inference.
-*
-* Smartly parse the response data, throwing a structured error if the response is not `ok`. ({@link DetailedError})
-*
-* @example const result = await parseResponse(client.posts.$get())
-*/
 async function parseResponse(fetchRes) {
 	return fetchRP(fetchRes);
 }

package/dist/compose.d.ts

@@ -1,4 +1,4 @@
-import { Env, ErrorHandler, Next, NotFoundHandler } from "./types.js";
+import { Env, Next, NotFoundHandler } from "./types.js";
 import { Context } from "./context.js";
 //#region src/compose.d.ts
 export declare const toError: (err: unknown) => Error;
@@ -8,10 +8,11 @@ export declare const toError: (err: unknown) => Error;
  * @template E - The environment type.
  *
  * @param {[[Function, unknown], unknown][] | [[Function]][]} middleware - An array of middleware functions and their corresponding parameters.
- * @param {ErrorHandler<E>} [onError] - An optional error handler function.
+ * @param {Function} [onError] - An optional callback receiving the error and context.
  * @param {NotFoundHandler<E>} [onNotFound] - An optional not-found handler function.
+ * @param {boolean} [updateRouteIndex] - Whether to update the matched route index.
  *
  * @returns {(context: Context, next?: Next) => Promise<Context>} - A composed middleware function.
  */
-export declare const compose: <E extends Env = Env>(middleware: [[Function, unknown], unknown][] | [[Function]][], onError?: ErrorHandler<E>, onNotFound?: NotFoundHandler<E>) => ((context: Context, next?: Next) => Promise<Context>);
+export declare const compose: <E extends Env = Env>(middleware: [[Function, unknown], unknown][] | [[Function]][], onError?: (err: Error, context: Context<E>) => Response | Promise<Response>, onNotFound?: NotFoundHandler<E>, updateRouteIndex?: boolean) => ((context: Context, next?: Next) => Promise<Context>);
 //#endregion

package/dist/compose.js

@@ -1,49 +1,31 @@
 //#region src/compose.ts
 const toError = (err) => err instanceof Error ? err : new Error(typeof err === "string" ? err : void 0, { cause: err });
-/**
-* Compose middleware functions into a single function based on `koa-compose` package.
-*
-* @template E - The environment type.
-*
-* @param {[[Function, unknown], unknown][] | [[Function]][]} middleware - An array of middleware functions and their corresponding parameters.
-* @param {ErrorHandler<E>} [onError] - An optional error handler function.
-* @param {NotFoundHandler<E>} [onNotFound] - An optional not-found handler function.
-*
-* @returns {(context: Context, next?: Next) => Promise<Context>} - A composed middleware function.
-*/
-const compose = (middleware, onError, onNotFound) => {
+const compose = (middleware, onError, onNotFound, updateRouteIndex = true) => {
 	return (context, next) => {
 		let index = -1;
 		return dispatch(0);
-		/**
-		* Dispatch the middleware functions.
-		*
-		* @param {number} i - The current index in the middleware array.
-		*
-		* @returns {Promise<Context>} - A promise that resolves to the context.
-		*/
 		async function dispatch(i) {
 			if (i <= index) throw new Error("next() called multiple times");
 			index = i;
 			let res;
 			let isError = false;
-			let handler;
-			if (middleware[i]) {
-				handler = middleware[i][0][0];
-				context.req.routeIndex = i;
-			} else handler = i === middleware.length && next || void 0;
+			const entry = middleware[i];
+			const handler = entry ? entry[0][0] : i === middleware.length && next || void 0;
+			if (entry) {
+				if (updateRouteIndex) context.req.routeIndex = i;
+			}
 			if (handler) try {
 				res = await handler(context, () => {
 					const routeIndex = context.req.routeIndex;
 					return dispatch(i + 1).finally(() => context.req.routeIndex = routeIndex);
 				});
 			} catch (err) {
-				if (onError) {
-					const error = toError(err);
-					context.error = error;
-					res = await onError(error, context);
-					isError = true;
-				} else throw err;
+				if (updateRouteIndex) context.req.routeIndex = i;
+				if (!onError) throw err;
+				const error = toError(err);
+				context.error = error;
+				res = await onError(error, context);
+				isError = true;
 			}
 			else if (context.finalized === false && onNotFound) res = await onNotFound(context);
 			if (res && (context.finalized === false || isError)) context.res = res;

package/dist/context/constants.d.ts

@@ -0,0 +1,3 @@
+//#region src/context/constants.d.ts
+export declare const GET_RESPONSE: unique symbol;
+//#endregion

package/dist/context/constants.js

@@ -0,0 +1,4 @@
+//#region src/context/constants.ts
+const GET_RESPONSE = Symbol();
+//#endregion
+export { GET_RESPONSE };

package/dist/context.d.ts

@@ -1,3 +1,4 @@
+import { GET_RESPONSE } from "./context/constants.js";
 import { Result } from "./router.js";
 import { ResponseHeader } from "./utils/headers.js";
 import { ContentfulStatusCode, RedirectStatusCode, StatusCode } from "./utils/http-status.js";
@@ -11,6 +12,40 @@ type HeaderRecord = Record<'Content-Type', BaseMime> | Record<ResponseHeader, st
  * Data type can be a string, ArrayBuffer, Blob, Uint8Array (buffer), or ReadableStream.
  */
 export type Data = string | ArrayBuffer | Blob | ReadableStream | Uint8Array<ArrayBuffer>;
+/**
+ * Identity information for a user authenticated by Cloudflare Access.
+ */
+export interface CloudflareAccessIdentity extends Record<string, unknown> {
+  email?: string;
+  name?: string;
+  user_uuid?: string;
+  account_id?: string;
+  iat?: number;
+  ip?: string;
+  amr?: string[];
+  idp?: {
+    id: string;
+    type: string;
+  };
+  geo?: {
+    country: string;
+  };
+  groups?: Array<{
+    id: string;
+    name: string;
+    email?: string;
+  }>;
+  devicePosture?: Record<string, unknown>;
+  is_warp?: boolean;
+  is_gateway?: boolean;
+}
+/**
+ * Cloudflare Access authentication information for the current request.
+ */
+export interface CloudflareAccessContext {
+  readonly aud: string;
+  getIdentity(): Promise<CloudflareAccessIdentity | undefined>;
+}
 /**
  * Interface for the execution context in a web worker or similar environment.
  */
@@ -33,6 +68,10 @@ export interface ExecutionContext {
    * For compatibility with Wrangler 4.x.
    */
   exports?: any;
+  /**
+   * Cloudflare Access authentication information, when available.
+   */
+  readonly access?: CloudflareAccessContext;
 }
 /**
  * Interface for context variable mapping.
@@ -256,6 +295,8 @@ export declare class Context<E extends Env = any, P extends string = any, I exte
    * @param _res - The Response object to set.
    */
   set res(_res: Response | undefined);
+  /** @internal Returns the existing response without creating one. */
+  get [GET_RESPONSE](): Response | undefined;
   /**
    * `.render()` can create a response within a layout.
    *

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,87 +66,26 @@ 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!')
-	* })
-	* ```
-	*/
+	get [GET_RESPONSE]() {
+		return this.#res;
+	}
 	get render() {
 		return (...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.
-	*/
 	get setLayout() {
 		return (layout) => this.#layout = layout;
 	}
-	/**
-	* Gets the current layout for the response.
-	*
-	* @returns The current layout function.
-	*/
 	get getLayout() {
 		return () => 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()
-	* })
-	* ```
-	*/
 	get setRenderer() {
 		return (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')
-	* })
-	* ```
-	*/
 	get header() {
 		return (name, value, options) => {
 			if (this.finalized) this.#res = createResponseInstance(this.#res.body, this.#res);
@@ -218,53 +100,17 @@ var Context = class {
 			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()
-	* })
-	* ```
-	*/
 	get set() {
 		return (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 get() {
 		return (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 var() {
 		if (!this.#var) return {};
 		return Object.fromEntries(this.#var);
@@ -302,59 +148,14 @@ var Context = class {
 	get newResponse() {
 		return (...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')
-	* })
-	* ```
-	*/
 	get body() {
 		return (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!')
-	* })
-	* ```
-	*/
 	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));
 		};
 	}
-	/**
-	* `.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!' })
-	* })
-	* ```
-	*/
 	get json() {
 		return (object, arg, headers) => {
 			const body = JSON.stringify(object);
@@ -368,21 +169,6 @@ var Context = class {
 			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)
-	* })
-	* ```
-	*/
 	get redirect() {
 		return (location, status) => {
 			const locationString = String(location);
@@ -390,18 +176,6 @@ var Context = class {
 			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()
-	* })
-	* ```
-	*/
 	get notFound() {
 		return () => {
 			this.#notFoundHandler ??= () => createResponseInstance();

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/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