1
0

9 Commits

Author SHA1 Message Date
d3b86f1dbe 2.2.0 2022-10-03 00:34:06 +02:00
aadb398b48 drop default export 2022-10-03 00:32:54 +02:00
5fa3475a20 2.1.2 2022-10-03 00:13:59 +02:00
0637549e90 remove compatibility box 2022-10-03 00:13:51 +02:00
f3279e71fc typo fix 2022-10-03 00:09:03 +02:00
bdb7be3699 2.1.1 2022-10-03 00:02:21 +02:00
45a781ea66 clean up 2022-10-03 00:01:13 +02:00
7f44f304a2 remove explicit authorization header 2022-10-02 23:57:52 +02:00
a786262ec6 fix cors 2022-10-02 23:50:48 +02:00
4 changed files with 62 additions and 43 deletions

View File

@@ -19,12 +19,12 @@ I worked a lot with [Express.js](https://expressjs.com/) in the past and really
### Simple Example ### Simple Example
```javascript ```javascript
import Router from '@tsndr/cloudflare-worker-router' import { Router } from '@tsndr/cloudflare-worker-router'
// Initialize router // Initialize router
const router = new Router() const router = new Router()
// Enabling buildin CORS support // Enabling build in CORS support
router.cors() router.cors()
// Register global middleware // Register global middleware
@@ -180,21 +180,7 @@ Key | Type | Description
## Setup ## Setup
--- Please follow Cloudflare's [Get started guide](https://developers.cloudflare.com/workers/get-started/guide/) to install wrangler, then install the router using this command:
### ❗️ Compatibility ❗️
CLI Tool | Router
-------- | ------
[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 ```bash
npm i -D @tsndr/cloudflare-worker-router npm i -D @tsndr/cloudflare-worker-router
@@ -206,7 +192,7 @@ and replace your `index.ts` / `index.js` with one of the following scripts
<summary>TypeScript (<code>src/index.ts</code>)</summary> <summary>TypeScript (<code>src/index.ts</code>)</summary>
```typescript ```typescript
import Router from '@tsndr/cloudflare-worker-router' import { Router } from '@tsndr/cloudflare-worker-router'
export interface Env { export interface Env {
// Example binding to KV. Learn more at https://developers.cloudflare.com/workers/runtime-apis/kv/ // Example binding to KV. Learn more at https://developers.cloudflare.com/workers/runtime-apis/kv/
@@ -235,7 +221,7 @@ export default {
<summary>JavaScript (<code>src/index.js</code>)</summary> <summary>JavaScript (<code>src/index.js</code>)</summary>
```javascript ```javascript
import Router from '@tsndr/cloudflare-worker-router' import { Router } from '@tsndr/cloudflare-worker-router'
const router = new Router() const router = new Router()

4
package-lock.json generated
View File

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

View File

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

View File

@@ -131,7 +131,7 @@ export interface RouterCorsConfig {
* @public * @public
* @class * @class
*/ */
export default class Router { export class Router {
/** /**
* Router Array * Router Array
@@ -165,6 +165,14 @@ export default class Router {
*/ */
protected corsConfig: RouterCorsConfig = {} protected corsConfig: RouterCorsConfig = {}
/**
* CORS enabled
*-
* @protected
* @type {boolean}
*/
protected corsEnabled: boolean = false
/** /**
* Register global handlers * Register global handlers
* *
@@ -306,10 +314,11 @@ export default class Router {
* @returns {Router} * @returns {Router}
*/ */
public cors(config?: RouterCorsConfig): Router { public cors(config?: RouterCorsConfig): Router {
this.corsEnabled = true
this.corsConfig = { this.corsConfig = {
allowOrigin: config?.allowOrigin || '*', allowOrigin: config?.allowOrigin || '*',
allowMethods: config?.allowMethods || '*', allowMethods: config?.allowMethods || '*',
allowHeaders: config?.allowHeaders || '*, Authorization', allowHeaders: config?.allowHeaders || '*',
maxAge: config?.maxAge || 86400, maxAge: config?.maxAge || 86400,
optionsSuccessStatus: config?.optionsSuccessStatus || 204 optionsSuccessStatus: config?.optionsSuccessStatus || 204
} }
@@ -331,6 +340,7 @@ export default class Router {
url, url,
handlers handlers
}) })
return this return this
} }
@@ -344,23 +354,33 @@ export default class Router {
private getRoute(request: RouterRequest): Route | undefined { private getRoute(request: RouterRequest): Route | undefined {
const url = new URL(request.url) const url = new URL(request.url)
const pathArr = url.pathname.split('/').filter(i => i) const pathArr = url.pathname.split('/').filter(i => i)
return this.routes.find(r => { return this.routes.find(r => {
const routeArr = r.url.split('/').filter(i => i) const routeArr = r.url.split('/').filter(i => i)
if (![request.method, '*'].includes(r.method) || routeArr.length !== pathArr.length) if (![request.method, '*'].includes(r.method) || routeArr.length !== pathArr.length)
return false return false
const params: RouterRequestParams = {} const params: RouterRequestParams = {}
for (let i = 0; i < routeArr.length; i++) { for (let i = 0; i < routeArr.length; i++) {
if (routeArr[i] !== pathArr[i] && routeArr[i][0] !== ':') if (routeArr[i] !== pathArr[i] && routeArr[i][0] !== ':')
return false return false
if (routeArr[i][0] === ':') if (routeArr[i][0] === ':')
params[routeArr[i].substring(1)] = pathArr[i] params[routeArr[i].substring(1)] = pathArr[i]
} }
request.params = params request.params = params
const query: any = {} const query: any = {}
for (const [k, v] of url.searchParams.entries()) { for (const [k, v] of url.searchParams.entries()) {
query[k] = v query[k] = v
} }
request.query = query request.query = query
return true return true
}) || this.routes.find(r => r.url === '*' && [request.method, '*'].includes(r.method)) }) || this.routes.find(r => r.url === '*' && [request.method, '*'].includes(r.method))
} }
@@ -371,9 +391,9 @@ export default class Router {
* @param {any} env * @param {any} env
* @param {Request} request * @param {Request} request
* @param {any} [extend] * @param {any} [extend]
* @returns {Response} * @returns {Promise<Response>}
*/ */
public async handle(env: any, request: Request, extend: any = {}) { public async handle(env: any, request: Request, extend: any = {}): Promise<Response> {
try { try {
const req: RouterRequest = { const req: RouterRequest = {
...extend, ...extend,
@@ -387,7 +407,9 @@ export default class Router {
} }
const headers = new Headers() const headers = new Headers()
const route = this.getRoute(req)
if (this.corsEnabled) {
if (this.corsConfig.allowOrigin) if (this.corsConfig.allowOrigin)
headers.set('Access-Control-Allow-Origin', this.corsConfig.allowOrigin) headers.set('Access-Control-Allow-Origin', this.corsConfig.allowOrigin)
if (this.corsConfig.allowMethods) if (this.corsConfig.allowMethods)
@@ -397,12 +419,17 @@ export default class Router {
if (this.corsConfig.maxAge) if (this.corsConfig.maxAge)
headers.set('Access-Control-Max-Age', this.corsConfig.maxAge.toString()) headers.set('Access-Control-Max-Age', this.corsConfig.maxAge.toString())
if (req.method === 'OPTIONS') { if (!route && req.method === 'OPTIONS') {
return new Response(null, { return new Response(null, {
headers, headers,
status: this.corsConfig.optionsSuccessStatus 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 (['POST', 'PUT', 'PATCH'].includes(req.method)) {
if (req.headers.has('Content-Type') && req.headers.get('Content-Type')!.includes('json')) { if (req.headers.has('Content-Type') && req.headers.get('Content-Type')!.includes('json')) {
try { try {
@@ -418,27 +445,33 @@ export default class Router {
} }
} }
} }
const route = this.getRoute(req)
if (!route)
return new Response(this.debugMode ? 'Route not found!' : null, { status: 404 })
const res: RouterResponse = { headers } const res: RouterResponse = { headers }
const handlers = [...this.globalHandlers, ...route.handlers] const handlers = [...this.globalHandlers, ...route.handlers]
let prevIndex = -1 let prevIndex = -1
const runner = async (index: number) => { const runner = async (index: number) => {
if (index === prevIndex) if (index === prevIndex)
throw new Error('next() called multiple times') throw new Error('next() called multiple times')
prevIndex = index prevIndex = index
if (typeof handlers[index] === 'function') if (typeof handlers[index] === 'function')
await handlers[index]({ env, req, res, next: async () => await runner(index + 1) }) await handlers[index]({ env, req, res, next: async () => await runner(index + 1) })
} }
await runner(0) await runner(0)
if (typeof res.body === 'object') { if (typeof res.body === 'object') {
if (!res.headers.has('Content-Type')) if (!res.headers.has('Content-Type'))
res.headers.set('Content-Type', 'application/json') res.headers.set('Content-Type', 'application/json')
res.body = JSON.stringify(res.body) res.body = JSON.stringify(res.body)
} }
if (res.raw) if (res.raw)
return 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 }) 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) { } catch(err) {
console.error(err) console.error(err)