import { compose } from './compose.ts' import type { Context } from './context.ts' import { HonoContext } from './context.ts' import { extendRequestPrototype } from './request.ts' import type { Router } from './router.ts' import { METHODS } from './router.ts' import { METHOD_NAME_ALL, METHOD_NAME_ALL_LOWERCASE } from './router.ts' import { RegExpRouter } from './router/reg-exp-router/index.ts' import { SmartRouter } from './router/smart-router/index.ts' import { StaticRouter } from './router/static-router/index.ts' import { TrieRouter } from './router/trie-router/index.ts' import { getPathFromURL, mergePath } from './utils/url.ts' export interface ContextVariableMap {} export type Bindings = Record // For Cloudflare Workers export type Variables = Record // For c.set/c.get functions export type Environment = { Bindings: Bindings Variables: Variables } export type ValidatedData = Record // For validated data export type Handler< RequestParamKeyType extends string = string, E extends Partial = Environment, D extends ValidatedData = ValidatedData > = ( c: Context, next: Next ) => Response | Promise | Promise | Promise export type MiddlewareHandler = = Environment>( c: Context, next: Next ) => Promise | Promise export type NotFoundHandler = Environment> = ( c: Context ) => Response | Promise export type ErrorHandler = Environment> = ( err: Error, c: Context ) => Response export type Next = () => Promise export const defaultNotFoundMessage = '404 Not Found' // eslint-disable-next-line @typescript-eslint/no-unused-vars type ParamKeyName = NameWithPattern extends `${infer Name}{${infer _Pattern}` ? Name : NameWithPattern type ParamKey = Component extends `:${infer NameWithPattern}` ? ParamKeyName : never type ParamKeys = Path extends `${infer Component}/${infer Rest}` ? ParamKey | ParamKeys : ParamKey interface HandlerInterface< T extends string, E extends Partial, D extends ValidatedData, U = Hono > { // app.get(handler...) , Data extends ValidatedData = D>( ...handlers: Handler extends never ? string : ParamKeys, Env, Data>[] ): U (...handlers: Handler[]): U // app.get('/', handler, handler...) = E, Data extends ValidatedData = D>( path: Path, ...handlers: Handler extends never ? string : ParamKeys, Env, Data>[] ): U (path: string, ...handlers: Handler[]): U } type Methods = typeof METHODS[number] | typeof METHOD_NAME_ALL_LOWERCASE function defineDynamicClass(): { new < E extends Partial = Environment, T extends string = string, D extends ValidatedData = ValidatedData, U = Hono >(): { [K in Methods]: HandlerInterface } } { return class {} as any } interface Route< E extends Partial = Environment, D extends ValidatedData = ValidatedData > { path: string method: string handler: Handler } export class Hono< E extends Partial = Environment, P extends string = '/', D extends ValidatedData = ValidatedData > extends defineDynamicClass()> { readonly router: Router> = new SmartRouter({ routers: [new StaticRouter(), new RegExpRouter(), new TrieRouter()], }) readonly strict: boolean = true // strict routing - default is true private _tempPath: string = '' private path: string = '/' routes: Route[] = [] constructor(init: Partial> = {}) { super() extendRequestPrototype() const allMethods = [...METHODS, METHOD_NAME_ALL_LOWERCASE] allMethods.map((method) => { this[method] = ( args1: Path | Handler, E, D>, ...args: [Handler, E, D>] ): this => { if (typeof args1 === 'string') { this.path = args1 } else { this.addRoute(method, this.path, args1) } args.map((handler) => { if (typeof handler !== 'string') { this.addRoute(method, this.path, handler) } }) return this } }) Object.assign(this, init) } private notFoundHandler: NotFoundHandler = (c: Context) => { const message = defaultNotFoundMessage return c.text(message, 404) } private errorHandler: ErrorHandler = (err: Error, c: Context) => { console.error(`${err.stack || err.message}`) const message = 'Internal Server Error' return c.text(message, 500) } route(path: string, app?: Hono): Hono { this._tempPath = path if (app) { app.routes.map((r) => { this.addRoute(r.method, r.path, r.handler) }) this._tempPath = '' } return this } use< Path extends string = string, Env extends Partial = E, Data extends ValidatedData = D >(...middleware: Handler[]): Hono use< Path extends string = string, Env extends Partial = E, Data extends ValidatedData = D >(arg1: string, ...middleware: Handler[]): Hono use(arg1: string | Handler, ...handlers: Handler[]): Hono { if (typeof arg1 === 'string') { this.path = arg1 } else { handlers.unshift(arg1) } handlers.map((handler) => { this.addRoute(METHOD_NAME_ALL, this.path, handler) }) return this } onError(handler: ErrorHandler): Hono { this.errorHandler = handler return this } notFound(handler: NotFoundHandler): Hono { this.notFoundHandler = handler return this } private addRoute(method: string, path: string, handler: Handler): void { method = method.toUpperCase() if (this._tempPath) { path = mergePath(this._tempPath, path) } this.router.add(method, path, handler) const r: Route = { path: path, method: method, handler: handler } this.routes.push(r) } private matchRoute(method: string, path: string) { return this.router.match(method, path) } private async dispatch( request: Request, eventOrExecutionCtx?: ExecutionContext | FetchEvent, env?: E['Bindings'] ): Promise { const path = getPathFromURL(request.url, this.strict) const method = request.method const result = this.matchRoute(method, path) request.paramData = result?.params const c = new HonoContext(request, env, eventOrExecutionCtx, this.notFoundHandler) // Do not `compose` if it has only one handler if (result && result.handlers.length === 1) { const handler = result.handlers[0] try { const res = handler(c, async () => {}) if (res) { const awaited = res instanceof Promise ? await res : res if (awaited) return awaited } return this.notFoundHandler(c) } catch (err) { if (err instanceof Error) { return this.errorHandler(err, c) } throw err } } const handlers = result ? result.handlers : [this.notFoundHandler] const composed = compose, E>(handlers, this.notFoundHandler) let context: HonoContext try { const tmp = composed(c) context = tmp instanceof Promise ? await tmp : tmp if (!context.finalized) { throw new Error( 'Context is not finalized. You may forget returning Response object or `await next()`' ) } } catch (err) { if (err instanceof Error) { return this.errorHandler(err, c) } throw err } return context.res } handleEvent(event: FetchEvent): Promise { return this.dispatch(event.request, event) } fetch = (request: Request, Environment?: E['Bindings'], executionCtx?: ExecutionContext) => { return this.dispatch(request, executionCtx, Environment) } request(input: RequestInfo, requestInit?: RequestInit): Promise { const req = input instanceof Request ? input : new Request(input, requestInit) return this.dispatch(req) } }