3.2.7

.editorconfig

@@ -7,3 +7,11 @@ insert_final_newline = false
 [src/**.ts]
 charset = utf-8
 indent_style = tab
+
+[README.md]
+indent_style = space
+indent_size = 4
+
+[{package,package-lock}.json]
+indent_style = space
+indent_size = 2

.github/workflows/publish-main.yml

@@ -1,4 +1,4 @@
-name: Publish (main)
+name: Publish
 
 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
@@ -21,8 +21,9 @@ jobs:
         env:
           NODE_AUTH_TOKEN: ${{secrets.NPM_TOKEN}}
         run: npm publish --tag latest --access public
-      - uses: actions/setup-node@v1
+      - uses: actions/setup-node@v3
         with:
+          node-version: latest
           registry-url: https://npm.pkg.github.com/
       - name: Publish to GPR
         env:

.github/workflows/test.yml

@@ -0,0 +1,21 @@
+name: Test
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  run:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+        with:
+          node-version: latest
+          registry-url: https://registry.npmjs.org/
+      - name: Install dependencies
+        run: npm ci
+      - name: Run tests
+        run: npm test

.npmignore

@@ -1,6 +1,10 @@
+.editorconfig
 .github/
-src/
-test/
+.gitignore
 .nvmrc
+coverage/
+jest.config.ts
 MIGRATION.md
+src/
+tests/
 tsconfig.json

.nvmrc

@@ -1 +0,0 @@
-v16

MIGRATION.md

@@ -1,71 +1,69 @@
 # 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)
-- [Fetch](#fetch--routerhandle)
+- [Update Router](#update-router)
+- [Handlers](#handlers)
 
 
-## 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>

README.md

@@ -4,15 +4,13 @@ Cloudflare Workers Router is a super lightweight router (1.0K gzipped) with midd
 
 When I was trying out Cloudflare Workers I almost immediately noticed how fast it was compared to other serverless offerings. So I wanted to build a full-fledged API to see how it performs doing real work, but since I wasn't able to find a router that suited my needs I created my own.
 
-I worked a lot with [Express.js](https://expressjs.com/) in the past and really enjoyed their middleware approach, but since none of the available Cloudflare Worker routers offered middleware support at the time, I felt the need to create this router.
-
 
 ## Contents
 
 - [Features](#features)
 - [Usage](#usage)
 - [Reference](#reference)
-- [Setup](#setup)
+- [Getting started](#getting-started)
 
 
 ## Features
@@ -26,12 +24,18 @@ I worked a lot with [Express.js](https://expressjs.com/) in the past and really
 
 ## Usage
 
+Migrating from `v2.x.x`, check out the [Migration Guide](MIGRATION.md).
+
 ### TypeScript Example
 
 ```typescript
 import { Router } from '@tsndr/cloudflare-worker-router'
 
-export interface Env {
+// Env Types
+export type Var<T = string> = T
+export type Secret<T = string> = T
+
+export type Env = {
     // Example binding to KV. Learn more at https://developers.cloudflare.com/workers/runtime-apis/kv/
     // MY_KV_NAMESPACE: KVNamespace
     //
@@ -41,22 +45,32 @@ export interface Env {
     // Example binding to R2. Learn more at https://developers.cloudflare.com/workers/runtime-apis/r2/
     // MY_BUCKET: R2Bucket
 
-    SECRET_TOKEN: string
+    ENVIRONMENT: Var<'dev' | 'prod'>
+
+    SECRET_TOKEN: Secret
 }
 
-// Initialize router
-const router = new Router<Env>()
+// Request Extension
+export type ExtReq = {
+    userId?: number
+}
+
+// Context Extension
+export type ExtCtx = {
+    //sentry?: Toucan
+}
+
+// Initialize Router
+const router = new Router<Env, ExtCtx, ExtReq>()
 
 // Enabling build in CORS support
 router.cors()
 
 // Register global middleware
-router.use(() => {
-    return new Response(null, {
-        headers: {
-            'X-Global-Middlewares': 'true'
-        }
-    })
+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
@@ -85,9 +99,7 @@ router.post('/user/:id', ({ req }) => {
 
 // Delete route using a middleware
 router.delete('/user/:id', ({ env, req }) => {
-    const { SECRET_TOKEN } = env
-
-    if (req.headers.get('Authorization') === SECRET_TOKEN)
+    if (req.headers.get('authorization') === env.SECRET_TOKEN)
         return new Response(null, { status: 401 })
 
 }, ({ req }) => {
@@ -121,12 +133,10 @@ const router = new Router()
 router.cors()
 
 // Register global middleware
-router.use(() => {
-    return new Response(null, {
-        headers: {
-            'X-Global-Middlewares': 'true'
-        }
-    })
+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
@@ -139,11 +149,12 @@ router.get('/user', () => {
 
 // Post route with url parameter
 router.post('/user/:id', ({ req }) => {
+
     const userId = req.params.id
 
     // Do stuff
 
-    if (errorDoingStuff) {
+    if (!true) {
         return Response.json({
             error: 'Error doing stuff!'
         }, { status: 400 })
@@ -154,12 +165,11 @@ router.post('/user/:id', ({ req }) => {
 
 // Delete route using a middleware
 router.delete('/user/:id', ({ env, req }) => {
-    const { SECRET_TOKEN } = env
-
-    if (req.headers.get('Authorization') === SECRET_TOKEN)
+    if (req.headers.get('authorization') === env.SECRET_TOKEN)
         return new Response(null, { status: 401 })
 
 }, ({ req }) => {
+
   const userId = req.params.id
 
   // Do stuff...
@@ -215,10 +225,12 @@ If enabled will overwrite other `OPTIONS` requests.
 #### `config` (object, optional)
 
 Key                        | Type       | Default Value
----------------------- | --------- | -------------
+-------------------------- | ---------- | -------------
 `allowOrigin`              | `string`   | `*`
 `allowMethods`             | `string`   | `*`
 `allowHeaders`             | `string`   | `*`
+`allowCredentials`         | `boolean`  | `undefined`
+`vary`                     | `string`   | `undefined`
 `maxAge`                   | `integer`  | `86400`
 `optionsSuccessStatus`     | `integer`  | `204`
 
@@ -226,7 +238,6 @@ Key                    | Type      | Default Value
 ### Supported Methods
 
 - `router.any(url, [...handlers])`
-- `router.connect(url, [...handlers])`
 - `router.delete(url, [...handlers])`
 - `router.get(url, [...handlers])`
 - `router.head(url, [...handlers])`
@@ -234,7 +245,6 @@ Key                    | Type      | Default Value
 - `router.patch(url, [...handlers])`
 - `router.post(url, [...handlers])`
 - `router.put(url, [...handlers])`
-- `router.trace(url, [...handlers])`
 
 
 #### `url` (string)
@@ -268,7 +278,7 @@ Key       | Type                | Description
 `query`   | `object`            | Object containing all query parameters
 
 
-## Setup
+## Getting started
 
 Please follow Cloudflare's [Get started guide](https://developers.cloudflare.com/workers/get-started/guide/) to install wrangler.
 
@@ -282,7 +292,7 @@ wrangler init <name>
 Use of TypeScript is strongly encouraged :)
 
 ```bash
-npm i -D @tsndr/cloudflare-worker-router
+npm i @tsndr/cloudflare-worker-router
 ```
 
 
@@ -291,7 +301,11 @@ npm i -D @tsndr/cloudflare-worker-router
 ```typescript
 import { Router } from '@tsndr/cloudflare-worker-router'
 
-export interface Env {
+// Env Types
+export type Var<T = string> = T
+export type Secret<T = string> = T
+
+export type Env = {
   // Example binding to KV. Learn more at https://developers.cloudflare.com/workers/runtime-apis/kv/
   // MY_KV_NAMESPACE: KVNamespace
   //
@@ -300,25 +314,50 @@ export interface Env {
   //
   // Example binding to R2. Learn more at https://developers.cloudflare.com/workers/runtime-apis/r2/
   // MY_BUCKET: R2Bucket
+  //
+  // Example Variable
+  // ENVIRONMENT: Var<'dev' | 'prod'>
+  //
+  // Example Secret
+  // JWT_SECRET: Secret
 }
 
-const router = new Router<Env>()
+// Request Extension
+export type ExtReq = {
+  userId?: number
+}
+
+// Context Extension
+export type ExtCtx = {
+  //sentry?: Toucan
+}
+
+// Handler Type
+export type Handler = RouterHandler<Env, ExtCtx, ExtReq>
+
+// Initialize Router
+const router = new Router<Env, ExtCtx, ExtReq>()
+
+// Enable Debug Mode
+router.debug()
+
+// Enabling build in CORS support
+//router.cors()
 
 /// Example Route
 //
-// router.get(/'hi', ({ res }) => {
-//    res.body = 'Hello World'
-//}
+// router.get('/hi', async () => {
+//   return new Response('Hello World')
+// })
 
 
 /// Example Route for splitting into multiple files
 //
-// const hiHandler: RouteHandler<Env> = ({ res }) => {
-//     res.body = 'Hello World'
+// const helloHandler: Handler = async () => {
+//    return new Response('Hello World')
 // }
 //
-// router.get('/hi', hiHandler)
-
+// router.get('/hellow', helloHandler)
 
 // TODO: add your routes here
 
@@ -340,9 +379,25 @@ import { Router } from '@tsndr/cloudflare-worker-router'
 
 const router = new Router()
 
-// router.get(/'hi', ({ res }) => {
-//    res.body = 'Hello World'
+// Enable Debug Mode
+//router.debug()
+
+// Enabling build in CORS support
+//router.cors()
+
+/// Example Route
+//
+// router.get('/hi', async () => {
+//    return new Response('Hello World')
+//})
+
+/// Example Route for splitting into multiple files
+//
+// async function hiHandler() {
+//    return new Response('Hello World')
 // }
+//
+// router.get('/hi', hiHandler)
 
 // TODO: add your routes here
 

package.json

@@ -1,22 +1,23 @@
 {
   "name": "@tsndr/cloudflare-worker-router",
-  "version": "3.0.0-0",
+  "version": "3.2.7",
   "description": "",
-  "main": "index.js",
+  "type": "module",
+  "exports": "./index.js",
   "types": "index.d.ts",
   "scripts": {
-    "build": "tsc"
+    "build": "tsc",
+    "test": "vitest"
   },
   "repository": {
     "type": "git",
     "url": "git+https://github.com/tsndr/cloudflare-worker-router.git"
   },
   "keywords": [
+    "api",
     "cloudflare",
     "cloudflare-worker",
     "cloudflare-workers",
-    "express",
-    "expressjs",
     "framework",
     "middleware",
     "router",
@@ -31,7 +32,9 @@
   },
   "homepage": "https://github.com/tsndr/cloudflare-worker-router#readme",
   "devDependencies": {
-    "@cloudflare/workers-types": "^3.13.0",
-    "typescript": "^4.7.4"
+    "@cloudflare/workers-types": "^4.20240222.0",
+    "@edge-runtime/vm": "^3.2.0",
+    "typescript": "^5.3.3",
+    "vitest": "^1.3.1"
   }
 }

src/index.ts

@@ -6,10 +6,10 @@
 * @property {string} url URL String
 * @property {RouterHandler[]} handlers Array of handler functions
 */
-export interface Route<TEnv> {
+export type Route<Env, CtxExt, ReqExt> = {
 	method: string
 	url: string
-	handlers: RouterHandler<TEnv>[]
+	handlers: RouterHandler<Env, CtxExt, ReqExt>[]
 }
 
 /**
@@ -20,10 +20,11 @@ export interface Route<TEnv> {
 * @property {RouterRequest} req Request Object
 * @property {ExecutionContext} ctx Context Object
 */
-export interface RouterContext<TEnv = any> {
-	env: TEnv
-	req: RouterRequest
-	ctx: ExecutionContext
+export type RouterContext<Env = any, CtxExt = {}, ReqExt = {}> = CtxExt & {
+	env: Env
+	req: RouterRequest<ReqExt>
+	dbg: boolean
+	ctx?: ExecutionContext
 }
 
 /**
@@ -35,18 +36,23 @@ export interface RouterContext<TEnv = any> {
 * @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 {Request} raw Raw Request Object
 * @property {IncomingRequestCfProperties} [cf] object containing custom Cloudflare properties. (https://developers.cloudflare.com/workers/examples/accessing-the-cloudflare-object)
 */
-export interface RouterRequest {
+export type RouterRequest<ReqExt> = ReqExt & {
 	url: string
 	method: string
 	params: RouterRequestParams
 	query: RouterRequestQuery
 	headers: Headers
-	body: string | any
+	raw: Request
+	arrayBuffer(): Promise<ArrayBuffer>
+	text(): Promise<string>
+	json<T>(): Promise<T>
+	formData(): Promise<FormData>
+	blob(): Promise<Blob>
+	bearer(): string | undefined
 	cf?: IncomingRequestCfProperties
-	[key: string]: any
 }
 
 /**
@@ -54,7 +60,7 @@ export interface RouterRequest {
 *
 * @typedef RouterRequestParams
 */
-export interface RouterRequestParams {
+export type RouterRequestParams = {
 	[key: string]: string
 }
 
@@ -63,7 +69,7 @@ export interface RouterRequestParams {
 *
 * @typedef RouterRequestQuery
 */
-export interface RouterRequestQuery {
+export type RouterRequestQuery = {
 	[key: string]: string
 }
 
@@ -74,8 +80,8 @@ export interface RouterRequestQuery {
 * @param {RouterContext} ctx
 * @returns {Promise<Response | void> Response | void}
 */
-export interface RouterHandler<TEnv = any> {
-	(ctx: RouterContext<TEnv>): Promise<Response | void> | Response | void
+export type RouterHandler<Env = any, CtxExt = {}, ReqExt = {}> = {
+	(ctx: RouterContext<Env, CtxExt, ReqExt>): Promise<Response | void> | Response | void
 }
 
 /**
@@ -85,24 +91,36 @@ export interface RouterHandler<TEnv = any> {
 * @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 {boolean} [allowCredentials="true"] Access-Control-Allow-Credentials (default: undefined)
+* @property {string} [vary="origin"] vary (default: undefined)
 * @property {number} [maxAge=86400] Access-Control-Max-Age (default: `86400`)
 * @property {number} [optionsSuccessStatus=204] Return status code for OPTIONS request (default: `204`)
 */
-export interface RouterCorsConfig {
+export type RouterCorsConfig = {
 	allowOrigin?: string
 	allowMethods?: string
 	allowHeaders?: string
+	allowCredentials?: boolean
+	vary?: string
 	maxAge?: number
 	optionsSuccessStatus?: number
 }
 
+export type RouterBuffer = {
+	arrayBuffer?: ArrayBuffer
+	text?: string
+	json?: any
+	formData?: FormData
+	blob?: Blob
+}
+
 /**
 * Router
 *
 * @public
 * @class
 */
-export class Router<TEnv = any> {
+export class Router<Env = any, CtxExt = {}, ReqExt = {}> {
 
 	/**
 	* Router Array
@@ -110,7 +128,7 @@ export class Router<TEnv = any> {
 	* @protected
 	* @type {Route[]}
 	*/
-	protected routes: Route<TEnv>[] = []
+	protected routes: Route<Env, CtxExt, ReqExt>[] = []
 
 	/**
 	* Global Handlers
@@ -118,7 +136,7 @@ export class Router<TEnv = any> {
 	* @protected
 	* @type {RouterHandler[]}
 	*/
-	protected globalHandlers: RouterHandler<TEnv>[] = []
+	protected globalHandlers: RouterHandler<Env, CtxExt, ReqExt>[] = []
 
 	/**
 	* Debug Mode
@@ -150,24 +168,13 @@ export class Router<TEnv = any> {
 	* @param {RouterHandler[]} handlers
 	* @returns {Router}
 	*/
-	public use(...handlers: RouterHandler<TEnv>[]): Router<TEnv> {
+	public use(...handlers: RouterHandler<Env, CtxExt, ReqExt>[]): Router<Env, CtxExt, ReqExt> {
 		for (let handler of handlers) {
 			this.globalHandlers.push(handler)
 		}
 		return this
 	}
 
-	/**
-	* Register CONNECT route
-	*
-	* @param {string} url
-	* @param  {RouterHandler[]} handlers
-	* @returns {Router}
-	*/
-	public connect(url: string, ...handlers: RouterHandler<TEnv>[]): Router<TEnv> {
-		return this.register('CONNECT', url, handlers)
-	}
-
 	/**
 	* Register DELETE route
 	*
@@ -175,7 +182,7 @@ export class Router<TEnv = any> {
 	* @param  {RouterHandler[]} handlers
 	* @returns {Router}
 	*/
-	public delete(url: string, ...handlers: RouterHandler<TEnv>[]): Router<TEnv> {
+	public delete(url: string, ...handlers: RouterHandler<Env, CtxExt, ReqExt>[]): Router<Env, CtxExt, ReqExt> {
 		return this.register('DELETE', url, handlers)
 	}
 
@@ -186,7 +193,7 @@ export class Router<TEnv = any> {
 	* @param  {RouterHandler[]} handlers
 	* @returns {Router}
 	*/
-	public get(url: string, ...handlers: RouterHandler<TEnv>[]): Router<TEnv> {
+	public get(url: string, ...handlers: RouterHandler<Env, CtxExt, ReqExt>[]): Router<Env, CtxExt, ReqExt> {
 		return this.register('GET', url, handlers)
 	}
 
@@ -197,7 +204,7 @@ export class Router<TEnv = any> {
 	* @param  {RouterHandler[]} handlers
 	* @returns {Router}
 	*/
-	public head(url: string, ...handlers: RouterHandler<TEnv>[]): Router<TEnv> {
+	public head(url: string, ...handlers: RouterHandler<Env, CtxExt, ReqExt>[]): Router<Env, CtxExt, ReqExt> {
 		return this.register('HEAD', url, handlers)
 	}
 
@@ -208,7 +215,7 @@ export class Router<TEnv = any> {
 	* @param  {RouterHandler[]} handlers
 	* @returns {Router}
 	*/
-	public options(url: string, ...handlers: RouterHandler<TEnv>[]): Router<TEnv> {
+	public options(url: string, ...handlers: RouterHandler<Env, CtxExt, ReqExt>[]): Router<Env, CtxExt, ReqExt> {
 		return this.register('OPTIONS', url, handlers)
 	}
 
@@ -219,7 +226,7 @@ export class Router<TEnv = any> {
 	* @param  {RouterHandler[]} handlers
 	* @returns {Router}
 	*/
-	public patch(url: string, ...handlers: RouterHandler<TEnv>[]): Router<TEnv> {
+	public patch(url: string, ...handlers: RouterHandler<Env, CtxExt, ReqExt>[]): Router<Env, CtxExt, ReqExt> {
 		return this.register('PATCH', url, handlers)
 	}
 
@@ -230,7 +237,7 @@ export class Router<TEnv = any> {
 	* @param  {RouterHandler[]} handlers
 	* @returns {Router}
 	*/
-	public post(url: string, ...handlers: RouterHandler<TEnv>[]): Router<TEnv> {
+	public post(url: string, ...handlers: RouterHandler<Env, CtxExt, ReqExt>[]): Router<Env, CtxExt, ReqExt> {
 		return this.register('POST', url, handlers)
 	}
 
@@ -241,21 +248,10 @@ export class Router<TEnv = any> {
 	* @param  {RouterHandler[]} handlers
 	* @returns {Router}
 	*/
-	public put(url: string, ...handlers: RouterHandler<TEnv>[]): Router<TEnv> {
+	public put(url: string, ...handlers: RouterHandler<Env, CtxExt, ReqExt>[]): Router<Env, CtxExt, ReqExt> {
 		return this.register('PUT', url, handlers)
 	}
 
-	/**
-	* Register TRACE route
-	*
-	* @param {string} url
-	* @param  {RouterHandler[]} handlers
-	* @returns {Router}
-	*/
-	public trace(url: string, ...handlers: RouterHandler<TEnv>[]): Router<TEnv> {
-		return this.register('TRACE', url, handlers)
-	}
-
 	/**
 	* Register route, ignoring method
 	*
@@ -263,7 +259,7 @@ export class Router<TEnv = any> {
 	* @param  {RouterHandler[]} handlers
 	* @returns {Router}
 	*/
-	public any(url: string, ...handlers: RouterHandler<TEnv>[]): Router<TEnv> {
+	public any(url: string, ...handlers: RouterHandler<Env, CtxExt, ReqExt>[]): Router<Env, CtxExt, ReqExt> {
 		return this.register('*', url, handlers)
 	}
 
@@ -273,7 +269,7 @@ export class Router<TEnv = any> {
 	* @param {boolean} [state=true] Whether to turn on or off debug mode (default: true)
 	* @returns {Router}
 	*/
-	public debug(state: boolean = true): Router<TEnv> {
+	public debug(state: boolean = true): Router<Env, CtxExt, ReqExt> {
 		this.debugMode = state
 		return this
 	}
@@ -284,14 +280,16 @@ export class Router<TEnv = any> {
 	* @param {RouterCorsConfig} [config]
 	* @returns {Router}
 	*/
-	public cors(config?: RouterCorsConfig): Router<TEnv> {
+	public cors(config?: RouterCorsConfig): Router<Env, CtxExt, ReqExt> {
 		this.corsEnabled = true
 		this.corsConfig = {
-			allowOrigin: config?.allowOrigin || '*',
-			allowMethods: config?.allowMethods || '*',
-			allowHeaders: config?.allowHeaders || '*',
-			maxAge: config?.maxAge || 86400,
-			optionsSuccessStatus: config?.optionsSuccessStatus || 204
+			allowOrigin: config?.allowOrigin ?? '*',
+			allowMethods: config?.allowMethods ?? '*',
+			allowHeaders: config?.allowHeaders ?? '*',
+			allowCredentials: config?.allowCredentials ?? undefined,
+			vary: config?.vary ?? undefined,
+			maxAge: config?.maxAge ?? 86400,
+			optionsSuccessStatus: config?.optionsSuccessStatus ?? 204
 		}
 		return this
 	}
@@ -303,6 +301,10 @@ export class Router<TEnv = any> {
 			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.allowCredentials && !headers.has('Access-Control-Allow-Credentials'))
+			headers.set('Access-Control-Allow-Credentials', this.corsConfig.allowCredentials.toString())
+		if (this.corsConfig.vary && !headers.has('vary'))
+			headers.set('vary', this.corsConfig.vary.toString())
 		if (this.corsConfig.maxAge && !headers.has('Access-Control-Max-Age'))
 			headers.set('Access-Control-Max-Age', this.corsConfig.maxAge.toString())
 		return headers
@@ -317,7 +319,7 @@ export class Router<TEnv = any> {
 	* @param {RouterHandler[]} handlers Arrar of handler functions
 	* @returns {Router}
 	*/
-	private register(method: string, url: string, handlers: RouterHandler<TEnv>[]): Router<TEnv> {
+	private register(method: string, url: string, handlers: RouterHandler<Env, CtxExt, ReqExt>[]): Router<Env, CtxExt, ReqExt> {
 		this.routes.push({
 			method,
 			url,
@@ -334,7 +336,7 @@ export class Router<TEnv = any> {
 	* @param {RouterRequest} request
 	* @returns {Route | undefined}
 	*/
-	private getRoute(request: RouterRequest): Route<TEnv> | undefined {
+	private getRoute(request: RouterRequest<ReqExt>): Route<Env, CtxExt, ReqExt> | undefined {
 		const url = new URL(request.url)
 		const pathArr = url.pathname.split('/').filter(i => i)
 
@@ -371,27 +373,30 @@ export class Router<TEnv = any> {
 	/**
 	* Handle requests
 	*
-	* @param {TEnv} env
 	* @param {Request} request
-	* @param {any} [extend]
+	* @param {Env} env
+	* @param {CtxExt} [ctxExt]
+	* @param {ReqExt} [reqExt]
 	* @returns {Promise<Response>}
 	*/
-	public async handle(request: Request, env: TEnv, ctx: ExecutionContext, extend: any = {}): Promise<Response> {
-		const req: RouterRequest = {
-			...extend,
+	public async handle(request: Request, env: Env, ctx?: ExecutionContext, ctxExt?: CtxExt, reqExt?: ReqExt): Promise<Response> {
+		const buffer: RouterBuffer = {}
+		const req = {
+			...(reqExt ?? {}),
 			method: request.method,
 			headers: request.headers,
 			url: request.url,
 			cf: request.cf,
+			raw: request,
 			params: {},
 			query: {},
-			body: ''
-		}
-
-		const route = this.getRoute(req)
-
-		if (!route)
-			return new Response(this.debugMode ? 'Route not found!' : null, { status: 404 })
+			arrayBuffer: async (): Promise<ArrayBuffer> => buffer.arrayBuffer ? buffer.arrayBuffer : buffer.arrayBuffer = await request.clone().arrayBuffer(),
+			text: async (): Promise<string> => buffer.text ? buffer.text : buffer.text = await request.clone().text(),
+			json: async <T>(): Promise<T> => buffer.json ? buffer.json : buffer.json = await request.clone().json<T>(),
+			formData: async (): Promise<FormData> => buffer.formData ? buffer.formData : buffer.formData = await request.clone().formData(),
+			blob: async (): Promise<Blob> => buffer.blob ? buffer.blob : buffer.blob = await request.clone().blob(),
+			bearer: () => request.headers.get('Authorization')?.replace(/^(B|b)earer /, '').trim()
+		} as RouterRequest<ReqExt>
 
 		if (this.corsEnabled && req.method === 'OPTIONS') {
 			return new Response(null, {
@@ -400,24 +405,43 @@ export class Router<TEnv = any> {
 			})
 		}
 
-		const handlers = [...this.globalHandlers, ...route.handlers]
-
+		const route = this.getRoute(req)
 		let response: Response | undefined
 
+		if (!route)
+			response = new Response(this.debugMode ? 'Route not found!' : null, { status: 404 })
+
+		if (!response) {
+			const handlers = [
+				...this.globalHandlers,
+				...(route?.handlers ?? [])
+			]
+
 			for (const handler of handlers) {
-			const res = await handler({ env, req, ctx })
+				const context = {
+					...(ctxExt ?? {}),
+					env,
+					req,
+					dbg: this.debugMode,
+					ctx
+				} as RouterContext<Env, CtxExt, ReqExt>
+
+				const res = await handler(context)
 
 				if (res) {
 					response = res
 					break
 				}
 			}
+		}
 
 		if (!response)
-			return new Response(this.debugMode ? 'Handler did not return a Response!' : null, { status: 404 })
+			response = new Response(this.debugMode ? 'Handler did not return a Response!' : null, { status: 404 })
 
-		if (this.corsEnabled)
+		if (this.corsEnabled) {
+			response = new Response(response.body, response)
 			this.setCorsHeaders(response.headers)
+		}
 
 		return response
 	}

tests/index.spec.ts

@@ -0,0 +1,366 @@
+import { describe, expect, test } from 'vitest'
+import { Router } from '../src/index'
+
+describe('Router', () => {
+	test('use', async () => {
+		const router = new Router()
+		const testRequest = new Request('https://example.com/')
+		const testResponse = new Response('success', { status: 200 })
+
+		expect(router.use(() => testResponse)).toBeInstanceOf(Router)
+
+		router.get('/', () => new Response('failed'))
+
+		const response = await router.handle(testRequest, {})
+
+		expect(response.status).toBe(200)
+
+		expect(await response.text()).toBe('success')
+	})
+
+	test('delete', async () => {
+		const router = new Router()
+		const testRequest = new Request('https://example.com/', { method: 'DELETE' })
+		const testResponse = new Response('success', { status: 200 })
+
+		expect(router.delete('/', () => testResponse)).toBeInstanceOf(Router)
+
+		const response = await router.handle(testRequest, {})
+
+		expect(response.status).toBe(200)
+
+		expect(await response.text()).toBe('success')
+	})
+
+	test('get', async () => {
+		const router = new Router()
+		const testRequest = new Request('https://example.com/', { method: 'GET' })
+		const testResponse = new Response('success', { status: 200 })
+
+		expect(router.get('/', () => testResponse)).toBeInstanceOf(Router)
+
+		const response = await router.handle(testRequest, {})
+
+		expect(response.status).toBe(200)
+
+		expect(await response.text()).toBe('success')
+	})
+
+	test('head', async () => {
+		const router = new Router()
+		const testRequest = new Request('https://example.com/', { method: 'HEAD' })
+		const testResponse = new Response('success', { status: 200 })
+
+		expect(router.head('/', () => testResponse)).toBeInstanceOf(Router)
+
+		const response = await router.handle(testRequest, {})
+
+		expect(response.status).toBe(200)
+
+		expect(await response.text()).toBe('success')
+	})
+
+	test('options', async () => {
+		const router = new Router()
+		const testRequest = new Request('https://example.com/', { method: 'OPTIONS' })
+		const testResponse = new Response('success', { status: 200 })
+
+		expect(router.options('/', () => testResponse)).toBeInstanceOf(Router)
+
+		const response = await router.handle(testRequest, {})
+
+		expect(response.status).toBe(200)
+
+		expect(await response.text()).toBe('success')
+	})
+
+	test('patch', async () => {
+		const router = new Router()
+		const testRequest = new Request('https://example.com/', { method: 'PATCH' })
+		const testResponse = new Response('success', { status: 200 })
+
+		expect(router.patch('/', () => testResponse)).toBeInstanceOf(Router)
+
+		const response = await router.handle(testRequest, {})
+
+		expect(response.status).toBe(200)
+
+		expect(await response.text()).toBe('success')
+	})
+
+	test('post', async () => {
+		const router = new Router()
+		const testRequest = new Request('https://example.com/', { method: 'POST' })
+		const testResponse = new Response('success', { status: 200 })
+
+		expect(router.post('/test', () => testResponse)).toBeInstanceOf(Router)
+		expect(router.post('/', () => testResponse)).toBeInstanceOf(Router)
+
+		const response = await router.handle(testRequest, {})
+
+		expect(response.status).toBe(200)
+
+		expect(await response.text()).toBe('success')
+	})
+
+	test('put', async () => {
+		const router = new Router()
+		const testRequest = new Request('https://example.com/', { method: 'PUT' })
+		const testResponse = new Response('success', { status: 200 })
+
+		expect(router.put('/test', () => testResponse)).toBeInstanceOf(Router)
+		expect(router.put('/', () => testResponse)).toBeInstanceOf(Router)
+
+		const response = await router.handle(testRequest, {})
+
+		expect(response.status).toBe(200)
+
+		expect(await response.text()).toBe('success')
+	})
+
+	test('any', async () => {
+		const router = new Router()
+		const testRequest = new Request('https://example.com/', { method: 'POST' })
+		const testResponse = new Response('success', { status: 200 })
+
+		expect(router.any('/test', () => testResponse)).toBeInstanceOf(Router)
+		expect(router.any('/', () => testResponse)).toBeInstanceOf(Router)
+
+		const response = await router.handle(testRequest, {})
+
+		expect(response.status).toBe(200)
+
+		expect(await response.text()).toBe('success')
+	})
+
+	test('cors', async () => {
+		const router = new Router()
+		const testRequest = new Request('https://example.com/', { method: 'GET' })
+		const testOptionsRequest = new Request('https://example.com/', { method: 'OPTIONS' })
+		const testResponse = new Response('success', { status: 200 })
+
+		expect(router.cors()).toBeInstanceOf(Router)
+
+		router.get('/', () => testResponse)
+
+		const response = await router.handle(testRequest, {})
+
+		expect(response.status).toBe(200)
+
+		expect(response.headers.get('Access-Control-Allow-Origin')).toBe('*')
+		expect(response.headers.get('Access-Control-Allow-Methods')).toBe('*')
+		expect(response.headers.get('Access-Control-Allow-Headers')).toBe('*')
+		expect(response.headers.get('Access-Control-Allow-Credentials')).toBe(null)
+		expect(response.headers.get('vary')).toBe(null)
+		expect(response.headers.get('Access-Control-Max-Age')).toBe('86400')
+
+		const optionsRes = await router.handle(testOptionsRequest, {})
+
+		expect(optionsRes.status).toBe(204)
+		expect(optionsRes.headers.get('Access-Control-Allow-Origin')).toBe('*')
+		expect(optionsRes.headers.get('Access-Control-Allow-Methods')).toBe('*')
+		expect(optionsRes.headers.get('Access-Control-Allow-Headers')).toBe('*')
+		expect(optionsRes.headers.get('Access-Control-Allow-Credentials')).toBe(null)
+		expect(optionsRes.headers.get('vary')).toBe(null)
+		expect(optionsRes.headers.get('Access-Control-Max-Age')).toBe('86400')
+
+		expect(await response.text()).toBe('success')
+	})
+
+	test('params', async () => {
+		const router = new Router()
+		const testRequest = new Request('https://example.com/bar/foo')
+
+		router.get('/:foo/:bar', ({ req }) => {
+			return Response.json(req.params)
+		})
+
+		const response = await router.handle(testRequest, {})
+
+		expect(response.status).toEqual(200)
+
+		expect(await response.json()).toMatchObject({ foo: 'bar', bar: 'foo' })
+	})
+
+	test('query', async () => {
+		const router = new Router()
+		const testRequest = new Request('https://example.com/?foo=bar&bar=foo')
+
+		router.get('/', ({ req }) => {
+			return Response.json(req.query)
+		})
+
+		const response = await router.handle(testRequest, {})
+
+		expect(response.status).toEqual(200)
+
+		expect(await response.json()).toMatchObject({ foo: 'bar', bar: 'foo' })
+	})
+
+	test('404', async () => {
+		const router = new Router()
+		const testRequest = new Request('https://example.com/')
+
+		const response = await router.handle(testRequest, {})
+
+		expect(response.status).toEqual(404)
+	})
+
+	test('debug mode', async () => {
+		const router = new Router()
+		const testRequest = new Request('https://example.com/')
+
+		router.debug()
+
+		const response = await router.handle(testRequest, {})
+
+		expect(response.status).toEqual(404)
+
+		expect(await response.text()).toBe('Route not found!')
+	})
+
+	test('handler no response', async () => {
+		const router = new Router()
+		const testRequest = new Request('https://example.com/')
+
+		router.debug()
+
+		router.get('/', () => {})
+
+		const response = await router.handle(testRequest, {})
+
+		expect(response.status).toEqual(404)
+
+		expect(await response.text()).toBe('Handler did not return a Response!')
+	})
+
+	test('wildcard', async () => {
+		const router = new Router()
+		const testRequest = new Request('https://example.com/foo/bar')
+		const testResponse = new Response('success', { status: 200 })
+
+		router.get('*', () => testResponse)
+
+		const response = await router.handle(testRequest, {})
+
+		expect(response.status).toEqual(200)
+
+		expect(await response.text()).toBe('success')
+	})
+
+	test('bearer', async () => {
+		const router = new Router()
+		const testToken = 'super-secret-token'
+		const testRequest = new Request('https://example.com/', { headers: { 'Authorization': `Bearer ${testToken}` }})
+
+		router.get('/', ({ req }) => new Response(req.bearer()))
+
+		const response = await router.handle(testRequest, {})
+
+		expect(response.status).toEqual(200)
+
+		expect(await response.text()).toBe(testToken)
+	})
+})
+
+describe('Middleware', () => {
+	const router = new Router()
+	const testHandlerSuccess = () => new Response('success', { status: 200 })
+	const testHandlerContinue = () => {}
+	const testHandlerFailed = () => new Response('failed', { status: 403 })
+
+	router.get('/success', testHandlerContinue, testHandlerSuccess)
+	router.get('/failed', testHandlerFailed, testHandlerSuccess)
+
+	test('continue', async () => {
+		const testRequest = new Request('https://example.com/success')
+		const response = await router.handle(testRequest, {})
+
+		expect(response.status).toEqual(200)
+
+		expect(await response.text()).toBe('success')
+	})
+
+	test('block', async () => {
+		const testRequest = new Request('https://example.com/failed')
+		const response = await router.handle(testRequest, {})
+
+		expect(response.status).toEqual(403)
+
+		expect(await response.text()).toBe('failed')
+	})
+})
+
+describe('Body', () => {
+
+	test('text then text', async () => {
+		const router = new Router()
+		const testText = "lorem ipsum dolor sit amet"
+		const testRequest = new Request('https://example.com/', { method: 'POST', body: testText })
+
+		router.post('/', async ({ req }) => {
+			return Response.json({
+				text: await req.text(),
+				text2: await req.text()
+			})
+		})
+
+		const response = await router.handle(testRequest, {})
+
+		expect(await response.json()).toMatchObject({ text: testText, text2: testText })
+	})
+
+	test('json then json', async () => {
+		const router = new Router()
+		const testObject = { text: 'cloudflare-worker-router', binary: true, amount: 17 }
+		const testJson = JSON.stringify(testObject)
+		const testRequest = new Request('https://example.com/', { method: 'POST', body: testJson })
+
+		router.post('/', async ({ req }) => {
+			return Response.json({
+				json: await req.json(),
+				json2: await req.json()
+			})
+		})
+
+		const response = await router.handle(testRequest, {})
+
+		expect(await response.json()).toMatchObject({ json: testObject, json2: testObject })
+	})
+
+	test('text then json', async () => {
+		const router = new Router()
+		const testObject = { text: 'cloudflare-worker-router', binary: true, amount: 17 }
+		const testJson = JSON.stringify(testObject)
+		const testRequest = new Request('https://example.com/', { method: 'POST', body: testJson })
+
+		router.post('/', async ({ req }) => {
+			return Response.json({
+				text: await req.text(),
+				json: await req.json()
+			})
+		})
+
+		const response = await router.handle(testRequest, {})
+
+		expect(await response.json()).toMatchObject({ text: testJson, json: testObject })
+	})
+
+	test('json then text', async () => {
+		const router = new Router()
+		const testObject = { text: 'cloudflare-worker-router', binary: true, amount: 17 }
+		const testJson = JSON.stringify(testObject)
+		const testRequest = new Request('https://example.com/', { method: 'POST', body: testJson })
+
+		router.post('/', async ({ req }) => {
+			return Response.json({
+				json: await req.json(),
+				text: await req.text()
+			})
+		})
+
+		const response = await router.handle(testRequest, {})
+
+		expect(await response.json()).toMatchObject({ text: testJson, json: testObject })
+	})
+})

vite.config.ts

@@ -0,0 +1,9 @@
+import { defineConfig } from 'vitest/config'
+
+export default defineConfig({
+	test: {
+		environment: 'edge-runtime',
+		reporters: ['verbose'],
+		watch: false
+	}
+})