1
0

25 Commits

Author SHA1 Message Date
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
7 changed files with 565 additions and 496 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: on:
release: release:
@@ -20,11 +20,11 @@ jobs:
- name: Publish to npmjs - name: Publish to npmjs
env: env:
NODE_AUTH_TOKEN: ${{secrets.NPM_TOKEN}} NODE_AUTH_TOKEN: ${{secrets.NPM_TOKEN}}
run: npm publish --tag latest --access public run: npm publish --tag pre --access public
- uses: actions/setup-node@v1 - uses: actions/setup-node@v1
with: with:
registry-url: https://npm.pkg.github.com/ registry-url: https://npm.pkg.github.com/
- name: Publish to GPR - name: Publish to GPR
env: env:
NODE_AUTH_TOKEN: ${{secrets.GITHUB_TOKEN}} NODE_AUTH_TOKEN: ${{secrets.GITHUB_TOKEN}}
run: npm publish --tag latest --access public run: npm publish --tag pre --access public

252
README.md
View File

@@ -1,6 +1,6 @@
# Cloudflare Workers Router # 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. 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,14 +9,107 @@ I worked a lot with [Express.js](https://expressjs.com/) in the past and really
## Contents ## Contents
- [Features](#features)
- [Usage](#usage) - [Usage](#usage)
- [Reference](#reference) - [Reference](#reference)
- [Setup](#setup) - [Setup](#setup)
## Features
- ZERO dependencies
- Lightweight (1.0K gzipped)
- Fully written in TypeScript
- Integrated Debug-Mode & CORS helper
- Built specifically around Middlewares
## Usage ## Usage
### Simple Example ### TypeScript Example
```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<Env>()
// 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 (!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 }) => {
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: Request, env: Env, ctx: ExecutionContext) {
return router.handle(request, env, ctx)
}
}
```
<details>
<summary>JavaScript Example</summary>
```javascript ```javascript
import { Router } from '@tsndr/cloudflare-worker-router' import { Router } from '@tsndr/cloudflare-worker-router'
@@ -28,62 +121,60 @@ const router = new Router()
router.cors() router.cors()
// Register global middleware // Register global middleware
router.use(({ req, res, next }) => { router.use(() => {
res.headers.set('X-Global-Middlewares', 'true') return new Response(null, {
next() headers: {
'X-Global-Middlewares': 'true'
}
})
}) })
// Simple get // Simple get
router.get('/user', ({ req, res }) => { router.get('/user', () => {
res.body = { return Response.json({
data: {
id: 1, id: 1,
name: 'John Doe' name: 'John Doe'
} })
}
}) })
// Post route with url parameter // 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) { if (errorDoingStuff) {
res.status = 400 return Response.json({
res.body = { error: 'Error doing stuff!'
error: 'User did stupid stuff!' }, { status: 400 })
}
return
} }
res.status = 204 return Response.json({ userId }, { status: 204 })
}) })
// Delete route using a middleware // Delete route using a middleware
router.delete('/user/:id', ({ req, res, next }) => { router.delete('/user/:id', ({ env, req }) => {
const { SECRET_TOKEN } = env
if (!apiTokenIsCorrect) { if (req.headers.get('Authorization') === SECRET_TOKEN)
res.status = 401 return new Response(null, { status: 401 })
return
}
await next()
}, (req, res) => {
}, ({ req }) => {
const userId = req.params.id const userId = req.params.id
// Do stuff... // Do stuff...
return Response.json({ userId })
}) })
// Listen Cloudflare Workers Fetch Event // Listen Cloudflare Workers Fetch Event
export default { export default {
async fetch(request, env) { async fetch(request, env, ctx) {
return router.handle(env, request) return router.handle(request, env, ctx)
} }
} }
``` ```
</details>
## Reference ## Reference
@@ -96,6 +187,10 @@ Enable or disable debug mode. Which will return the `error.stack` in case of an
#### `state` #### `state`
State is a `boolean` which determines if debug mode should be enabled or not (default: `true`) 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])` ### `router.use([...handlers])`
@@ -106,8 +201,10 @@ Register a global middleware handler.
Handler is a `function` which will be called for every request. Handler is a `function` which will be called for every request.
#### `ctx` #### `ctx`
Object containing `env`, [`req`](#req-object), [`res`](#res-object), `next`
Object containing `env`, [`req`](#req-object)
### `router.cors([config])` ### `router.cors([config])`
@@ -126,16 +223,19 @@ Key | Type | Default Value
`optionsSuccessStatus` | `integer` | `204` `optionsSuccessStatus` | `integer` | `204`
### `router.any(url, [...handlers])` ### Supported Methods
### `router.connect(url, [...handlers])`
### `router.delete(url, [...handlers])` - `router.any(url, [...handlers])`
### `router.get(url, [...handlers])` - `router.connect(url, [...handlers])`
### `router.head(url, [...handlers])` - `router.delete(url, [...handlers])`
### `router.options(url, [...handlers])` - `router.get(url, [...handlers])`
### `router.patch(url, [...handlers])` - `router.head(url, [...handlers])`
### `router.post(url, [...handlers])` - `router.options(url, [...handlers])`
### `router.put(url, [...handlers])` - `router.patch(url, [...handlers])`
### `router.trace(url, [...handlers])` - `router.post(url, [...handlers])`
- `router.put(url, [...handlers])`
- `router.trace(url, [...handlers])`
#### `url` (string) #### `url` (string)
@@ -145,16 +245,16 @@ Supports the use of dynamic parameters, prefixed with a `:` (i.e. `/user/:userId
#### `handlers` (function, optional) #### `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 ### `ctx`-Object
Key | Type | Description Key | Type | Description
--------- | ------------------- | ----------- --------- | ------------------- | -----------
`env` | `object` | Environment `env` | `object` | Environment
`req` | `req`-Object | Request Object `req` | `req`-Object | Request Object
`res` | `res`-Object | Response Object `ctx` | `ctx`-Object | Cloudflare's `ctx`-Object
`next` | `next`-Handler | Next Handler
### `req`-Object ### `req`-Object
@@ -168,69 +268,87 @@ Key | Type | Description
`query` | `object` | Object containing all query parameters `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 ## Setup
Please follow Cloudflare's [Get started guide](https://developers.cloudflare.com/workers/get-started/guide/) to install wrangler, then install the router using this command: Please follow Cloudflare's [Get started guide](https://developers.cloudflare.com/workers/get-started/guide/) to install wrangler.
#### Initialize Project
```bash
wrangler init <name>
```
Use of TypeScript is strongly encouraged :)
```bash ```bash
npm i -D @tsndr/cloudflare-worker-router npm i -D @tsndr/cloudflare-worker-router
``` ```
and replace your `index.ts` / `index.js` with one of the following scripts
<details> ### TypeScript (<code>src/index.ts</code>)
<summary>TypeScript (<code>src/index.ts</code>)</summary>
```typescript ```typescript
import { Router } from '@tsndr/cloudflare-worker-router' import { Router } from '@tsndr/cloudflare-worker-router'
export interface Env { export interface 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
// //
// Example binding to Durable Object. Learn more at https://developers.cloudflare.com/workers/runtime-apis/durable-objects/ // 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/ // 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 // TODO: add your routes here
export default { export default {
async fetch(request: Request, env: Env, ctx: ExecutionContext): Promise<Response> { async fetch(request: Request, env: Env, ctx: ExecutionContext) {
return router.handle(env, request) return router.handle(request, env, ctx)
} }
} }
``` ```
</details>
### JavaScript (<code>src/index.js</code>)
<details> <details>
<summary>JavaScript (<code>src/index.js</code>)</summary> <summary>Consider using TypeScript instead :)</summary>
```javascript ```javascript
import { Router } from '@tsndr/cloudflare-worker-router' import { Router } from '@tsndr/cloudflare-worker-router'
const router = new Router() const router = new Router()
// router.get(/'hi', ({ res }) => {
// res.body = 'Hello World'
//}
// TODO: add your routes here // TODO: add your routes here
export default { export default {
async fetch(request, env, ctx) { 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", "name": "@tsndr/cloudflare-worker-router",
"version": "2.2.0", "version": "3.0.0-2",
"lockfileVersion": 2, "lockfileVersion": 2,
"requires": true, "requires": true,
"packages": { "packages": {
"": { "": {
"name": "@tsndr/cloudflare-worker-router", "name": "@tsndr/cloudflare-worker-router",
"version": "2.2.0", "version": "3.0.0-2",
"license": "MIT", "license": "MIT",
"devDependencies": { "devDependencies": {
"@cloudflare/workers-types": "^3.13.0", "@cloudflare/workers-types": "^3.13.0",

View File

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

View File

@@ -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 { export interface Route<TEnv> {
method: string method: string
url: string url: string
handlers: RouterHandler[] handlers: RouterHandler<TEnv>[]
} }
/** /**
@@ -18,14 +18,12 @@
* @typedef RouterContext * @typedef RouterContext
* @property {RouterEnv} env Environment * @property {RouterEnv} env Environment
* @property {RouterRequest} req Request Object * @property {RouterRequest} req Request Object
* @property {RouterResponse} res Response Object * @property {ExecutionContext} ctx Context Object
* @property {RouterNext} next Next Handler
*/ */
export interface RouterContext { export interface RouterContext<TEnv = any> {
env: any env: TEnv
req: RouterRequest req: RouterRequest
res: RouterResponse ctx?: ExecutionContext
next: RouterNext
} }
/** /**
@@ -69,42 +67,15 @@ export interface RouterRequestQuery {
[key: string]: string [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
}
/**
* Next Function
*
* @callback RouterNext
* @returns {Promise<void>}
*/
export interface RouterNext {
(): Promise<void>
}
/** /**
* Handler Function * Handler Function
* *
* @callback RouterHandler * @callback RouterHandler
* @param {RouterContext} ctx * @param {RouterContext} ctx
* @returns {Promise<void> | void} * @returns {Promise<Response | void> Response | void}
*/ */
export interface RouterHandler { export interface RouterHandler<TEnv = any> {
(ctx: RouterContext): Promise<void> | void (ctx: RouterContext<TEnv>): Promise<Response | void> | Response | void
} }
/** /**
@@ -131,7 +102,7 @@ export interface RouterCorsConfig {
* @public * @public
* @class * @class
*/ */
export class Router { export class Router<TEnv = any> {
/** /**
* Router Array * Router Array
@@ -139,7 +110,7 @@ export class Router {
* @protected * @protected
* @type {Route[]} * @type {Route[]}
*/ */
protected routes: Route[] = [] protected routes: Route<TEnv>[] = []
/** /**
* Global Handlers * Global Handlers
@@ -147,7 +118,7 @@ export class Router {
* @protected * @protected
* @type {RouterHandler[]} * @type {RouterHandler[]}
*/ */
protected globalHandlers: RouterHandler[] = [] protected globalHandlers: RouterHandler<TEnv>[] = []
/** /**
* Debug Mode * Debug Mode
@@ -167,7 +138,7 @@ export class Router {
/** /**
* CORS enabled * CORS enabled
*- *
* @protected * @protected
* @type {boolean} * @type {boolean}
*/ */
@@ -179,7 +150,7 @@ export class Router {
* @param {RouterHandler[]} handlers * @param {RouterHandler[]} handlers
* @returns {Router} * @returns {Router}
*/ */
public use(...handlers: RouterHandler[]): Router { public use(...handlers: RouterHandler<TEnv>[]): Router<TEnv> {
for (let handler of handlers) { for (let handler of handlers) {
this.globalHandlers.push(handler) this.globalHandlers.push(handler)
} }
@@ -193,7 +164,7 @@ export class Router {
* @param {RouterHandler[]} handlers * @param {RouterHandler[]} handlers
* @returns {Router} * @returns {Router}
*/ */
public connect(url: string, ...handlers: RouterHandler[]): Router { public connect(url: string, ...handlers: RouterHandler<TEnv>[]): Router<TEnv> {
return this.register('CONNECT', url, handlers) return this.register('CONNECT', url, handlers)
} }
@@ -204,7 +175,7 @@ export class Router {
* @param {RouterHandler[]} handlers * @param {RouterHandler[]} handlers
* @returns {Router} * @returns {Router}
*/ */
public delete(url: string, ...handlers: RouterHandler[]): Router { public delete(url: string, ...handlers: RouterHandler<TEnv>[]): Router<TEnv> {
return this.register('DELETE', url, handlers) return this.register('DELETE', url, handlers)
} }
@@ -215,7 +186,7 @@ export class Router {
* @param {RouterHandler[]} handlers * @param {RouterHandler[]} handlers
* @returns {Router} * @returns {Router}
*/ */
public get(url: string, ...handlers: RouterHandler[]): Router { public get(url: string, ...handlers: RouterHandler<TEnv>[]): Router<TEnv> {
return this.register('GET', url, handlers) return this.register('GET', url, handlers)
} }
@@ -226,7 +197,7 @@ export class Router {
* @param {RouterHandler[]} handlers * @param {RouterHandler[]} handlers
* @returns {Router} * @returns {Router}
*/ */
public head(url: string, ...handlers: RouterHandler[]): Router { public head(url: string, ...handlers: RouterHandler<TEnv>[]): Router<TEnv> {
return this.register('HEAD', url, handlers) return this.register('HEAD', url, handlers)
} }
@@ -237,7 +208,7 @@ export class Router {
* @param {RouterHandler[]} handlers * @param {RouterHandler[]} handlers
* @returns {Router} * @returns {Router}
*/ */
public options(url: string, ...handlers: RouterHandler[]): Router { public options(url: string, ...handlers: RouterHandler<TEnv>[]): Router<TEnv> {
return this.register('OPTIONS', url, handlers) return this.register('OPTIONS', url, handlers)
} }
@@ -248,7 +219,7 @@ export class Router {
* @param {RouterHandler[]} handlers * @param {RouterHandler[]} handlers
* @returns {Router} * @returns {Router}
*/ */
public patch(url: string, ...handlers: RouterHandler[]): Router { public patch(url: string, ...handlers: RouterHandler<TEnv>[]): Router<TEnv> {
return this.register('PATCH', url, handlers) return this.register('PATCH', url, handlers)
} }
@@ -259,7 +230,7 @@ export class Router {
* @param {RouterHandler[]} handlers * @param {RouterHandler[]} handlers
* @returns {Router} * @returns {Router}
*/ */
public post(url: string, ...handlers: RouterHandler[]): Router { public post(url: string, ...handlers: RouterHandler<TEnv>[]): Router<TEnv> {
return this.register('POST', url, handlers) return this.register('POST', url, handlers)
} }
@@ -270,7 +241,7 @@ export class Router {
* @param {RouterHandler[]} handlers * @param {RouterHandler[]} handlers
* @returns {Router} * @returns {Router}
*/ */
public put(url: string, ...handlers: RouterHandler[]): Router { public put(url: string, ...handlers: RouterHandler<TEnv>[]): Router<TEnv> {
return this.register('PUT', url, handlers) return this.register('PUT', url, handlers)
} }
@@ -281,7 +252,7 @@ export class Router {
* @param {RouterHandler[]} handlers * @param {RouterHandler[]} handlers
* @returns {Router} * @returns {Router}
*/ */
public trace(url: string, ...handlers: RouterHandler[]): Router { public trace(url: string, ...handlers: RouterHandler<TEnv>[]): Router<TEnv> {
return this.register('TRACE', url, handlers) return this.register('TRACE', url, handlers)
} }
@@ -292,7 +263,7 @@ export class Router {
* @param {RouterHandler[]} handlers * @param {RouterHandler[]} handlers
* @returns {Router} * @returns {Router}
*/ */
public any(url: string, ...handlers: RouterHandler[]): Router { public any(url: string, ...handlers: RouterHandler<TEnv>[]): Router<TEnv> {
return this.register('*', url, handlers) return this.register('*', url, handlers)
} }
@@ -302,7 +273,7 @@ export class Router {
* @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 { public debug(state: boolean = true): Router<TEnv> {
this.debugMode = state this.debugMode = state
return this return this
} }
@@ -313,7 +284,7 @@ export class Router {
* @param {RouterCorsConfig} [config] * @param {RouterCorsConfig} [config]
* @returns {Router} * @returns {Router}
*/ */
public cors(config?: RouterCorsConfig): Router { public cors(config?: RouterCorsConfig): Router<TEnv> {
this.corsEnabled = true this.corsEnabled = true
this.corsConfig = { this.corsConfig = {
allowOrigin: config?.allowOrigin || '*', allowOrigin: config?.allowOrigin || '*',
@@ -325,6 +296,18 @@ export class Router {
return this 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 * Register route
* *
@@ -334,7 +317,7 @@ export class Router {
* @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[]): Router { private register(method: string, url: string, handlers: RouterHandler<TEnv>[]): Router<TEnv> {
this.routes.push({ this.routes.push({
method, method,
url, url,
@@ -351,7 +334,7 @@ export class Router {
* @param {RouterRequest} request * @param {RouterRequest} request
* @returns {Route | undefined} * @returns {Route | undefined}
*/ */
private getRoute(request: RouterRequest): Route | undefined { private getRoute(request: RouterRequest): Route<TEnv> | 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)
@@ -388,13 +371,12 @@ export class Router {
/** /**
* Handle requests * Handle requests
* *
* @param {any} env * @param {TEnv} env
* @param {Request} request * @param {Request} request
* @param {any} [extend] * @param {any} [extend]
* @returns {Promise<Response>} * @returns {Promise<Response>}
*/ */
public async handle(env: any, request: Request, extend: any = {}): Promise<Response> { public async handle(request: Request, env: TEnv, ctx?: ExecutionContext, extend: any = {}): Promise<Response> {
try {
const req: RouterRequest = { const req: RouterRequest = {
...extend, ...extend,
method: request.method, method: request.method,
@@ -406,76 +388,37 @@ export class Router {
body: '' body: ''
} }
const headers = new Headers()
const route = this.getRoute(req) 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) if (!route)
return new Response(this.debugMode ? 'Route not found!' : null, { status: 404 }) return new Response(this.debugMode ? 'Route not found!' : null, { status: 404 })
if (['POST', 'PUT', 'PATCH'].includes(req.method)) { if (this.corsEnabled && req.method === 'OPTIONS') {
if (req.headers.has('Content-Type') && req.headers.get('Content-Type')!.includes('json')) { return new Response(null, {
try { headers: this.setCorsHeaders(),
req.body = await request.json() status: this.corsConfig.optionsSuccessStatus
} catch { })
req.body = {}
}
} else {
try {
req.body = await request.text()
} catch {
req.body = ''
}
}
} }
const res: RouterResponse = { headers }
const handlers = [...this.globalHandlers, ...route.handlers] const handlers = [...this.globalHandlers, ...route.handlers]
let prevIndex = -1
const runner = async (index: number) => { let response: Response | undefined
if (index === prevIndex)
throw new Error('next() called multiple times')
prevIndex = index for (const handler of handlers) {
const res = await handler({ env, req, ctx })
if (typeof handlers[index] === 'function') if (res) {
await handlers[index]({ env, req, res, next: async () => await runner(index + 1) }) 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, "alwaysStrict": true,
"noUnusedLocals": true, "noUnusedLocals": true,
"noUnusedParameters": true, "noUnusedParameters": true,
"noImplicitReturns": true,
"noFallthroughCasesInSwitch": true, "noFallthroughCasesInSwitch": true,
"esModuleInterop": true, "esModuleInterop": true,
"preserveConstEnums": true, "preserveConstEnums": true,