3.0.0-16

.github/workflows/publish-pre.yml

@@ -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 pre --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:

.nvmrc

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

MIGRATION.md

@@ -15,7 +15,7 @@ From `v2.x.x` to `v3.x.x`.
 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
 ```
 
 

README.md

@@ -12,7 +12,7 @@ I worked a lot with [Express.js](https://expressjs.com/) in the past and really
 - [Features](#features)
 - [Usage](#usage)
 - [Reference](#reference)
-- [Setup](#setup)
+- [Getting started](#getting-started)
 
 
 ## Features
@@ -33,7 +33,7 @@ Migrating from `v2.x.x`, check out the [Migration Guide](MIGRATION.md).
 ```typescript
 import { Router } from '@tsndr/cloudflare-worker-router'
 
-export interface Env {
+export type Env = {
     // Example binding to KV. Learn more at https://developers.cloudflare.com/workers/runtime-apis/kv/
     // MY_KV_NAMESPACE: KVNamespace
     //
@@ -264,7 +264,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.
 
@@ -287,7 +287,7 @@ npm i -D @tsndr/cloudflare-worker-router
 ```typescript
 import { Router } from '@tsndr/cloudflare-worker-router'
 
-export interface Env {
+export type Env = {
   // Example binding to KV. Learn more at https://developers.cloudflare.com/workers/runtime-apis/kv/
   // MY_KV_NAMESPACE: KVNamespace
   //
@@ -302,9 +302,9 @@ const router = new Router<Env>()
 
 /// Example Route
 //
-// router.get(/'hi', async () => {
+// router.get('/hi', async () => {
 //    return new Response('Hello World')
-//}
+//})
 
 
 /// Example Route for splitting into multiple files
@@ -338,9 +338,9 @@ const router = new Router()
 
 /// Example Route
 //
-// router.get(/'hi', async () => {
+// router.get('/hi', async () => {
 //    return new Response('Hello World')
-//}
+//})
 
 /// Example Route for splitting into multiple files
 //

package-lock.json

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

package.json

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

src/index.ts

@@ -6,10 +6,10 @@
 * @property {string} url URL String
 * @property {RouterHandler[]} handlers Array of handler functions
 */
-export type Route<TEnv, TExt> = {
+export type Route<TEnv, TCtx, TReq> = {
 	method: string
 	url: string
-	handlers: RouterHandler<TEnv, TExt>[]
+	handlers: RouterHandler<TEnv, TCtx, TReq>[]
 }
 
 /**
@@ -20,9 +20,9 @@ export type Route<TEnv, TExt> = {
 * @property {RouterRequest} req Request Object
 * @property {ExecutionContext} ctx Context Object
 */
-export type RouterContext<TEnv = any, TExt = any> = {
+export type RouterContext<TEnv = any, TCtx = any, TReq = any> = TCtx & {
 	env: TEnv
-	req: RouterRequest<TExt>
+	req: RouterRequest<TReq>
 	dbg: boolean
 	ctx?: ExecutionContext
 }
@@ -36,19 +36,24 @@ export type RouterContext<TEnv = any, TExt = 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 type RouterRequest<TExt> = {
+export type RouterRequest<TReq> = TReq & {
 	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
-} & TExt
+}
 
 /**
 * Request Parameters
@@ -75,8 +80,8 @@ export type RouterRequestQuery = {
 * @param {RouterContext} ctx
 * @returns {Promise<Response | void> Response | void}
 */
-export type RouterHandler<TEnv = any, TExt = any> = {
+export type RouterHandler<TEnv = any, TCtx = any, TReq = any> = {
-	(ctx: RouterContext<TEnv, TExt>): Promise<Response | void> | Response | void
+	(ctx: RouterContext<TEnv, TCtx, TReq>): Promise<Response | void> | Response | void
 }
 
 /**
@@ -97,13 +102,21 @@ export type RouterCorsConfig = {
 	optionsSuccessStatus?: number
 }
 
+export type RouterBuffer = {
+	arrayBuffer?: ArrayBuffer
+	text?: string
+	json?: any
+	formData?: FormData
+	blob?: Blob
+}
+
 /**
 * Router
 *
 * @public
 * @class
 */
-export class Router<TEnv = any, TExt = any> {
+export class Router<TEnv = any, TCtx = any, TReq = any> {
 
 	/**
 	* Router Array
@@ -111,7 +124,7 @@ export class Router<TEnv = any, TExt = any> {
 	* @protected
 	* @type {Route[]}
 	*/
-	protected routes: Route<TEnv, TExt>[] = []
+	protected routes: Route<TEnv, TCtx, TReq>[] = []
 
 	/**
 	* Global Handlers
@@ -119,7 +132,7 @@ export class Router<TEnv = any, TExt = any> {
 	* @protected
 	* @type {RouterHandler[]}
 	*/
-	protected globalHandlers: RouterHandler<TEnv, TExt>[] = []
+	protected globalHandlers: RouterHandler<TEnv, TCtx, TReq>[] = []
 
 	/**
 	* Debug Mode
@@ -137,6 +150,14 @@ export class Router<TEnv = any, TExt = any> {
 	*/
 	protected corsConfig: RouterCorsConfig = {}
 
+	/**
+	* Buffer
+	*
+	* @protected
+	* @type {RouterBuffer}
+	*/
+	protected buffer: RouterBuffer = {}
+
 	/**
 	* CORS enabled
 	*
@@ -151,7 +172,7 @@ export class Router<TEnv = any, TExt = any> {
 	* @param {RouterHandler[]} handlers
 	* @returns {Router}
 	*/
-	public use(...handlers: RouterHandler<TEnv, TExt>[]): Router<TEnv, TExt> {
+	public use(...handlers: RouterHandler<TEnv, TCtx, TReq>[]): Router<TEnv, TCtx, TReq> {
 		for (let handler of handlers) {
 			this.globalHandlers.push(handler)
 		}
@@ -165,7 +186,7 @@ export class Router<TEnv = any, TExt = any> {
 	* @param  {RouterHandler[]} handlers
 	* @returns {Router}
 	*/
-	public connect(url: string, ...handlers: RouterHandler<TEnv, TExt>[]): Router<TEnv, TExt> {
+	public connect(url: string, ...handlers: RouterHandler<TEnv, TCtx, TReq>[]): Router<TEnv, TCtx, TReq> {
 		return this.register('CONNECT', url, handlers)
 	}
 
@@ -176,7 +197,7 @@ export class Router<TEnv = any, TExt = any> {
 	* @param  {RouterHandler[]} handlers
 	* @returns {Router}
 	*/
-	public delete(url: string, ...handlers: RouterHandler<TEnv, TExt>[]): Router<TEnv, TExt> {
+	public delete(url: string, ...handlers: RouterHandler<TEnv, TCtx, TReq>[]): Router<TEnv, TCtx, TReq> {
 		return this.register('DELETE', url, handlers)
 	}
 
@@ -187,7 +208,7 @@ export class Router<TEnv = any, TExt = any> {
 	* @param  {RouterHandler[]} handlers
 	* @returns {Router}
 	*/
-	public get(url: string, ...handlers: RouterHandler<TEnv, TExt>[]): Router<TEnv, TExt> {
+	public get(url: string, ...handlers: RouterHandler<TEnv, TCtx, TReq>[]): Router<TEnv, TCtx, TReq> {
 		return this.register('GET', url, handlers)
 	}
 
@@ -198,7 +219,7 @@ export class Router<TEnv = any, TExt = any> {
 	* @param  {RouterHandler[]} handlers
 	* @returns {Router}
 	*/
-	public head(url: string, ...handlers: RouterHandler<TEnv, TExt>[]): Router<TEnv, TExt> {
+	public head(url: string, ...handlers: RouterHandler<TEnv, TCtx, TReq>[]): Router<TEnv, TCtx, TReq> {
 		return this.register('HEAD', url, handlers)
 	}
 
@@ -209,7 +230,7 @@ export class Router<TEnv = any, TExt = any> {
 	* @param  {RouterHandler[]} handlers
 	* @returns {Router}
 	*/
-	public options(url: string, ...handlers: RouterHandler<TEnv, TExt>[]): Router<TEnv, TExt> {
+	public options(url: string, ...handlers: RouterHandler<TEnv, TCtx, TReq>[]): Router<TEnv, TCtx, TReq> {
 		return this.register('OPTIONS', url, handlers)
 	}
 
@@ -220,7 +241,7 @@ export class Router<TEnv = any, TExt = any> {
 	* @param  {RouterHandler[]} handlers
 	* @returns {Router}
 	*/
-	public patch(url: string, ...handlers: RouterHandler<TEnv, TExt>[]): Router<TEnv, TExt> {
+	public patch(url: string, ...handlers: RouterHandler<TEnv, TCtx, TReq>[]): Router<TEnv, TCtx, TReq> {
 		return this.register('PATCH', url, handlers)
 	}
 
@@ -231,7 +252,7 @@ export class Router<TEnv = any, TExt = any> {
 	* @param  {RouterHandler[]} handlers
 	* @returns {Router}
 	*/
-	public post(url: string, ...handlers: RouterHandler<TEnv, TExt>[]): Router<TEnv, TExt> {
+	public post(url: string, ...handlers: RouterHandler<TEnv, TCtx, TReq>[]): Router<TEnv, TCtx, TReq> {
 		return this.register('POST', url, handlers)
 	}
 
@@ -242,7 +263,7 @@ export class Router<TEnv = any, TExt = any> {
 	* @param  {RouterHandler[]} handlers
 	* @returns {Router}
 	*/
-	public put(url: string, ...handlers: RouterHandler<TEnv, TExt>[]): Router<TEnv, TExt> {
+	public put(url: string, ...handlers: RouterHandler<TEnv, TCtx, TReq>[]): Router<TEnv, TCtx, TReq> {
 		return this.register('PUT', url, handlers)
 	}
 
@@ -253,7 +274,7 @@ export class Router<TEnv = any, TExt = any> {
 	* @param  {RouterHandler[]} handlers
 	* @returns {Router}
 	*/
-	public trace(url: string, ...handlers: RouterHandler<TEnv, TExt>[]): Router<TEnv, TExt> {
+	public trace(url: string, ...handlers: RouterHandler<TEnv, TCtx, TReq>[]): Router<TEnv, TCtx, TReq> {
 		return this.register('TRACE', url, handlers)
 	}
 
@@ -264,7 +285,7 @@ export class Router<TEnv = any, TExt = any> {
 	* @param  {RouterHandler[]} handlers
 	* @returns {Router}
 	*/
-	public any(url: string, ...handlers: RouterHandler<TEnv, TExt>[]): Router<TEnv, TExt> {
+	public any(url: string, ...handlers: RouterHandler<TEnv, TCtx, TReq>[]): Router<TEnv, TCtx, TReq> {
 		return this.register('*', url, handlers)
 	}
 
@@ -274,7 +295,7 @@ export class Router<TEnv = any, TExt = any> {
 	* @param {boolean} [state=true] Whether to turn on or off debug mode (default: true)
 	* @returns {Router}
 	*/
-	public debug(state: boolean = true): Router<TEnv, TExt> {
+	public debug(state: boolean = true): Router<TEnv, TCtx, TReq> {
 		this.debugMode = state
 		return this
 	}
@@ -285,7 +306,7 @@ export class Router<TEnv = any, TExt = any> {
 	* @param {RouterCorsConfig} [config]
 	* @returns {Router}
 	*/
-	public cors(config?: RouterCorsConfig): Router<TEnv, TExt> {
+	public cors(config?: RouterCorsConfig): Router<TEnv, TCtx, TReq> {
 		this.corsEnabled = true
 		this.corsConfig = {
 			allowOrigin: config?.allowOrigin ?? '*',
@@ -318,7 +339,7 @@ export class Router<TEnv = any, TExt = any> {
 	* @param {RouterHandler[]} handlers Arrar of handler functions
 	* @returns {Router}
 	*/
-	private register(method: string, url: string, handlers: RouterHandler<TEnv, TExt>[]): Router<TEnv, TExt> {
+	private register(method: string, url: string, handlers: RouterHandler<TEnv, TCtx, TReq>[]): Router<TEnv, TCtx, TReq> {
 		this.routes.push({
 			method,
 			url,
@@ -335,7 +356,7 @@ export class Router<TEnv = any, TExt = any> {
 	* @param {RouterRequest} request
 	* @returns {Route | undefined}
 	*/
-	private getRoute(request: RouterRequest<TExt>): Route<TEnv, TExt> | undefined {
+	private getRoute(request: RouterRequest<TReq>): Route<TEnv, TCtx, TReq> | undefined {
 		const url = new URL(request.url)
 		const pathArr = url.pathname.split('/').filter(i => i)
 
@@ -374,12 +395,13 @@ export class Router<TEnv = any, TExt = any> {
 	*
 	* @param {Request} request
 	* @param {TEnv} env
-	* @param {TExt} [ext]
+	* @param {TCtx} [extCtx]
+	* @param {TReq} [extReq]
 	* @returns {Promise<Response>}
 	*/
-	public async handle(request: Request, env: TEnv, ctx?: ExecutionContext, ext?: TExt): Promise<Response> {
+	public async handle(request: Request, env: TEnv, ctx?: ExecutionContext, extCtx?: TCtx, extReq?: TReq): Promise<Response> {
 		const req = {
-			...(ext ?? {}),
+			...(extReq ?? {}),
 			method: request.method,
 			headers: request.headers,
 			url: request.url,
@@ -387,13 +409,13 @@ export class Router<TEnv = any, TExt = any> {
 			raw: request,
 			params: {},
 			query: {},
-			body: ''
+			arrayBuffer: async (): Promise<ArrayBuffer> => this.buffer.arrayBuffer ? this.buffer.arrayBuffer : this.buffer.arrayBuffer = await request.arrayBuffer(),
-		} as RouterRequest<TExt>
+			text: async (): Promise<string> => this.buffer.text ? this.buffer.text : this.buffer.text = await request.text(),
-
+			json: async <T>(): Promise<T> => this.buffer.json ? this.buffer.json : this.buffer.json = await request.json<T>(),
-		const route = this.getRoute(req)
+			formData: async (): Promise<FormData> => this.buffer.formData ? this.buffer.formData : this.buffer.formData = await request.formData(),
-
+			blob: async (): Promise<Blob> => this.buffer.blob ? this.buffer.blob : this.buffer.blob = await request.blob(),
-		if (!route)
+			bearer: () => request.headers.get('Authorization')?.replace(/^(B|b)earer /, '').trim()
-			return new Response(this.debugMode ? 'Route not found!' : null, { status: 404 })
+		} as RouterRequest<TReq>
 
 		if (this.corsEnabled && req.method === 'OPTIONS') {
 			return new Response(null, {
@@ -402,13 +424,26 @@ export class Router<TEnv = any, TExt = any> {
 			})
 		}
 
+		const route = this.getRoute(req)
+
+		if (!route)
+			return new Response(this.debugMode ? 'Route not found!' : null, { status: 404 })
+
 		const handlers = [...this.globalHandlers, ...route.handlers]
 		const dbg = this.debugMode
 
 		let response: Response | undefined
 
 		for (const handler of handlers) {
-			const res = await handler({ env, req, dbg, ctx })
+			const context = {
+				...(extCtx ?? {}),
+				env,
+				req,
+				dbg,
+				ctx
+			} as RouterContext<TEnv, TCtx, TReq>
+
+			const res = await handler(context)
 
 			if (res) {
 				response = res
@@ -419,8 +454,10 @@ export class Router<TEnv = any, TExt = any> {
 		if (!response)
 			return 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
 	}