-
-
Notifications
You must be signed in to change notification settings - Fork 442
/
hono.ts
284 lines (243 loc) · 8.56 KB
/
hono.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
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<string, any> // For Cloudflare Workers
export type Variables = Record<string, any> // For c.set/c.get functions
export type Environment = {
Bindings: Bindings
Variables: Variables
}
export type ValidatedData = Record<string, any> // For validated data
export type Handler<
RequestParamKeyType extends string = string,
E extends Partial<Environment> = Environment,
D extends ValidatedData = ValidatedData
> = (
c: Context<RequestParamKeyType, E, D>,
next: Next
) => Response | Promise<Response> | Promise<void> | Promise<Response | undefined>
export type MiddlewareHandler = <E extends Partial<Environment> = Environment>(
c: Context<string, E>,
next: Next
) => Promise<void> | Promise<Response | undefined>
export type NotFoundHandler<E extends Partial<Environment> = Environment> = (
c: Context<string, E>
) => Response | Promise<Response>
export type ErrorHandler<E extends Partial<Environment> = Environment> = (
err: Error,
c: Context<string, E>
) => Response
export type Next = () => Promise<void>
export const defaultNotFoundMessage = '404 Not Found'
// eslint-disable-next-line @typescript-eslint/no-unused-vars
type ParamKeyName<NameWithPattern> = NameWithPattern extends `${infer Name}{${infer _Pattern}`
? Name
: NameWithPattern
type ParamKey<Component> = Component extends `:${infer NameWithPattern}`
? ParamKeyName<NameWithPattern>
: never
type ParamKeys<Path> = Path extends `${infer Component}/${infer Rest}`
? ParamKey<Component> | ParamKeys<Rest>
: ParamKey<Path>
interface HandlerInterface<
T extends string,
E extends Partial<Environment>,
D extends ValidatedData,
U = Hono<E, T, D>
> {
// app.get(handler...)
<Path extends string, Env extends Partial<Environment>, Data extends ValidatedData = D>(
...handlers: Handler<ParamKeys<Path> extends never ? string : ParamKeys<Path>, Env, Data>[]
): U
(...handlers: Handler<string, E, D>[]): U
// app.get('/', handler, handler...)
<Path extends string, Env extends Partial<Environment> = E, Data extends ValidatedData = D>(
path: Path,
...handlers: Handler<ParamKeys<Path> extends never ? string : ParamKeys<Path>, Env, Data>[]
): U
(path: string, ...handlers: Handler<string, E, D>[]): U
}
type Methods = typeof METHODS[number] | typeof METHOD_NAME_ALL_LOWERCASE
function defineDynamicClass(): {
new <
E extends Partial<Environment> = Environment,
T extends string = string,
D extends ValidatedData = ValidatedData,
U = Hono<E, T, D>
>(): {
[K in Methods]: HandlerInterface<T, E, D, U>
}
} {
return class {} as any
}
interface Route<
E extends Partial<Environment> = Environment,
D extends ValidatedData = ValidatedData
> {
path: string
method: string
handler: Handler<string, E, D>
}
export class Hono<
E extends Partial<Environment> = Environment,
P extends string = '/',
D extends ValidatedData = ValidatedData
> extends defineDynamicClass()<E, P, D, Hono<E, P, D>> {
readonly router: Router<Handler<string, E, D>> = 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<E, D>[] = []
constructor(init: Partial<Pick<Hono, 'router' | 'strict'>> = {}) {
super()
extendRequestPrototype()
const allMethods = [...METHODS, METHOD_NAME_ALL_LOWERCASE]
allMethods.map((method) => {
this[method] = <Path extends string = ''>(
args1: Path | Handler<ParamKeys<Path>, E, D>,
...args: [Handler<ParamKeys<Path>, 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<E> = (c: Context<string, E>) => {
const message = defaultNotFoundMessage
return c.text(message, 404)
}
private errorHandler: ErrorHandler<E> = (err: Error, c: Context<string, E>) => {
console.error(`${err.stack || err.message}`)
const message = 'Internal Server Error'
return c.text(message, 500)
}
route(path: string, app?: Hono<any>): Hono<E, P, D> {
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<Environment> = E,
Data extends ValidatedData = D
>(...middleware: Handler<Path, Env, Data>[]): Hono<Env, Path, Data>
use<
Path extends string = string,
Env extends Partial<Environment> = E,
Data extends ValidatedData = D
>(arg1: string, ...middleware: Handler<Path, Env, Data>[]): Hono<Env, Path, D>
use(arg1: string | Handler<string, E, D>, ...handlers: Handler<string, E, D>[]): Hono<E, P, D> {
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<E>): Hono<E, P, D> {
this.errorHandler = handler
return this
}
notFound(handler: NotFoundHandler<E>): Hono<E, P, D> {
this.notFoundHandler = handler
return this
}
private addRoute(method: string, path: string, handler: Handler<string, E, D>): void {
method = method.toUpperCase()
if (this._tempPath) {
path = mergePath(this._tempPath, path)
}
this.router.add(method, path, handler)
const r: Route<E, D> = { 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<Response> {
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<string, E, D>(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<HonoContext<string, E>, E>(handlers, this.notFoundHandler)
let context: HonoContext<string, E>
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<Response> {
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<Response> {
const req = input instanceof Request ? input : new Request(input, requestInit)
return this.dispatch(req)
}
}