3.0.0-5

.npmignore

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

package-lock.json

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

package.json

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

src/index.ts

@@ -6,10 +6,10 @@
 * @property {string} url URL String
 * @property {RouterHandler[]} handlers Array of handler functions
 */
-export interface Route<TEnv> {
+export interface Route<TEnv, TExt> {
 	method: string
 	url: string
-	handlers: RouterHandler<TEnv>[]
+	handlers: RouterHandler<TEnv, TExt>[]
 }
 
 /**
@@ -20,10 +20,10 @@ export interface Route<TEnv> {
 * @property {RouterRequest} req Request Object
 * @property {ExecutionContext} ctx Context Object
 */
-export interface RouterContext<TEnv = any> {
+export interface RouterContext<TEnv = any, TExt = any> {
 	env: TEnv
-	req: RouterRequest
-	ctx: ExecutionContext
+	req: RouterRequest<TExt>
+	ctx?: ExecutionContext
 }
 
 /**
@@ -38,16 +38,16 @@ export interface RouterContext<TEnv = any> {
 * @property {string | any} body Only available if method is `POST`, `PUT`, `PATCH` or `DELETE`. Contains either the received body string or a parsed object if valid JSON was sent.
 * @property {IncomingRequestCfProperties} [cf] object containing custom Cloudflare properties. (https://developers.cloudflare.com/workers/examples/accessing-the-cloudflare-object)
 */
-export interface RouterRequest {
+export type RouterRequest<TExt> = {
 	url: string
 	method: string
 	params: RouterRequestParams
 	query: RouterRequestQuery
 	headers: Headers
 	body: string | any
+	raw: Request
 	cf?: IncomingRequestCfProperties
-	[key: string]: any
-}
+} & TExt
 
 /**
 * Request Parameters
@@ -74,8 +74,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 interface RouterHandler<TEnv = any, TExt = any> {
+	(ctx: RouterContext<TEnv, TExt>): Promise<Response | void> | Response | void
 }
 
 /**
@@ -102,7 +102,7 @@ export interface RouterCorsConfig {
 * @public
 * @class
 */
-export class Router<TEnv = any> {
+export class Router<TEnv = any, TExt = any> {
 
 	/**
 	* Router Array
@@ -110,7 +110,7 @@ export class Router<TEnv = any> {
 	* @protected
 	* @type {Route[]}
 	*/
-	protected routes: Route<TEnv>[] = []
+	protected routes: Route<TEnv, TExt>[] = []
 
 	/**
 	* Global Handlers
@@ -118,7 +118,7 @@ export class Router<TEnv = any> {
 	* @protected
 	* @type {RouterHandler[]}
 	*/
-	protected globalHandlers: RouterHandler<TEnv>[] = []
+	protected globalHandlers: RouterHandler<TEnv, TExt>[] = []
 
 	/**
 	* Debug Mode
@@ -150,7 +150,7 @@ export class Router<TEnv = any> {
 	* @param {RouterHandler[]} handlers
 	* @returns {Router}
 	*/
-	public use(...handlers: RouterHandler<TEnv>[]): Router<TEnv> {
+	public use(...handlers: RouterHandler<TEnv, TExt>[]): Router<TEnv, TExt> {
 		for (let handler of handlers) {
 			this.globalHandlers.push(handler)
 		}
@@ -164,7 +164,7 @@ export class Router<TEnv = any> {
 	* @param  {RouterHandler[]} handlers
 	* @returns {Router}
 	*/
-	public connect(url: string, ...handlers: RouterHandler<TEnv>[]): Router<TEnv> {
+	public connect(url: string, ...handlers: RouterHandler<TEnv, TExt>[]): Router<TEnv, TExt> {
 		return this.register('CONNECT', url, handlers)
 	}
 
@@ -175,7 +175,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<TEnv, TExt>[]): Router<TEnv, TExt> {
 		return this.register('DELETE', url, handlers)
 	}
 
@@ -186,7 +186,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<TEnv, TExt>[]): Router<TEnv, TExt> {
 		return this.register('GET', url, handlers)
 	}
 
@@ -197,7 +197,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<TEnv, TExt>[]): Router<TEnv, TExt> {
 		return this.register('HEAD', url, handlers)
 	}
 
@@ -208,7 +208,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<TEnv, TExt>[]): Router<TEnv, TExt> {
 		return this.register('OPTIONS', url, handlers)
 	}
 
@@ -219,7 +219,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<TEnv, TExt>[]): Router<TEnv, TExt> {
 		return this.register('PATCH', url, handlers)
 	}
 
@@ -230,7 +230,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<TEnv, TExt>[]): Router<TEnv, TExt> {
 		return this.register('POST', url, handlers)
 	}
 
@@ -241,7 +241,7 @@ 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<TEnv, TExt>[]): Router<TEnv, TExt> {
 		return this.register('PUT', url, handlers)
 	}
 
@@ -252,7 +252,7 @@ export class Router<TEnv = any> {
 	* @param  {RouterHandler[]} handlers
 	* @returns {Router}
 	*/
-	public trace(url: string, ...handlers: RouterHandler<TEnv>[]): Router<TEnv> {
+	public trace(url: string, ...handlers: RouterHandler<TEnv, TExt>[]): Router<TEnv, TExt> {
 		return this.register('TRACE', url, handlers)
 	}
 
@@ -263,7 +263,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<TEnv, TExt>[]): Router<TEnv, TExt> {
 		return this.register('*', url, handlers)
 	}
 
@@ -273,7 +273,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<TEnv, TExt> {
 		this.debugMode = state
 		return this
 	}
@@ -284,7 +284,7 @@ export class Router<TEnv = any> {
 	* @param {RouterCorsConfig} [config]
 	* @returns {Router}
 	*/
-	public cors(config?: RouterCorsConfig): Router<TEnv> {
+	public cors(config?: RouterCorsConfig): Router<TEnv, TExt> {
 		this.corsEnabled = true
 		this.corsConfig = {
 			allowOrigin: config?.allowOrigin || '*',
@@ -317,7 +317,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<TEnv, TExt>[]): Router<TEnv, TExt> {
 		this.routes.push({
 			method,
 			url,
@@ -334,7 +334,7 @@ export class Router<TEnv = any> {
 	* @param {RouterRequest} request
 	* @returns {Route | undefined}
 	*/
-	private getRoute(request: RouterRequest): Route<TEnv> | undefined {
+	private getRoute(request: RouterRequest<TExt>): Route<TEnv, TExt> | undefined {
 		const url = new URL(request.url)
 		const pathArr = url.pathname.split('/').filter(i => i)
 
@@ -373,20 +373,21 @@ export class Router<TEnv = any> {
 	*
 	* @param {TEnv} env
 	* @param {Request} request
-	* @param {any} [extend]
+	* @param {TExt} [ext]
 	* @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: TEnv, ctx?: ExecutionContext, ext?: TExt): Promise<Response> {
+		const req = {
+			...(ext ?? {}),
 			method: request.method,
 			headers: request.headers,
 			url: request.url,
 			cf: request.cf,
+			raw: request,
 			params: {},
 			query: {},
 			body: ''
-		}
+		} as RouterRequest<TExt>
 
 		const route = this.getRoute(req)