Compare commits
92 Commits
v3.0.0-4
...
a08adf3c03
| Author | SHA1 | Date | |
|---|---|---|---|
|
a08adf3c03
|
|||
|
2e594d09f5
|
|||
|
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
|
|||
|
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
|
|||
|
1e78778ba0
|
|||
|
b0d05656bb
|
|||
|
d4ba12a517
|
|||
|
b48e5c2333
|
|||
|
bf41e2c193
|
|||
|
5342cfd310
|
|||
|
8f400ff5b7
|
|||
|
51f30f642f
|
|||
|
bcab122e15
|
|||
|
f3181ca9a5
|
|||
|
7edfc835fa
|
|||
|
7300e36469
|
|||
|
e122feadb5
|
|||
|
ceed474f24
|
|||
|
864b7f153c
|
@@ -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
|
||||||
30
.github/workflows/publish-pre.yml
vendored
30
.github/workflows/publish-pre.yml
vendored
@@ -1,30 +0,0 @@
|
|||||||
name: Publish (pre)
|
|
||||||
|
|
||||||
on:
|
|
||||||
release:
|
|
||||||
types: [published]
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
publish:
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
steps:
|
|
||||||
- uses: actions/checkout@v3
|
|
||||||
- uses: actions/setup-node@v3
|
|
||||||
with:
|
|
||||||
node-version: 16
|
|
||||||
registry-url: https://registry.npmjs.org/
|
|
||||||
- name: Install dependencies
|
|
||||||
run: npm ci
|
|
||||||
- name: Build
|
|
||||||
run: npm run build
|
|
||||||
- name: Publish to npmjs
|
|
||||||
env:
|
|
||||||
NODE_AUTH_TOKEN: ${{secrets.NPM_TOKEN}}
|
|
||||||
run: npm publish --tag pre --access public
|
|
||||||
- uses: actions/setup-node@v1
|
|
||||||
with:
|
|
||||||
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
|
|
||||||
40
.github/workflows/publish.yml
vendored
Normal file
40
.github/workflows/publish.yml
vendored
Normal file
@@ -0,0 +1,40 @@
|
|||||||
|
name: Publish
|
||||||
|
run-name: Publish ${{ github.ref_name }}
|
||||||
|
|
||||||
|
on:
|
||||||
|
release:
|
||||||
|
types: [ published ]
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
publish:
|
||||||
|
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: Publish to npmjs
|
||||||
|
env:
|
||||||
|
NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
|
||||||
|
run: npm publish --tag ${{ contains(github.ref_name, '-') && 'pre' || '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 ${{ 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
|
||||||
96
MIGRATION.md
96
MIGRATION.md
@@ -1,71 +1,69 @@
|
|||||||
# Migration Guide
|
# Migration Guide
|
||||||
|
|
||||||
From `v1.x.x` to `v2.x.x`.
|
From `v2.x.x` to `v3.x.x`.
|
||||||
|
|
||||||
|
|
||||||
## Contents
|
## Contents
|
||||||
|
|
||||||
- [Preparation](#preparation)
|
- [Update Router](#update-router)
|
||||||
- [Update](#update)
|
- [Handlers](#handlers)
|
||||||
- [Import / Require](#import--require)
|
|
||||||
- [Routes](#routes)
|
|
||||||
- [Fetch](#fetch--routerhandle)
|
|
||||||
|
|
||||||
|
|
||||||
## Preparation
|
## Update Router
|
||||||
|
|
||||||
Follow Cloudflare's [Migration Guide](https://developers.cloudflare.com/workers/wrangler/migration/migrating-from-wrangler-1/) to update your protject to [wrangler2](https://github.com/cloudflare/wrangler2).
|
Update to the latest version version of the router.
|
||||||
|
|
||||||
## Update
|
|
||||||
|
|
||||||
Update to the latest version verstion
|
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
npm i -D @tsndr/cloudflare-worker-router
|
npm i -D @tsndr/cloudflare-worker-router@^3
|
||||||
```
|
```
|
||||||
|
|
||||||
## Import / Require
|
|
||||||
|
|
||||||
Switch to ESModules.
|
## Handlers
|
||||||
|
|
||||||
|
- Remove `res` and `next` from handler parameter list.
|
||||||
|
- Replace `res.` with `return new Response()` / `return Response.json()`.
|
||||||
|
- Remove `next()` calls from middlewares.
|
||||||
|
|
||||||
|
|
||||||
### Before
|
### Before
|
||||||
|
|
||||||
```javascript
|
```typescript
|
||||||
const Router = require('@tsndr/cloudflare-worker-router')
|
// Register global middleware
|
||||||
|
router.use(({ env, req, res, next }) => {
|
||||||
|
if (req.headers.get('authorization') !== env.SECRET_TOKEN) {
|
||||||
|
res.status = 401
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
next()
|
||||||
|
})
|
||||||
|
|
||||||
|
// Simple get
|
||||||
|
router.get('/user', ({ res }) => {
|
||||||
|
res.body = {
|
||||||
|
id: 1,
|
||||||
|
name: 'John Doe'
|
||||||
|
}
|
||||||
|
})
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
||||||
### After
|
### After
|
||||||
|
|
||||||
```javascript
|
```typescript
|
||||||
import Router from '@tsndr/cloudflare-worker-router'
|
// Register global middleware
|
||||||
|
router.use(({ env, req }) => {
|
||||||
|
// Intercept if token doesn't match
|
||||||
|
if (req.headers.get('authorization') !== env.SECRET_TOKEN) {
|
||||||
|
return new Response(null, { status: 401 })
|
||||||
|
}
|
||||||
|
})
|
||||||
|
|
||||||
|
// Simple get
|
||||||
|
router.get('/user', () => {
|
||||||
|
return Response.json({
|
||||||
|
id: 1,
|
||||||
|
name: 'John Doe'
|
||||||
|
})
|
||||||
|
})
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
||||||
## Routes
|
|
||||||
|
|
||||||
Just add curly braces.
|
|
||||||
|
|
||||||
|
|
||||||
### Before
|
|
||||||
|
|
||||||
<a href="https://gist.github.com/tsndr/34e8544266ae15d51abd019d7c3d27ca" target="_blank"><img width="469" alt="Petrify 2022-06-24 at 5 57 01 PM" src="https://user-images.githubusercontent.com/2940127/175572731-a8729c1b-15e2-45ac-be80-7e8527c5502a.png"></a>
|
|
||||||
|
|
||||||
|
|
||||||
### After
|
|
||||||
|
|
||||||
<a href="https://gist.github.com/tsndr/8db6e8dd55e348015c2ff8e93dd6aa31" target="_blank"><img width="469" alt="Petrify 2022-06-24 at 5 55 56 PM" src="https://user-images.githubusercontent.com/2940127/175572549-0eea8fc4-3d90-412a-89cc-d2f4569f1139.png"></a>
|
|
||||||
|
|
||||||
|
|
||||||
## Fetch / `router.handle()`
|
|
||||||
|
|
||||||
❗️ Be aware that with `v2.0.0` the parameters of `router.handle()` changed ❗️
|
|
||||||
|
|
||||||
|
|
||||||
### Before
|
|
||||||
|
|
||||||
<a href="https://gist.github.com/tsndr/12b0f800269760c597646c90a562ef88" target="_blank"><img width="469" alt="Petrify 2022-06-24 at 5 58 43 PM" src="https://user-images.githubusercontent.com/2940127/175572993-fb4681c2-eece-4c92-88e8-1c2f57644769.png"></a>
|
|
||||||
|
|
||||||
|
|
||||||
### After
|
|
||||||
|
|
||||||
<a href="https://gist.github.com/tsndr/30902b01b134e2a58cf3a53648dd3e47" target="_blank"><img width="393" alt="Petrify 2022-06-24 at 5 59 22 PM" src="https://user-images.githubusercontent.com/2940127/175573110-b7dfcfb2-855d-4529-a957-6f8b9ec439f3.png"></a>
|
|
||||||
|
|||||||
168
README.md
168
README.md
@@ -4,15 +4,13 @@ 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
|
||||||
|
|
||||||
- [Features](#features)
|
- [Features](#features)
|
||||||
- [Usage](#usage)
|
- [Usage](#usage)
|
||||||
- [Reference](#reference)
|
- [Reference](#reference)
|
||||||
- [Setup](#setup)
|
- [Getting started](#getting-started)
|
||||||
|
|
||||||
|
|
||||||
## Features
|
## Features
|
||||||
@@ -20,18 +18,25 @@ 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
|
||||||
|
|
||||||
|
Migrating from `v2.x.x`, check out the [Migration Guide](MIGRATION.md).
|
||||||
|
|
||||||
### TypeScript Example
|
### TypeScript Example
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
import { Router } from '@tsndr/cloudflare-worker-router'
|
import { Router } from '@tsndr/cloudflare-worker-router'
|
||||||
|
|
||||||
export interface Env {
|
// 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/
|
// Example binding to KV. Learn more at https://developers.cloudflare.com/workers/runtime-apis/kv/
|
||||||
// MY_KV_NAMESPACE: KVNamespace
|
// MY_KV_NAMESPACE: KVNamespace
|
||||||
//
|
//
|
||||||
@@ -41,22 +46,32 @@ export interface 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()
|
||||||
|
|
||||||
// Register global middleware
|
// Register global middleware
|
||||||
router.use(() => {
|
router.use(({ env, req }) => {
|
||||||
return new Response(null, {
|
// Intercept if token doesn't match
|
||||||
headers: {
|
if (req.headers.get('authorization') !== env.SECRET_TOKEN)
|
||||||
'X-Global-Middlewares': 'true'
|
return new Response(null, { status: 401 })
|
||||||
}
|
|
||||||
})
|
|
||||||
})
|
})
|
||||||
|
|
||||||
// Simple get
|
// Simple get
|
||||||
@@ -85,9 +100,7 @@ router.post('/user/:id', ({ req }) => {
|
|||||||
|
|
||||||
// Delete route using a middleware
|
// Delete route using a middleware
|
||||||
router.delete('/user/:id', ({ env, req }) => {
|
router.delete('/user/:id', ({ env, req }) => {
|
||||||
const { SECRET_TOKEN } = env
|
if (req.headers.get('authorization') === env.SECRET_TOKEN)
|
||||||
|
|
||||||
if (req.headers.get('Authorization') === SECRET_TOKEN)
|
|
||||||
return new Response(null, { status: 401 })
|
return new Response(null, { status: 401 })
|
||||||
|
|
||||||
}, ({ req }) => {
|
}, ({ req }) => {
|
||||||
@@ -121,12 +134,10 @@ const router = new Router()
|
|||||||
router.cors()
|
router.cors()
|
||||||
|
|
||||||
// Register global middleware
|
// Register global middleware
|
||||||
router.use(() => {
|
router.use(({ env, req }) => {
|
||||||
return new Response(null, {
|
// Intercept if token doesn't match
|
||||||
headers: {
|
if (req.headers.get('authorization') !== env.SECRET_TOKEN)
|
||||||
'X-Global-Middlewares': 'true'
|
return new Response(null, { status: 401 })
|
||||||
}
|
|
||||||
})
|
|
||||||
})
|
})
|
||||||
|
|
||||||
// Simple get
|
// Simple get
|
||||||
@@ -139,11 +150,12 @@ router.get('/user', () => {
|
|||||||
|
|
||||||
// Post route with url parameter
|
// Post route with url parameter
|
||||||
router.post('/user/:id', ({ req }) => {
|
router.post('/user/:id', ({ req }) => {
|
||||||
|
|
||||||
const userId = req.params.id
|
const userId = req.params.id
|
||||||
|
|
||||||
// Do stuff
|
// Do stuff
|
||||||
|
|
||||||
if (errorDoingStuff) {
|
if (!true) {
|
||||||
return Response.json({
|
return Response.json({
|
||||||
error: 'Error doing stuff!'
|
error: 'Error doing stuff!'
|
||||||
}, { status: 400 })
|
}, { status: 400 })
|
||||||
@@ -154,17 +166,16 @@ router.post('/user/:id', ({ req }) => {
|
|||||||
|
|
||||||
// Delete route using a middleware
|
// Delete route using a middleware
|
||||||
router.delete('/user/:id', ({ env, req }) => {
|
router.delete('/user/:id', ({ env, req }) => {
|
||||||
const { SECRET_TOKEN } = env
|
if (req.headers.get('authorization') === env.SECRET_TOKEN)
|
||||||
|
|
||||||
if (req.headers.get('Authorization') === SECRET_TOKEN)
|
|
||||||
return new Response(null, { status: 401 })
|
return new Response(null, { status: 401 })
|
||||||
|
|
||||||
}, ({ req }) => {
|
}, ({ req }) => {
|
||||||
const userId = req.params.id
|
|
||||||
|
|
||||||
// Do stuff...
|
const userId = req.params.id
|
||||||
|
|
||||||
return Response.json({ userId })
|
// Do stuff...
|
||||||
|
|
||||||
|
return Response.json({ userId })
|
||||||
})
|
})
|
||||||
|
|
||||||
// Listen Cloudflare Workers Fetch Event
|
// Listen Cloudflare Workers Fetch Event
|
||||||
@@ -214,19 +225,20 @@ If enabled will overwrite other `OPTIONS` requests.
|
|||||||
|
|
||||||
#### `config` (object, optional)
|
#### `config` (object, optional)
|
||||||
|
|
||||||
Key | Type | Default Value
|
Key | Type | Default Value
|
||||||
---------------------- | --------- | -------------
|
-------------------------- | ---------- | -------------
|
||||||
`allowOrigin` | `string` | `*`
|
`allowOrigin` | `string` | `*`
|
||||||
`allowMethods` | `string` | `*`
|
`allowMethods` | `string` | `*`
|
||||||
`allowHeaders` | `string` | `*`
|
`allowHeaders` | `string` | `*`
|
||||||
`maxAge` | `integer` | `86400`
|
`allowCredentials` | `boolean` | `undefined`
|
||||||
`optionsSuccessStatus` | `integer` | `204`
|
`vary` | `string` | `undefined`
|
||||||
|
`maxAge` | `integer` | `86400`
|
||||||
|
`optionsSuccessStatus` | `integer` | `204`
|
||||||
|
|
||||||
|
|
||||||
### 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])`
|
||||||
@@ -234,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)
|
||||||
@@ -268,7 +279,7 @@ Key | Type | Description
|
|||||||
`query` | `object` | Object containing all query parameters
|
`query` | `object` | Object containing all query parameters
|
||||||
|
|
||||||
|
|
||||||
## Setup
|
## Getting started
|
||||||
|
|
||||||
Please follow Cloudflare's [Get started guide](https://developers.cloudflare.com/workers/get-started/guide/) to install wrangler.
|
Please follow Cloudflare's [Get started guide](https://developers.cloudflare.com/workers/get-started/guide/) to install wrangler.
|
||||||
|
|
||||||
@@ -282,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
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
||||||
@@ -291,7 +302,11 @@ npm i -D @tsndr/cloudflare-worker-router
|
|||||||
```typescript
|
```typescript
|
||||||
import { Router } from '@tsndr/cloudflare-worker-router'
|
import { Router } from '@tsndr/cloudflare-worker-router'
|
||||||
|
|
||||||
export interface Env {
|
// 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/
|
// Example binding to KV. Learn more at https://developers.cloudflare.com/workers/runtime-apis/kv/
|
||||||
// MY_KV_NAMESPACE: KVNamespace
|
// MY_KV_NAMESPACE: KVNamespace
|
||||||
//
|
//
|
||||||
@@ -300,32 +315,57 @@ export interface 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', ({ res }) => {
|
// router.get('/hi', async () => {
|
||||||
// res.body = '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> = ({ res }) => {
|
// const helloHandler: Handler = async () => {
|
||||||
// res.body = '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)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
@@ -340,9 +380,25 @@ import { Router } from '@tsndr/cloudflare-worker-router'
|
|||||||
|
|
||||||
const router = new Router()
|
const router = new Router()
|
||||||
|
|
||||||
// router.get(/'hi', ({ res }) => {
|
// Enable Debug Mode
|
||||||
// res.body = 'Hello World'
|
//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
|
||||||
|
//
|
||||||
|
// async function hiHandler() {
|
||||||
|
// return new Response('Hello World')
|
||||||
|
// }
|
||||||
|
//
|
||||||
|
// router.get('/hi', hiHandler)
|
||||||
|
|
||||||
// TODO: add your routes here
|
// TODO: add your routes here
|
||||||
|
|
||||||
|
|||||||
1317
package-lock.json
generated
1317
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.0.0-4",
|
"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": "^3.13.0",
|
"@cloudflare/workers-types": "^4.20241022.0",
|
||||||
"typescript": "^4.7.4"
|
"@edge-runtime/vm": "^4.0.3",
|
||||||
|
"typescript": "^5.6.3",
|
||||||
|
"vitest": "^2.1.3"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
182
src/index.ts
182
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 interface Route<TEnv> {
|
export type Route<Env, CtxExt, ReqExt> = {
|
||||||
method: string
|
method: string
|
||||||
url: string
|
url: string
|
||||||
handlers: RouterHandler<TEnv>[]
|
handlers: RouterHandler<Env, CtxExt, ReqExt>[]
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -20,9 +20,10 @@ export interface Route<TEnv> {
|
|||||||
* @property {RouterRequest} req Request Object
|
* @property {RouterRequest} req Request Object
|
||||||
* @property {ExecutionContext} ctx Context Object
|
* @property {ExecutionContext} ctx Context Object
|
||||||
*/
|
*/
|
||||||
export interface RouterContext<TEnv = any> {
|
export type RouterContext<Env = any, CtxExt = {}, ReqExt = {}> = CtxExt & {
|
||||||
env: TEnv
|
env: Env
|
||||||
req: RouterRequest
|
req: RouterRequest<ReqExt>
|
||||||
|
dbg: boolean
|
||||||
ctx?: ExecutionContext
|
ctx?: ExecutionContext
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -35,19 +36,24 @@ export interface RouterContext<TEnv = any> {
|
|||||||
* @property {RouterRequestParams} params Object containing all parameters defined in the url string
|
* @property {RouterRequestParams} params Object containing all parameters defined in the url string
|
||||||
* @property {RouterRequestQuery} query Object containing all query parameters
|
* @property {RouterRequestQuery} query Object containing all query parameters
|
||||||
* @property {Headers} headers Request headers object
|
* @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)
|
* @property {IncomingRequestCfProperties} [cf] object containing custom Cloudflare properties. (https://developers.cloudflare.com/workers/examples/accessing-the-cloudflare-object)
|
||||||
*/
|
*/
|
||||||
export interface RouterRequest {
|
export type RouterRequest<ReqExt> = ReqExt & {
|
||||||
url: string
|
url: string
|
||||||
method: string
|
method: string
|
||||||
params: RouterRequestParams
|
params: RouterRequestParams
|
||||||
query: RouterRequestQuery
|
query: RouterRequestQuery
|
||||||
headers: Headers
|
headers: Headers
|
||||||
body: string | any
|
|
||||||
raw: Request
|
raw: Request
|
||||||
|
arrayBuffer(): Promise<ArrayBuffer>
|
||||||
|
text(): Promise<string>
|
||||||
|
json<T>(): Promise<T>
|
||||||
|
formData(): Promise<FormData>
|
||||||
|
blob(): Promise<Blob>
|
||||||
|
bearer(): string | undefined
|
||||||
|
basic(): [string, string]
|
||||||
cf?: IncomingRequestCfProperties
|
cf?: IncomingRequestCfProperties
|
||||||
[key: string]: any
|
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -55,7 +61,7 @@ export interface RouterRequest {
|
|||||||
*
|
*
|
||||||
* @typedef RouterRequestParams
|
* @typedef RouterRequestParams
|
||||||
*/
|
*/
|
||||||
export interface RouterRequestParams {
|
export type RouterRequestParams = {
|
||||||
[key: string]: string
|
[key: string]: string
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -64,7 +70,7 @@ export interface RouterRequestParams {
|
|||||||
*
|
*
|
||||||
* @typedef RouterRequestQuery
|
* @typedef RouterRequestQuery
|
||||||
*/
|
*/
|
||||||
export interface RouterRequestQuery {
|
export type RouterRequestQuery = {
|
||||||
[key: string]: string
|
[key: string]: string
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -75,8 +81,8 @@ export interface RouterRequestQuery {
|
|||||||
* @param {RouterContext} ctx
|
* @param {RouterContext} ctx
|
||||||
* @returns {Promise<Response | void> Response | void}
|
* @returns {Promise<Response | void> Response | void}
|
||||||
*/
|
*/
|
||||||
export interface RouterHandler<TEnv = any> {
|
export type RouterHandler<Env = any, CtxExt = {}, ReqExt = {}> = {
|
||||||
(ctx: RouterContext<TEnv>): Promise<Response | void> | Response | void
|
(ctx: RouterContext<Env, CtxExt, ReqExt>): Promise<Response | void> | Response | void
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -86,24 +92,36 @@ export interface RouterHandler<TEnv = any> {
|
|||||||
* @property {string} [allowOrigin="*"] Access-Control-Allow-Origin (default: `*`)
|
* @property {string} [allowOrigin="*"] Access-Control-Allow-Origin (default: `*`)
|
||||||
* @property {string} [allowMethods="*"] Access-Control-Allow-Methods (default: `*`)
|
* @property {string} [allowMethods="*"] Access-Control-Allow-Methods (default: `*`)
|
||||||
* @property {string} [allowHeaders="*"] Access-Control-Allow-Headers (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} [maxAge=86400] Access-Control-Max-Age (default: `86400`)
|
||||||
* @property {number} [optionsSuccessStatus=204] Return status code for OPTIONS request (default: `204`)
|
* @property {number} [optionsSuccessStatus=204] Return status code for OPTIONS request (default: `204`)
|
||||||
*/
|
*/
|
||||||
export interface RouterCorsConfig {
|
export type RouterCorsConfig = {
|
||||||
allowOrigin?: string
|
allowOrigin?: string
|
||||||
allowMethods?: string
|
allowMethods?: string
|
||||||
allowHeaders?: string
|
allowHeaders?: string
|
||||||
|
allowCredentials?: boolean
|
||||||
|
vary?: string
|
||||||
maxAge?: number
|
maxAge?: number
|
||||||
optionsSuccessStatus?: number
|
optionsSuccessStatus?: number
|
||||||
}
|
}
|
||||||
|
|
||||||
|
export type RouterBuffer = {
|
||||||
|
arrayBuffer?: ArrayBuffer
|
||||||
|
text?: string
|
||||||
|
json?: any
|
||||||
|
formData?: FormData
|
||||||
|
blob?: Blob
|
||||||
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Router
|
* Router
|
||||||
*
|
*
|
||||||
* @public
|
* @public
|
||||||
* @class
|
* @class
|
||||||
*/
|
*/
|
||||||
export class Router<TEnv = any> {
|
export class Router<Env = any, CtxExt = {}, ReqExt = {}> {
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Router Array
|
* Router Array
|
||||||
@@ -111,7 +129,7 @@ export class Router<TEnv = any> {
|
|||||||
* @protected
|
* @protected
|
||||||
* @type {Route[]}
|
* @type {Route[]}
|
||||||
*/
|
*/
|
||||||
protected routes: Route<TEnv>[] = []
|
protected routes: Route<Env, CtxExt, ReqExt>[] = []
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Global Handlers
|
* Global Handlers
|
||||||
@@ -119,7 +137,7 @@ export class Router<TEnv = any> {
|
|||||||
* @protected
|
* @protected
|
||||||
* @type {RouterHandler[]}
|
* @type {RouterHandler[]}
|
||||||
*/
|
*/
|
||||||
protected globalHandlers: RouterHandler<TEnv>[] = []
|
protected globalHandlers: RouterHandler<Env, CtxExt, ReqExt>[] = []
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Debug Mode
|
* Debug Mode
|
||||||
@@ -151,24 +169,13 @@ export class Router<TEnv = any> {
|
|||||||
* @param {RouterHandler[]} handlers
|
* @param {RouterHandler[]} handlers
|
||||||
* @returns {Router}
|
* @returns {Router}
|
||||||
*/
|
*/
|
||||||
public use(...handlers: RouterHandler<TEnv>[]): Router<TEnv> {
|
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>[]): Router<TEnv> {
|
|
||||||
return this.register('CONNECT', url, handlers)
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Register DELETE route
|
* Register DELETE route
|
||||||
*
|
*
|
||||||
@@ -176,7 +183,7 @@ export class Router<TEnv = any> {
|
|||||||
* @param {RouterHandler[]} handlers
|
* @param {RouterHandler[]} handlers
|
||||||
* @returns {Router}
|
* @returns {Router}
|
||||||
*/
|
*/
|
||||||
public delete(url: string, ...handlers: RouterHandler<TEnv>[]): Router<TEnv> {
|
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)
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -187,7 +194,7 @@ export class Router<TEnv = any> {
|
|||||||
* @param {RouterHandler[]} handlers
|
* @param {RouterHandler[]} handlers
|
||||||
* @returns {Router}
|
* @returns {Router}
|
||||||
*/
|
*/
|
||||||
public get(url: string, ...handlers: RouterHandler<TEnv>[]): Router<TEnv> {
|
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)
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -198,7 +205,7 @@ export class Router<TEnv = any> {
|
|||||||
* @param {RouterHandler[]} handlers
|
* @param {RouterHandler[]} handlers
|
||||||
* @returns {Router}
|
* @returns {Router}
|
||||||
*/
|
*/
|
||||||
public head(url: string, ...handlers: RouterHandler<TEnv>[]): Router<TEnv> {
|
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)
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -209,7 +216,7 @@ export class Router<TEnv = any> {
|
|||||||
* @param {RouterHandler[]} handlers
|
* @param {RouterHandler[]} handlers
|
||||||
* @returns {Router}
|
* @returns {Router}
|
||||||
*/
|
*/
|
||||||
public options(url: string, ...handlers: RouterHandler<TEnv>[]): Router<TEnv> {
|
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)
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -220,7 +227,7 @@ export class Router<TEnv = any> {
|
|||||||
* @param {RouterHandler[]} handlers
|
* @param {RouterHandler[]} handlers
|
||||||
* @returns {Router}
|
* @returns {Router}
|
||||||
*/
|
*/
|
||||||
public patch(url: string, ...handlers: RouterHandler<TEnv>[]): Router<TEnv> {
|
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)
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -231,7 +238,7 @@ export class Router<TEnv = any> {
|
|||||||
* @param {RouterHandler[]} handlers
|
* @param {RouterHandler[]} handlers
|
||||||
* @returns {Router}
|
* @returns {Router}
|
||||||
*/
|
*/
|
||||||
public post(url: string, ...handlers: RouterHandler<TEnv>[]): Router<TEnv> {
|
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)
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -242,21 +249,10 @@ export class Router<TEnv = any> {
|
|||||||
* @param {RouterHandler[]} handlers
|
* @param {RouterHandler[]} handlers
|
||||||
* @returns {Router}
|
* @returns {Router}
|
||||||
*/
|
*/
|
||||||
public put(url: string, ...handlers: RouterHandler<TEnv>[]): Router<TEnv> {
|
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>[]): Router<TEnv> {
|
|
||||||
return this.register('TRACE', url, handlers)
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Register route, ignoring method
|
* Register route, ignoring method
|
||||||
*
|
*
|
||||||
@@ -264,7 +260,7 @@ export class Router<TEnv = any> {
|
|||||||
* @param {RouterHandler[]} handlers
|
* @param {RouterHandler[]} handlers
|
||||||
* @returns {Router}
|
* @returns {Router}
|
||||||
*/
|
*/
|
||||||
public any(url: string, ...handlers: RouterHandler<TEnv>[]): Router<TEnv> {
|
public any(url: string, ...handlers: RouterHandler<Env, CtxExt, ReqExt>[]): Router<Env, CtxExt, ReqExt> {
|
||||||
return this.register('*', url, handlers)
|
return this.register('*', url, handlers)
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -274,7 +270,7 @@ export class Router<TEnv = 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> {
|
public debug(state: boolean = true): Router<Env, CtxExt, ReqExt> {
|
||||||
this.debugMode = state
|
this.debugMode = state
|
||||||
return this
|
return this
|
||||||
}
|
}
|
||||||
@@ -285,14 +281,16 @@ export class Router<TEnv = any> {
|
|||||||
* @param {RouterCorsConfig} [config]
|
* @param {RouterCorsConfig} [config]
|
||||||
* @returns {Router}
|
* @returns {Router}
|
||||||
*/
|
*/
|
||||||
public cors(config?: RouterCorsConfig): Router<TEnv> {
|
public cors(config?: RouterCorsConfig): Router<Env, CtxExt, ReqExt> {
|
||||||
this.corsEnabled = true
|
this.corsEnabled = true
|
||||||
this.corsConfig = {
|
this.corsConfig = {
|
||||||
allowOrigin: config?.allowOrigin || '*',
|
allowOrigin: config?.allowOrigin ?? '*',
|
||||||
allowMethods: config?.allowMethods || '*',
|
allowMethods: config?.allowMethods ?? '*',
|
||||||
allowHeaders: config?.allowHeaders || '*',
|
allowHeaders: config?.allowHeaders ?? '*',
|
||||||
maxAge: config?.maxAge || 86400,
|
allowCredentials: config?.allowCredentials ?? undefined,
|
||||||
optionsSuccessStatus: config?.optionsSuccessStatus || 204
|
vary: config?.vary ?? undefined,
|
||||||
|
maxAge: config?.maxAge ?? 86400,
|
||||||
|
optionsSuccessStatus: config?.optionsSuccessStatus ?? 204
|
||||||
}
|
}
|
||||||
return this
|
return this
|
||||||
}
|
}
|
||||||
@@ -304,6 +302,10 @@ export class Router<TEnv = any> {
|
|||||||
headers.set('Access-Control-Allow-Methods', this.corsConfig.allowMethods)
|
headers.set('Access-Control-Allow-Methods', this.corsConfig.allowMethods)
|
||||||
if (this.corsConfig.allowHeaders && !headers.has('Access-Control-Allow-Headers'))
|
if (this.corsConfig.allowHeaders && !headers.has('Access-Control-Allow-Headers'))
|
||||||
headers.set('Access-Control-Allow-Headers', this.corsConfig.allowHeaders)
|
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'))
|
if (this.corsConfig.maxAge && !headers.has('Access-Control-Max-Age'))
|
||||||
headers.set('Access-Control-Max-Age', this.corsConfig.maxAge.toString())
|
headers.set('Access-Control-Max-Age', this.corsConfig.maxAge.toString())
|
||||||
return headers
|
return headers
|
||||||
@@ -318,7 +320,7 @@ export class Router<TEnv = 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>[]): Router<TEnv> {
|
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,
|
||||||
@@ -335,7 +337,7 @@ export class Router<TEnv = any> {
|
|||||||
* @param {RouterRequest} request
|
* @param {RouterRequest} request
|
||||||
* @returns {Route | undefined}
|
* @returns {Route | undefined}
|
||||||
*/
|
*/
|
||||||
private getRoute(request: RouterRequest): Route<TEnv> | 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)
|
||||||
|
|
||||||
@@ -369,17 +371,19 @@ export class Router<TEnv = any> {
|
|||||||
}) || this.routes.find(r => r.url === '*' && [request.method, '*'].includes(r.method))
|
}) || this.routes.find(r => r.url === '*' && [request.method, '*'].includes(r.method))
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Handle requests
|
* Handle requests
|
||||||
*
|
*
|
||||||
* @param {TEnv} env
|
|
||||||
* @param {Request} request
|
* @param {Request} request
|
||||||
* @param {any} [extend]
|
* @param {Env} env
|
||||||
|
* @param {CtxExt} [ctxExt]
|
||||||
|
* @param {ReqExt} [reqExt]
|
||||||
* @returns {Promise<Response>}
|
* @returns {Promise<Response>}
|
||||||
*/
|
*/
|
||||||
public async handle(request: Request, env: TEnv, ctx?: ExecutionContext, extend: any = {}): Promise<Response> {
|
public async handle(request: Request, env: Env, ctx?: ExecutionContext, ctxExt?: CtxExt, reqExt?: ReqExt): Promise<Response> {
|
||||||
const req: RouterRequest = {
|
const buffer: RouterBuffer = {}
|
||||||
...extend,
|
const req = {
|
||||||
|
...(reqExt ?? {}),
|
||||||
method: request.method,
|
method: request.method,
|
||||||
headers: request.headers,
|
headers: request.headers,
|
||||||
url: request.url,
|
url: request.url,
|
||||||
@@ -387,13 +391,14 @@ export class Router<TEnv = any> {
|
|||||||
raw: request,
|
raw: request,
|
||||||
params: {},
|
params: {},
|
||||||
query: {},
|
query: {},
|
||||||
body: ''
|
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>(),
|
||||||
const route = this.getRoute(req)
|
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(),
|
||||||
if (!route)
|
bearer: () => request.headers.get('Authorization')?.replace(/^[Bb]earer\s/, '').trim(),
|
||||||
return new Response(this.debugMode ? 'Route not found!' : null, { status: 404 })
|
basic: () => (atob(request.headers.get('Authorization')?.replace(/^[Bb]asic\s/, '').trim() ?? '') || undefined)?.split(':')
|
||||||
|
} as RouterRequest<ReqExt>
|
||||||
|
|
||||||
if (this.corsEnabled && req.method === 'OPTIONS') {
|
if (this.corsEnabled && req.method === 'OPTIONS') {
|
||||||
return new Response(null, {
|
return new Response(null, {
|
||||||
@@ -402,24 +407,43 @@ export class Router<TEnv = any> {
|
|||||||
})
|
})
|
||||||
}
|
}
|
||||||
|
|
||||||
const handlers = [...this.globalHandlers, ...route.handlers]
|
const route = this.getRoute(req)
|
||||||
|
|
||||||
let response: Response | undefined
|
let response: Response | undefined
|
||||||
|
|
||||||
for (const handler of handlers) {
|
if (!route)
|
||||||
const res = await handler({ env, req, ctx })
|
response = new Response(this.debugMode ? 'Route not found!' : null, { status: 404 })
|
||||||
|
|
||||||
if (res) {
|
if (!response) {
|
||||||
response = res
|
const handlers = [
|
||||||
break
|
...this.globalHandlers,
|
||||||
|
...(route?.handlers ?? [])
|
||||||
|
]
|
||||||
|
|
||||||
|
for (const handler of handlers) {
|
||||||
|
const context = {
|
||||||
|
...(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)
|
||||||
this.setCorsHeaders(response.headers)
|
this.setCorsHeaders(response.headers)
|
||||||
|
}
|
||||||
|
|
||||||
return response
|
return response
|
||||||
}
|
}
|
||||||
|
|||||||
381
tests/index.spec.ts
Normal file
381
tests/index.spec.ts
Normal file
@@ -0,0 +1,381 @@
|
|||||||
|
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)
|
||||||
|
})
|
||||||
|
|
||||||
|
test('basic', async () => {
|
||||||
|
const router = new Router()
|
||||||
|
const testCredentials = ['user', 'password']
|
||||||
|
const testBasicAuth = btoa(testCredentials.join(':'))
|
||||||
|
const testRequest = new Request('https://example.com/', { headers: { 'Authorization': `Basic ${testBasicAuth}` }})
|
||||||
|
|
||||||
|
router.get('/', ({ req }) => Response.json(req.basic()))
|
||||||
|
|
||||||
|
const response = await router.handle(testRequest, {})
|
||||||
|
|
||||||
|
expect(response.status).toEqual(200)
|
||||||
|
|
||||||
|
expect(await response.json()).toMatchObject(testCredentials)
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
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