diff --git a/README.md b/README.md index 769d707..261d11e 100644 --- a/README.md +++ b/README.md @@ -40,8 +40,9 @@ export interface Env { // // 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() @@ -50,61 +51,61 @@ const router = new Router() router.cors() // Register global middleware -router.use(({ req, res, next }) => { - res.headers.set('X-Global-Middlewares', 'true') - next() +router.use(() => { + return new Response(null, { + headers: { + 'X-Global-Middlewares': 'true' + } + }) }) // Simple get -router.get('/user', ({ req, res }) => { - res.body = { - data: { - id: 1, - name: 'John Doe' - } - } +router.get('/user', () => { + return Response.json({ + id: 1, + name: 'John Doe' + }) }) // Post route with url parameter -router.post('/user/:id', ({ req, res }) => { +router.post('/user/:id', ({ req }) => { const userId = req.params.id - // Do stuff... + // Do stuff - if (errorDoingStuff) { - res.status = 400 - res.body = { - error: 'User did stupid stuff!' - } - return + if (!true) { + return Response.json({ + error: 'Error doing stuff!' + }, { status: 400 }) } - res.status = 204 + return Response.json({ userId }, { status: 204 }) }) // Delete route using a middleware -router.delete('/user/:id', ({ req, res, next }) => { +router.delete('/user/:id', ({ env, req }) => { + const { SECRET_TOKEN } = env - if (!apiTokenIsCorrect) { - res.status = 401 - return - } + if (req.headers.get('Authorization') === SECRET_TOKEN) + return new Response(null, { status: 401 }) - await next() -}, (req, res) => { +}, ({ req }) => { - const userId = req.params.id + const userId = req.params.id - // Do stuff... + // Do stuff... + + return Response.json({ userId }) }) // Listen Cloudflare Workers Fetch Event export default { - async fetch(request: Request, env: Env): Promise { - return router.handle(env, request) + async fetch(request: Request, env: Env, ctx: ExecutionContext) { + return router.handle(request, env, ctx) } } + ```
@@ -120,59 +121,56 @@ const router = new Router() router.cors() // Register global middleware -router.use(({ req, res, next }) => { - res.headers.set('X-Global-Middlewares', 'true') - next() +router.use(() => { + return new Response(null, { + headers: { + 'X-Global-Middlewares': 'true' + } + }) }) // Simple get -router.get('/user', ({ req, res }) => { - res.body = { - data: { - id: 1, - name: 'John Doe' - } - } +router.get('/user', () => { + return Response.json({ + id: 1, + name: 'John Doe' + }) }) // Post route with url parameter -router.post('/user/:id', ({ req, res }) => { - +router.post('/user/:id', ({ req }) => { const userId = req.params.id - // Do stuff... + // Do stuff - if (errorDoingStuff) { - res.status = 400 - res.body = { - error: 'User did stupid stuff!' - } - return - } + if (errorDoingStuff) { + return Response.json({ + error: 'Error doing stuff!' + }, { status: 400 }) + } - res.status = 204 + return Response.json({ userId }, { status: 204 }) }) // Delete route using a middleware -router.delete('/user/:id', ({ req, res, next }) => { +router.delete('/user/:id', ({ env, req }) => { + const { SECRET_TOKEN } = env - if (!apiTokenIsCorrect) { - res.status = 401 - return - } - - await next() -}, (req, res) => { + if (req.headers.get('Authorization') === 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) { - return router.handle(env, request) + async fetch(request, env, ctx) { + return router.handle(request, env, ctx) } } ``` @@ -206,7 +204,7 @@ 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])` @@ -247,16 +245,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 -`next` | `next`-Handler | Next Handler +`ctx` | `ctx`-Object | Cloudflare's `ctx`-Object ### `req`-Object @@ -270,16 +268,6 @@ Key | Type | Description `query` | `object` | Object containing all query parameters -### `res`-Object - -Key | Type | Description ------------ | ------------------- | ----------- -`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 Please follow Cloudflare's [Get started guide](https://developers.cloudflare.com/workers/get-started/guide/) to install wrangler. @@ -335,8 +323,8 @@ const router = new Router() // TODO: add your routes here export default { - async fetch(request: Request, env: Env, ctx: ExecutionContext): Promise { - return router.handle(env, request) + async fetch(request: Request, env: Env, ctx: ExecutionContext) { + return router.handle(request, env, ctx) } } ``` @@ -360,7 +348,7 @@ const router = new Router() export default { async fetch(request, env, ctx) { - return router.handle(env, request) + return router.handle(request, env, ctx) } } ``` diff --git a/src/index.ts b/src/index.ts index 1dd7a2d..a7e9c3b 100644 --- a/src/index.ts +++ b/src/index.ts @@ -13,19 +13,17 @@ export interface Route { } /** -* Router Context -* -* @typedef RouterContext -* @property {RouterEnv} env Environment -* @property {RouterRequest} req Request Object -* @property {RouterResponse} res Response Object -* @property {RouterNext} next Next Handler -*/ -export interface RouterContext { - env: TEnv - req: RouterRequest - res: RouterResponse - next: RouterNext + * Router Context + * + * @typedef RouterContext + * @property {RouterEnv} env Environment + * @property {RouterRequest} req Request Object + * @property {ExecutionContext} ctx Context Object + */ +export interface RouterContext { + env: TEnv + req: RouterRequest + ctx: ExecutionContext } /** @@ -70,41 +68,14 @@ export interface RouterRequestQuery { } /** -* Response Object -* -* @typedef RouterResponse -* @property {Headers} headers Response headers object -* @property {number} [status=204] Return status code (default: `204`) -* @property {string | any} [body] Either an `object` (will be converted to JSON) or a string -* @property {Response} [raw] A response object that is to be returned, this will void all other res properties and return this as is. -*/ -export interface RouterResponse { - headers: Headers - status?: number - body?: string | any - raw?: Response, - webSocket?: WebSocket -} - -/** -* Next Function -* -* @callback RouterNext -* @returns {Promise} -*/ -export interface RouterNext { - (): Promise -} - -/** -* Handler Function -* -* @callback RouterHandler -* @param {RouterContext} ctx -* @returns {Promise | void} -*/ + * Handler Function + * + * @callback RouterHandler + * @param {RouterContext} ctx + * @returns {Promise Response | void} + */ export interface RouterHandler { - (ctx: RouterContext): Promise | void + (ctx: RouterContext): Promise | Response | void } /** @@ -325,21 +296,33 @@ export class Router { return this } - /** - * Register route - * - * @private - * @param {string} method HTTP request method - * @param {string} url URL String - * @param {RouterHandler[]} handlers Arrar of handler functions - * @returns {Router} - */ - private register(method: string, url: string, handlers: RouterHandler[]): Router { - this.routes.push({ - method, - url, - handlers - }) + private setCorsHeaders(headers: Headers = new Headers()): Headers { + if (this.corsConfig.allowOrigin && !headers.has('Access-Control-Allow-Origin')) + headers.set('Access-Control-Allow-Origin', this.corsConfig.allowOrigin) + if (this.corsConfig.allowMethods && !headers.has('Access-Control-Allow-Methods')) + 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.maxAge && !headers.has('Access-Control-Max-Age')) + headers.set('Access-Control-Max-Age', this.corsConfig.maxAge.toString()) + return headers + } + + /** + * Register route + * + * @private + * @param {string} method HTTP request method + * @param {string} url URL String + * @param {RouterHandler[]} handlers Arrar of handler functions + * @returns {Router} + */ + private register(method: string, url: string, handlers: RouterHandler[]): Router { + this.routes.push({ + method, + url, + handlers + }) return this } @@ -385,97 +368,57 @@ export class Router { }) || this.routes.find(r => r.url === '*' && [request.method, '*'].includes(r.method)) } - /** - * Handle requests - * - * @param {TEnv} env - * @param {Request} request - * @param {any} [extend] - * @returns {Promise} - */ - public async handle(env: TEnv, request: Request, extend: any = {}): Promise { - try { - const req: RouterRequest = { - ...extend, - method: request.method, - headers: request.headers, - url: request.url, - cf: request.cf, - params: {}, - query: {}, - body: '' - } + /** + * Handle requests + * + * @param {TEnv} env + * @param {Request} request + * @param {any} [extend] + * @returns {Promise} + */ + public async handle(request: Request, env: TEnv, ctx: ExecutionContext, extend: any = {}): Promise { + const req: RouterRequest = { + ...extend, + method: request.method, + headers: request.headers, + url: request.url, + cf: request.cf, + params: {}, + query: {}, + body: '' + } - const headers = new Headers() - const route = this.getRoute(req) + const route = this.getRoute(req) - if (this.corsEnabled) { - if (this.corsConfig.allowOrigin) - headers.set('Access-Control-Allow-Origin', this.corsConfig.allowOrigin) - if (this.corsConfig.allowMethods) - headers.set('Access-Control-Allow-Methods', this.corsConfig.allowMethods) - if (this.corsConfig.allowHeaders) - headers.set('Access-Control-Allow-Headers', this.corsConfig.allowHeaders) - if (this.corsConfig.maxAge) - headers.set('Access-Control-Max-Age', this.corsConfig.maxAge.toString()) + if (!route) + return new Response(this.debugMode ? 'Route not found!' : null, { status: 404 }) - if (!route && req.method === 'OPTIONS') { - return new Response(null, { - headers, - status: this.corsConfig.optionsSuccessStatus - }) - } - } + if (this.corsEnabled && req.method === 'OPTIONS') { + return new Response(null, { + headers: this.setCorsHeaders(), + status: this.corsConfig.optionsSuccessStatus + }) + } - if (!route) - return new Response(this.debugMode ? 'Route not found!' : null, { status: 404 }) + const handlers = [...this.globalHandlers, ...route.handlers] - 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 = '' - } - } - } + let response: Response | undefined - const res: RouterResponse = { headers } - const handlers = [...this.globalHandlers, ...route.handlers] - let prevIndex = -1 + for (const handler of handlers) { + const res = await handler({ env, req, ctx }) - const runner = async (index: number) => { - if (index === prevIndex) - throw new Error('next() called multiple times') + if (res) { + response = res + break + } + } - prevIndex = index + if (!response) + return new Response(this.debugMode ? 'Handler did not return a Response!' : null, { status: 404 }) - if (typeof handlers[index] === 'function') - await handlers[index]({ env, req, res, next: async () => await runner(index + 1) }) - } + if (this.corsEnabled) + this.setCorsHeaders(response.headers) - 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 }) - } - } + return response + } } diff --git a/tsconfig.json b/tsconfig.json index 44621bd..c5b3383 100644 --- a/tsconfig.json +++ b/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"] -} \ No newline at end of file +}