hono 4.13.13 → 5.0.0-rc.1

package/README.md

@@ -63,9 +63,9 @@ The migration guide is available on [docs/MIGRATION.md](docs/MIGRATION.md).
 Contributions Welcome! You can contribute in the following ways.
 
 - Create an Issue - Propose a new feature. Report a bug.
-- Pull Request - Fix a bug or typo. Refactor the code.
-- Create third-party middleware - See [Third-party middleware](docs/CONTRIBUTING.md#third-party-middleware).
+- Build middleware and libraries - Grow the Hono ecosystem.
 - Share - Share your thoughts on the Blog, X, and others.
+- Sponsor - Support the maintainers through GitHub Sponsors: [@yusukebe](https://github.com/sponsors/yusukebe) and [@usualoma](https://github.com/sponsors/usualoma).
 - Make your application - Please try to use Hono.
 
 For more details, see [docs/CONTRIBUTING.md](docs/CONTRIBUTING.md).

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/{types/compose.d.ts → compose.d.ts}

@@ -1,16 +1,18 @@
-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;
 /**
  * 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 {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,44 +1,31 @@
 //#region src/compose.ts
-/**
-* 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 toError = (err) => err instanceof Error ? err : new Error(typeof err === "string" ? err : void 0, { cause: err });
+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, () => dispatch(i + 1));
+				res = await handler(context, () => {
+					const routeIndex = context.req.routeIndex;
+					return dispatch(i + 1).finally(() => context.req.routeIndex = routeIndex);
+				});
 			} catch (err) {
-				if (err instanceof Error && onError) {
-					context.error = err;
-					res = await onError(err, 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;
@@ -47,4 +34,4 @@ const compose = (middleware, onError, onNotFound) => {
 	};
 };
 //#endregion
-export { compose };
+export { compose, toError };

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/{types/context.d.ts → 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.
    *
@@ -268,14 +309,14 @@ export declare class Context<E extends Env = any, P extends string = any, I exte
    * })
    * ```
    */
-  render: Renderer;
+  get render(): Renderer;
   /**
    * Sets the layout for the response.
    *
    * @param layout - The layout to set.
    * @returns The layout function.
    */
-  setLayout: (layout: Layout<PropsForRenderer & {
+  get setLayout(): (layout: Layout<PropsForRenderer & {
     Layout: Layout;
   }>) => Layout<PropsForRenderer & {
     Layout: Layout;
@@ -285,7 +326,7 @@ export declare class Context<E extends Env = any, P extends string = any, I exte
    *
    * @returns The current layout function.
    */
-  getLayout: () => Layout<PropsForRenderer & {
+  get getLayout(): () => Layout<PropsForRenderer & {
     Layout: Layout;
   }> | undefined;
   /**
@@ -309,7 +350,7 @@ export declare class Context<E extends Env = any, P extends string = any, I exte
    * })
    * ```
    */
-  setRenderer: (renderer: Renderer) => void;
+  get setRenderer(): (renderer: Renderer) => void;
   /**
    * `.header()` can set headers.
    *
@@ -330,8 +371,8 @@ export declare class Context<E extends Env = any, P extends string = any, I exte
    * })
    * ```
    */
-  header: SetHeaders;
-  status: (status: StatusCode) => void;
+  get header(): SetHeaders;
+  get status(): (status: StatusCode) => void;
   /**
    * `.set()` can set the value specified by the key.
    *
@@ -345,7 +386,7 @@ export declare class Context<E extends Env = any, P extends string = any, I exte
    * })
    * ```
    */
-  set: Set<IsAny<E> extends true ? {
+  get set(): Set<IsAny<E> extends true ? {
     Variables: ContextVariableMap & Record<PropertyKey, any>;
   } : E>;
   /**
@@ -361,7 +402,7 @@ export declare class Context<E extends Env = any, P extends string = any, I exte
    * })
    * ```
    */
-  get: Get<IsAny<E> extends true ? {
+  get get(): Get<IsAny<E> extends true ? {
     Variables: ContextVariableMap & Record<PropertyKey, any>;
   } : E>;
   /**
@@ -375,7 +416,7 @@ export declare class Context<E extends Env = any, P extends string = any, I exte
    * ```
    */
   get var(): Readonly<ContextVariableMap & (IsAny<E['Variables']> extends true ? Record<string, any> : E['Variables'])>;
-  newResponse: NewResponse;
+  get newResponse(): NewResponse;
   /**
    * `.body()` can return the HTTP response.
    * You can set headers with `.header()` and set HTTP status code with `.status`.
@@ -397,7 +438,7 @@ export declare class Context<E extends Env = any, P extends string = any, I exte
    * })
    * ```
    */
-  body: BodyRespond;
+  get body(): BodyRespond;
   /**
    * `.text()` can render text as `Content-Type:text/plain`.
    *
@@ -410,7 +451,7 @@ export declare class Context<E extends Env = any, P extends string = any, I exte
    * })
    * ```
    */
-  text: TextRespond;
+  get text(): TextRespond;
   /**
    * `.json()` can render JSON as `Content-Type:application/json`.
    *
@@ -423,8 +464,8 @@ export declare class Context<E extends Env = any, P extends string = any, I exte
    * })
    * ```
    */
-  json: JSONRespond;
-  html: HTMLRespond;
+  get json(): JSONRespond;
+  get html(): HTMLRespond;
   /**
    * `.redirect()` can Redirect, default status code is 302.
    *
@@ -440,7 +481,7 @@ export declare class Context<E extends Env = any, P extends string = any, I exte
    * })
    * ```
    */
-  redirect: <T extends RedirectStatusCode = 302>(location: string | URL, status?: T) => Response & TypedResponse<undefined, T, "redirect">;
+  get redirect(): <T extends RedirectStatusCode = 302>(location: string | URL, status?: T) => Response & TypedResponse<undefined, T, 'redirect'>;
   /**
    * `.notFound()` can return the Not Found Response.
    *
@@ -453,7 +494,7 @@ export declare class Context<E extends Env = any, P extends string = any, I exte
    * })
    * ```
    */
-  notFound: () => ReturnType<NotFoundHandler>;
+  get notFound(): () => ReturnType<NotFoundHandler>;
 }
 //#endregion
 export {};