1
0

72 Commits

Author SHA1 Message Date
101de4f5f6 3.0.0-16 2023-05-25 20:38:48 +02:00
9ee1182fa9 update node for dev 2023-05-25 20:37:41 +02:00
0309b0131f update migration guide 2023-05-25 20:34:55 +02:00
afd7ea662f 3.0.0-15 2023-05-25 20:01:45 +02:00
a742753cb7 update workflow 2023-05-25 20:01:36 +02:00
d631645b99 3.0.0-14 2023-05-25 19:55:37 +02:00
cb1bf98053 update types 2023-05-25 19:55:25 +02:00
648514a3c7 3.0.0-13 2023-05-25 19:52:56 +02:00
34f4512dee allow for context extension 2023-05-25 19:52:31 +02:00
02b65e85e6 clean up 2023-05-25 17:35:11 +02:00
d71b0638c4 3.0.0-12 2023-03-15 22:04:06 +01:00
0c7f04d71b make body reusable 2023-03-15 22:04:06 +01:00
c18e164018 update dependencies 2023-03-15 01:31:33 +01:00
307a93d86c 3.0.0-11 2023-02-21 15:45:20 +01:00
3a955af1bc fix cors edge case 2023-02-21 15:45:12 +01:00
db22422968 add arrayBuffer, text, formData, blob 2023-02-21 15:44:49 +01:00
0a73e4c32e 3.0.0-10 2023-02-05 02:11:19 +01:00
8bd8e50ee5 update 2023-02-05 02:11:09 +01:00
e4ec06bf47 3.0.0-9 2023-02-05 01:46:53 +01:00
2ad75dc3fb move things around, update body behavior 2023-02-05 01:46:20 +01:00
c2b6189a86 3.0.0-8 2023-02-02 20:53:11 +01:00
33cafbf17c update replace to be case insensitive 2023-02-02 20:53:02 +01:00
1e78778ba0 3.0.0-7 2023-02-02 20:38:45 +01:00
b0d05656bb add bearer helper function 2023-02-02 20:37:58 +01:00
d4ba12a517 update readme 2023-02-02 19:03:18 +01:00
b48e5c2333 clean up 2023-02-02 18:51:12 +01:00
bf41e2c193 update readme 2023-02-02 18:48:20 +01:00
5342cfd310 update dev dependencies 2023-02-02 18:43:36 +01:00
8f400ff5b7 3.0.0-6 2023-02-02 18:38:37 +01:00
51f30f642f clean up 2023-02-02 18:37:45 +01:00
bcab122e15 add dbg to handler context 2023-02-02 18:37:28 +01:00
f3181ca9a5 change || to ?? 2023-02-02 18:31:33 +01:00
7edfc835fa change interfaces to types 2023-02-02 18:30:03 +01:00
7300e36469 update migration guide 2023-02-02 18:08:49 +01:00
e122feadb5 update readmes 2023-02-02 17:40:28 +01:00
ceed474f24 3.0.0-5 2023-01-16 21:27:11 +01:00
864b7f153c extend request type 2023-01-16 21:26:42 +01:00
6a2173cdbc 3.0.0-4 2022-11-28 23:09:34 +01:00
87a3d344d9 add req.raw type 2022-11-28 23:09:12 +01:00
9f96fd112e 3.0.0-3 2022-11-28 23:04:30 +01:00
5f34e30c1e add raw request 2022-11-28 23:04:12 +01:00
b38baf7d62 add editorconfig 2022-11-28 23:03:59 +01:00
07cb83ff9f 3.0.0-2 2022-11-28 21:27:49 +01:00
2a064dcb9c make cf ctx optional 2022-11-28 21:27:25 +01:00
5e18d06dfd 3.0.0-1 2022-11-28 20:34:54 +01:00
4f169120de update workflow 2022-11-28 20:33:18 +01:00
eeb1b69e62 3.0.0-0 2022-11-28 20:09:35 +01:00
a80cf9ea2e recalculate file size 2022-11-25 01:15:35 +01:00
c41e3e95f9 clean up 2022-11-25 01:13:22 +01:00
61ad67766f switch to return syntax 2022-11-25 01:13:22 +01:00
c6dfaa3158 add editorconfig 2022-11-25 01:13:22 +01:00
215a3731da switch to return syntax 2022-11-25 01:10:51 +01:00
ad4557ecb3 add editorconfig 2022-11-25 00:58:21 +01:00
2529e5ce24 2.3.0 2022-11-25 00:43:43 +01:00
42de017ba0 update readme 2022-11-25 00:41:41 +01:00
81dd03af27 ocd 2022-11-24 23:33:48 +01:00
7fe0a5405f at least a little bit nicer 2022-11-24 23:13:30 +01:00
Toby
05984eb7da Update README.md 2022-11-24 19:28:11 +01:00
Toby
ba371dcc6d Update README.md 2022-11-24 19:27:10 +01:00
Toby
aeb4eb06e4 add TEnv generic 2022-11-24 17:37:52 +01:00
efd74609f1 add default any 2022-11-24 17:36:33 +01:00
Toby
fbc862a1f0 Merge branch 'main' into env-type-support 2022-11-24 17:34:33 +01:00
01487748af update readme 2022-11-24 17:32:11 +01:00
Toby
3374b92075 Update README.md 2022-11-24 17:32:11 +01:00
e8212b5fa8 rename T to TEnv 2022-11-24 16:02:17 +01:00
Toby
ded6b81e28 Update README.md 2022-11-24 15:50:10 +01:00
Anbcodes
972dc916f7 added the ability to specify the type of RouterContext.env 2022-10-06 15:57:18 -04:00
d3b86f1dbe 2.2.0 2022-10-03 00:34:06 +02:00
aadb398b48 drop default export 2022-10-03 00:32:54 +02:00
5fa3475a20 2.1.2 2022-10-03 00:13:59 +02:00
0637549e90 remove compatibility box 2022-10-03 00:13:51 +02:00
f3279e71fc typo fix 2022-10-03 00:09:03 +02:00
10 changed files with 725 additions and 638 deletions

9
.editorconfig Normal file
View File

@@ -0,0 +1,9 @@
root = true
[*]
end_of_line = lf
insert_final_newline = false
[src/**.ts]
charset = utf-8
indent_style = tab

View File

@@ -1,4 +1,4 @@
name: Publish (main)
name: Publish (pre)
on:
release:
@@ -11,7 +11,7 @@ jobs:
- uses: actions/checkout@v3
- uses: actions/setup-node@v3
with:
node-version: 16
node-version: 'latest'
registry-url: https://registry.npmjs.org/
- name: Install dependencies
run: npm ci
@@ -20,11 +20,12 @@ jobs:
- name: Publish to npmjs
env:
NODE_AUTH_TOKEN: ${{secrets.NPM_TOKEN}}
run: npm publish --tag latest --access public
- uses: actions/setup-node@v1
run: npm publish --tag pre --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 latest --access public
run: npm publish --tag pre --access public

View File

@@ -4,3 +4,4 @@ test/
.nvmrc
MIGRATION.md
tsconfig.json
.editorconfig

1
.nvmrc
View File

@@ -1 +0,0 @@
v16

View File

@@ -1,71 +1,70 @@
# Migration Guide
From `v1.x.x` to `v2.x.x`.
From `v2.x.x` to `v3.x.x`.
## Contents
- [Preparation](#preparation)
- [Update](#update)
- [Import / Require](#import--require)
- [Routes](#routes)
- [Update Router](#update-router)
- [Handlers](#handlers)
- [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
Update to the latest version verstion
Update to the latest version version of the router.
```bash
npm i -D @tsndr/cloudflare-worker-router
npm i -D @tsndr/cloudflare-worker-router@^3
```
## 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
```javascript
const Router = require('@tsndr/cloudflare-worker-router')
```typescript
// 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
```javascript
import Router from '@tsndr/cloudflare-worker-router'
```typescript
// 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>

290
README.md
View File

@@ -1,6 +1,6 @@
# Cloudflare Workers Router
Cloudflare Workers Router is a super lightweight router (2.30 KiB) with middleware support and **ZERO dependencies** for [Cloudflare Workers](https://workers.cloudflare.com/).
Cloudflare Workers Router is a super lightweight router (1.0K gzipped) with middleware support and **ZERO dependencies** for [Cloudflare Workers](https://workers.cloudflare.com/).
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.
@@ -9,81 +9,168 @@ I worked a lot with [Express.js](https://expressjs.com/) in the past and really
## Contents
- [Features](#features)
- [Usage](#usage)
- [Reference](#reference)
- [Setup](#setup)
- [Getting started](#getting-started)
## Features
- ZERO dependencies
- Lightweight (1.0K gzipped)
- Fully written in TypeScript
- Integrated Debug-Mode & CORS helper
- Built specifically around Middlewares
## Usage
### Simple Example
Migrating from `v2.x.x`, check out the [Migration Guide](MIGRATION.md).
```javascript
import Router from '@tsndr/cloudflare-worker-router'
### TypeScript Example
```typescript
import { Router } from '@tsndr/cloudflare-worker-router'
export type Env = {
// Example binding to KV. Learn more at https://developers.cloudflare.com/workers/runtime-apis/kv/
// MY_KV_NAMESPACE: KVNamespace
//
// Example binding to Durable Object. Learn more at https://developers.cloudflare.com/workers/runtime-apis/durable-objects/
// MY_DURABLE_OBJECT: DurableObjectNamespace
//
// Example binding to R2. Learn more at https://developers.cloudflare.com/workers/runtime-apis/r2/
// MY_BUCKET: R2Bucket
SECRET_TOKEN: string
}
// Initialize router
const router = new Router()
const router = new Router<Env>()
// Enabling buildin CORS support
// Enabling build in CORS support
router.cors()
// Register global middleware
router.use(({ req, res, next }) => {
res.headers.set('X-Global-Middlewares', 'true')
next()
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', ({ req, res }) => {
res.body = {
data: {
id: 1,
name: 'John Doe'
}
}
router.get('/user', () => {
return Response.json({
id: 1,
name: 'John Doe'
})
})
// Post route with url parameter
router.post('/user/:id', ({ req, res }) => {
router.post('/user/:id', ({ req }) => {
const userId = req.params.id
const userId = req.params.id
// Do stuff...
// Do stuff
if (errorDoingStuff) {
res.status = 400
res.body = {
error: 'User did stupid stuff!'
if (!true) {
return Response.json({
error: 'Error doing stuff!'
}, { status: 400 })
}
return
}
res.status = 204
return Response.json({ userId }, { status: 204 })
})
// Delete route using a middleware
router.delete('/user/:id', ({ req, res, next }) => {
router.delete('/user/:id', ({ env, req }) => {
if (req.headers.get('authorization') === env.SECRET_TOKEN)
return new Response(null, { status: 401 })
if (!apiTokenIsCorrect) {
res.status = 401
return
}
await next()
}, (req, res) => {
}, ({ req }) => {
const userId = req.params.id
// Do stuff...
return Response.json({ userId })
})
// Listen Cloudflare Workers Fetch Event
export default {
async fetch(request, env) {
return router.handle(env, request)
}
async fetch(request: Request, env: Env, ctx: ExecutionContext) {
return router.handle(request, env, ctx)
}
}
```
<details>
<summary>JavaScript Example</summary>
```javascript
import { Router } from '@tsndr/cloudflare-worker-router'
// Initialize router
const router = new Router()
// Enabling build in CORS support
router.cors()
// 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'
})
})
// Post route with url parameter
router.post('/user/:id', ({ req }) => {
const userId = req.params.id
// Do stuff
if (!true) {
return Response.json({
error: 'Error doing stuff!'
}, { status: 400 })
}
return Response.json({ userId }, { status: 204 })
})
// Delete route using a middleware
router.delete('/user/:id', ({ env, req }) => {
if (req.headers.get('authorization') === env.SECRET_TOKEN)
return new Response(null, { status: 401 })
}, ({ req }) => {
const userId = req.params.id
// Do stuff...
return Response.json({ userId })
})
// Listen Cloudflare Workers Fetch Event
export default {
async fetch(request, env, ctx) {
return router.handle(request, env, ctx)
}
}
```
</details>
## Reference
@@ -96,6 +183,10 @@ Enable or disable debug mode. Which will return the `error.stack` in case of an
#### `state`
State is a `boolean` which determines if debug mode should be enabled or not (default: `true`)
Key | Type | Default Value
---------------------- | --------- | -------------
`state` | `boolean` | `true`
### `router.use([...handlers])`
@@ -106,8 +197,10 @@ Register a global middleware handler.
Handler is a `function` which will be called for every request.
#### `ctx`
Object containing `env`, [`req`](#req-object), [`res`](#res-object), `next`
Object containing `env`, [`req`](#req-object)
### `router.cors([config])`
@@ -126,16 +219,19 @@ Key | Type | Default Value
`optionsSuccessStatus` | `integer` | `204`
### `router.any(url, [...handlers])`
### `router.connect(url, [...handlers])`
### `router.delete(url, [...handlers])`
### `router.get(url, [...handlers])`
### `router.head(url, [...handlers])`
### `router.options(url, [...handlers])`
### `router.patch(url, [...handlers])`
### `router.post(url, [...handlers])`
### `router.put(url, [...handlers])`
### `router.trace(url, [...handlers])`
### Supported Methods
- `router.any(url, [...handlers])`
- `router.connect(url, [...handlers])`
- `router.delete(url, [...handlers])`
- `router.get(url, [...handlers])`
- `router.head(url, [...handlers])`
- `router.options(url, [...handlers])`
- `router.patch(url, [...handlers])`
- `router.post(url, [...handlers])`
- `router.put(url, [...handlers])`
- `router.trace(url, [...handlers])`
#### `url` (string)
@@ -145,16 +241,16 @@ Supports the use of dynamic parameters, prefixed with a `:` (i.e. `/user/:userId
#### `handlers` (function, optional)
An unlimited number of functions getting [`req`](#req-object) and [`res`](#res-object) passed into them.
An unlimited number of functions getting [`ctx`](#ctx-object) passed into them.
### `ctx`-Object
Key | Type | Description
--------- | ------------------- | -----------
`env` | `object` | Environment
`req` | `req`-Object | Request Object
`res` | `res`-Object | Response Object
`next` | `next`-Handler | Next Handler
`ctx` | `ctx`-Object | Cloudflare's `ctx`-Object
### `req`-Object
@@ -168,83 +264,97 @@ Key | Type | Description
`query` | `object` | Object containing all query parameters
### `res`-Object
## Getting started
Key | Type | Description
----------- | ------------------- | -----------
`body` | `object` / `string` | Either set an `object` (will be converted to JSON) or a string
`headers` | `Headers` | Response [Headers Object](https://developer.mozilla.org/en-US/docs/Web/API/Headers)
`status` | `integer` | Return status code (default: `204`)
`webSocket` | `WebSocket` | Upgraded websocket connection
Please follow Cloudflare's [Get started guide](https://developers.cloudflare.com/workers/get-started/guide/) to install wrangler.
## Setup
#### Initialize Project
---
### ❗️ Compatibility ❗️
```bash
wrangler init <name>
```
CLI Tool | Router
-------- | ------
[wrangler2](https://github.com/cloudflare/wrangler2#readme) | Use `v2.x.x` or later.
[@cloudflare/wrangler](https://github.com/cloudflare/wrangler#readme) | Use `v1.x.x`, [here](https://github.com/tsndr/cloudflare-worker-router/tree/legacy#readme).
See [Migration from v1.x.x to v2.x.x](https://github.com/tsndr/cloudflare-worker-router/blob/main/MIGRATION.md#migration-guide) if you want to update.
---
### **[Wrangler2](https://github.com/cloudflare/wrangler2#readme)**
Please follow Cloudflare's [Get started guide](https://developers.cloudflare.com/workers/get-started/guide/), then install the router using this command
Use of TypeScript is strongly encouraged :)
```bash
npm i -D @tsndr/cloudflare-worker-router
```
and replace your `index.ts` / `index.js` with one of the following scripts
<details>
<summary>TypeScript (<code>src/index.ts</code>)</summary>
### TypeScript (<code>src/index.ts</code>)
```typescript
import Router from '@tsndr/cloudflare-worker-router'
import { Router } from '@tsndr/cloudflare-worker-router'
export interface Env {
export type Env = {
// Example binding to KV. Learn more at https://developers.cloudflare.com/workers/runtime-apis/kv/
// MY_KV_NAMESPACE: KVNamespace;
// MY_KV_NAMESPACE: KVNamespace
//
// Example binding to Durable Object. Learn more at https://developers.cloudflare.com/workers/runtime-apis/durable-objects/
// MY_DURABLE_OBJECT: DurableObjectNamespace;
// MY_DURABLE_OBJECT: DurableObjectNamespace
//
// Example binding to R2. Learn more at https://developers.cloudflare.com/workers/runtime-apis/r2/
// MY_BUCKET: R2Bucket;
// MY_BUCKET: R2Bucket
}
const router = new Router()
const router = new Router<Env>()
/// Example Route
//
// router.get('/hi', async () => {
// return new Response('Hello World')
//})
/// Example Route for splitting into multiple files
//
// const hiHandler: RouteHandler<Env> = async () => {
// return new Response('Hello World')
// }
//
// router.get('/hi', hiHandler)
// TODO: add your routes here
export default {
async fetch(request: Request, env: Env, ctx: ExecutionContext): Promise<Response> {
return router.handle(env, request)
async fetch(request: Request, env: Env, ctx: ExecutionContext) {
return router.handle(request, env, ctx)
}
}
```
</details>
### JavaScript (<code>src/index.js</code>)
<details>
<summary>JavaScript (<code>src/index.js</code>)</summary>
<summary>Consider using TypeScript instead :)</summary>
```javascript
import Router from '@tsndr/cloudflare-worker-router'
import { Router } from '@tsndr/cloudflare-worker-router'
const router = new Router()
/// 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
export default {
async fetch(request, env, ctx) {
return router.handle(env, request)
return router.handle(request, env, ctx)
}
}
```
</details>

38
package-lock.json generated
View File

@@ -1,50 +1,36 @@
{
"name": "@tsndr/cloudflare-worker-router",
"version": "2.1.1",
"lockfileVersion": 2,
"version": "3.0.0-16",
"lockfileVersion": 3,
"requires": true,
"packages": {
"": {
"name": "@tsndr/cloudflare-worker-router",
"version": "2.1.1",
"version": "3.0.0-16",
"license": "MIT",
"devDependencies": {
"@cloudflare/workers-types": "^3.13.0",
"typescript": "^4.7.4"
"@cloudflare/workers-types": "^4.20230518.0",
"typescript": "^5.0.4"
}
},
"node_modules/@cloudflare/workers-types": {
"version": "3.13.0",
"resolved": "https://registry.npmjs.org/@cloudflare/workers-types/-/workers-types-3.13.0.tgz",
"integrity": "sha512-oyhzfYlWBLgd9odJ/WHcsD/8B+IaAjSD+OcPEGLzX5kGRONjwcW3NY0WQfsVIhQzZ6AbPzjwkmj4D2VFwU1xRQ==",
"version": "4.20230518.0",
"resolved": "https://registry.npmjs.org/@cloudflare/workers-types/-/workers-types-4.20230518.0.tgz",
"integrity": "sha512-A0w1V+5SUawGaaPRlhFhSC/SCDT9oQG8TMoWOKFLA4qbqagELqEAFD4KySBIkeVOvCBLT1DZSYBMCxbXddl0kw==",
"dev": true
},
"node_modules/typescript": {
"version": "4.7.4",
"resolved": "https://registry.npmjs.org/typescript/-/typescript-4.7.4.tgz",
"integrity": "sha512-C0WQT0gezHuw6AdY1M2jxUO83Rjf0HP7Sk1DtXj6j1EwkQNZrHAg2XPWlq62oqEhYvONq5pkC2Y9oPljWToLmQ==",
"version": "5.0.4",
"resolved": "https://registry.npmjs.org/typescript/-/typescript-5.0.4.tgz",
"integrity": "sha512-cW9T5W9xY37cc+jfEnaUvX91foxtHkza3Nw3wkoF4sSlKn0MONdkdEndig/qPBWXNkmplh3NzayQzCiHM4/hqw==",
"dev": true,
"bin": {
"tsc": "bin/tsc",
"tsserver": "bin/tsserver"
},
"engines": {
"node": ">=4.2.0"
"node": ">=12.20"
}
}
},
"dependencies": {
"@cloudflare/workers-types": {
"version": "3.13.0",
"resolved": "https://registry.npmjs.org/@cloudflare/workers-types/-/workers-types-3.13.0.tgz",
"integrity": "sha512-oyhzfYlWBLgd9odJ/WHcsD/8B+IaAjSD+OcPEGLzX5kGRONjwcW3NY0WQfsVIhQzZ6AbPzjwkmj4D2VFwU1xRQ==",
"dev": true
},
"typescript": {
"version": "4.7.4",
"resolved": "https://registry.npmjs.org/typescript/-/typescript-4.7.4.tgz",
"integrity": "sha512-C0WQT0gezHuw6AdY1M2jxUO83Rjf0HP7Sk1DtXj6j1EwkQNZrHAg2XPWlq62oqEhYvONq5pkC2Y9oPljWToLmQ==",
"dev": true
}
}
}

View File

@@ -1,6 +1,6 @@
{
"name": "@tsndr/cloudflare-worker-router",
"version": "2.1.1",
"version": "3.0.0-16",
"description": "",
"main": "index.js",
"types": "index.d.ts",
@@ -31,7 +31,7 @@
},
"homepage": "https://github.com/tsndr/cloudflare-worker-router#readme",
"devDependencies": {
"@cloudflare/workers-types": "^3.13.0",
"typescript": "^4.7.4"
"@cloudflare/workers-types": "^4.20230518.0",
"typescript": "^5.0.4"
}
}

View File

@@ -1,481 +1,464 @@
/**
* Route Object
*
* @typedef Route
* @property {string} method HTTP request method
* @property {string} url URL String
* @property {RouterHandler[]} handlers Array of handler functions
*/
export interface Route {
method: string
url: string
handlers: RouterHandler[]
* Route Object
*
* @typedef Route
* @property {string} method HTTP request method
* @property {string} url URL String
* @property {RouterHandler[]} handlers Array of handler functions
*/
export type Route<TEnv, TCtx, TReq> = {
method: string
url: string
handlers: RouterHandler<TEnv, TCtx, TReq>[]
}
/**
* Router Context
*
* @typedef RouterContext
* @property {RouterEnv} env Environment
* @property {RouterRequest} req Request Object
* @property {RouterResponse} res Response Object
* @property {RouterNext} next Next Handler
*/
export interface RouterContext {
env: any
req: RouterRequest
res: RouterResponse
next: RouterNext
* Router Context
*
* @typedef RouterContext
* @property {RouterEnv} env Environment
* @property {RouterRequest} req Request Object
* @property {ExecutionContext} ctx Context Object
*/
export type RouterContext<TEnv = any, TCtx = any, TReq = any> = TCtx & {
env: TEnv
req: RouterRequest<TReq>
dbg: boolean
ctx?: ExecutionContext
}
/**
* Request Object
*
* @typedef RouterRequest
* @property {string} url URL
* @property {string} method HTTP request method
* @property {RouterRequestParams} params Object containing all parameters defined in the url string
* @property {RouterRequestQuery} query Object containing all query parameters
* @property {Headers} headers Request headers object
* @property {string | any} body Only available if method is `POST`, `PUT`, `PATCH` or `DELETE`. Contains either the received body string or a parsed object if valid JSON was sent.
* @property {IncomingRequestCfProperties} [cf] object containing custom Cloudflare properties. (https://developers.cloudflare.com/workers/examples/accessing-the-cloudflare-object)
*/
export interface RouterRequest {
url: string
method: string
params: RouterRequestParams
query: RouterRequestQuery
headers: Headers
body: string | any
cf?: IncomingRequestCfProperties
[key: string]: any
* Request Object
*
* @typedef RouterRequest
* @property {string} url URL
* @property {string} method HTTP request method
* @property {RouterRequestParams} params Object containing all parameters defined in the url string
* @property {RouterRequestQuery} query Object containing all query parameters
* @property {Headers} headers Request headers object
* @property {Request} raw Raw Request Object
* @property {IncomingRequestCfProperties} [cf] object containing custom Cloudflare properties. (https://developers.cloudflare.com/workers/examples/accessing-the-cloudflare-object)
*/
export type RouterRequest<TReq> = TReq & {
url: string
method: string
params: RouterRequestParams
query: RouterRequestQuery
headers: Headers
raw: Request
arrayBuffer(): Promise<ArrayBuffer>
text(): Promise<string>
json<T>(): Promise<T>
formData(): Promise<FormData>
blob(): Promise<Blob>
bearer: () => string | undefined
cf?: IncomingRequestCfProperties
}
/**
* Request Parameters
*
* @typedef RouterRequestParams
*/
export interface RouterRequestParams {
[key: string]: string
* Request Parameters
*
* @typedef RouterRequestParams
*/
export type RouterRequestParams = {
[key: string]: string
}
/**
* Request Query
*
* @typedef RouterRequestQuery
*/
export interface RouterRequestQuery {
[key: string]: string
* Request Query
*
* @typedef RouterRequestQuery
*/
export type RouterRequestQuery = {
[key: string]: string
}
/**
* Response Object
*
* @typedef RouterResponse
* @property {Headers} headers Response headers object
* @property {number} [status=204] Return status code (default: `204`)
* @property {string | any} [body] Either an `object` (will be converted to JSON) or a string
* @property {Response} [raw] A response object that is to be returned, this will void all other res properties and return this as is.
*/
export interface RouterResponse {
headers: Headers
status?: number
body?: string | any
raw?: Response,
webSocket?: WebSocket
* Handler Function
*
* @callback RouterHandler
* @param {RouterContext} ctx
* @returns {Promise<Response | void> Response | void}
*/
export type RouterHandler<TEnv = any, TCtx = any, TReq = any> = {
(ctx: RouterContext<TEnv, TCtx, TReq>): Promise<Response | void> | Response | void
}
/**
* Next Function
*
* @callback RouterNext
* @returns {Promise<void>}
*/
export interface RouterNext {
(): Promise<void>
* CORS Config
*
* @typedef RouterCorsConfig
* @property {string} [allowOrigin="*"] Access-Control-Allow-Origin (default: `*`)
* @property {string} [allowMethods="*"] Access-Control-Allow-Methods (default: `*`)
* @property {string} [allowHeaders="*"] Access-Control-Allow-Headers (default: `*`)
* @property {number} [maxAge=86400] Access-Control-Max-Age (default: `86400`)
* @property {number} [optionsSuccessStatus=204] Return status code for OPTIONS request (default: `204`)
*/
export type RouterCorsConfig = {
allowOrigin?: string
allowMethods?: string
allowHeaders?: string
maxAge?: number
optionsSuccessStatus?: number
}
export type RouterBuffer = {
arrayBuffer?: ArrayBuffer
text?: string
json?: any
formData?: FormData
blob?: Blob
}
/**
* Handler Function
*
* @callback RouterHandler
* @param {RouterContext} ctx
* @returns {Promise<void> | void}
*/
export interface RouterHandler {
(ctx: RouterContext): Promise<void> | void
}
/**
* CORS Config
*
* @typedef RouterCorsConfig
* @property {string} [allowOrigin="*"] Access-Control-Allow-Origin (default: `*`)
* @property {string} [allowMethods="*"] Access-Control-Allow-Methods (default: `*`)
* @property {string} [allowHeaders="*"] Access-Control-Allow-Headers (default: `*`)
* @property {number} [maxAge=86400] Access-Control-Max-Age (default: `86400`)
* @property {number} [optionsSuccessStatus=204] Return status code for OPTIONS request (default: `204`)
*/
export interface RouterCorsConfig {
allowOrigin?: string
allowMethods?: string
allowHeaders?: string
maxAge?: number
optionsSuccessStatus?: number
}
/**
* Router
*
* @public
* @class
*/
export default class Router {
/**
* Router Array
*
* @protected
* @type {Route[]}
*/
protected routes: Route[] = []
/**
* Global Handlers
*
* @protected
* @type {RouterHandler[]}
*/
protected globalHandlers: RouterHandler[] = []
/**
* Debug Mode
*
* @protected
* @type {boolean}
*/
protected debugMode: boolean = false
/**
* CORS Config
*
* @protected
* @type {RouterCorsConfig}
*/
protected corsConfig: RouterCorsConfig = {}
/**
* CORS enabled
*-
* @protected
* @type {boolean}
*/
protected corsEnabled: boolean = false
/**
* Register global handlers
*
* @param {RouterHandler[]} handlers
* @returns {Router}
*/
public use(...handlers: RouterHandler[]): Router {
for (let handler of handlers) {
this.globalHandlers.push(handler)
}
return this
}
/**
* Register CONNECT route
*
* @param {string} url
* @param {RouterHandler[]} handlers
* @returns {Router}
*/
public connect(url: string, ...handlers: RouterHandler[]): Router {
return this.register('CONNECT', url, handlers)
}
/**
* Register DELETE route
*
* @param {string} url
* @param {RouterHandler[]} handlers
* @returns {Router}
*/
public delete(url: string, ...handlers: RouterHandler[]): Router {
return this.register('DELETE', url, handlers)
}
/**
* Register GET route
*
* @param {string} url
* @param {RouterHandler[]} handlers
* @returns {Router}
*/
public get(url: string, ...handlers: RouterHandler[]): Router {
return this.register('GET', url, handlers)
}
/**
* Register HEAD route
*
* @param {string} url
* @param {RouterHandler[]} handlers
* @returns {Router}
*/
public head(url: string, ...handlers: RouterHandler[]): Router {
return this.register('HEAD', url, handlers)
}
/**
* Register OPTIONS route
*
* @param {string} url
* @param {RouterHandler[]} handlers
* @returns {Router}
*/
public options(url: string, ...handlers: RouterHandler[]): Router {
return this.register('OPTIONS', url, handlers)
}
/**
* Register PATCH route
*
* @param {string} url
* @param {RouterHandler[]} handlers
* @returns {Router}
*/
public patch(url: string, ...handlers: RouterHandler[]): Router {
return this.register('PATCH', url, handlers)
}
/**
* Register POST route
*
* @param {string} url
* @param {RouterHandler[]} handlers
* @returns {Router}
*/
public post(url: string, ...handlers: RouterHandler[]): Router {
return this.register('POST', url, handlers)
}
/**
* Register PUT route
*
* @param {string} url
* @param {RouterHandler[]} handlers
* @returns {Router}
*/
public put(url: string, ...handlers: RouterHandler[]): Router {
return this.register('PUT', url, handlers)
}
/**
* Register TRACE route
*
* @param {string} url
* @param {RouterHandler[]} handlers
* @returns {Router}
*/
public trace(url: string, ...handlers: RouterHandler[]): Router {
return this.register('TRACE', url, handlers)
}
/**
* Register route, ignoring method
*
* @param {string} url
* @param {RouterHandler[]} handlers
* @returns {Router}
*/
public any(url: string, ...handlers: RouterHandler[]): Router {
return this.register('*', url, handlers)
}
/**
* Debug Mode
*
* @param {boolean} [state=true] Whether to turn on or off debug mode (default: true)
* @returns {Router}
*/
public debug(state: boolean = true): Router {
this.debugMode = state
return this
}
/**
* Enable CORS support
*
* @param {RouterCorsConfig} [config]
* @returns {Router}
*/
public cors(config?: RouterCorsConfig): Router {
this.corsEnabled = true
this.corsConfig = {
allowOrigin: config?.allowOrigin || '*',
allowMethods: config?.allowMethods || '*',
allowHeaders: config?.allowHeaders || '*',
maxAge: config?.maxAge || 86400,
optionsSuccessStatus: config?.optionsSuccessStatus || 204
}
return this
}
/**
* Register route
*
* @private
* @param {string} method HTTP request method
* @param {string} url URL String
* @param {RouterHandler[]} handlers Arrar of handler functions
* @returns {Router}
*/
private register(method: string, url: string, handlers: RouterHandler[]): Router {
this.routes.push({
method,
url,
handlers
})
return this
}
/**
* Get Route by request
*
* @private
* @param {RouterRequest} request
* @returns {Route | undefined}
*/
private getRoute(request: RouterRequest): Route | undefined {
const url = new URL(request.url)
const pathArr = url.pathname.split('/').filter(i => i)
return this.routes.find(r => {
const routeArr = r.url.split('/').filter(i => i)
if (![request.method, '*'].includes(r.method) || routeArr.length !== pathArr.length)
return false
const params: RouterRequestParams = {}
for (let i = 0; i < routeArr.length; i++) {
if (routeArr[i] !== pathArr[i] && routeArr[i][0] !== ':')
return false
if (routeArr[i][0] === ':')
params[routeArr[i].substring(1)] = pathArr[i]
}
request.params = params
const query: any = {}
for (const [k, v] of url.searchParams.entries()) {
query[k] = v
}
request.query = query
return true
}) || this.routes.find(r => r.url === '*' && [request.method, '*'].includes(r.method))
}
/**
* Handle requests
*
* @param {any} env
* @param {Request} request
* @param {any} [extend]
* @returns {Promise<Response>}
*/
public async handle(env: any, request: Request, extend: any = {}): Promise<Response> {
try {
const req: RouterRequest = {
...extend,
method: request.method,
headers: request.headers,
url: request.url,
cf: request.cf,
params: {},
query: {},
body: ''
}
const headers = new Headers()
const route = this.getRoute(req)
if (this.corsEnabled) {
if (this.corsConfig.allowOrigin)
headers.set('Access-Control-Allow-Origin', this.corsConfig.allowOrigin)
if (this.corsConfig.allowMethods)
headers.set('Access-Control-Allow-Methods', this.corsConfig.allowMethods)
if (this.corsConfig.allowHeaders)
headers.set('Access-Control-Allow-Headers', this.corsConfig.allowHeaders)
if (this.corsConfig.maxAge)
headers.set('Access-Control-Max-Age', this.corsConfig.maxAge.toString())
if (!route && req.method === 'OPTIONS') {
return new Response(null, {
headers,
status: this.corsConfig.optionsSuccessStatus
})
}
}
if (!route)
return new Response(this.debugMode ? 'Route not found!' : null, { status: 404 })
if (['POST', 'PUT', 'PATCH'].includes(req.method)) {
if (req.headers.has('Content-Type') && req.headers.get('Content-Type')!.includes('json')) {
try {
req.body = await request.json()
} catch {
req.body = {}
}
} else {
try {
req.body = await request.text()
} catch {
req.body = ''
}
}
}
const res: RouterResponse = { headers }
const handlers = [...this.globalHandlers, ...route.handlers]
let prevIndex = -1
const runner = async (index: number) => {
if (index === prevIndex)
throw new Error('next() called multiple times')
prevIndex = index
if (typeof handlers[index] === 'function')
await handlers[index]({ env, req, res, next: async () => await runner(index + 1) })
}
await runner(0)
if (typeof res.body === 'object') {
if (!res.headers.has('Content-Type'))
res.headers.set('Content-Type', 'application/json')
res.body = JSON.stringify(res.body)
}
if (res.raw)
return res.raw
return new Response([101, 204, 205, 304].includes(res.status || (res.body ? 200 : 204)) ? null : res.body, { status: res.status, headers: res.headers, webSocket: res.webSocket || null })
} catch(err) {
console.error(err)
return new Response(this.debugMode && err instanceof Error ? err.stack : '', { status: 500 })
}
}
* Router
*
* @public
* @class
*/
export class Router<TEnv = any, TCtx = any, TReq = any> {
/**
* Router Array
*
* @protected
* @type {Route[]}
*/
protected routes: Route<TEnv, TCtx, TReq>[] = []
/**
* Global Handlers
*
* @protected
* @type {RouterHandler[]}
*/
protected globalHandlers: RouterHandler<TEnv, TCtx, TReq>[] = []
/**
* Debug Mode
*
* @protected
* @type {boolean}
*/
protected debugMode: boolean = false
/**
* CORS Config
*
* @protected
* @type {RouterCorsConfig}
*/
protected corsConfig: RouterCorsConfig = {}
/**
* Buffer
*
* @protected
* @type {RouterBuffer}
*/
protected buffer: RouterBuffer = {}
/**
* CORS enabled
*
* @protected
* @type {boolean}
*/
protected corsEnabled: boolean = false
/**
* Register global handlers
*
* @param {RouterHandler[]} handlers
* @returns {Router}
*/
public use(...handlers: RouterHandler<TEnv, TCtx, TReq>[]): Router<TEnv, TCtx, TReq> {
for (let handler of handlers) {
this.globalHandlers.push(handler)
}
return this
}
/**
* Register CONNECT route
*
* @param {string} url
* @param {RouterHandler[]} handlers
* @returns {Router}
*/
public connect(url: string, ...handlers: RouterHandler<TEnv, TCtx, TReq>[]): Router<TEnv, TCtx, TReq> {
return this.register('CONNECT', url, handlers)
}
/**
* Register DELETE route
*
* @param {string} url
* @param {RouterHandler[]} handlers
* @returns {Router}
*/
public delete(url: string, ...handlers: RouterHandler<TEnv, TCtx, TReq>[]): Router<TEnv, TCtx, TReq> {
return this.register('DELETE', url, handlers)
}
/**
* Register GET route
*
* @param {string} url
* @param {RouterHandler[]} handlers
* @returns {Router}
*/
public get(url: string, ...handlers: RouterHandler<TEnv, TCtx, TReq>[]): Router<TEnv, TCtx, TReq> {
return this.register('GET', url, handlers)
}
/**
* Register HEAD route
*
* @param {string} url
* @param {RouterHandler[]} handlers
* @returns {Router}
*/
public head(url: string, ...handlers: RouterHandler<TEnv, TCtx, TReq>[]): Router<TEnv, TCtx, TReq> {
return this.register('HEAD', url, handlers)
}
/**
* Register OPTIONS route
*
* @param {string} url
* @param {RouterHandler[]} handlers
* @returns {Router}
*/
public options(url: string, ...handlers: RouterHandler<TEnv, TCtx, TReq>[]): Router<TEnv, TCtx, TReq> {
return this.register('OPTIONS', url, handlers)
}
/**
* Register PATCH route
*
* @param {string} url
* @param {RouterHandler[]} handlers
* @returns {Router}
*/
public patch(url: string, ...handlers: RouterHandler<TEnv, TCtx, TReq>[]): Router<TEnv, TCtx, TReq> {
return this.register('PATCH', url, handlers)
}
/**
* Register POST route
*
* @param {string} url
* @param {RouterHandler[]} handlers
* @returns {Router}
*/
public post(url: string, ...handlers: RouterHandler<TEnv, TCtx, TReq>[]): Router<TEnv, TCtx, TReq> {
return this.register('POST', url, handlers)
}
/**
* Register PUT route
*
* @param {string} url
* @param {RouterHandler[]} handlers
* @returns {Router}
*/
public put(url: string, ...handlers: RouterHandler<TEnv, TCtx, TReq>[]): Router<TEnv, TCtx, TReq> {
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
*
* @param {string} url
* @param {RouterHandler[]} handlers
* @returns {Router}
*/
public any(url: string, ...handlers: RouterHandler<TEnv, TCtx, TReq>[]): Router<TEnv, TCtx, TReq> {
return this.register('*', url, handlers)
}
/**
* Debug Mode
*
* @param {boolean} [state=true] Whether to turn on or off debug mode (default: true)
* @returns {Router}
*/
public debug(state: boolean = true): Router<TEnv, TCtx, TReq> {
this.debugMode = state
return this
}
/**
* Enable CORS support
*
* @param {RouterCorsConfig} [config]
* @returns {Router}
*/
public cors(config?: RouterCorsConfig): Router<TEnv, TCtx, TReq> {
this.corsEnabled = true
this.corsConfig = {
allowOrigin: config?.allowOrigin ?? '*',
allowMethods: config?.allowMethods ?? '*',
allowHeaders: config?.allowHeaders ?? '*',
maxAge: config?.maxAge ?? 86400,
optionsSuccessStatus: config?.optionsSuccessStatus ?? 204
}
return this
}
private setCorsHeaders(headers: Headers = new Headers()): Headers {
if (this.corsConfig.allowOrigin && !headers.has('Access-Control-Allow-Origin'))
headers.set('Access-Control-Allow-Origin', this.corsConfig.allowOrigin)
if (this.corsConfig.allowMethods && !headers.has('Access-Control-Allow-Methods'))
headers.set('Access-Control-Allow-Methods', this.corsConfig.allowMethods)
if (this.corsConfig.allowHeaders && !headers.has('Access-Control-Allow-Headers'))
headers.set('Access-Control-Allow-Headers', this.corsConfig.allowHeaders)
if (this.corsConfig.maxAge && !headers.has('Access-Control-Max-Age'))
headers.set('Access-Control-Max-Age', this.corsConfig.maxAge.toString())
return headers
}
/**
* Register route
*
* @private
* @param {string} method HTTP request method
* @param {string} url URL String
* @param {RouterHandler[]} handlers Arrar of handler functions
* @returns {Router}
*/
private register(method: string, url: string, handlers: RouterHandler<TEnv, TCtx, TReq>[]): Router<TEnv, TCtx, TReq> {
this.routes.push({
method,
url,
handlers
})
return this
}
/**
* Get Route by request
*
* @private
* @param {RouterRequest} request
* @returns {Route | undefined}
*/
private getRoute(request: RouterRequest<TReq>): Route<TEnv, TCtx, TReq> | undefined {
const url = new URL(request.url)
const pathArr = url.pathname.split('/').filter(i => i)
return this.routes.find(r => {
const routeArr = r.url.split('/').filter(i => i)
if (![request.method, '*'].includes(r.method) || routeArr.length !== pathArr.length)
return false
const params: RouterRequestParams = {}
for (let i = 0; i < routeArr.length; i++) {
if (routeArr[i] !== pathArr[i] && routeArr[i][0] !== ':')
return false
if (routeArr[i][0] === ':')
params[routeArr[i].substring(1)] = pathArr[i]
}
request.params = params
const query: any = {}
for (const [k, v] of url.searchParams.entries()) {
query[k] = v
}
request.query = query
return true
}) || this.routes.find(r => r.url === '*' && [request.method, '*'].includes(r.method))
}
/**
* Handle requests
*
* @param {Request} request
* @param {TEnv} env
* @param {TCtx} [extCtx]
* @param {TReq} [extReq]
* @returns {Promise<Response>}
*/
public async handle(request: Request, env: TEnv, ctx?: ExecutionContext, extCtx?: TCtx, extReq?: TReq): Promise<Response> {
const req = {
...(extReq ?? {}),
method: request.method,
headers: request.headers,
url: request.url,
cf: request.cf,
raw: request,
params: {},
query: {},
arrayBuffer: async (): Promise<ArrayBuffer> => this.buffer.arrayBuffer ? this.buffer.arrayBuffer : this.buffer.arrayBuffer = await request.arrayBuffer(),
text: async (): Promise<string> => this.buffer.text ? this.buffer.text : this.buffer.text = await request.text(),
json: async <T>(): Promise<T> => this.buffer.json ? this.buffer.json : this.buffer.json = await request.json<T>(),
formData: async (): Promise<FormData> => this.buffer.formData ? this.buffer.formData : this.buffer.formData = await request.formData(),
blob: async (): Promise<Blob> => this.buffer.blob ? this.buffer.blob : this.buffer.blob = await request.blob(),
bearer: () => request.headers.get('Authorization')?.replace(/^(B|b)earer /, '').trim()
} as RouterRequest<TReq>
if (this.corsEnabled && req.method === 'OPTIONS') {
return new Response(null, {
headers: this.setCorsHeaders(),
status: this.corsConfig.optionsSuccessStatus
})
}
const route = this.getRoute(req)
if (!route)
return new Response(this.debugMode ? 'Route not found!' : null, { status: 404 })
const handlers = [...this.globalHandlers, ...route.handlers]
const dbg = this.debugMode
let response: Response | undefined
for (const handler of handlers) {
const context = {
...(extCtx ?? {}),
env,
req,
dbg,
ctx
} as RouterContext<TEnv, TCtx, TReq>
const res = await handler(context)
if (res) {
response = res
break
}
}
if (!response)
return new Response(this.debugMode ? 'Handler did not return a Response!' : null, { status: 404 })
if (this.corsEnabled) {
response = new Response(response.body, response)
this.setCorsHeaders(response.headers)
}
return response
}
}

View File

@@ -15,7 +15,6 @@
"alwaysStrict": true,
"noUnusedLocals": true,
"noUnusedParameters": true,
"noImplicitReturns": true,
"noFallthroughCasesInSwitch": true,
"esModuleInterop": true,
"preserveConstEnums": true,