3.0.0-11

.editorconfig

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

.github/workflows/publish-pre.yml

@@ -1,4 +1,4 @@
-name: Publish (main)
+name: Publish (pre)
 
 on:
   release:
@@ -20,11 +20,11 @@ jobs:
       - name: Publish to npmjs
         env:
           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
         with:
           registry-url: https://npm.pkg.github.com/
       - name: Publish to GPR
         env:
           NODE_AUTH_TOKEN: ${{secrets.GITHUB_TOKEN}}
-        run: npm publish --tag latest --access public
+        run: npm publish --tag pre --access public

.npmignore

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

MIGRATION.md

@@ -1,71 +1,70 @@
 # Migration Guide
 
-From `v1.x.x` to `v2.x.x`.
+From `v2.x.x` to `v3.x.x`.
+
 
 ## Contents
 
-- [Preparation](#preparation)
+- [Update Router](#update-router)
-- [Update](#update)
+- [Handlers](#handlers)
-- [Import / Require](#import--require)
-- [Routes](#routes)
 - [Fetch](#fetch--routerhandle)
 
 
-## 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 to the latest version version of the router.
-
-## Update
-
-Update to the latest version verstion
 
 ```bash
 npm i -D @tsndr/cloudflare-worker-router
 ```
 
-## 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
+```typescript
-const Router = require('@tsndr/cloudflare-worker-router')
+// 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
+```typescript
-import Router from '@tsndr/cloudflare-worker-router'
+// 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

@@ -1,6 +1,6 @@
 # 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.
 
@@ -9,81 +9,168 @@ I worked a lot with [Express.js](https://expressjs.com/) in the past and really
 
 ## Contents
 
+- [Features](#features)
 - [Usage](#usage)
 - [Reference](#reference)
-- [Setup](#setup)
+- [Getting started](#getting-started)
+
+
+## Features
+
+- ZERO dependencies
+- Lightweight (1.0K gzipped)
+- Fully written in TypeScript
+- Integrated Debug-Mode & CORS helper
+- Built specifically around Middlewares
 
 
 ## Usage
 
-### Simple Example
+Migrating from `v2.x.x`, check out the [Migration Guide](MIGRATION.md).
 
-```javascript
+### TypeScript Example
-import Router from '@tsndr/cloudflare-worker-router'
+
+```typescript
+import { Router } from '@tsndr/cloudflare-worker-router'
+
+export type 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()
+const router = new Router<Env>()
 
-// Enabling buildin CORS support
+// Enabling build in CORS support
 router.cors()
 
 // Register global middleware
-router.use(({ req, res, next }) => {
+router.use(({ env, req }) => {
-  res.headers.set('X-Global-Middlewares', 'true')
+    // Intercept if token doesn't match
-  next()
+    if (req.headers.get('authorization') !== env.SECRET_TOKEN)
+        return new Response(null, { status: 401 })
 })
 
 // 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
-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 (!true) {
-    res.status = 400
+        return Response.json({
-    res.body = {
+            error: 'Error doing stuff!'
-      error: 'User did stupid stuff!'
+        }, { status: 400 })
     }
-    return
+
-  }
+    return Response.json({ userId }, { status: 204 })
-  
-  res.status = 204
 })
 
 // Delete route using a middleware
-router.delete('/user/:id', ({ req, res, next }) => {
+router.delete('/user/:id', ({ env, req }) => {
+    if (req.headers.get('authorization') === env.SECRET_TOKEN)
+        return new Response(null, { status: 401 })
 
-  if (!apiTokenIsCorrect) {
+}, ({ req }) => {
-    res.status = 401
-    return
-  }
-  
-  await next()
-}, (req, res) => {
 
   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: Request, env: Env, ctx: ExecutionContext) {
-    return router.handle(env, request)
+        return router.handle(request, env, ctx)
-  }
+    }
+}
+
+```
+
+<details>
+    <summary>JavaScript Example</summary>
+
+```javascript
+import { Router } from '@tsndr/cloudflare-worker-router'
+
+// Initialize router
+const router = new Router()
+
+// Enabling build in CORS support
+router.cors()
+
+// 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'
+    })
+})
+
+// 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 }) => {
+    if (req.headers.get('authorization') === env.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, env, ctx) {
+        return router.handle(request, env, ctx)
+    }
 }
 ```
+</details>
 
 
 ## Reference
@@ -96,6 +183,10 @@ Enable or disable debug mode. Which will return the `error.stack` in case of an
 #### `state`
 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])`
 
@@ -106,8 +197,10 @@ Register a global middleware handler.
 
 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])`
@@ -126,16 +219,19 @@ Key                    | Type      | Default Value
 `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)
 
@@ -145,16 +241,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
@@ -168,83 +264,97 @@ Key       | Type                | Description
 `query`   | `object`            | Object containing all query parameters
 
 
-### `res`-Object
+## Getting started
 
-Key         | Type                | Description
+Please follow Cloudflare's [Get started guide](https://developers.cloudflare.com/workers/get-started/guide/) to install wrangler.
------------ | ------------------- | -----------
-`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
+#### Initialize Project
 
----
+```bash
-### ❗️ Compatibility ❗️
+wrangler init <name>
+```
 
-CLI Tool | Router
+Use of TypeScript is strongly encouraged :)
--------- | ------
-[wrangler2](https://github.com/cloudflare/wrangler2#readme) | Use `v2.x.x` or later.
-[@cloudflare/wrangler](https://github.com/cloudflare/wrangler#readme) | Use `v1.x.x`, [here](https://github.com/tsndr/cloudflare-worker-router/tree/legacy#readme).
-
-See [Migration from v1.x.x to v2.x.x](https://github.com/tsndr/cloudflare-worker-router/blob/main/MIGRATION.md#migration-guide) if you want to update.
-
----
-
-### **[Wrangler2](https://github.com/cloudflare/wrangler2#readme)**
-
-Please follow Cloudflare's [Get started guide](https://developers.cloudflare.com/workers/get-started/guide/), then install the router using this command
 
 ```bash
 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
-import Router from '@tsndr/cloudflare-worker-router'
+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;
+  // 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;
+  // MY_DURABLE_OBJECT: DurableObjectNamespace
   //
   // 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', async () => {
+//    return new Response('Hello World')
+//})
+
+
+/// Example Route for splitting into multiple files
+//
+// const hiHandler: RouteHandler<Env> = async () => {
+//    return new Response('Hello World')
+// }
+//
+// router.get('/hi', hiHandler)
+
 
 // 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)
     }
 }
 ```
-</details>
+
+
+### JavaScript (<code>src/index.js</code>)
 
 <details>
-<summary>JavaScript (<code>src/index.js</code>)</summary>
+    <summary>Consider using TypeScript instead :)</summary>
 
 ```javascript
-import Router from '@tsndr/cloudflare-worker-router'
+import { Router } from '@tsndr/cloudflare-worker-router'
 
 const router = new Router()
 
+/// 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
 
 export default {
     async fetch(request, env, ctx) {
-        return router.handle(env, request)
+        return router.handle(request, env, ctx)
     }
 }
 ```
-</details>

package-lock.json

@@ -1,28 +1,28 @@
 {
   "name": "@tsndr/cloudflare-worker-router",
-  "version": "2.1.1",
+  "version": "3.0.0-11",
   "lockfileVersion": 2,
   "requires": true,
   "packages": {
     "": {
       "name": "@tsndr/cloudflare-worker-router",
-      "version": "2.1.1",
+      "version": "3.0.0-11",
       "license": "MIT",
       "devDependencies": {
-        "@cloudflare/workers-types": "^3.13.0",
+        "@cloudflare/workers-types": "^4.20230115.0",
-        "typescript": "^4.7.4"
+        "typescript": "^4.9.5"
       }
     },
     "node_modules/@cloudflare/workers-types": {
-      "version": "3.13.0",
+      "version": "4.20230115.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.20230115.0.tgz",
-      "integrity": "sha512-oyhzfYlWBLgd9odJ/WHcsD/8B+IaAjSD+OcPEGLzX5kGRONjwcW3NY0WQfsVIhQzZ6AbPzjwkmj4D2VFwU1xRQ==",
+      "integrity": "sha512-GPJEiO8AFN+jUpA+DHJ1qdVmk4s/hq8JYKjOV/+U7avGquQbVnj905+Kg6uAEfrq16muwmRKl+XJGqsvlBlDNg==",
       "dev": true
     },
     "node_modules/typescript": {
-      "version": "4.7.4",
+      "version": "4.9.5",
-      "resolved": "https://registry.npmjs.org/typescript/-/typescript-4.7.4.tgz",
+      "resolved": "https://registry.npmjs.org/typescript/-/typescript-4.9.5.tgz",
-      "integrity": "sha512-C0WQT0gezHuw6AdY1M2jxUO83Rjf0HP7Sk1DtXj6j1EwkQNZrHAg2XPWlq62oqEhYvONq5pkC2Y9oPljWToLmQ==",
+      "integrity": "sha512-1FXk9E2Hm+QzZQ7z+McJiHL4NW1F2EzMu9Nq9i3zAaGqibafqYwCVU6WyWAuyQRRzOlxou8xZSyXLEN8oKj24g==",
       "dev": true,
       "bin": {
         "tsc": "bin/tsc",
@@ -35,15 +35,15 @@
   },
   "dependencies": {
     "@cloudflare/workers-types": {
-      "version": "3.13.0",
+      "version": "4.20230115.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.20230115.0.tgz",
-      "integrity": "sha512-oyhzfYlWBLgd9odJ/WHcsD/8B+IaAjSD+OcPEGLzX5kGRONjwcW3NY0WQfsVIhQzZ6AbPzjwkmj4D2VFwU1xRQ==",
+      "integrity": "sha512-GPJEiO8AFN+jUpA+DHJ1qdVmk4s/hq8JYKjOV/+U7avGquQbVnj905+Kg6uAEfrq16muwmRKl+XJGqsvlBlDNg==",
       "dev": true
     },
     "typescript": {
-      "version": "4.7.4",
+      "version": "4.9.5",
-      "resolved": "https://registry.npmjs.org/typescript/-/typescript-4.7.4.tgz",
+      "resolved": "https://registry.npmjs.org/typescript/-/typescript-4.9.5.tgz",
-      "integrity": "sha512-C0WQT0gezHuw6AdY1M2jxUO83Rjf0HP7Sk1DtXj6j1EwkQNZrHAg2XPWlq62oqEhYvONq5pkC2Y9oPljWToLmQ==",
+      "integrity": "sha512-1FXk9E2Hm+QzZQ7z+McJiHL4NW1F2EzMu9Nq9i3zAaGqibafqYwCVU6WyWAuyQRRzOlxou8xZSyXLEN8oKj24g==",
       "dev": true
     }
   }

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tsndr/cloudflare-worker-router",
-  "version": "2.1.1",
+  "version": "3.0.0-11",
   "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.20230115.0",
-    "typescript": "^4.7.4"
+    "typescript": "^4.9.5"
   }
 }

src/index.ts

@@ -1,481 +1,439 @@
 /**
- * Route Object
+* Route Object
- * 
+*
- * @typedef Route
+* @typedef Route
- * @property {string} method HTTP request method
+* @property {string} method HTTP request method
- * @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 type Route<TEnv, TExt> = {
-    method: string
+	method: string
-    url: string
+	url: string
-    handlers: RouterHandler[]
+	handlers: RouterHandler<TEnv, TExt>[]
 }
 
 /**
- * Router Context
+* Router Context
- * 
+*
- * @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 type RouterContext<TEnv = any, TExt = any> = {
-export interface RouterContext {
+	env: TEnv
-    env: any
+	req: RouterRequest<TExt>
-    req: RouterRequest
+	dbg: boolean
-    res: RouterResponse
+	ctx?: ExecutionContext
-    next: RouterNext
 }
 
 /**
- * Request Object
+* Request Object
- * 
+*
- * @typedef RouterRequest
+* @typedef RouterRequest
- * @property {string} url URL
+* @property {string} url URL
- * @property {string} method HTTP request method
+* @property {string} method HTTP request method
- * @property {RouterRequestParams} params Object containing all parameters defined in the url string
+* @property {RouterRequestParams} params Object containing all parameters defined in the url string
- * @property {RouterRequestQuery} query Object containing all query parameters
+* @property {RouterRequestQuery} query Object containing all query parameters
- * @property {Headers} headers Request headers object
+* @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)
+* @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
+	url: string
-    method: string
+	method: string
-    params: RouterRequestParams
+	params: RouterRequestParams
-    query: RouterRequestQuery
+	query: RouterRequestQuery
-    headers: Headers
+	headers: Headers
-    body: string | any
+	raw: Request
-    cf?: IncomingRequestCfProperties
+	arrayBuffer(): Promise<ArrayBuffer>
-    [key: string]: any
+	text(): Promise<string>
+	json<T>(): Promise<T>
+	formData(): Promise<FormData>
+	blob(): Promise<Blob>
+	bearer: () => string
+	cf?: IncomingRequestCfProperties
+} & TExt
+
+/**
+* Request Parameters
+*
+* @typedef RouterRequestParams
+*/
+export type RouterRequestParams = {
+	[key: string]: string
 }
 
 /**
- * Request Parameters
+* Request Query
- * 
+*
- * @typedef RouterRequestParams
+* @typedef RouterRequestQuery
- */
+*/
-export interface RouterRequestParams {
+export type RouterRequestQuery = {
-    [key: string]: string
+	[key: string]: string
 }
 
 /**
- * Request Query
+* Handler Function
- * 
+*
- * @typedef RouterRequestQuery
+* @callback RouterHandler
- */
+* @param {RouterContext} ctx
-export interface RouterRequestQuery {
+* @returns {Promise<Response | void> Response | void}
-    [key: string]: string
+*/
+export type RouterHandler<TEnv = any, TExt = any> = {
+	(ctx: RouterContext<TEnv, TExt>): Promise<Response | void> | Response | void
 }
 
 /**
- * Response Object
+* CORS Config
- * 
+*
- * @typedef RouterResponse
+* @typedef RouterCorsConfig
- * @property {Headers} headers Response headers object
+* @property {string} [allowOrigin="*"] Access-Control-Allow-Origin (default: `*`)
- * @property {number} [status=204] Return status code (default: `204`)
+* @property {string} [allowMethods="*"] Access-Control-Allow-Methods (default: `*`)
- * @property {string | any} [body] Either an `object` (will be converted to JSON) or a string
+* @property {string} [allowHeaders="*"] Access-Control-Allow-Headers (default: `*`)
- * @property {Response} [raw] A response object that is to be returned, this will void all other res properties and return this as is.
+* @property {number} [maxAge=86400] Access-Control-Max-Age (default: `86400`)
- */
+* @property {number} [optionsSuccessStatus=204] Return status code for OPTIONS request (default: `204`)
-export interface RouterResponse {
+*/
-    headers: Headers
+export type RouterCorsConfig = {
-    status?: number
+	allowOrigin?: string
-    body?: string | any
+	allowMethods?: string
-    raw?: Response,
+	allowHeaders?: string
-    webSocket?: WebSocket
+	maxAge?: number
+	optionsSuccessStatus?: number
 }
 
 /**
- * Next Function
+* Router
- * 
+*
- * @callback RouterNext
+* @public
- * @returns {Promise<void>}
+* @class
- */
+*/
-export interface RouterNext {
+export class Router<TEnv = any, TExt = any> {
-    (): Promise<void>
+
-}
+	/**
-
+	* Router Array
-/**
+	*
- * Handler Function
+	* @protected
- * 
+	* @type {Route[]}
- * @callback RouterHandler
+	*/
- * @param {RouterContext} ctx
+	protected routes: Route<TEnv, TExt>[] = []
- * @returns {Promise<void> | void}
+
- */
+	/**
-export interface RouterHandler {
+	* Global Handlers
-    (ctx: RouterContext): Promise<void> | void
+	*
-}
+	* @protected
-
+	* @type {RouterHandler[]}
-/**
+	*/
- * CORS Config
+	protected globalHandlers: RouterHandler<TEnv, TExt>[] = []
- * 
+
- * @typedef RouterCorsConfig
+	/**
- * @property {string} [allowOrigin="*"] Access-Control-Allow-Origin (default: `*`)
+	* Debug Mode
- * @property {string} [allowMethods="*"] Access-Control-Allow-Methods (default: `*`)
+	*
- * @property {string} [allowHeaders="*"] Access-Control-Allow-Headers (default: `*`)
+	* @protected
- * @property {number} [maxAge=86400] Access-Control-Max-Age (default: `86400`)
+	* @type {boolean}
- * @property {number} [optionsSuccessStatus=204] Return status code for OPTIONS request (default: `204`)
+	*/
- */
+	protected debugMode: boolean = false
-export interface RouterCorsConfig {
+
-    allowOrigin?: string
+	/**
-    allowMethods?: string
+	* CORS Config
-    allowHeaders?: string
+	*
-    maxAge?: number
+	* @protected
-    optionsSuccessStatus?: number
+	* @type {RouterCorsConfig}
-}
+	*/
-
+	protected corsConfig: RouterCorsConfig = {}
-/**
+
- * Router
+	/**
- * 
+	* CORS enabled
- * @public
+	*
- * @class
+	* @protected
- */
+	* @type {boolean}
-export default class Router {
+	*/
-
+	protected corsEnabled: boolean = false
-    /**
+
-     * Router Array
+	/**
-     * 
+	* Register global handlers
-     * @protected
+	*
-     * @type {Route[]}
+	* @param {RouterHandler[]} handlers
-     */
+	* @returns {Router}
-    protected routes: Route[] = []
+	*/
-
+	public use(...handlers: RouterHandler<TEnv, TExt>[]): Router<TEnv, TExt> {
-    /**
+		for (let handler of handlers) {
-     * Global Handlers
+			this.globalHandlers.push(handler)
-     * 
+		}
-     * @protected
+		return this
-     * @type {RouterHandler[]}
+	}
-     */
+
-    protected globalHandlers: RouterHandler[] = []
+	/**
-
+	* Register CONNECT route
-    /**
+	*
-     * Debug Mode
+	* @param {string} url
-     * 
+	* @param  {RouterHandler[]} handlers
-     * @protected
+	* @returns {Router}
-     * @type {boolean}
+	*/
-     */
+	public connect(url: string, ...handlers: RouterHandler<TEnv, TExt>[]): Router<TEnv, TExt> {
-    protected debugMode: boolean = false
+		return this.register('CONNECT', url, handlers)
-
+	}
-    /**
+
-     * CORS Config
+	/**
-     * 
+	* Register DELETE route
-     * @protected
+	*
-     * @type {RouterCorsConfig}
+	* @param {string} url
-     */
+	* @param  {RouterHandler[]} handlers
-    protected corsConfig: RouterCorsConfig = {}
+	* @returns {Router}
-
+	*/
-    /**
+	public delete(url: string, ...handlers: RouterHandler<TEnv, TExt>[]): Router<TEnv, TExt> {
-     * CORS enabled
+		return this.register('DELETE', url, handlers)
-     *-
+	}
-     * @protected
+
-     * @type {boolean}
+	/**
-     */
+	* Register GET route
-    protected corsEnabled: boolean = false
+	*
-
+	* @param {string} url
-    /**
+	* @param  {RouterHandler[]} handlers
-     * Register global handlers
+	* @returns {Router}
-     * 
+	*/
-     * @param {RouterHandler[]} handlers
+	public get(url: string, ...handlers: RouterHandler<TEnv, TExt>[]): Router<TEnv, TExt> {
-     * @returns {Router}
+		return this.register('GET', url, handlers)
-     */
+	}
-    public use(...handlers: RouterHandler[]): Router {
+
-        for (let handler of handlers) {
+	/**
-            this.globalHandlers.push(handler)
+	* Register HEAD route
-        }
+	*
-        return this
+	* @param {string} url
-    }
+	* @param  {RouterHandler[]} handlers
-
+	* @returns {Router}
-    /**
+	*/
-     * Register CONNECT route
+	public head(url: string, ...handlers: RouterHandler<TEnv, TExt>[]): Router<TEnv, TExt> {
-     * 
+		return this.register('HEAD', url, handlers)
-     * @param {string} url 
+	}
-     * @param  {RouterHandler[]} handlers 
+
-     * @returns {Router}
+	/**
-     */
+	* Register OPTIONS route
-    public connect(url: string, ...handlers: RouterHandler[]): Router {
+	*
-        return this.register('CONNECT', url, handlers)
+	* @param {string} url
-    }
+	* @param  {RouterHandler[]} handlers
-
+	* @returns {Router}
-    /**
+	*/
-     * Register DELETE route
+	public options(url: string, ...handlers: RouterHandler<TEnv, TExt>[]): Router<TEnv, TExt> {
-     * 
+		return this.register('OPTIONS', url, handlers)
-     * @param {string} url 
+	}
-     * @param  {RouterHandler[]} handlers 
+
-     * @returns {Router}
+	/**
-     */
+	* Register PATCH route
-    public delete(url: string, ...handlers: RouterHandler[]): Router {
+	*
-        return this.register('DELETE', url, handlers)
+	* @param {string} url
-    }
+	* @param  {RouterHandler[]} handlers
-
+	* @returns {Router}
-    /**
+	*/
-     * Register GET route
+	public patch(url: string, ...handlers: RouterHandler<TEnv, TExt>[]): Router<TEnv, TExt> {
-     * 
+		return this.register('PATCH', url, handlers)
-     * @param {string} url 
+	}
-     * @param  {RouterHandler[]} handlers 
+
-     * @returns {Router}
+	/**
-     */
+	* Register POST route
-    public get(url: string, ...handlers: RouterHandler[]): Router {
+	*
-        return this.register('GET', url, handlers)
+	* @param {string} url
-    }
+	* @param  {RouterHandler[]} handlers
-
+	* @returns {Router}
-    /**
+	*/
-     * Register HEAD route
+	public post(url: string, ...handlers: RouterHandler<TEnv, TExt>[]): Router<TEnv, TExt> {
-     * 
+		return this.register('POST', url, handlers)
-     * @param {string} url 
+	}
-     * @param  {RouterHandler[]} handlers 
+
-     * @returns {Router}
+	/**
-     */
+	* Register PUT route
-    public head(url: string, ...handlers: RouterHandler[]): Router {
+	*
-        return this.register('HEAD', url, handlers)
+	* @param {string} url
-    }
+	* @param  {RouterHandler[]} handlers
-
+	* @returns {Router}
-    /**
+	*/
-     * Register OPTIONS route
+	public put(url: string, ...handlers: RouterHandler<TEnv, TExt>[]): Router<TEnv, TExt> {
-     * 
+		return this.register('PUT', url, handlers)
-     * @param {string} url 
+	}
-     * @param  {RouterHandler[]} handlers 
+
-     * @returns {Router}
+	/**
-     */
+	* Register TRACE route
-    public options(url: string, ...handlers: RouterHandler[]): Router {
+	*
-        return this.register('OPTIONS', url, handlers)
+	* @param {string} url
-    }
+	* @param  {RouterHandler[]} handlers
-
+	* @returns {Router}
-    /**
+	*/
-     * Register PATCH route
+	public trace(url: string, ...handlers: RouterHandler<TEnv, TExt>[]): Router<TEnv, TExt> {
-     * 
+		return this.register('TRACE', url, handlers)
-     * @param {string} url 
+	}
-     * @param  {RouterHandler[]} handlers 
+
-     * @returns {Router}
+	/**
-     */
+	* Register route, ignoring method
-    public patch(url: string, ...handlers: RouterHandler[]): Router {
+	*
-        return this.register('PATCH', url, handlers)
+	* @param {string} url
-    }
+	* @param  {RouterHandler[]} handlers
-
+	* @returns {Router}
-    /**
+	*/
-     * Register POST route
+	public any(url: string, ...handlers: RouterHandler<TEnv, TExt>[]): Router<TEnv, TExt> {
-     * 
+		return this.register('*', url, handlers)
-     * @param {string} url 
+	}
-     * @param  {RouterHandler[]} handlers 
+
-     * @returns {Router}
+	/**
-     */
+	* Debug Mode
-    public post(url: string, ...handlers: RouterHandler[]): Router {
+	*
-        return this.register('POST', url, handlers)
+	* @param {boolean} [state=true] Whether to turn on or off debug mode (default: true)
-    }
+	* @returns {Router}
-
+	*/
-    /**
+	public debug(state: boolean = true): Router<TEnv, TExt> {
-     * Register PUT route
+		this.debugMode = state
-     * 
+		return this
-     * @param {string} url 
+	}
-     * @param  {RouterHandler[]} handlers 
+
-     * @returns {Router}
+	/**
-     */
+	* Enable CORS support
-    public put(url: string, ...handlers: RouterHandler[]): Router {
+	*
-        return this.register('PUT', url, handlers)
+	* @param {RouterCorsConfig} [config]
-    }
+	* @returns {Router}
-
+	*/
-    /**
+	public cors(config?: RouterCorsConfig): Router<TEnv, TExt> {
-     * Register TRACE route
+		this.corsEnabled = true
-     * 
+		this.corsConfig = {
-     * @param {string} url 
+			allowOrigin: config?.allowOrigin ?? '*',
-     * @param  {RouterHandler[]} handlers 
+			allowMethods: config?.allowMethods ?? '*',
-     * @returns {Router}
+			allowHeaders: config?.allowHeaders ?? '*',
-     */
+			maxAge: config?.maxAge ?? 86400,
-    public trace(url: string, ...handlers: RouterHandler[]): Router {
+			optionsSuccessStatus: config?.optionsSuccessStatus ?? 204
-        return this.register('TRACE', url, handlers)
+		}
-    }
+		return this
-
+	}
-    /**
+
-     * Register route, ignoring method
+	private setCorsHeaders(headers: Headers = new Headers()): Headers {
-     * 
+		if (this.corsConfig.allowOrigin && !headers.has('Access-Control-Allow-Origin'))
-     * @param {string} url 
+			headers.set('Access-Control-Allow-Origin', this.corsConfig.allowOrigin)
-     * @param  {RouterHandler[]} handlers 
+		if (this.corsConfig.allowMethods && !headers.has('Access-Control-Allow-Methods'))
-     * @returns {Router}
+			headers.set('Access-Control-Allow-Methods', this.corsConfig.allowMethods)
-     */
+		if (this.corsConfig.allowHeaders && !headers.has('Access-Control-Allow-Headers'))
-    public any(url: string, ...handlers: RouterHandler[]): Router {
+			headers.set('Access-Control-Allow-Headers', this.corsConfig.allowHeaders)
-        return this.register('*', url, handlers)
+		if (this.corsConfig.maxAge && !headers.has('Access-Control-Max-Age'))
-    }
+			headers.set('Access-Control-Max-Age', this.corsConfig.maxAge.toString())
-
+		return headers
-    /**
+	}
-     * Debug Mode
+
-     * 
+	/**
-     * @param {boolean} [state=true] Whether to turn on or off debug mode (default: true)
+	* Register route
-     * @returns {Router}
+	*
-     */
+	* @private
-    public debug(state: boolean = true): Router {
+	* @param {string} method HTTP request method
-        this.debugMode = state
+	* @param {string} url URL String
-        return this
+	* @param {RouterHandler[]} handlers Arrar of handler functions
-    }
+	* @returns {Router}
-
+	*/
-    /**
+	private register(method: string, url: string, handlers: RouterHandler<TEnv, TExt>[]): Router<TEnv, TExt> {
-     * Enable CORS support
+		this.routes.push({
-     * 
+			method,
-     * @param {RouterCorsConfig} [config]
+			url,
-     * @returns {Router}
+			handlers
-     */
+		})
-    public cors(config?: RouterCorsConfig): Router {
+
-        this.corsEnabled = true
+		return this
-        this.corsConfig = {
+	}
-            allowOrigin: config?.allowOrigin || '*',
+
-            allowMethods: config?.allowMethods || '*',
+	/**
-            allowHeaders: config?.allowHeaders || '*',
+	* Get Route by request
-            maxAge: config?.maxAge || 86400,
+	*
-            optionsSuccessStatus: config?.optionsSuccessStatus || 204
+	* @private
-        }
+	* @param {RouterRequest} request
-        return this
+	* @returns {Route | undefined}
-    }
+	*/
-
+	private getRoute(request: RouterRequest<TExt>): Route<TEnv, TExt> | undefined {
-    /**
+		const url = new URL(request.url)
-     * Register route
+		const pathArr = url.pathname.split('/').filter(i => i)
-     * 
+
-     * @private
+		return this.routes.find(r => {
-     * @param {string} method HTTP request method
+			const routeArr = r.url.split('/').filter(i => i)
-     * @param {string} url URL String
+
-     * @param {RouterHandler[]} handlers Arrar of handler functions
+			if (![request.method, '*'].includes(r.method) || routeArr.length !== pathArr.length)
-     * @returns {Router}
+				return false
-     */
+
-    private register(method: string, url: string, handlers: RouterHandler[]): Router {
+			const params: RouterRequestParams = {}
-        this.routes.push({
+
-            method,
+			for (let i = 0; i < routeArr.length; i++) {
-            url,
+				if (routeArr[i] !== pathArr[i] && routeArr[i][0] !== ':')
-            handlers
+					return false
-        })
+
-
+				if (routeArr[i][0] === ':')
-        return this
+					params[routeArr[i].substring(1)] = pathArr[i]
-    }
+			}
-
+
-    /**
+			request.params = params
-     * Get Route by request
+
-     * 
+			const query: any = {}
-     * @private
+
-     * @param {RouterRequest} request
+			for (const [k, v] of url.searchParams.entries()) {
-     * @returns {Route | undefined}
+				query[k] = v
-     */
+			}
-    private getRoute(request: RouterRequest): Route | undefined {
+
-        const url = new URL(request.url)
+			request.query = query
-        const pathArr = url.pathname.split('/').filter(i => i)
+
-
+			return true
-        return this.routes.find(r => {
+		}) || this.routes.find(r => r.url === '*' && [request.method, '*'].includes(r.method))
-            const routeArr = r.url.split('/').filter(i => i)
+	}
-
+
-            if (![request.method, '*'].includes(r.method) || routeArr.length !== pathArr.length)
+   /**
-                return false
+	* Handle requests
-
+	*
-            const params: RouterRequestParams = {}
+	* @param {Request} request
-
+	* @param {TEnv} env
-            for (let i = 0; i < routeArr.length; i++) {
+	* @param {TExt} [ext]
-                if (routeArr[i] !== pathArr[i] && routeArr[i][0] !== ':')
+	* @returns {Promise<Response>}
-                    return false
+	*/
-
+	public async handle(request: Request, env: TEnv, ctx?: ExecutionContext, ext?: TExt): Promise<Response> {
-                if (routeArr[i][0] === ':')
+		const req = {
-                    params[routeArr[i].substring(1)] = pathArr[i]
+			...(ext ?? {}),
-            }
+			method: request.method,
-
+			headers: request.headers,
-            request.params = params
+			url: request.url,
-
+			cf: request.cf,
-            const query: any = {}
+			raw: request,
-
+			params: {},
-            for (const [k, v] of url.searchParams.entries()) {
+			query: {},
-                query[k] = v
+			arrayBuffer: (): Promise<ArrayBuffer> => request.arrayBuffer(),
-            }
+			text: (): Promise<string> => request.text(),
-
+			json: <T>(): Promise<T> => request.json<T>(),
-            request.query = query
+			formData: (): Promise<FormData> => request.formData(),
-
+			blob: (): Promise<Blob> => request.blob(),
-            return true
+			bearer: () => request.headers.get('Authorization')?.replace(/^(B|b)earer /, '').trim() ?? '',
-        }) || this.routes.find(r => r.url === '*' && [request.method, '*'].includes(r.method))
+		} as RouterRequest<TExt>
-    }
+
-
+		if (this.corsEnabled && req.method === 'OPTIONS') {
-    /**
+			return new Response(null, {
-     * Handle requests
+				headers: this.setCorsHeaders(),
-     * 
+				status: this.corsConfig.optionsSuccessStatus
-     * @param {any} env
+			})
-     * @param {Request} request
+		}
-     * @param {any} [extend]
+
-     * @returns {Promise<Response>}
+		const route = this.getRoute(req)
-     */
+
-    public async handle(env: any, request: Request, extend: any = {}): Promise<Response> {
+		if (!route)
-        try {
+			return new Response(this.debugMode ? 'Route not found!' : null, { status: 404 })
-            const req: RouterRequest = {
+
-                ...extend,
+		const handlers = [...this.globalHandlers, ...route.handlers]
-                method: request.method,
+		const dbg = this.debugMode
-                headers: request.headers,
+
-                url: request.url,
+		let response: Response | undefined
-                cf: request.cf,
+
-                params: {},
+		for (const handler of handlers) {
-                query: {},
+			const res = await handler({ env, req, dbg, ctx })
-                body: ''
+
-            }
+			if (res) {
-
+				response = res
-            const headers = new Headers()
+				break
-            const route = this.getRoute(req)
+			}
-
+		}
-            if (this.corsEnabled) {
+
-                if (this.corsConfig.allowOrigin)
+		if (!response)
-                    headers.set('Access-Control-Allow-Origin', this.corsConfig.allowOrigin)
+			return new Response(this.debugMode ? 'Handler did not return a Response!' : null, { status: 404 })
-                if (this.corsConfig.allowMethods)
+
-                    headers.set('Access-Control-Allow-Methods', this.corsConfig.allowMethods)
+		if (this.corsEnabled) {
-                if (this.corsConfig.allowHeaders)
+			response = new Response(response.body, response)
-                    headers.set('Access-Control-Allow-Headers', this.corsConfig.allowHeaders)
+			this.setCorsHeaders(response.headers)
-                if (this.corsConfig.maxAge)
+		}
-                    headers.set('Access-Control-Max-Age', this.corsConfig.maxAge.toString())
+
-
+		return response
-                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 (req.headers.has('Content-Type') && req.headers.get('Content-Type')!.includes('json')) {
-                    try {
-                        req.body = await request.json()
-                    } 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) => {
-                if (index === prevIndex)
-                    throw new Error('next() called multiple times')
-
-                prevIndex = index
-
-                if (typeof handlers[index] === 'function')
-                    await handlers[index]({ env, req, res, next: async () => await runner(index + 1) })
-            }
-
-            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 })
-        }
-    }
 }

tsconfig.json

@@ -15,7 +15,6 @@
         "alwaysStrict": true,
         "noUnusedLocals": true,
         "noUnusedParameters": true,
-        "noImplicitReturns": true,
         "noFallthroughCasesInSwitch": true,
         "esModuleInterop": true,
         "preserveConstEnums": true,
@@ -24,4 +23,4 @@
     },
     "include": ["src"],
     "exclude": ["node_modules"]
-}
+}