3.0.0-0

.editorconfig

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

README.md

@@ -1,6 +1,6 @@
 # Cloudflare Workers Router
 
-Cloudflare Workers Router is a super lightweight router (1.3K gzipped) 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.
 
@@ -18,7 +18,7 @@ I worked a lot with [Express.js](https://expressjs.com/) in the past and really
 ## Features
 
 - ZERO dependencies
-- Lightweight (1.3K gzipped)
+- Lightweight (1.0K gzipped)
 - Fully written in TypeScript
 - Integrated Debug-Mode & CORS helper
 - Built specifically around Middlewares
@@ -40,8 +40,9 @@ export interface Env {
     //
     // 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>()
@@ -50,61 +51,61 @@ const router = new Router<Env>()
 router.cors()
 
 // 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
-router.get('/user', ({ req, res }) => {
+router.get('/user', () => {
-    res.body = {
+    return Response.json({
-        data: {
         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) {
+    if (!true) {
-        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
-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 }) => {
-}, (req, res) => {
 
   const userId = req.params.id
 
   // Do stuff...
+
+  return Response.json({ userId })
 })
 
 // Listen Cloudflare Workers Fetch Event
 export default {
-    async fetch(request: Request, env: Env): Promise<Response> {
+    async fetch(request: Request, env: Env, ctx: ExecutionContext) {
-        return router.handle(env, request)
+        return router.handle(request, env, ctx)
     }
 }
+
 ```
 
 <details>
@@ -120,59 +121,56 @@ const router = new Router()
 router.cors()
 
 // 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
-router.get('/user', ({ req, res }) => {
+router.get('/user', () => {
-    res.body = {
+    return Response.json({
-        data: {
         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
+        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
-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
 
     // Do stuff...
+
+    return Response.json({ userId })
 })
 
 // Listen Cloudflare Workers Fetch Event
 export default {
-    async fetch(request, env) {
+    async fetch(request, env, ctx) {
-        return router.handle(env, request)
+        return router.handle(request, env, ctx)
     }
 }
 ```
@@ -206,7 +204,7 @@ 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])`
@@ -247,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
+`ctx`     | `ctx`-Object        | Cloudflare's `ctx`-Object
-`next`    | `next`-Handler      | Next Handler
 
 
 ### `req`-Object
@@ -270,16 +268,6 @@ 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
 
 Please follow Cloudflare's [Get started guide](https://developers.cloudflare.com/workers/get-started/guide/) to install wrangler.
@@ -335,8 +323,8 @@ const router = new Router<Env>()
 // TODO: add your routes here
 
 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)
     }
 }
 ```
@@ -360,7 +348,7 @@ const router = new Router()
 
 export default {
     async fetch(request, env, ctx) {
-        return router.handle(env, request)
+        return router.handle(request, env, ctx)
     }
 }
 ```

package-lock.json

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

package.json

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

src/index.ts

@@ -18,14 +18,12 @@
 * @typedef RouterContext
 * @property {RouterEnv} env Environment
 * @property {RouterRequest} req Request Object
- * @property {RouterResponse} res Response Object
+* @property {ExecutionContext} ctx Context Object
- * @property {RouterNext} next Next Handler
 */
-export interface RouterContext<TEnv> {
+export interface RouterContext<TEnv = any> {
 	env: TEnv
 	req: RouterRequest
-    res: RouterResponse
+	ctx: ExecutionContext
-    next: RouterNext
 }
 
 /**
@@ -69,42 +67,15 @@ 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 {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
 *
 * @callback RouterHandler
 * @param {RouterContext} ctx
- * @returns {Promise<void> | void}
+* @returns {Promise<Response | void> Response | void}
 */
 export interface RouterHandler<TEnv = any> {
-    (ctx: RouterContext<TEnv>): Promise<void> | void
+	(ctx: RouterContext<TEnv>): Promise<Response | void> | Response | void
 }
 
 /**
@@ -167,7 +138,7 @@ export class Router<TEnv = any> {
 
 	/**
 	* CORS enabled
-     *-
+	*
 	* @protected
 	* @type {boolean}
 	*/
@@ -325,6 +296,18 @@ export class Router<TEnv = any> {
 		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
 	*
@@ -393,8 +376,7 @@ export class Router<TEnv = any> {
 	* @param {any} [extend]
 	* @returns {Promise<Response>}
 	*/
-    public async handle(env: TEnv, request: Request, extend: any = {}): Promise<Response> {
+	public async handle(request: Request, env: TEnv, ctx: ExecutionContext, extend: any = {}): Promise<Response> {
-        try {
 		const req: RouterRequest = {
 			...extend,
 			method: request.method,
@@ -406,76 +388,37 @@ export class Router<TEnv = any> {
 			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 (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]
-            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
+	}
 }

tsconfig.json

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