Compare commits
40 Commits
v3.0.0-7
...
a4fd646d6b
| Author | SHA1 | Date | |
|---|---|---|---|
|
a4fd646d6b
|
|||
|
606d5f1cb2
|
|||
|
95ccb2263a
|
|||
|
dc88d900cb
|
|||
|
0dca90f4f9
|
|||
|
cb8724edc4
|
|||
|
08c329ff20
|
|||
|
e9a0a2436d
|
|||
|
76d7040a1b
|
|||
|
0037fb64ea
|
|||
|
|
a5ccf0fc01 | ||
|
|
e006d0a3b1 | ||
|
|
c7d7a642e6 | ||
|
|
49c7897bd0 | ||
|
e28976a4b6
|
|||
|
eea9e580f6
|
|||
|
68e614b3fa
|
|||
|
7a20454f79
|
|||
|
101de4f5f6
|
|||
|
9ee1182fa9
|
|||
|
0309b0131f
|
|||
|
afd7ea662f
|
|||
|
a742753cb7
|
|||
|
d631645b99
|
|||
|
cb1bf98053
|
|||
|
648514a3c7
|
|||
|
34f4512dee
|
|||
|
02b65e85e6
|
|||
|
d71b0638c4
|
|||
|
0c7f04d71b
|
|||
|
c18e164018
|
|||
|
307a93d86c
|
|||
|
3a955af1bc
|
|||
|
db22422968
|
|||
|
0a73e4c32e
|
|||
|
8bd8e50ee5
|
|||
|
e4ec06bf47
|
|||
|
2ad75dc3fb
|
|||
|
c2b6189a86
|
|||
|
33cafbf17c
|
@@ -7,3 +7,7 @@ insert_final_newline = false
|
||||
[src/**.ts]
|
||||
charset = utf-8
|
||||
indent_style = tab
|
||||
|
||||
[README.md]
|
||||
indent_style = space
|
||||
indent_size = 4
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
name: Publish (pre)
|
||||
name: Publish (main)
|
||||
|
||||
on:
|
||||
release:
|
||||
@@ -11,7 +11,7 @@ jobs:
|
||||
- uses: actions/checkout@v3
|
||||
- uses: actions/setup-node@v3
|
||||
with:
|
||||
node-version: 16
|
||||
node-version: latest
|
||||
registry-url: https://registry.npmjs.org/
|
||||
- name: Install dependencies
|
||||
run: npm ci
|
||||
@@ -20,11 +20,12 @@ jobs:
|
||||
- name: Publish to npmjs
|
||||
env:
|
||||
NODE_AUTH_TOKEN: ${{secrets.NPM_TOKEN}}
|
||||
run: npm publish --tag pre --access public
|
||||
- uses: actions/setup-node@v1
|
||||
run: npm publish --tag latest --access public
|
||||
- uses: actions/setup-node@v3
|
||||
with:
|
||||
node-version: latest
|
||||
registry-url: https://npm.pkg.github.com/
|
||||
- name: Publish to GPR
|
||||
env:
|
||||
NODE_AUTH_TOKEN: ${{secrets.GITHUB_TOKEN}}
|
||||
run: npm publish --tag pre --access public
|
||||
run: npm publish --tag latest --access public
|
||||
@@ -7,7 +7,6 @@ From `v2.x.x` to `v3.x.x`.
|
||||
|
||||
- [Update Router](#update-router)
|
||||
- [Handlers](#handlers)
|
||||
- [Fetch](#fetch--routerhandle)
|
||||
|
||||
|
||||
## Update Router
|
||||
@@ -15,7 +14,7 @@ From `v2.x.x` to `v3.x.x`.
|
||||
Update to the latest version version of the router.
|
||||
|
||||
```bash
|
||||
npm i -D @tsndr/cloudflare-worker-router
|
||||
npm i -D @tsndr/cloudflare-worker-router@^3
|
||||
```
|
||||
|
||||
|
||||
|
||||
71
README.md
71
README.md
@@ -33,6 +33,10 @@ Migrating from `v2.x.x`, check out the [Migration Guide](MIGRATION.md).
|
||||
```typescript
|
||||
import { Router } from '@tsndr/cloudflare-worker-router'
|
||||
|
||||
// Env Types
|
||||
export type Var<T = string> = T
|
||||
export type Secret<T = string> = T
|
||||
|
||||
export type Env = {
|
||||
// Example binding to KV. Learn more at https://developers.cloudflare.com/workers/runtime-apis/kv/
|
||||
// MY_KV_NAMESPACE: KVNamespace
|
||||
@@ -43,11 +47,23 @@ export type Env = {
|
||||
// Example binding to R2. Learn more at https://developers.cloudflare.com/workers/runtime-apis/r2/
|
||||
// MY_BUCKET: R2Bucket
|
||||
|
||||
SECRET_TOKEN: string
|
||||
ENVIRONMENT: Var<'dev' | 'prod'>
|
||||
|
||||
SECRET_TOKEN: Secret
|
||||
}
|
||||
|
||||
// Initialize router
|
||||
const router = new Router<Env>()
|
||||
// Request Extension
|
||||
export type ExtReq = {
|
||||
userId?: number
|
||||
}
|
||||
|
||||
// Context Extension
|
||||
export type ExtCtx = {
|
||||
//sentry?: Toucan
|
||||
}
|
||||
|
||||
// Initialize Router
|
||||
const router = new Router<Env, ExtCtx, ExtReq>()
|
||||
|
||||
// Enabling build in CORS support
|
||||
router.cors()
|
||||
@@ -211,10 +227,12 @@ If enabled will overwrite other `OPTIONS` requests.
|
||||
#### `config` (object, optional)
|
||||
|
||||
Key | Type | Default Value
|
||||
---------------------- | --------- | -------------
|
||||
-------------------------- | ---------- | -------------
|
||||
`allowOrigin` | `string` | `*`
|
||||
`allowMethods` | `string` | `*`
|
||||
`allowHeaders` | `string` | `*`
|
||||
`allowCredentials` | `boolean` | `undefined`
|
||||
`vary` | `string` | `undefined`
|
||||
`maxAge` | `integer` | `86400`
|
||||
`optionsSuccessStatus` | `integer` | `204`
|
||||
|
||||
@@ -287,6 +305,10 @@ npm i -D @tsndr/cloudflare-worker-router
|
||||
```typescript
|
||||
import { Router } from '@tsndr/cloudflare-worker-router'
|
||||
|
||||
// Env Types
|
||||
export type Var<T = string> = T
|
||||
export type Secret<T = string> = T
|
||||
|
||||
export type Env = {
|
||||
// Example binding to KV. Learn more at https://developers.cloudflare.com/workers/runtime-apis/kv/
|
||||
// MY_KV_NAMESPACE: KVNamespace
|
||||
@@ -296,25 +318,50 @@ export type Env = {
|
||||
//
|
||||
// Example binding to R2. Learn more at https://developers.cloudflare.com/workers/runtime-apis/r2/
|
||||
// MY_BUCKET: R2Bucket
|
||||
//
|
||||
// Example Variable
|
||||
// ENVIRONMENT: Var<'dev' | 'prod'>
|
||||
//
|
||||
// Example Secret
|
||||
// JWT_SECRET: Secret
|
||||
}
|
||||
|
||||
const router = new Router<Env>()
|
||||
// Request Extension
|
||||
export type ExtReq = {
|
||||
userId?: number
|
||||
}
|
||||
|
||||
// Context Extension
|
||||
export type ExtCtx = {
|
||||
//sentry?: Toucan
|
||||
}
|
||||
|
||||
// Handler Type
|
||||
export type Handler = RouterHandler<Env, ExtCtx, ExtReq>
|
||||
|
||||
// Initialize Router
|
||||
const router = new Router<Env, ExtCtx, ExtReq>()
|
||||
|
||||
// Enable Debug Mode
|
||||
router.debug()
|
||||
|
||||
// Enabling build in CORS support
|
||||
//router.cors()
|
||||
|
||||
/// Example Route
|
||||
//
|
||||
// router.get('/hi', async () => {
|
||||
// return new Response('Hello World')
|
||||
//})
|
||||
// })
|
||||
|
||||
|
||||
/// Example Route for splitting into multiple files
|
||||
//
|
||||
// const hiHandler: RouteHandler<Env> = async () => {
|
||||
// const helloHandler: Handler = async () => {
|
||||
// return new Response('Hello World')
|
||||
// }
|
||||
//
|
||||
// router.get('/hi', hiHandler)
|
||||
|
||||
// router.get('/hellow', helloHandler)
|
||||
|
||||
// TODO: add your routes here
|
||||
|
||||
@@ -336,6 +383,12 @@ import { Router } from '@tsndr/cloudflare-worker-router'
|
||||
|
||||
const router = new Router()
|
||||
|
||||
// Enable Debug Mode
|
||||
//router.debug()
|
||||
|
||||
// Enabling build in CORS support
|
||||
//router.cors()
|
||||
|
||||
/// Example Route
|
||||
//
|
||||
// router.get('/hi', async () => {
|
||||
|
||||
38
package-lock.json
generated
38
package-lock.json
generated
@@ -1,50 +1,36 @@
|
||||
{
|
||||
"name": "@tsndr/cloudflare-worker-router",
|
||||
"version": "3.0.0-7",
|
||||
"lockfileVersion": 2,
|
||||
"version": "3.1.3",
|
||||
"lockfileVersion": 3,
|
||||
"requires": true,
|
||||
"packages": {
|
||||
"": {
|
||||
"name": "@tsndr/cloudflare-worker-router",
|
||||
"version": "3.0.0-7",
|
||||
"version": "3.1.3",
|
||||
"license": "MIT",
|
||||
"devDependencies": {
|
||||
"@cloudflare/workers-types": "^4.20230115.0",
|
||||
"typescript": "^4.9.5"
|
||||
"@cloudflare/workers-types": "^4.20231025.0",
|
||||
"typescript": "^5.2.2"
|
||||
}
|
||||
},
|
||||
"node_modules/@cloudflare/workers-types": {
|
||||
"version": "4.20230115.0",
|
||||
"resolved": "https://registry.npmjs.org/@cloudflare/workers-types/-/workers-types-4.20230115.0.tgz",
|
||||
"integrity": "sha512-GPJEiO8AFN+jUpA+DHJ1qdVmk4s/hq8JYKjOV/+U7avGquQbVnj905+Kg6uAEfrq16muwmRKl+XJGqsvlBlDNg==",
|
||||
"version": "4.20231025.0",
|
||||
"resolved": "https://registry.npmjs.org/@cloudflare/workers-types/-/workers-types-4.20231025.0.tgz",
|
||||
"integrity": "sha512-TkcZkntUTOcvJ4vgmwpNfLTclpMbmbClZCe62B25/VTukmyv91joRa4eKzSjzCZUXTbFHNmVdOpmGaaJU2U3+A==",
|
||||
"dev": true
|
||||
},
|
||||
"node_modules/typescript": {
|
||||
"version": "4.9.5",
|
||||
"resolved": "https://registry.npmjs.org/typescript/-/typescript-4.9.5.tgz",
|
||||
"integrity": "sha512-1FXk9E2Hm+QzZQ7z+McJiHL4NW1F2EzMu9Nq9i3zAaGqibafqYwCVU6WyWAuyQRRzOlxou8xZSyXLEN8oKj24g==",
|
||||
"version": "5.2.2",
|
||||
"resolved": "https://registry.npmjs.org/typescript/-/typescript-5.2.2.tgz",
|
||||
"integrity": "sha512-mI4WrpHsbCIcwT9cF4FZvr80QUeKvsUsUvKDoR+X/7XHQH98xYD8YHZg7ANtz2GtZt/CBq2QJ0thkGJMHfqc1w==",
|
||||
"dev": true,
|
||||
"bin": {
|
||||
"tsc": "bin/tsc",
|
||||
"tsserver": "bin/tsserver"
|
||||
},
|
||||
"engines": {
|
||||
"node": ">=4.2.0"
|
||||
"node": ">=14.17"
|
||||
}
|
||||
}
|
||||
},
|
||||
"dependencies": {
|
||||
"@cloudflare/workers-types": {
|
||||
"version": "4.20230115.0",
|
||||
"resolved": "https://registry.npmjs.org/@cloudflare/workers-types/-/workers-types-4.20230115.0.tgz",
|
||||
"integrity": "sha512-GPJEiO8AFN+jUpA+DHJ1qdVmk4s/hq8JYKjOV/+U7avGquQbVnj905+Kg6uAEfrq16muwmRKl+XJGqsvlBlDNg==",
|
||||
"dev": true
|
||||
},
|
||||
"typescript": {
|
||||
"version": "4.9.5",
|
||||
"resolved": "https://registry.npmjs.org/typescript/-/typescript-4.9.5.tgz",
|
||||
"integrity": "sha512-1FXk9E2Hm+QzZQ7z+McJiHL4NW1F2EzMu9Nq9i3zAaGqibafqYwCVU6WyWAuyQRRzOlxou8xZSyXLEN8oKj24g==",
|
||||
"dev": true
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "@tsndr/cloudflare-worker-router",
|
||||
"version": "3.0.0-7",
|
||||
"version": "3.1.3",
|
||||
"description": "",
|
||||
"main": "index.js",
|
||||
"types": "index.d.ts",
|
||||
@@ -31,7 +31,7 @@
|
||||
},
|
||||
"homepage": "https://github.com/tsndr/cloudflare-worker-router#readme",
|
||||
"devDependencies": {
|
||||
"@cloudflare/workers-types": "^4.20230115.0",
|
||||
"typescript": "^4.9.5"
|
||||
"@cloudflare/workers-types": "^4.20231025.0",
|
||||
"typescript": "^5.2.2"
|
||||
}
|
||||
}
|
||||
|
||||
144
src/index.ts
144
src/index.ts
@@ -6,10 +6,10 @@
|
||||
* @property {string} url URL String
|
||||
* @property {RouterHandler[]} handlers Array of handler functions
|
||||
*/
|
||||
export type Route<TEnv, TExt> = {
|
||||
export type Route<Env, CtxExt, ReqExt> = {
|
||||
method: string
|
||||
url: string
|
||||
handlers: RouterHandler<TEnv, TExt>[]
|
||||
handlers: RouterHandler<Env, CtxExt, ReqExt>[]
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -20,9 +20,9 @@ export type Route<TEnv, TExt> = {
|
||||
* @property {RouterRequest} req Request Object
|
||||
* @property {ExecutionContext} ctx Context Object
|
||||
*/
|
||||
export type RouterContext<TEnv = any, TExt = any> = {
|
||||
env: TEnv
|
||||
req: RouterRequest<TExt>
|
||||
export type RouterContext<Env = any, CtxExt = {}, ReqExt = {}> = CtxExt & {
|
||||
env: Env
|
||||
req: RouterRequest<ReqExt>
|
||||
dbg: boolean
|
||||
ctx?: ExecutionContext
|
||||
}
|
||||
@@ -36,20 +36,24 @@ export type RouterContext<TEnv = any, TExt = any> = {
|
||||
* @property {RouterRequestParams} params Object containing all parameters defined in the url string
|
||||
* @property {RouterRequestQuery} query Object containing all query parameters
|
||||
* @property {Headers} headers Request headers object
|
||||
* @property {string | any} body Only available if method is `POST`, `PUT`, `PATCH` or `DELETE`. Contains either the received body string or a parsed object if valid JSON was sent.
|
||||
* @property {Request} raw Raw Request Object
|
||||
* @property {IncomingRequestCfProperties} [cf] object containing custom Cloudflare properties. (https://developers.cloudflare.com/workers/examples/accessing-the-cloudflare-object)
|
||||
*/
|
||||
export type RouterRequest<TExt> = {
|
||||
export type RouterRequest<ReqExt> = ReqExt & {
|
||||
url: string
|
||||
method: string
|
||||
params: RouterRequestParams
|
||||
query: RouterRequestQuery
|
||||
headers: Headers
|
||||
body: string | any
|
||||
raw: Request
|
||||
arrayBuffer(): Promise<ArrayBuffer>
|
||||
text(): Promise<string>
|
||||
json<T>(): Promise<T>
|
||||
formData(): Promise<FormData>
|
||||
blob(): Promise<Blob>
|
||||
bearer(): string | undefined
|
||||
cf?: IncomingRequestCfProperties
|
||||
bearer: () => string
|
||||
} & TExt
|
||||
}
|
||||
|
||||
/**
|
||||
* Request Parameters
|
||||
@@ -76,8 +80,8 @@ export type RouterRequestQuery = {
|
||||
* @param {RouterContext} ctx
|
||||
* @returns {Promise<Response | void> Response | void}
|
||||
*/
|
||||
export type RouterHandler<TEnv = any, TExt = any> = {
|
||||
(ctx: RouterContext<TEnv, TExt>): Promise<Response | void> | Response | void
|
||||
export type RouterHandler<Env = any, CtxExt = {}, ReqExt = {}> = {
|
||||
(ctx: RouterContext<Env, CtxExt, ReqExt>): Promise<Response | void> | Response | void
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -87,6 +91,8 @@ export type RouterHandler<TEnv = any, TExt = any> = {
|
||||
* @property {string} [allowOrigin="*"] Access-Control-Allow-Origin (default: `*`)
|
||||
* @property {string} [allowMethods="*"] Access-Control-Allow-Methods (default: `*`)
|
||||
* @property {string} [allowHeaders="*"] Access-Control-Allow-Headers (default: `*`)
|
||||
* @property {boolean} [allowCredentials="true"] Access-Control-Allow-Credentials (default: undefined)
|
||||
* @property {string} [vary="origin"] vary (default: undefined)
|
||||
* @property {number} [maxAge=86400] Access-Control-Max-Age (default: `86400`)
|
||||
* @property {number} [optionsSuccessStatus=204] Return status code for OPTIONS request (default: `204`)
|
||||
*/
|
||||
@@ -94,17 +100,27 @@ export type RouterCorsConfig = {
|
||||
allowOrigin?: string
|
||||
allowMethods?: string
|
||||
allowHeaders?: string
|
||||
allowCredentials?: boolean
|
||||
vary?: string
|
||||
maxAge?: number
|
||||
optionsSuccessStatus?: number
|
||||
}
|
||||
|
||||
export type RouterBuffer = {
|
||||
arrayBuffer?: ArrayBuffer
|
||||
text?: string
|
||||
json?: any
|
||||
formData?: FormData
|
||||
blob?: Blob
|
||||
}
|
||||
|
||||
/**
|
||||
* Router
|
||||
*
|
||||
* @public
|
||||
* @class
|
||||
*/
|
||||
export class Router<TEnv = any, TExt = any> {
|
||||
export class Router<Env = any, CtxExt = {}, ReqExt = {}> {
|
||||
|
||||
/**
|
||||
* Router Array
|
||||
@@ -112,7 +128,7 @@ export class Router<TEnv = any, TExt = any> {
|
||||
* @protected
|
||||
* @type {Route[]}
|
||||
*/
|
||||
protected routes: Route<TEnv, TExt>[] = []
|
||||
protected routes: Route<Env, CtxExt, ReqExt>[] = []
|
||||
|
||||
/**
|
||||
* Global Handlers
|
||||
@@ -120,7 +136,7 @@ export class Router<TEnv = any, TExt = any> {
|
||||
* @protected
|
||||
* @type {RouterHandler[]}
|
||||
*/
|
||||
protected globalHandlers: RouterHandler<TEnv, TExt>[] = []
|
||||
protected globalHandlers: RouterHandler<Env, CtxExt, ReqExt>[] = []
|
||||
|
||||
/**
|
||||
* Debug Mode
|
||||
@@ -152,24 +168,13 @@ export class Router<TEnv = any, TExt = any> {
|
||||
* @param {RouterHandler[]} handlers
|
||||
* @returns {Router}
|
||||
*/
|
||||
public use(...handlers: RouterHandler<TEnv, TExt>[]): Router<TEnv, TExt> {
|
||||
public use(...handlers: RouterHandler<Env, CtxExt, ReqExt>[]): Router<Env, CtxExt, ReqExt> {
|
||||
for (let handler of handlers) {
|
||||
this.globalHandlers.push(handler)
|
||||
}
|
||||
return this
|
||||
}
|
||||
|
||||
/**
|
||||
* Register CONNECT route
|
||||
*
|
||||
* @param {string} url
|
||||
* @param {RouterHandler[]} handlers
|
||||
* @returns {Router}
|
||||
*/
|
||||
public connect(url: string, ...handlers: RouterHandler<TEnv, TExt>[]): Router<TEnv, TExt> {
|
||||
return this.register('CONNECT', url, handlers)
|
||||
}
|
||||
|
||||
/**
|
||||
* Register DELETE route
|
||||
*
|
||||
@@ -177,7 +182,7 @@ export class Router<TEnv = any, TExt = any> {
|
||||
* @param {RouterHandler[]} handlers
|
||||
* @returns {Router}
|
||||
*/
|
||||
public delete(url: string, ...handlers: RouterHandler<TEnv, TExt>[]): Router<TEnv, TExt> {
|
||||
public delete(url: string, ...handlers: RouterHandler<Env, CtxExt, ReqExt>[]): Router<Env, CtxExt, ReqExt> {
|
||||
return this.register('DELETE', url, handlers)
|
||||
}
|
||||
|
||||
@@ -188,7 +193,7 @@ export class Router<TEnv = any, TExt = any> {
|
||||
* @param {RouterHandler[]} handlers
|
||||
* @returns {Router}
|
||||
*/
|
||||
public get(url: string, ...handlers: RouterHandler<TEnv, TExt>[]): Router<TEnv, TExt> {
|
||||
public get(url: string, ...handlers: RouterHandler<Env, CtxExt, ReqExt>[]): Router<Env, CtxExt, ReqExt> {
|
||||
return this.register('GET', url, handlers)
|
||||
}
|
||||
|
||||
@@ -199,7 +204,7 @@ export class Router<TEnv = any, TExt = any> {
|
||||
* @param {RouterHandler[]} handlers
|
||||
* @returns {Router}
|
||||
*/
|
||||
public head(url: string, ...handlers: RouterHandler<TEnv, TExt>[]): Router<TEnv, TExt> {
|
||||
public head(url: string, ...handlers: RouterHandler<Env, CtxExt, ReqExt>[]): Router<Env, CtxExt, ReqExt> {
|
||||
return this.register('HEAD', url, handlers)
|
||||
}
|
||||
|
||||
@@ -210,7 +215,7 @@ export class Router<TEnv = any, TExt = any> {
|
||||
* @param {RouterHandler[]} handlers
|
||||
* @returns {Router}
|
||||
*/
|
||||
public options(url: string, ...handlers: RouterHandler<TEnv, TExt>[]): Router<TEnv, TExt> {
|
||||
public options(url: string, ...handlers: RouterHandler<Env, CtxExt, ReqExt>[]): Router<Env, CtxExt, ReqExt> {
|
||||
return this.register('OPTIONS', url, handlers)
|
||||
}
|
||||
|
||||
@@ -221,7 +226,7 @@ export class Router<TEnv = any, TExt = any> {
|
||||
* @param {RouterHandler[]} handlers
|
||||
* @returns {Router}
|
||||
*/
|
||||
public patch(url: string, ...handlers: RouterHandler<TEnv, TExt>[]): Router<TEnv, TExt> {
|
||||
public patch(url: string, ...handlers: RouterHandler<Env, CtxExt, ReqExt>[]): Router<Env, CtxExt, ReqExt> {
|
||||
return this.register('PATCH', url, handlers)
|
||||
}
|
||||
|
||||
@@ -232,7 +237,7 @@ export class Router<TEnv = any, TExt = any> {
|
||||
* @param {RouterHandler[]} handlers
|
||||
* @returns {Router}
|
||||
*/
|
||||
public post(url: string, ...handlers: RouterHandler<TEnv, TExt>[]): Router<TEnv, TExt> {
|
||||
public post(url: string, ...handlers: RouterHandler<Env, CtxExt, ReqExt>[]): Router<Env, CtxExt, ReqExt> {
|
||||
return this.register('POST', url, handlers)
|
||||
}
|
||||
|
||||
@@ -243,21 +248,10 @@ export class Router<TEnv = any, TExt = any> {
|
||||
* @param {RouterHandler[]} handlers
|
||||
* @returns {Router}
|
||||
*/
|
||||
public put(url: string, ...handlers: RouterHandler<TEnv, TExt>[]): Router<TEnv, TExt> {
|
||||
public put(url: string, ...handlers: RouterHandler<Env, CtxExt, ReqExt>[]): Router<Env, CtxExt, ReqExt> {
|
||||
return this.register('PUT', url, handlers)
|
||||
}
|
||||
|
||||
/**
|
||||
* Register TRACE route
|
||||
*
|
||||
* @param {string} url
|
||||
* @param {RouterHandler[]} handlers
|
||||
* @returns {Router}
|
||||
*/
|
||||
public trace(url: string, ...handlers: RouterHandler<TEnv, TExt>[]): Router<TEnv, TExt> {
|
||||
return this.register('TRACE', url, handlers)
|
||||
}
|
||||
|
||||
/**
|
||||
* Register route, ignoring method
|
||||
*
|
||||
@@ -265,7 +259,7 @@ export class Router<TEnv = any, TExt = any> {
|
||||
* @param {RouterHandler[]} handlers
|
||||
* @returns {Router}
|
||||
*/
|
||||
public any(url: string, ...handlers: RouterHandler<TEnv, TExt>[]): Router<TEnv, TExt> {
|
||||
public any(url: string, ...handlers: RouterHandler<Env, CtxExt, ReqExt>[]): Router<Env, CtxExt, ReqExt> {
|
||||
return this.register('*', url, handlers)
|
||||
}
|
||||
|
||||
@@ -275,7 +269,7 @@ export class Router<TEnv = any, TExt = any> {
|
||||
* @param {boolean} [state=true] Whether to turn on or off debug mode (default: true)
|
||||
* @returns {Router}
|
||||
*/
|
||||
public debug(state: boolean = true): Router<TEnv, TExt> {
|
||||
public debug(state: boolean = true): Router<Env, CtxExt, ReqExt> {
|
||||
this.debugMode = state
|
||||
return this
|
||||
}
|
||||
@@ -286,12 +280,14 @@ export class Router<TEnv = any, TExt = any> {
|
||||
* @param {RouterCorsConfig} [config]
|
||||
* @returns {Router}
|
||||
*/
|
||||
public cors(config?: RouterCorsConfig): Router<TEnv, TExt> {
|
||||
public cors(config?: RouterCorsConfig): Router<Env, CtxExt, ReqExt> {
|
||||
this.corsEnabled = true
|
||||
this.corsConfig = {
|
||||
allowOrigin: config?.allowOrigin ?? '*',
|
||||
allowMethods: config?.allowMethods ?? '*',
|
||||
allowHeaders: config?.allowHeaders ?? '*',
|
||||
allowCredentials: config?.allowCredentials ?? undefined,
|
||||
vary: config?.vary ?? undefined,
|
||||
maxAge: config?.maxAge ?? 86400,
|
||||
optionsSuccessStatus: config?.optionsSuccessStatus ?? 204
|
||||
}
|
||||
@@ -305,6 +301,10 @@ export class Router<TEnv = any, TExt = any> {
|
||||
headers.set('Access-Control-Allow-Methods', this.corsConfig.allowMethods)
|
||||
if (this.corsConfig.allowHeaders && !headers.has('Access-Control-Allow-Headers'))
|
||||
headers.set('Access-Control-Allow-Headers', this.corsConfig.allowHeaders)
|
||||
if (this.corsConfig.allowCredentials && !headers.has('Access-Control-Allow-Credentials'))
|
||||
headers.set('Access-Control-Allow-Credentials', this.corsConfig.allowCredentials.toString())
|
||||
if (this.corsConfig.vary && !headers.has('vary'))
|
||||
headers.set('vary', this.corsConfig.vary.toString())
|
||||
if (this.corsConfig.maxAge && !headers.has('Access-Control-Max-Age'))
|
||||
headers.set('Access-Control-Max-Age', this.corsConfig.maxAge.toString())
|
||||
return headers
|
||||
@@ -319,7 +319,7 @@ export class Router<TEnv = any, TExt = any> {
|
||||
* @param {RouterHandler[]} handlers Arrar of handler functions
|
||||
* @returns {Router}
|
||||
*/
|
||||
private register(method: string, url: string, handlers: RouterHandler<TEnv, TExt>[]): Router<TEnv, TExt> {
|
||||
private register(method: string, url: string, handlers: RouterHandler<Env, CtxExt, ReqExt>[]): Router<Env, CtxExt, ReqExt> {
|
||||
this.routes.push({
|
||||
method,
|
||||
url,
|
||||
@@ -336,7 +336,7 @@ export class Router<TEnv = any, TExt = any> {
|
||||
* @param {RouterRequest} request
|
||||
* @returns {Route | undefined}
|
||||
*/
|
||||
private getRoute(request: RouterRequest<TExt>): Route<TEnv, TExt> | undefined {
|
||||
private getRoute(request: RouterRequest<ReqExt>): Route<Env, CtxExt, ReqExt> | undefined {
|
||||
const url = new URL(request.url)
|
||||
const pathArr = url.pathname.split('/').filter(i => i)
|
||||
|
||||
@@ -374,13 +374,15 @@ export class Router<TEnv = any, TExt = any> {
|
||||
* Handle requests
|
||||
*
|
||||
* @param {Request} request
|
||||
* @param {TEnv} env
|
||||
* @param {TExt} [ext]
|
||||
* @param {Env} env
|
||||
* @param {CtxExt} [ctxExt]
|
||||
* @param {ReqExt} [reqExt]
|
||||
* @returns {Promise<Response>}
|
||||
*/
|
||||
public async handle(request: Request, env: TEnv, ctx?: ExecutionContext, ext?: TExt): Promise<Response> {
|
||||
public async handle(request: Request, env: Env, ctx?: ExecutionContext, ctxExt?: CtxExt, reqExt?: ReqExt): Promise<Response> {
|
||||
const buffer: RouterBuffer = {}
|
||||
const req = {
|
||||
...(ext ?? {}),
|
||||
...(reqExt ?? {}),
|
||||
method: request.method,
|
||||
headers: request.headers,
|
||||
url: request.url,
|
||||
@@ -388,14 +390,13 @@ export class Router<TEnv = any, TExt = any> {
|
||||
raw: request,
|
||||
params: {},
|
||||
query: {},
|
||||
body: '',
|
||||
bearer: () => request.headers.get('Authorization')?.replace('Bearer ', '').trim() ?? '',
|
||||
} as RouterRequest<TExt>
|
||||
|
||||
const route = this.getRoute(req)
|
||||
|
||||
if (!route)
|
||||
return new Response(this.debugMode ? 'Route not found!' : null, { status: 404 })
|
||||
arrayBuffer: async (): Promise<ArrayBuffer> => buffer.arrayBuffer ? buffer.arrayBuffer : buffer.arrayBuffer = await request.clone().arrayBuffer(),
|
||||
text: async (): Promise<string> => buffer.text ? buffer.text : buffer.text = await request.clone().text(),
|
||||
json: async <T>(): Promise<T> => buffer.json ? buffer.json : buffer.json = await request.clone().json<T>(),
|
||||
formData: async (): Promise<FormData> => buffer.formData ? buffer.formData : buffer.formData = await request.clone().formData(),
|
||||
blob: async (): Promise<Blob> => buffer.blob ? buffer.blob : buffer.blob = await request.clone().blob(),
|
||||
bearer: () => request.headers.get('Authorization')?.replace(/^(B|b)earer /, '').trim()
|
||||
} as RouterRequest<ReqExt>
|
||||
|
||||
if (this.corsEnabled && req.method === 'OPTIONS') {
|
||||
return new Response(null, {
|
||||
@@ -404,13 +405,26 @@ export class Router<TEnv = any, TExt = any> {
|
||||
})
|
||||
}
|
||||
|
||||
const route = this.getRoute(req)
|
||||
|
||||
if (!route)
|
||||
return new Response(this.debugMode ? 'Route not found!' : null, { status: 404 })
|
||||
|
||||
const handlers = [...this.globalHandlers, ...route.handlers]
|
||||
const dbg = this.debugMode
|
||||
|
||||
let response: Response | undefined
|
||||
|
||||
for (const handler of handlers) {
|
||||
const res = await handler({ env, req, dbg, ctx })
|
||||
const context = {
|
||||
...(ctxExt ?? {}),
|
||||
env,
|
||||
req,
|
||||
dbg,
|
||||
ctx
|
||||
} as RouterContext<Env, CtxExt, ReqExt>
|
||||
|
||||
const res = await handler(context)
|
||||
|
||||
if (res) {
|
||||
response = res
|
||||
@@ -421,8 +435,10 @@ export class Router<TEnv = any, TExt = any> {
|
||||
if (!response)
|
||||
return new Response(this.debugMode ? 'Handler did not return a Response!' : null, { status: 404 })
|
||||
|
||||
if (this.corsEnabled)
|
||||
if (this.corsEnabled) {
|
||||
response = new Response(response.body, response)
|
||||
this.setCorsHeaders(response.headers)
|
||||
}
|
||||
|
||||
return response
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user