Compare commits
43 Commits
v3.1.0
...
d1c84cf6f6
| Author | SHA1 | Date | |
|---|---|---|---|
|
d1c84cf6f6
|
|||
|
ba67b34a0d
|
|||
|
2d5bdfe40e
|
|||
|
7bb935fa53
|
|||
|
49d5806d89
|
|||
|
73a0d4a4f9
|
|||
|
24a85e9814
|
|||
|
dfdc50ba8a
|
|||
|
67bba2a339
|
|||
|
c21e91bcb6
|
|||
|
fe2f8ec227
|
|||
|
0e78ec4787
|
|||
|
fd7dce7256
|
|||
|
1d72a15ca6
|
|||
|
a740f1b103
|
|||
|
21dc38b676
|
|||
|
9df19a50cd
|
|||
|
7dce99214d
|
|||
|
5aedc0248d
|
|||
|
3aecc4ca5f
|
|||
|
e04bcfb395
|
|||
|
f2ba5f5bc5
|
|||
|
306c046adb
|
|||
|
2dab64be19
|
|||
|
175deddc9c
|
|||
|
ff638ad04f
|
|||
|
b118c28dc7
|
|||
|
9451f466fc
|
|||
|
71fcd6c3c0
|
|||
|
e55392d890
|
|||
|
3aaecd8877
|
|||
|
d8d13c4339
|
|||
|
09d5586cc6
|
|||
|
110bfdd95c
|
|||
|
c68a979614
|
|||
|
a4fd646d6b
|
|||
|
606d5f1cb2
|
|||
|
95ccb2263a
|
|||
|
dc88d900cb
|
|||
|
0dca90f4f9
|
|||
|
cb8724edc4
|
|||
|
08c329ff20
|
|||
|
e9a0a2436d
|
@@ -7,3 +7,11 @@ insert_final_newline = false
|
|||||||
[src/**.ts]
|
[src/**.ts]
|
||||||
charset = utf-8
|
charset = utf-8
|
||||||
indent_style = tab
|
indent_style = tab
|
||||||
|
|
||||||
|
[README.md]
|
||||||
|
indent_style = space
|
||||||
|
indent_size = 4
|
||||||
|
|
||||||
|
[{package,package-lock}.json]
|
||||||
|
indent_style = space
|
||||||
|
indent_size = 2
|
||||||
@@ -1,8 +1,9 @@
|
|||||||
name: Publish (main)
|
name: Publish
|
||||||
|
run-name: Publish ${{ github.ref_name }}
|
||||||
|
|
||||||
on:
|
on:
|
||||||
release:
|
release:
|
||||||
types: [published]
|
types: [ published ]
|
||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
publish:
|
publish:
|
||||||
@@ -13,19 +14,27 @@ jobs:
|
|||||||
with:
|
with:
|
||||||
node-version: latest
|
node-version: latest
|
||||||
registry-url: https://registry.npmjs.org/
|
registry-url: https://registry.npmjs.org/
|
||||||
|
|
||||||
- name: Install dependencies
|
- name: Install dependencies
|
||||||
run: npm ci
|
run: npm ci
|
||||||
|
|
||||||
|
- name: Run tests
|
||||||
|
run: npm test
|
||||||
|
|
||||||
- name: Build
|
- name: Build
|
||||||
run: npm run build
|
run: npm run build
|
||||||
|
|
||||||
- name: Publish to npmjs
|
- name: Publish to npmjs
|
||||||
env:
|
env:
|
||||||
NODE_AUTH_TOKEN: ${{secrets.NPM_TOKEN}}
|
NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
|
||||||
run: npm publish --tag latest --access public
|
run: npm publish --tag ${{ contains(github.ref_name, '-') && 'pre' || 'latest' }} --access public
|
||||||
|
|
||||||
- uses: actions/setup-node@v3
|
- uses: actions/setup-node@v3
|
||||||
with:
|
with:
|
||||||
node-version: latest
|
node-version: latest
|
||||||
registry-url: https://npm.pkg.github.com/
|
registry-url: https://npm.pkg.github.com/
|
||||||
|
|
||||||
- name: Publish to GPR
|
- name: Publish to GPR
|
||||||
env:
|
env:
|
||||||
NODE_AUTH_TOKEN: ${{secrets.GITHUB_TOKEN}}
|
NODE_AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||||
run: npm publish --tag latest --access public
|
run: npm publish --tag ${{ contains(github.ref_name, '-') && 'pre' || 'latest' }} --access public
|
||||||
31
.github/workflows/release.yml
vendored
Normal file
31
.github/workflows/release.yml
vendored
Normal file
@@ -0,0 +1,31 @@
|
|||||||
|
name: Release
|
||||||
|
run-name: Release ${{ github.ref_name }}
|
||||||
|
|
||||||
|
on:
|
||||||
|
push:
|
||||||
|
tags:
|
||||||
|
- 'v*'
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
release:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v3
|
||||||
|
- uses: actions/setup-node@v3
|
||||||
|
with:
|
||||||
|
node-version: latest
|
||||||
|
registry-url: https://registry.npmjs.org/
|
||||||
|
|
||||||
|
- name: Install dependencies
|
||||||
|
run: npm ci
|
||||||
|
|
||||||
|
- name: Run tests
|
||||||
|
run: npm test
|
||||||
|
|
||||||
|
- name: Build
|
||||||
|
run: npm run build
|
||||||
|
|
||||||
|
- name: Create release
|
||||||
|
run: gh release create ${{ github.ref_name }} --draft --generate-notes ${{ contains(github.ref_name, '-') && '--prerelease --latest=false' || '--latest' }}
|
||||||
|
env:
|
||||||
|
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||||
26
.github/workflows/test.yml
vendored
Normal file
26
.github/workflows/test.yml
vendored
Normal file
@@ -0,0 +1,26 @@
|
|||||||
|
name: Test
|
||||||
|
|
||||||
|
on:
|
||||||
|
push:
|
||||||
|
branches: [ main ]
|
||||||
|
pull_request:
|
||||||
|
branches: [ main ]
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
run:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v3
|
||||||
|
- uses: actions/setup-node@v3
|
||||||
|
with:
|
||||||
|
node-version: latest
|
||||||
|
registry-url: https://registry.npmjs.org/
|
||||||
|
|
||||||
|
- name: Install dependencies
|
||||||
|
run: npm ci
|
||||||
|
|
||||||
|
- name: Run tests
|
||||||
|
run: npm test
|
||||||
|
|
||||||
|
- name: Build
|
||||||
|
run: npm run build
|
||||||
15
.npmignore
15
.npmignore
@@ -1,7 +1,10 @@
|
|||||||
.github/
|
|
||||||
src/
|
|
||||||
test/
|
|
||||||
.nvmrc
|
|
||||||
MIGRATION.md
|
|
||||||
tsconfig.json
|
|
||||||
.editorconfig
|
.editorconfig
|
||||||
|
.github/
|
||||||
|
.gitignore
|
||||||
|
.nvmrc
|
||||||
|
coverage/
|
||||||
|
jest.config.ts
|
||||||
|
MIGRATION.md
|
||||||
|
src/
|
||||||
|
tests/
|
||||||
|
tsconfig.json
|
||||||
84
README.md
84
README.md
@@ -4,8 +4,6 @@ Cloudflare Workers Router is a super lightweight router (1.0K gzipped) with midd
|
|||||||
|
|
||||||
When I was trying out Cloudflare Workers I almost immediately noticed how fast it was compared to other serverless offerings. So I wanted to build a full-fledged API to see how it performs doing real work, but since I wasn't able to find a router that suited my needs I created my own.
|
When I was trying out Cloudflare Workers I almost immediately noticed how fast it was compared to other serverless offerings. So I wanted to build a full-fledged API to see how it performs doing real work, but since I wasn't able to find a router that suited my needs I created my own.
|
||||||
|
|
||||||
I worked a lot with [Express.js](https://expressjs.com/) in the past and really enjoyed their middleware approach, but since none of the available Cloudflare Worker routers offered middleware support at the time, I felt the need to create this router.
|
|
||||||
|
|
||||||
|
|
||||||
## Contents
|
## Contents
|
||||||
|
|
||||||
@@ -20,8 +18,9 @@ I worked a lot with [Express.js](https://expressjs.com/) in the past and really
|
|||||||
- ZERO dependencies
|
- ZERO dependencies
|
||||||
- Lightweight (1.0K gzipped)
|
- Lightweight (1.0K gzipped)
|
||||||
- Fully written in TypeScript
|
- Fully written in TypeScript
|
||||||
- Integrated Debug-Mode & CORS helper
|
|
||||||
- Built specifically around Middlewares
|
- Built specifically around Middlewares
|
||||||
|
- Debug-Mode, CORS and Bearer helpers
|
||||||
|
- Allows accessing request body multiple times
|
||||||
|
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
@@ -33,6 +32,10 @@ Migrating from `v2.x.x`, check out the [Migration Guide](MIGRATION.md).
|
|||||||
```typescript
|
```typescript
|
||||||
import { Router } from '@tsndr/cloudflare-worker-router'
|
import { Router } from '@tsndr/cloudflare-worker-router'
|
||||||
|
|
||||||
|
// Env Types
|
||||||
|
export type Var<T = string> = T
|
||||||
|
export type Secret<T = string> = T
|
||||||
|
|
||||||
export type Env = {
|
export type Env = {
|
||||||
// Example binding to KV. Learn more at https://developers.cloudflare.com/workers/runtime-apis/kv/
|
// Example binding to KV. Learn more at https://developers.cloudflare.com/workers/runtime-apis/kv/
|
||||||
// MY_KV_NAMESPACE: KVNamespace
|
// MY_KV_NAMESPACE: KVNamespace
|
||||||
@@ -43,11 +46,23 @@ export type Env = {
|
|||||||
// Example binding to R2. Learn more at https://developers.cloudflare.com/workers/runtime-apis/r2/
|
// Example binding to R2. Learn more at https://developers.cloudflare.com/workers/runtime-apis/r2/
|
||||||
// MY_BUCKET: R2Bucket
|
// MY_BUCKET: R2Bucket
|
||||||
|
|
||||||
SECRET_TOKEN: string
|
ENVIRONMENT: Var<'dev' | 'prod'>
|
||||||
|
|
||||||
|
SECRET_TOKEN: Secret
|
||||||
}
|
}
|
||||||
|
|
||||||
// Initialize router
|
// Request Extension
|
||||||
const router = new Router<Env>()
|
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
|
// Enabling build in CORS support
|
||||||
router.cors()
|
router.cors()
|
||||||
@@ -224,7 +239,6 @@ Key | Type | Default Value
|
|||||||
### Supported Methods
|
### Supported Methods
|
||||||
|
|
||||||
- `router.any(url, [...handlers])`
|
- `router.any(url, [...handlers])`
|
||||||
- `router.connect(url, [...handlers])`
|
|
||||||
- `router.delete(url, [...handlers])`
|
- `router.delete(url, [...handlers])`
|
||||||
- `router.get(url, [...handlers])`
|
- `router.get(url, [...handlers])`
|
||||||
- `router.head(url, [...handlers])`
|
- `router.head(url, [...handlers])`
|
||||||
@@ -232,7 +246,6 @@ Key | Type | Default Value
|
|||||||
- `router.patch(url, [...handlers])`
|
- `router.patch(url, [...handlers])`
|
||||||
- `router.post(url, [...handlers])`
|
- `router.post(url, [...handlers])`
|
||||||
- `router.put(url, [...handlers])`
|
- `router.put(url, [...handlers])`
|
||||||
- `router.trace(url, [...handlers])`
|
|
||||||
|
|
||||||
|
|
||||||
#### `url` (string)
|
#### `url` (string)
|
||||||
@@ -280,7 +293,7 @@ wrangler init <name>
|
|||||||
Use of TypeScript is strongly encouraged :)
|
Use of TypeScript is strongly encouraged :)
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
npm i -D @tsndr/cloudflare-worker-router
|
npm i @tsndr/cloudflare-worker-router
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
||||||
@@ -289,6 +302,10 @@ npm i -D @tsndr/cloudflare-worker-router
|
|||||||
```typescript
|
```typescript
|
||||||
import { Router } from '@tsndr/cloudflare-worker-router'
|
import { Router } from '@tsndr/cloudflare-worker-router'
|
||||||
|
|
||||||
|
// Env Types
|
||||||
|
export type Var<T = string> = T
|
||||||
|
export type Secret<T = string> = T
|
||||||
|
|
||||||
export type Env = {
|
export type Env = {
|
||||||
// Example binding to KV. Learn more at https://developers.cloudflare.com/workers/runtime-apis/kv/
|
// Example binding to KV. Learn more at https://developers.cloudflare.com/workers/runtime-apis/kv/
|
||||||
// MY_KV_NAMESPACE: KVNamespace
|
// MY_KV_NAMESPACE: KVNamespace
|
||||||
@@ -298,32 +315,57 @@ export type Env = {
|
|||||||
//
|
//
|
||||||
// Example binding to R2. Learn more at https://developers.cloudflare.com/workers/runtime-apis/r2/
|
// Example binding to R2. Learn more at https://developers.cloudflare.com/workers/runtime-apis/r2/
|
||||||
// MY_BUCKET: R2Bucket
|
// 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
|
/// Example Route
|
||||||
//
|
//
|
||||||
// router.get('/hi', async () => {
|
// router.get('/hi', async () => {
|
||||||
// return new Response('Hello World')
|
// return new Response('Hello World')
|
||||||
//})
|
// })
|
||||||
|
|
||||||
|
|
||||||
/// Example Route for splitting into multiple files
|
/// Example Route for splitting into multiple files
|
||||||
//
|
//
|
||||||
// const hiHandler: RouteHandler<Env> = async () => {
|
// const helloHandler: Handler = async () => {
|
||||||
// return new Response('Hello World')
|
// return new Response('Hello World')
|
||||||
// }
|
// }
|
||||||
//
|
//
|
||||||
// router.get('/hi', hiHandler)
|
// router.get('/hellow', helloHandler)
|
||||||
|
|
||||||
|
|
||||||
// TODO: add your routes here
|
// TODO: add your routes here
|
||||||
|
|
||||||
export default {
|
export default {
|
||||||
async fetch(request: Request, env: Env, ctx: ExecutionContext) {
|
async fetch(request: Request, env: Env, ctx: ExecutionContext) {
|
||||||
return router.handle(request, env, ctx)
|
return router.handle(request, env, ctx)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
@@ -338,6 +380,12 @@ import { Router } from '@tsndr/cloudflare-worker-router'
|
|||||||
|
|
||||||
const router = new Router()
|
const router = new Router()
|
||||||
|
|
||||||
|
// Enable Debug Mode
|
||||||
|
//router.debug()
|
||||||
|
|
||||||
|
// Enabling build in CORS support
|
||||||
|
//router.cors()
|
||||||
|
|
||||||
/// Example Route
|
/// Example Route
|
||||||
//
|
//
|
||||||
// router.get('/hi', async () => {
|
// router.get('/hi', async () => {
|
||||||
|
|||||||
1301
package-lock.json
generated
1301
package-lock.json
generated
File diff suppressed because it is too large
Load Diff
17
package.json
17
package.json
@@ -1,22 +1,23 @@
|
|||||||
{
|
{
|
||||||
"name": "@tsndr/cloudflare-worker-router",
|
"name": "@tsndr/cloudflare-worker-router",
|
||||||
"version": "3.1.0",
|
"version": "3.2.10",
|
||||||
"description": "",
|
"description": "",
|
||||||
"main": "index.js",
|
"type": "module",
|
||||||
|
"exports": "./index.js",
|
||||||
"types": "index.d.ts",
|
"types": "index.d.ts",
|
||||||
"scripts": {
|
"scripts": {
|
||||||
"build": "tsc"
|
"build": "tsc",
|
||||||
|
"test": "vitest"
|
||||||
},
|
},
|
||||||
"repository": {
|
"repository": {
|
||||||
"type": "git",
|
"type": "git",
|
||||||
"url": "git+https://github.com/tsndr/cloudflare-worker-router.git"
|
"url": "git+https://github.com/tsndr/cloudflare-worker-router.git"
|
||||||
},
|
},
|
||||||
"keywords": [
|
"keywords": [
|
||||||
|
"api",
|
||||||
"cloudflare",
|
"cloudflare",
|
||||||
"cloudflare-worker",
|
"cloudflare-worker",
|
||||||
"cloudflare-workers",
|
"cloudflare-workers",
|
||||||
"express",
|
|
||||||
"expressjs",
|
|
||||||
"framework",
|
"framework",
|
||||||
"middleware",
|
"middleware",
|
||||||
"router",
|
"router",
|
||||||
@@ -31,7 +32,9 @@
|
|||||||
},
|
},
|
||||||
"homepage": "https://github.com/tsndr/cloudflare-worker-router#readme",
|
"homepage": "https://github.com/tsndr/cloudflare-worker-router#readme",
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"@cloudflare/workers-types": "^4.20230814.0",
|
"@cloudflare/workers-types": "^4.20241022.0",
|
||||||
"typescript": "^5.1.6"
|
"@edge-runtime/vm": "^4.0.3",
|
||||||
|
"typescript": "^5.6.3",
|
||||||
|
"vitest": "^2.1.3"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
139
src/index.ts
139
src/index.ts
@@ -6,10 +6,10 @@
|
|||||||
* @property {string} url URL String
|
* @property {string} url URL String
|
||||||
* @property {RouterHandler[]} handlers Array of handler functions
|
* @property {RouterHandler[]} handlers Array of handler functions
|
||||||
*/
|
*/
|
||||||
export type Route<TEnv, TCtx, TReq> = {
|
export type Route<Env, CtxExt, ReqExt> = {
|
||||||
method: string
|
method: string
|
||||||
url: string
|
url: string
|
||||||
handlers: RouterHandler<TEnv, TCtx, TReq>[]
|
handlers: RouterHandler<Env, CtxExt, ReqExt>[]
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -20,9 +20,9 @@ export type Route<TEnv, TCtx, TReq> = {
|
|||||||
* @property {RouterRequest} req Request Object
|
* @property {RouterRequest} req Request Object
|
||||||
* @property {ExecutionContext} ctx Context Object
|
* @property {ExecutionContext} ctx Context Object
|
||||||
*/
|
*/
|
||||||
export type RouterContext<TEnv = any, TCtx = any, TReq = any> = TCtx & {
|
export type RouterContext<Env = any, CtxExt = {}, ReqExt = {}> = CtxExt & {
|
||||||
env: TEnv
|
env: Env
|
||||||
req: RouterRequest<TReq>
|
req: RouterRequest<ReqExt>
|
||||||
dbg: boolean
|
dbg: boolean
|
||||||
ctx?: ExecutionContext
|
ctx?: ExecutionContext
|
||||||
}
|
}
|
||||||
@@ -39,7 +39,7 @@ export type RouterContext<TEnv = any, TCtx = any, TReq = any> = TCtx & {
|
|||||||
* @property {Request} raw Raw Request Object
|
* @property {Request} raw Raw Request Object
|
||||||
* @property {IncomingRequestCfProperties} [cf] object containing custom Cloudflare properties. (https://developers.cloudflare.com/workers/examples/accessing-the-cloudflare-object)
|
* @property {IncomingRequestCfProperties} [cf] object containing custom Cloudflare properties. (https://developers.cloudflare.com/workers/examples/accessing-the-cloudflare-object)
|
||||||
*/
|
*/
|
||||||
export type RouterRequest<TReq> = TReq & {
|
export type RouterRequest<ReqExt> = ReqExt & {
|
||||||
url: string
|
url: string
|
||||||
method: string
|
method: string
|
||||||
params: RouterRequestParams
|
params: RouterRequestParams
|
||||||
@@ -51,7 +51,7 @@ export type RouterRequest<TReq> = TReq & {
|
|||||||
json<T>(): Promise<T>
|
json<T>(): Promise<T>
|
||||||
formData(): Promise<FormData>
|
formData(): Promise<FormData>
|
||||||
blob(): Promise<Blob>
|
blob(): Promise<Blob>
|
||||||
bearer: () => string | undefined
|
bearer(): string | undefined
|
||||||
cf?: IncomingRequestCfProperties
|
cf?: IncomingRequestCfProperties
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -80,8 +80,8 @@ export type RouterRequestQuery = {
|
|||||||
* @param {RouterContext} ctx
|
* @param {RouterContext} ctx
|
||||||
* @returns {Promise<Response | void> Response | void}
|
* @returns {Promise<Response | void> Response | void}
|
||||||
*/
|
*/
|
||||||
export type RouterHandler<TEnv = any, TCtx = any, TReq = any> = {
|
export type RouterHandler<Env = any, CtxExt = {}, ReqExt = {}> = {
|
||||||
(ctx: RouterContext<TEnv, TCtx, TReq>): Promise<Response | void> | Response | void
|
(ctx: RouterContext<Env, CtxExt, ReqExt>): Promise<Response | void> | Response | void
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -120,7 +120,7 @@ export type RouterBuffer = {
|
|||||||
* @public
|
* @public
|
||||||
* @class
|
* @class
|
||||||
*/
|
*/
|
||||||
export class Router<TEnv = any, TCtx = any, TReq = any> {
|
export class Router<Env = any, CtxExt = {}, ReqExt = {}> {
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Router Array
|
* Router Array
|
||||||
@@ -128,7 +128,7 @@ export class Router<TEnv = any, TCtx = any, TReq = any> {
|
|||||||
* @protected
|
* @protected
|
||||||
* @type {Route[]}
|
* @type {Route[]}
|
||||||
*/
|
*/
|
||||||
protected routes: Route<TEnv, TCtx, TReq>[] = []
|
protected routes: Route<Env, CtxExt, ReqExt>[] = []
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Global Handlers
|
* Global Handlers
|
||||||
@@ -136,7 +136,7 @@ export class Router<TEnv = any, TCtx = any, TReq = any> {
|
|||||||
* @protected
|
* @protected
|
||||||
* @type {RouterHandler[]}
|
* @type {RouterHandler[]}
|
||||||
*/
|
*/
|
||||||
protected globalHandlers: RouterHandler<TEnv, TCtx, TReq>[] = []
|
protected globalHandlers: RouterHandler<Env, CtxExt, ReqExt>[] = []
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Debug Mode
|
* Debug Mode
|
||||||
@@ -168,24 +168,13 @@ export class Router<TEnv = any, TCtx = any, TReq = any> {
|
|||||||
* @param {RouterHandler[]} handlers
|
* @param {RouterHandler[]} handlers
|
||||||
* @returns {Router}
|
* @returns {Router}
|
||||||
*/
|
*/
|
||||||
public use(...handlers: RouterHandler<TEnv, TCtx, TReq>[]): Router<TEnv, TCtx, TReq> {
|
public use(...handlers: RouterHandler<Env, CtxExt, ReqExt>[]): Router<Env, CtxExt, ReqExt> {
|
||||||
for (let handler of handlers) {
|
for (let handler of handlers) {
|
||||||
this.globalHandlers.push(handler)
|
this.globalHandlers.push(handler)
|
||||||
}
|
}
|
||||||
return this
|
return this
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
|
||||||
* Register CONNECT route
|
|
||||||
*
|
|
||||||
* @param {string} url
|
|
||||||
* @param {RouterHandler[]} handlers
|
|
||||||
* @returns {Router}
|
|
||||||
*/
|
|
||||||
public connect(url: string, ...handlers: RouterHandler<TEnv, TCtx, TReq>[]): Router<TEnv, TCtx, TReq> {
|
|
||||||
return this.register('CONNECT', url, handlers)
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Register DELETE route
|
* Register DELETE route
|
||||||
*
|
*
|
||||||
@@ -193,7 +182,7 @@ export class Router<TEnv = any, TCtx = any, TReq = any> {
|
|||||||
* @param {RouterHandler[]} handlers
|
* @param {RouterHandler[]} handlers
|
||||||
* @returns {Router}
|
* @returns {Router}
|
||||||
*/
|
*/
|
||||||
public delete(url: string, ...handlers: RouterHandler<TEnv, TCtx, TReq>[]): Router<TEnv, TCtx, TReq> {
|
public delete(url: string, ...handlers: RouterHandler<Env, CtxExt, ReqExt>[]): Router<Env, CtxExt, ReqExt> {
|
||||||
return this.register('DELETE', url, handlers)
|
return this.register('DELETE', url, handlers)
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -204,7 +193,7 @@ export class Router<TEnv = any, TCtx = any, TReq = any> {
|
|||||||
* @param {RouterHandler[]} handlers
|
* @param {RouterHandler[]} handlers
|
||||||
* @returns {Router}
|
* @returns {Router}
|
||||||
*/
|
*/
|
||||||
public get(url: string, ...handlers: RouterHandler<TEnv, TCtx, TReq>[]): Router<TEnv, TCtx, TReq> {
|
public get(url: string, ...handlers: RouterHandler<Env, CtxExt, ReqExt>[]): Router<Env, CtxExt, ReqExt> {
|
||||||
return this.register('GET', url, handlers)
|
return this.register('GET', url, handlers)
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -215,7 +204,7 @@ export class Router<TEnv = any, TCtx = any, TReq = any> {
|
|||||||
* @param {RouterHandler[]} handlers
|
* @param {RouterHandler[]} handlers
|
||||||
* @returns {Router}
|
* @returns {Router}
|
||||||
*/
|
*/
|
||||||
public head(url: string, ...handlers: RouterHandler<TEnv, TCtx, TReq>[]): Router<TEnv, TCtx, TReq> {
|
public head(url: string, ...handlers: RouterHandler<Env, CtxExt, ReqExt>[]): Router<Env, CtxExt, ReqExt> {
|
||||||
return this.register('HEAD', url, handlers)
|
return this.register('HEAD', url, handlers)
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -226,7 +215,7 @@ export class Router<TEnv = any, TCtx = any, TReq = any> {
|
|||||||
* @param {RouterHandler[]} handlers
|
* @param {RouterHandler[]} handlers
|
||||||
* @returns {Router}
|
* @returns {Router}
|
||||||
*/
|
*/
|
||||||
public options(url: string, ...handlers: RouterHandler<TEnv, TCtx, TReq>[]): Router<TEnv, TCtx, TReq> {
|
public options(url: string, ...handlers: RouterHandler<Env, CtxExt, ReqExt>[]): Router<Env, CtxExt, ReqExt> {
|
||||||
return this.register('OPTIONS', url, handlers)
|
return this.register('OPTIONS', url, handlers)
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -237,7 +226,7 @@ export class Router<TEnv = any, TCtx = any, TReq = any> {
|
|||||||
* @param {RouterHandler[]} handlers
|
* @param {RouterHandler[]} handlers
|
||||||
* @returns {Router}
|
* @returns {Router}
|
||||||
*/
|
*/
|
||||||
public patch(url: string, ...handlers: RouterHandler<TEnv, TCtx, TReq>[]): Router<TEnv, TCtx, TReq> {
|
public patch(url: string, ...handlers: RouterHandler<Env, CtxExt, ReqExt>[]): Router<Env, CtxExt, ReqExt> {
|
||||||
return this.register('PATCH', url, handlers)
|
return this.register('PATCH', url, handlers)
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -248,7 +237,7 @@ export class Router<TEnv = any, TCtx = any, TReq = any> {
|
|||||||
* @param {RouterHandler[]} handlers
|
* @param {RouterHandler[]} handlers
|
||||||
* @returns {Router}
|
* @returns {Router}
|
||||||
*/
|
*/
|
||||||
public post(url: string, ...handlers: RouterHandler<TEnv, TCtx, TReq>[]): Router<TEnv, TCtx, TReq> {
|
public post(url: string, ...handlers: RouterHandler<Env, CtxExt, ReqExt>[]): Router<Env, CtxExt, ReqExt> {
|
||||||
return this.register('POST', url, handlers)
|
return this.register('POST', url, handlers)
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -259,21 +248,10 @@ export class Router<TEnv = any, TCtx = any, TReq = any> {
|
|||||||
* @param {RouterHandler[]} handlers
|
* @param {RouterHandler[]} handlers
|
||||||
* @returns {Router}
|
* @returns {Router}
|
||||||
*/
|
*/
|
||||||
public put(url: string, ...handlers: RouterHandler<TEnv, TCtx, TReq>[]): Router<TEnv, TCtx, TReq> {
|
public put(url: string, ...handlers: RouterHandler<Env, CtxExt, ReqExt>[]): Router<Env, CtxExt, ReqExt> {
|
||||||
return this.register('PUT', url, handlers)
|
return this.register('PUT', url, handlers)
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
|
||||||
* Register TRACE route
|
|
||||||
*
|
|
||||||
* @param {string} url
|
|
||||||
* @param {RouterHandler[]} handlers
|
|
||||||
* @returns {Router}
|
|
||||||
*/
|
|
||||||
public trace(url: string, ...handlers: RouterHandler<TEnv, TCtx, TReq>[]): Router<TEnv, TCtx, TReq> {
|
|
||||||
return this.register('TRACE', url, handlers)
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Register route, ignoring method
|
* Register route, ignoring method
|
||||||
*
|
*
|
||||||
@@ -281,7 +259,7 @@ export class Router<TEnv = any, TCtx = any, TReq = any> {
|
|||||||
* @param {RouterHandler[]} handlers
|
* @param {RouterHandler[]} handlers
|
||||||
* @returns {Router}
|
* @returns {Router}
|
||||||
*/
|
*/
|
||||||
public any(url: string, ...handlers: RouterHandler<TEnv, TCtx, TReq>[]): Router<TEnv, TCtx, TReq> {
|
public any(url: string, ...handlers: RouterHandler<Env, CtxExt, ReqExt>[]): Router<Env, CtxExt, ReqExt> {
|
||||||
return this.register('*', url, handlers)
|
return this.register('*', url, handlers)
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -291,7 +269,7 @@ export class Router<TEnv = any, TCtx = any, TReq = any> {
|
|||||||
* @param {boolean} [state=true] Whether to turn on or off debug mode (default: true)
|
* @param {boolean} [state=true] Whether to turn on or off debug mode (default: true)
|
||||||
* @returns {Router}
|
* @returns {Router}
|
||||||
*/
|
*/
|
||||||
public debug(state: boolean = true): Router<TEnv, TCtx, TReq> {
|
public debug(state: boolean = true): Router<Env, CtxExt, ReqExt> {
|
||||||
this.debugMode = state
|
this.debugMode = state
|
||||||
return this
|
return this
|
||||||
}
|
}
|
||||||
@@ -302,7 +280,7 @@ export class Router<TEnv = any, TCtx = any, TReq = any> {
|
|||||||
* @param {RouterCorsConfig} [config]
|
* @param {RouterCorsConfig} [config]
|
||||||
* @returns {Router}
|
* @returns {Router}
|
||||||
*/
|
*/
|
||||||
public cors(config?: RouterCorsConfig): Router<TEnv, TCtx, TReq> {
|
public cors(config?: RouterCorsConfig): Router<Env, CtxExt, ReqExt> {
|
||||||
this.corsEnabled = true
|
this.corsEnabled = true
|
||||||
this.corsConfig = {
|
this.corsConfig = {
|
||||||
allowOrigin: config?.allowOrigin ?? '*',
|
allowOrigin: config?.allowOrigin ?? '*',
|
||||||
@@ -341,7 +319,7 @@ export class Router<TEnv = any, TCtx = any, TReq = any> {
|
|||||||
* @param {RouterHandler[]} handlers Arrar of handler functions
|
* @param {RouterHandler[]} handlers Arrar of handler functions
|
||||||
* @returns {Router}
|
* @returns {Router}
|
||||||
*/
|
*/
|
||||||
private register(method: string, url: string, handlers: RouterHandler<TEnv, TCtx, TReq>[]): Router<TEnv, TCtx, TReq> {
|
private register(method: string, url: string, handlers: RouterHandler<Env, CtxExt, ReqExt>[]): Router<Env, CtxExt, ReqExt> {
|
||||||
this.routes.push({
|
this.routes.push({
|
||||||
method,
|
method,
|
||||||
url,
|
url,
|
||||||
@@ -358,7 +336,7 @@ export class Router<TEnv = any, TCtx = any, TReq = any> {
|
|||||||
* @param {RouterRequest} request
|
* @param {RouterRequest} request
|
||||||
* @returns {Route | undefined}
|
* @returns {Route | undefined}
|
||||||
*/
|
*/
|
||||||
private getRoute(request: RouterRequest<TReq>): Route<TEnv, TCtx, TReq> | undefined {
|
private getRoute(request: RouterRequest<ReqExt>): Route<Env, CtxExt, ReqExt> | undefined {
|
||||||
const url = new URL(request.url)
|
const url = new URL(request.url)
|
||||||
const pathArr = url.pathname.split('/').filter(i => i)
|
const pathArr = url.pathname.split('/').filter(i => i)
|
||||||
|
|
||||||
@@ -396,15 +374,15 @@ export class Router<TEnv = any, TCtx = any, TReq = any> {
|
|||||||
* Handle requests
|
* Handle requests
|
||||||
*
|
*
|
||||||
* @param {Request} request
|
* @param {Request} request
|
||||||
* @param {TEnv} env
|
* @param {Env} env
|
||||||
* @param {TCtx} [extCtx]
|
* @param {CtxExt} [ctxExt]
|
||||||
* @param {TReq} [extReq]
|
* @param {ReqExt} [reqExt]
|
||||||
* @returns {Promise<Response>}
|
* @returns {Promise<Response>}
|
||||||
*/
|
*/
|
||||||
public async handle(request: Request, env: TEnv, ctx?: ExecutionContext, extCtx?: TCtx, extReq?: TReq): Promise<Response> {
|
public async handle(request: Request, env: Env, ctx?: ExecutionContext, ctxExt?: CtxExt, reqExt?: ReqExt): Promise<Response> {
|
||||||
const buffer: RouterBuffer = {};
|
const buffer: RouterBuffer = {}
|
||||||
const req = {
|
const req = {
|
||||||
...(extReq ?? {}),
|
...(reqExt ?? {}),
|
||||||
method: request.method,
|
method: request.method,
|
||||||
headers: request.headers,
|
headers: request.headers,
|
||||||
url: request.url,
|
url: request.url,
|
||||||
@@ -412,13 +390,13 @@ export class Router<TEnv = any, TCtx = any, TReq = any> {
|
|||||||
raw: request,
|
raw: request,
|
||||||
params: {},
|
params: {},
|
||||||
query: {},
|
query: {},
|
||||||
arrayBuffer: async (): Promise<ArrayBuffer> => buffer.arrayBuffer ? buffer.arrayBuffer : buffer.arrayBuffer = await request.arrayBuffer(),
|
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.text(),
|
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.json<T>(),
|
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.formData(),
|
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.blob(),
|
blob: async (): Promise<Blob> => buffer.blob ? buffer.blob : buffer.blob = await request.clone().blob(),
|
||||||
bearer: () => request.headers.get('Authorization')?.replace(/^(B|b)earer /, '').trim()
|
bearer: () => request.headers.get('Authorization')?.replace(/^(B|b)earer /, '').trim()
|
||||||
} as RouterRequest<TReq>
|
} as RouterRequest<ReqExt>
|
||||||
|
|
||||||
if (this.corsEnabled && req.method === 'OPTIONS') {
|
if (this.corsEnabled && req.method === 'OPTIONS') {
|
||||||
return new Response(null, {
|
return new Response(null, {
|
||||||
@@ -428,34 +406,37 @@ export class Router<TEnv = any, TCtx = any, TReq = any> {
|
|||||||
}
|
}
|
||||||
|
|
||||||
const route = this.getRoute(req)
|
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
|
let response: Response | undefined
|
||||||
|
|
||||||
for (const handler of handlers) {
|
if (!route)
|
||||||
const context = {
|
response = new Response(this.debugMode ? 'Route not found!' : null, { status: 404 })
|
||||||
...(extCtx ?? {}),
|
|
||||||
env,
|
|
||||||
req,
|
|
||||||
dbg,
|
|
||||||
ctx
|
|
||||||
} as RouterContext<TEnv, TCtx, TReq>
|
|
||||||
|
|
||||||
const res = await handler(context)
|
if (!response) {
|
||||||
|
const handlers = [
|
||||||
|
...this.globalHandlers,
|
||||||
|
...(route?.handlers ?? [])
|
||||||
|
]
|
||||||
|
|
||||||
if (res) {
|
for (const handler of handlers) {
|
||||||
response = res
|
const context = {
|
||||||
break
|
...(ctxExt ?? {}),
|
||||||
|
env,
|
||||||
|
req,
|
||||||
|
dbg: this.debugMode,
|
||||||
|
ctx
|
||||||
|
} as RouterContext<Env, CtxExt, ReqExt>
|
||||||
|
|
||||||
|
const res = await handler(context)
|
||||||
|
|
||||||
|
if (res) {
|
||||||
|
response = res
|
||||||
|
break
|
||||||
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
if (!response)
|
if (!response)
|
||||||
return new Response(this.debugMode ? 'Handler did not return a Response!' : null, { status: 404 })
|
response = 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)
|
response = new Response(response.body, response)
|
||||||
|
|||||||
366
tests/index.spec.ts
Normal file
366
tests/index.spec.ts
Normal file
@@ -0,0 +1,366 @@
|
|||||||
|
import { describe, expect, test } from 'vitest'
|
||||||
|
import { Router } from '../src/index'
|
||||||
|
|
||||||
|
describe('Router', () => {
|
||||||
|
test('use', async () => {
|
||||||
|
const router = new Router()
|
||||||
|
const testRequest = new Request('https://example.com/')
|
||||||
|
const testResponse = new Response('success', { status: 200 })
|
||||||
|
|
||||||
|
expect(router.use(() => testResponse)).toBeInstanceOf(Router)
|
||||||
|
|
||||||
|
router.get('/', () => new Response('failed'))
|
||||||
|
|
||||||
|
const response = await router.handle(testRequest, {})
|
||||||
|
|
||||||
|
expect(response.status).toBe(200)
|
||||||
|
|
||||||
|
expect(await response.text()).toBe('success')
|
||||||
|
})
|
||||||
|
|
||||||
|
test('delete', async () => {
|
||||||
|
const router = new Router()
|
||||||
|
const testRequest = new Request('https://example.com/', { method: 'DELETE' })
|
||||||
|
const testResponse = new Response('success', { status: 200 })
|
||||||
|
|
||||||
|
expect(router.delete('/', () => testResponse)).toBeInstanceOf(Router)
|
||||||
|
|
||||||
|
const response = await router.handle(testRequest, {})
|
||||||
|
|
||||||
|
expect(response.status).toBe(200)
|
||||||
|
|
||||||
|
expect(await response.text()).toBe('success')
|
||||||
|
})
|
||||||
|
|
||||||
|
test('get', async () => {
|
||||||
|
const router = new Router()
|
||||||
|
const testRequest = new Request('https://example.com/', { method: 'GET' })
|
||||||
|
const testResponse = new Response('success', { status: 200 })
|
||||||
|
|
||||||
|
expect(router.get('/', () => testResponse)).toBeInstanceOf(Router)
|
||||||
|
|
||||||
|
const response = await router.handle(testRequest, {})
|
||||||
|
|
||||||
|
expect(response.status).toBe(200)
|
||||||
|
|
||||||
|
expect(await response.text()).toBe('success')
|
||||||
|
})
|
||||||
|
|
||||||
|
test('head', async () => {
|
||||||
|
const router = new Router()
|
||||||
|
const testRequest = new Request('https://example.com/', { method: 'HEAD' })
|
||||||
|
const testResponse = new Response('success', { status: 200 })
|
||||||
|
|
||||||
|
expect(router.head('/', () => testResponse)).toBeInstanceOf(Router)
|
||||||
|
|
||||||
|
const response = await router.handle(testRequest, {})
|
||||||
|
|
||||||
|
expect(response.status).toBe(200)
|
||||||
|
|
||||||
|
expect(await response.text()).toBe('success')
|
||||||
|
})
|
||||||
|
|
||||||
|
test('options', async () => {
|
||||||
|
const router = new Router()
|
||||||
|
const testRequest = new Request('https://example.com/', { method: 'OPTIONS' })
|
||||||
|
const testResponse = new Response('success', { status: 200 })
|
||||||
|
|
||||||
|
expect(router.options('/', () => testResponse)).toBeInstanceOf(Router)
|
||||||
|
|
||||||
|
const response = await router.handle(testRequest, {})
|
||||||
|
|
||||||
|
expect(response.status).toBe(200)
|
||||||
|
|
||||||
|
expect(await response.text()).toBe('success')
|
||||||
|
})
|
||||||
|
|
||||||
|
test('patch', async () => {
|
||||||
|
const router = new Router()
|
||||||
|
const testRequest = new Request('https://example.com/', { method: 'PATCH' })
|
||||||
|
const testResponse = new Response('success', { status: 200 })
|
||||||
|
|
||||||
|
expect(router.patch('/', () => testResponse)).toBeInstanceOf(Router)
|
||||||
|
|
||||||
|
const response = await router.handle(testRequest, {})
|
||||||
|
|
||||||
|
expect(response.status).toBe(200)
|
||||||
|
|
||||||
|
expect(await response.text()).toBe('success')
|
||||||
|
})
|
||||||
|
|
||||||
|
test('post', async () => {
|
||||||
|
const router = new Router()
|
||||||
|
const testRequest = new Request('https://example.com/', { method: 'POST' })
|
||||||
|
const testResponse = new Response('success', { status: 200 })
|
||||||
|
|
||||||
|
expect(router.post('/test', () => testResponse)).toBeInstanceOf(Router)
|
||||||
|
expect(router.post('/', () => testResponse)).toBeInstanceOf(Router)
|
||||||
|
|
||||||
|
const response = await router.handle(testRequest, {})
|
||||||
|
|
||||||
|
expect(response.status).toBe(200)
|
||||||
|
|
||||||
|
expect(await response.text()).toBe('success')
|
||||||
|
})
|
||||||
|
|
||||||
|
test('put', async () => {
|
||||||
|
const router = new Router()
|
||||||
|
const testRequest = new Request('https://example.com/', { method: 'PUT' })
|
||||||
|
const testResponse = new Response('success', { status: 200 })
|
||||||
|
|
||||||
|
expect(router.put('/test', () => testResponse)).toBeInstanceOf(Router)
|
||||||
|
expect(router.put('/', () => testResponse)).toBeInstanceOf(Router)
|
||||||
|
|
||||||
|
const response = await router.handle(testRequest, {})
|
||||||
|
|
||||||
|
expect(response.status).toBe(200)
|
||||||
|
|
||||||
|
expect(await response.text()).toBe('success')
|
||||||
|
})
|
||||||
|
|
||||||
|
test('any', async () => {
|
||||||
|
const router = new Router()
|
||||||
|
const testRequest = new Request('https://example.com/', { method: 'POST' })
|
||||||
|
const testResponse = new Response('success', { status: 200 })
|
||||||
|
|
||||||
|
expect(router.any('/test', () => testResponse)).toBeInstanceOf(Router)
|
||||||
|
expect(router.any('/', () => testResponse)).toBeInstanceOf(Router)
|
||||||
|
|
||||||
|
const response = await router.handle(testRequest, {})
|
||||||
|
|
||||||
|
expect(response.status).toBe(200)
|
||||||
|
|
||||||
|
expect(await response.text()).toBe('success')
|
||||||
|
})
|
||||||
|
|
||||||
|
test('cors', async () => {
|
||||||
|
const router = new Router()
|
||||||
|
const testRequest = new Request('https://example.com/', { method: 'GET' })
|
||||||
|
const testOptionsRequest = new Request('https://example.com/', { method: 'OPTIONS' })
|
||||||
|
const testResponse = new Response('success', { status: 200 })
|
||||||
|
|
||||||
|
expect(router.cors()).toBeInstanceOf(Router)
|
||||||
|
|
||||||
|
router.get('/', () => testResponse)
|
||||||
|
|
||||||
|
const response = await router.handle(testRequest, {})
|
||||||
|
|
||||||
|
expect(response.status).toBe(200)
|
||||||
|
|
||||||
|
expect(response.headers.get('Access-Control-Allow-Origin')).toBe('*')
|
||||||
|
expect(response.headers.get('Access-Control-Allow-Methods')).toBe('*')
|
||||||
|
expect(response.headers.get('Access-Control-Allow-Headers')).toBe('*')
|
||||||
|
expect(response.headers.get('Access-Control-Allow-Credentials')).toBe(null)
|
||||||
|
expect(response.headers.get('vary')).toBe(null)
|
||||||
|
expect(response.headers.get('Access-Control-Max-Age')).toBe('86400')
|
||||||
|
|
||||||
|
const optionsRes = await router.handle(testOptionsRequest, {})
|
||||||
|
|
||||||
|
expect(optionsRes.status).toBe(204)
|
||||||
|
expect(optionsRes.headers.get('Access-Control-Allow-Origin')).toBe('*')
|
||||||
|
expect(optionsRes.headers.get('Access-Control-Allow-Methods')).toBe('*')
|
||||||
|
expect(optionsRes.headers.get('Access-Control-Allow-Headers')).toBe('*')
|
||||||
|
expect(optionsRes.headers.get('Access-Control-Allow-Credentials')).toBe(null)
|
||||||
|
expect(optionsRes.headers.get('vary')).toBe(null)
|
||||||
|
expect(optionsRes.headers.get('Access-Control-Max-Age')).toBe('86400')
|
||||||
|
|
||||||
|
expect(await response.text()).toBe('success')
|
||||||
|
})
|
||||||
|
|
||||||
|
test('params', async () => {
|
||||||
|
const router = new Router()
|
||||||
|
const testRequest = new Request('https://example.com/bar/foo')
|
||||||
|
|
||||||
|
router.get('/:foo/:bar', ({ req }) => {
|
||||||
|
return Response.json(req.params)
|
||||||
|
})
|
||||||
|
|
||||||
|
const response = await router.handle(testRequest, {})
|
||||||
|
|
||||||
|
expect(response.status).toEqual(200)
|
||||||
|
|
||||||
|
expect(await response.json()).toMatchObject({ foo: 'bar', bar: 'foo' })
|
||||||
|
})
|
||||||
|
|
||||||
|
test('query', async () => {
|
||||||
|
const router = new Router()
|
||||||
|
const testRequest = new Request('https://example.com/?foo=bar&bar=foo')
|
||||||
|
|
||||||
|
router.get('/', ({ req }) => {
|
||||||
|
return Response.json(req.query)
|
||||||
|
})
|
||||||
|
|
||||||
|
const response = await router.handle(testRequest, {})
|
||||||
|
|
||||||
|
expect(response.status).toEqual(200)
|
||||||
|
|
||||||
|
expect(await response.json()).toMatchObject({ foo: 'bar', bar: 'foo' })
|
||||||
|
})
|
||||||
|
|
||||||
|
test('404', async () => {
|
||||||
|
const router = new Router()
|
||||||
|
const testRequest = new Request('https://example.com/')
|
||||||
|
|
||||||
|
const response = await router.handle(testRequest, {})
|
||||||
|
|
||||||
|
expect(response.status).toEqual(404)
|
||||||
|
})
|
||||||
|
|
||||||
|
test('debug mode', async () => {
|
||||||
|
const router = new Router()
|
||||||
|
const testRequest = new Request('https://example.com/')
|
||||||
|
|
||||||
|
router.debug()
|
||||||
|
|
||||||
|
const response = await router.handle(testRequest, {})
|
||||||
|
|
||||||
|
expect(response.status).toEqual(404)
|
||||||
|
|
||||||
|
expect(await response.text()).toBe('Route not found!')
|
||||||
|
})
|
||||||
|
|
||||||
|
test('handler no response', async () => {
|
||||||
|
const router = new Router()
|
||||||
|
const testRequest = new Request('https://example.com/')
|
||||||
|
|
||||||
|
router.debug()
|
||||||
|
|
||||||
|
router.get('/', () => {})
|
||||||
|
|
||||||
|
const response = await router.handle(testRequest, {})
|
||||||
|
|
||||||
|
expect(response.status).toEqual(404)
|
||||||
|
|
||||||
|
expect(await response.text()).toBe('Handler did not return a Response!')
|
||||||
|
})
|
||||||
|
|
||||||
|
test('wildcard', async () => {
|
||||||
|
const router = new Router()
|
||||||
|
const testRequest = new Request('https://example.com/foo/bar')
|
||||||
|
const testResponse = new Response('success', { status: 200 })
|
||||||
|
|
||||||
|
router.get('*', () => testResponse)
|
||||||
|
|
||||||
|
const response = await router.handle(testRequest, {})
|
||||||
|
|
||||||
|
expect(response.status).toEqual(200)
|
||||||
|
|
||||||
|
expect(await response.text()).toBe('success')
|
||||||
|
})
|
||||||
|
|
||||||
|
test('bearer', async () => {
|
||||||
|
const router = new Router()
|
||||||
|
const testToken = 'super-secret-token'
|
||||||
|
const testRequest = new Request('https://example.com/', { headers: { 'Authorization': `Bearer ${testToken}` }})
|
||||||
|
|
||||||
|
router.get('/', ({ req }) => new Response(req.bearer()))
|
||||||
|
|
||||||
|
const response = await router.handle(testRequest, {})
|
||||||
|
|
||||||
|
expect(response.status).toEqual(200)
|
||||||
|
|
||||||
|
expect(await response.text()).toBe(testToken)
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
describe('Middleware', () => {
|
||||||
|
const router = new Router()
|
||||||
|
const testHandlerSuccess = () => new Response('success', { status: 200 })
|
||||||
|
const testHandlerContinue = () => {}
|
||||||
|
const testHandlerFailed = () => new Response('failed', { status: 403 })
|
||||||
|
|
||||||
|
router.get('/success', testHandlerContinue, testHandlerSuccess)
|
||||||
|
router.get('/failed', testHandlerFailed, testHandlerSuccess)
|
||||||
|
|
||||||
|
test('continue', async () => {
|
||||||
|
const testRequest = new Request('https://example.com/success')
|
||||||
|
const response = await router.handle(testRequest, {})
|
||||||
|
|
||||||
|
expect(response.status).toEqual(200)
|
||||||
|
|
||||||
|
expect(await response.text()).toBe('success')
|
||||||
|
})
|
||||||
|
|
||||||
|
test('block', async () => {
|
||||||
|
const testRequest = new Request('https://example.com/failed')
|
||||||
|
const response = await router.handle(testRequest, {})
|
||||||
|
|
||||||
|
expect(response.status).toEqual(403)
|
||||||
|
|
||||||
|
expect(await response.text()).toBe('failed')
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
describe('Body', () => {
|
||||||
|
|
||||||
|
test('text then text', async () => {
|
||||||
|
const router = new Router()
|
||||||
|
const testText = "lorem ipsum dolor sit amet"
|
||||||
|
const testRequest = new Request('https://example.com/', { method: 'POST', body: testText })
|
||||||
|
|
||||||
|
router.post('/', async ({ req }) => {
|
||||||
|
return Response.json({
|
||||||
|
text: await req.text(),
|
||||||
|
text2: await req.text()
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
const response = await router.handle(testRequest, {})
|
||||||
|
|
||||||
|
expect(await response.json()).toMatchObject({ text: testText, text2: testText })
|
||||||
|
})
|
||||||
|
|
||||||
|
test('json then json', async () => {
|
||||||
|
const router = new Router()
|
||||||
|
const testObject = { text: 'cloudflare-worker-router', binary: true, amount: 17 }
|
||||||
|
const testJson = JSON.stringify(testObject)
|
||||||
|
const testRequest = new Request('https://example.com/', { method: 'POST', body: testJson })
|
||||||
|
|
||||||
|
router.post('/', async ({ req }) => {
|
||||||
|
return Response.json({
|
||||||
|
json: await req.json(),
|
||||||
|
json2: await req.json()
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
const response = await router.handle(testRequest, {})
|
||||||
|
|
||||||
|
expect(await response.json()).toMatchObject({ json: testObject, json2: testObject })
|
||||||
|
})
|
||||||
|
|
||||||
|
test('text then json', async () => {
|
||||||
|
const router = new Router()
|
||||||
|
const testObject = { text: 'cloudflare-worker-router', binary: true, amount: 17 }
|
||||||
|
const testJson = JSON.stringify(testObject)
|
||||||
|
const testRequest = new Request('https://example.com/', { method: 'POST', body: testJson })
|
||||||
|
|
||||||
|
router.post('/', async ({ req }) => {
|
||||||
|
return Response.json({
|
||||||
|
text: await req.text(),
|
||||||
|
json: await req.json()
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
const response = await router.handle(testRequest, {})
|
||||||
|
|
||||||
|
expect(await response.json()).toMatchObject({ text: testJson, json: testObject })
|
||||||
|
})
|
||||||
|
|
||||||
|
test('json then text', async () => {
|
||||||
|
const router = new Router()
|
||||||
|
const testObject = { text: 'cloudflare-worker-router', binary: true, amount: 17 }
|
||||||
|
const testJson = JSON.stringify(testObject)
|
||||||
|
const testRequest = new Request('https://example.com/', { method: 'POST', body: testJson })
|
||||||
|
|
||||||
|
router.post('/', async ({ req }) => {
|
||||||
|
return Response.json({
|
||||||
|
json: await req.json(),
|
||||||
|
text: await req.text()
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
const response = await router.handle(testRequest, {})
|
||||||
|
|
||||||
|
expect(await response.json()).toMatchObject({ text: testJson, json: testObject })
|
||||||
|
})
|
||||||
|
})
|
||||||
@@ -1,7 +1,7 @@
|
|||||||
{
|
{
|
||||||
"compilerOptions": {
|
"compilerOptions": {
|
||||||
"outDir": ".",
|
"outDir": ".",
|
||||||
"module": "commonjs",
|
"module": "esnext",
|
||||||
"target": "esnext",
|
"target": "esnext",
|
||||||
"lib": ["esnext"],
|
"lib": ["esnext"],
|
||||||
"declaration": true,
|
"declaration": true,
|
||||||
|
|||||||
9
vite.config.ts
Normal file
9
vite.config.ts
Normal file
@@ -0,0 +1,9 @@
|
|||||||
|
import { defineConfig } from 'vitest/config'
|
||||||
|
|
||||||
|
export default defineConfig({
|
||||||
|
test: {
|
||||||
|
environment: 'edge-runtime',
|
||||||
|
reporters: ['verbose'],
|
||||||
|
watch: false
|
||||||
|
}
|
||||||
|
})
|
||||||
Reference in New Issue
Block a user