1
0

44 Commits

Author SHA1 Message Date
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
bdb7be3699 2.1.1 2022-10-03 00:02:21 +02:00
45a781ea66 clean up 2022-10-03 00:01:13 +02:00
7f44f304a2 remove explicit authorization header 2022-10-02 23:57:52 +02:00
a786262ec6 fix cors 2022-10-02 23:50:48 +02:00
8e58dc349e 2.1.0 2022-09-29 18:56:02 +02:00
e94e84a742 fix cors always on issue 2022-09-29 18:48:23 +02:00
b16a56bbca minor type fixes 2022-07-19 18:51:31 +02:00
8 changed files with 593 additions and 505 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:
@@ -20,11 +20,11 @@ jobs:
- name: Publish to npmjs
env:
NODE_AUTH_TOKEN: ${{secrets.NPM_TOKEN}}
run: npm publish --tag latest --access public
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 latest --access public
run: npm publish --tag pre --access public

View File

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

268
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,172 @@ I worked a lot with [Express.js](https://expressjs.com/) in the past and really
## Contents
- [Features](#features)
- [Usage](#usage)
- [Reference](#reference)
- [Setup](#setup)
## Features
- ZERO dependencies
- Lightweight (1.0K gzipped)
- Fully written in TypeScript
- Integrated Debug-Mode & CORS helper
- Built specifically around Middlewares
## Usage
### Simple Example
### TypeScript Example
```javascript
import Router from '@tsndr/cloudflare-worker-router'
```typescript
import { Router } from '@tsndr/cloudflare-worker-router'
export interface 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(() => {
return new Response(null, {
headers: {
'X-Global-Middlewares': 'true'
}
})
})
// Simple get
router.get('/user', ({ req, res }) => {
res.body = {
data: {
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
// Do stuff...
// Do stuff
if (errorDoingStuff) {
res.status = 400
res.body = {
error: 'User did stupid stuff!'
}
return
if (!true) {
return Response.json({
error: 'Error doing stuff!'
}, { status: 400 })
}
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 }) => {
const { SECRET_TOKEN } = env
if (!apiTokenIsCorrect) {
res.status = 401
return
}
if (req.headers.get('Authorization') === SECRET_TOKEN)
return new Response(null, { status: 401 })
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(() => {
return new Response(null, {
headers: {
'X-Global-Middlewares': 'true'
}
})
})
// 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 (errorDoingStuff) {
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 }) => {
const { SECRET_TOKEN } = env
if (req.headers.get('Authorization') === 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 +187,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 +201,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 +223,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 +245,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 +268,87 @@ Key | Type | Description
`query` | `object` | Object containing all query parameters
### `res`-Object
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
## Setup
---
### ❗️ Compatibility ❗️
Please follow Cloudflare's [Get started guide](https://developers.cloudflare.com/workers/get-started/guide/) to install wrangler.
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.
#### Initialize Project
---
```bash
wrangler init <name>
```
### **[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 {
// 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', ({ res }) => {
// res.body = 'Hello World'
//}
/// Example Route for splitting into multiple files
//
// const hiHandler: RouteHandler<Env> = ({ res }) => {
// res.body = '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()
// router.get(/'hi', ({ res }) => {
// res.body = 'Hello World'
//}
// TODO: add your routes here
export default {
async fetch(request, env, ctx) {
return router.handle(env, request)
return router.handle(request, env, ctx)
}
}
```
</details>

4
package-lock.json generated
View File

@@ -1,12 +1,12 @@
{
"name": "@tsndr/cloudflare-worker-router",
"version": "2.0.2",
"version": "3.0.0-5",
"lockfileVersion": 2,
"requires": true,
"packages": {
"": {
"name": "@tsndr/cloudflare-worker-router",
"version": "2.0.2",
"version": "3.0.0-5",
"license": "MIT",
"devDependencies": {
"@cloudflare/workers-types": "^3.13.0",

View File

@@ -1,6 +1,6 @@
{
"name": "@tsndr/cloudflare-worker-router",
"version": "2.0.2",
"version": "3.0.0-5",
"description": "",
"main": "index.js",
"types": "index.d.ts",

View File

@@ -1,137 +1,108 @@
/**
* 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 {
* 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<TEnv, TExt> {
method: string
url: string
handlers: RouterHandler[]
handlers: RouterHandler<TEnv, TExt>[]
}
/**
* Router Context
*
* @typedef RouterContext
* @property {Object<string, string>} 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 interface RouterContext<TEnv = any, TExt = any> {
env: TEnv
req: RouterRequest<TExt>
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 {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 {
* 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 type RouterRequest<TExt> = {
url: string
method: string
params: RouterRequestParams
query: RouterRequestQuery
headers: Headers
body: any
body: string | any
raw: Request
cf?: IncomingRequestCfProperties
[key: string]: any
}
} & TExt
/**
* Request Parameters
*
* @typedef RouterRequestParams
*/
* Request Parameters
*
* @typedef RouterRequestParams
*/
export interface RouterRequestParams {
[key: string]: string
}
/**
* Request Query
*
* @typedef RouterRequestQuery
*/
* Request Query
*
* @typedef RouterRequestQuery
*/
export interface RouterRequestQuery {
[key: string]: string
}
/**
* Response Object
*
* @typedef RouterResponse
* @property {Headers} headers Response headers object
* @property {number} [status=204] Return status code (default: `204`)
* @property {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?: any
raw?: Response,
webSocket?: WebSocket
* Handler Function
*
* @callback RouterHandler
* @param {RouterContext} ctx
* @returns {Promise<Response | void> Response | void}
*/
export interface RouterHandler<TEnv = any, TExt = any> {
(ctx: RouterContext<TEnv, TExt>): Promise<Response | void> | Response | void
}
/**
* Next Function
*
* @callback RouterNext
* @returns {Promise}
*/
export interface RouterNext {
(): Promise<void>
}
/**
* 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`)
*/
* 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
allowOrigin?: string
allowMethods?: string
allowHeaders?: string
maxAge?: number
optionsSuccessStatus?: number
}
/**
* Router
*
* @public
* @class
*/
export default class Router {
* Router
*
* @public
* @class
*/
export class Router<TEnv = any, TExt = any> {
/**
* Router Array
@@ -139,12 +110,15 @@ export default class Router {
* @protected
* @type {Route[]}
*/
protected routes: Route[] = []
protected routes: Route<TEnv, TExt>[] = []
/**
* Global Handlers
*
* @protected
* @type {RouterHandler[]}
*/
protected globalHandlers: RouterHandler[] = []
protected globalHandlers: RouterHandler<TEnv, TExt>[] = []
/**
* Debug Mode
@@ -160,13 +134,15 @@ export default class Router {
* @protected
* @type {RouterCorsConfig}
*/
protected corsConfig: RouterCorsConfig = {
allowOrigin: '*',
allowMethods: '*',
allowHeaders: '*',
maxAge: 86400,
optionsSuccessStatus: 204
}
protected corsConfig: RouterCorsConfig = {}
/**
* CORS enabled
*
* @protected
* @type {boolean}
*/
protected corsEnabled: boolean = false
/**
* Register global handlers
@@ -174,7 +150,7 @@ export default class Router {
* @param {RouterHandler[]} handlers
* @returns {Router}
*/
public use(...handlers: RouterHandler[]): Router {
public use(...handlers: RouterHandler<TEnv, TExt>[]): Router<TEnv, TExt> {
for (let handler of handlers) {
this.globalHandlers.push(handler)
}
@@ -188,7 +164,7 @@ export default class Router {
* @param {RouterHandler[]} handlers
* @returns {Router}
*/
public connect(url: string, ...handlers: RouterHandler[]): Router {
public connect(url: string, ...handlers: RouterHandler<TEnv, TExt>[]): Router<TEnv, TExt> {
return this.register('CONNECT', url, handlers)
}
@@ -199,7 +175,7 @@ export default class Router {
* @param {RouterHandler[]} handlers
* @returns {Router}
*/
public delete(url: string, ...handlers: RouterHandler[]): Router {
public delete(url: string, ...handlers: RouterHandler<TEnv, TExt>[]): Router<TEnv, TExt> {
return this.register('DELETE', url, handlers)
}
@@ -210,7 +186,7 @@ export default class Router {
* @param {RouterHandler[]} handlers
* @returns {Router}
*/
public get(url: string, ...handlers: RouterHandler[]): Router {
public get(url: string, ...handlers: RouterHandler<TEnv, TExt>[]): Router<TEnv, TExt> {
return this.register('GET', url, handlers)
}
@@ -221,7 +197,7 @@ export default class Router {
* @param {RouterHandler[]} handlers
* @returns {Router}
*/
public head(url: string, ...handlers: RouterHandler[]): Router {
public head(url: string, ...handlers: RouterHandler<TEnv, TExt>[]): Router<TEnv, TExt> {
return this.register('HEAD', url, handlers)
}
@@ -232,7 +208,7 @@ export default class Router {
* @param {RouterHandler[]} handlers
* @returns {Router}
*/
public options(url: string, ...handlers: RouterHandler[]): Router {
public options(url: string, ...handlers: RouterHandler<TEnv, TExt>[]): Router<TEnv, TExt> {
return this.register('OPTIONS', url, handlers)
}
@@ -243,7 +219,7 @@ export default class Router {
* @param {RouterHandler[]} handlers
* @returns {Router}
*/
public patch(url: string, ...handlers: RouterHandler[]): Router {
public patch(url: string, ...handlers: RouterHandler<TEnv, TExt>[]): Router<TEnv, TExt> {
return this.register('PATCH', url, handlers)
}
@@ -254,7 +230,7 @@ export default class Router {
* @param {RouterHandler[]} handlers
* @returns {Router}
*/
public post(url: string, ...handlers: RouterHandler[]): Router {
public post(url: string, ...handlers: RouterHandler<TEnv, TExt>[]): Router<TEnv, TExt> {
return this.register('POST', url, handlers)
}
@@ -265,7 +241,7 @@ export default class Router {
* @param {RouterHandler[]} handlers
* @returns {Router}
*/
public put(url: string, ...handlers: RouterHandler[]): Router {
public put(url: string, ...handlers: RouterHandler<TEnv, TExt>[]): Router<TEnv, TExt> {
return this.register('PUT', url, handlers)
}
@@ -276,7 +252,7 @@ export default class Router {
* @param {RouterHandler[]} handlers
* @returns {Router}
*/
public trace(url: string, ...handlers: RouterHandler[]): Router {
public trace(url: string, ...handlers: RouterHandler<TEnv, TExt>[]): Router<TEnv, TExt> {
return this.register('TRACE', url, handlers)
}
@@ -287,7 +263,7 @@ export default class Router {
* @param {RouterHandler[]} handlers
* @returns {Router}
*/
public any(url: string, ...handlers: RouterHandler[]): Router {
public any(url: string, ...handlers: RouterHandler<TEnv, TExt>[]): Router<TEnv, TExt> {
return this.register('*', url, handlers)
}
@@ -297,7 +273,7 @@ export default class Router {
* @param {boolean} [state=true] Whether to turn on or off debug mode (default: true)
* @returns {Router}
*/
public debug(state = true): Router {
public debug(state: boolean = true): Router<TEnv, TExt> {
this.debugMode = state
return this
}
@@ -308,17 +284,30 @@ export default class Router {
* @param {RouterCorsConfig} [config]
* @returns {Router}
*/
public cors(config?: RouterCorsConfig): Router {
public cors(config?: RouterCorsConfig): Router<TEnv, TExt> {
this.corsEnabled = true
this.corsConfig = {
allowOrigin: config?.allowOrigin || '*',
allowMethods: config?.allowMethods || '*',
allowHeaders: config?.allowHeaders || '*, Authorization',
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
*
@@ -328,12 +317,13 @@ export default class Router {
* @param {RouterHandler[]} handlers Arrar of handler functions
* @returns {Router}
*/
private register(method: string, url: string, handlers: RouterHandler[]): Router {
private register(method: string, url: string, handlers: RouterHandler<TEnv, TExt>[]): Router<TEnv, TExt> {
this.routes.push({
method,
url,
handlers
})
return this
}
@@ -341,29 +331,39 @@ export default class Router {
* Get Route by request
*
* @private
* @param {Request} request
* @returns {RouterRequest | undefined}
* @param {RouterRequest} request
* @returns {Route | undefined}
*/
private getRoute(request: RouterRequest): Route | undefined {
private getRoute(request: RouterRequest<TExt>): Route<TEnv, TExt> | 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))
}
@@ -371,80 +371,55 @@ export default class Router {
/**
* Handle requests
*
* @param {any} env
* @param {TEnv} env
* @param {Request} request
* @param {any} [extend]
* @returns {Response}
* @param {TExt} [ext]
* @returns {Promise<Response>}
*/
public async handle(env: any, request: Request, extend: any = {}) {
try {
const req: RouterRequest = {
...extend,
public async handle(request: Request, env: TEnv, ctx?: ExecutionContext, ext?: TExt): Promise<Response> {
const req = {
...(ext ?? {}),
method: request.method,
headers: request.headers,
url: request.url,
cf: request.cf,
raw: request,
params: {},
query: {},
body: ''
}
if (req.method === 'OPTIONS' && Object.keys(this.corsConfig).length) {
} as RouterRequest<TExt>
const route = this.getRoute(req)
if (!route)
return new Response(this.debugMode ? 'Route not found!' : null, { status: 404 })
if (this.corsEnabled && req.method === 'OPTIONS') {
return new Response(null, {
headers: {
'Access-Control-Allow-Origin': this.corsConfig.allowOrigin,
'Access-Control-Allow-Methods': this.corsConfig.allowMethods,
'Access-Control-Allow-Headers': this.corsConfig.allowHeaders,
'Access-Control-Max-Age': this.corsConfig.maxAge!.toString()
},
headers: this.setCorsHeaders(),
status: this.corsConfig.optionsSuccessStatus
})
}
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 route = this.getRoute(req)
if (!route)
return new Response(this.debugMode ? 'Route not found!' : null, { status: 404 })
const res: RouterResponse = { headers: new Headers() }
if (Object.keys(this.corsConfig).length) {
res.headers.set('Access-Control-Allow-Origin', this.corsConfig.allowOrigin)
res.headers.set('Access-Control-Allow-Methods', this.corsConfig.allowMethods)
res.headers.set('Access-Control-Allow-Headers', this.corsConfig.allowHeaders)
res.headers.set('Access-Control-Max-Age', this.corsConfig.maxAge.toString())
}
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) })
let response: Response | undefined
for (const handler of handlers) {
const res = await handler({ env, req, ctx })
if (res) {
response = res
break
}
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 })
}
if (!response)
return new Response(this.debugMode ? 'Handler did not return a Response!' : null, { status: 404 })
if (this.corsEnabled)
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,