3.1.3

.editorconfig

@@ -7,3 +7,7 @@ insert_final_newline = false
 [src/**.ts]
 charset = utf-8
 indent_style = tab
+
+[README.md]
+indent_style = space
+indent_size = 4

MIGRATION.md

@@ -7,7 +7,6 @@ From `v2.x.x` to `v3.x.x`.
 
 - [Update Router](#update-router)
 - [Handlers](#handlers)
-- [Fetch](#fetch--routerhandle)
 
 
 ## Update Router

README.md

@@ -33,6 +33,10 @@ Migrating from `v2.x.x`, check out the [Migration Guide](MIGRATION.md).
 ```typescript
 import { Router } from '@tsndr/cloudflare-worker-router'
 
+// Env Types
+export type Var<T = string> = T
+export type Secret<T = string> = T
+
 export type Env = {
     // Example binding to KV. Learn more at https://developers.cloudflare.com/workers/runtime-apis/kv/
     // MY_KV_NAMESPACE: KVNamespace
@@ -43,11 +47,23 @@ export type Env = {
     // Example binding to R2. Learn more at https://developers.cloudflare.com/workers/runtime-apis/r2/
     // MY_BUCKET: R2Bucket
 
-    SECRET_TOKEN: string
+    ENVIRONMENT: Var<'dev' | 'prod'>
+
+    SECRET_TOKEN: Secret
 }
 
-// Initialize router
+// Request Extension
-const router = new Router<Env>()
+export type ExtReq = {
+    userId?: number
+}
+
+// Context Extension
+export type ExtCtx = {
+    //sentry?: Toucan
+}
+
+// Initialize Router
+const router = new Router<Env, ExtCtx, ExtReq>()
 
 // Enabling build in CORS support
 router.cors()
@@ -211,10 +227,12 @@ If enabled will overwrite other `OPTIONS` requests.
 #### `config` (object, optional)
 
 Key                        | Type       | Default Value
----------------------- | --------- | -------------
+-------------------------- | ---------- | -------------
 `allowOrigin`              | `string`   | `*`
 `allowMethods`             | `string`   | `*`
 `allowHeaders`             | `string`   | `*`
+`allowCredentials`         | `boolean`  | `undefined`
+`vary`                     | `string`   | `undefined`
 `maxAge`                   | `integer`  | `86400`
 `optionsSuccessStatus`     | `integer`  | `204`
 
@@ -287,6 +305,10 @@ npm i -D @tsndr/cloudflare-worker-router
 ```typescript
 import { Router } from '@tsndr/cloudflare-worker-router'
 
+// Env Types
+export type Var<T = string> = T
+export type Secret<T = string> = T
+
 export type Env = {
   // Example binding to KV. Learn more at https://developers.cloudflare.com/workers/runtime-apis/kv/
   // MY_KV_NAMESPACE: KVNamespace
@@ -296,9 +318,35 @@ export type Env = {
   //
   // Example binding to R2. Learn more at https://developers.cloudflare.com/workers/runtime-apis/r2/
   // MY_BUCKET: R2Bucket
+  //
+  // Example Variable
+  // ENVIRONMENT: Var<'dev' | 'prod'>
+  //
+  // Example Secret
+  // JWT_SECRET: Secret
 }
 
-const router = new Router<Env>()
+// Request Extension
+export type ExtReq = {
+  userId?: number
+}
+
+// Context Extension
+export type ExtCtx = {
+  //sentry?: Toucan
+}
+
+// Handler Type
+export type Handler = RouterHandler<Env, ExtCtx, ExtReq>
+
+// Initialize Router
+const router = new Router<Env, ExtCtx, ExtReq>()
+
+// Enable Debug Mode
+router.debug()
+
+// Enabling build in CORS support
+//router.cors()
 
 /// Example Route
 //
@@ -309,12 +357,11 @@ const router = new Router<Env>()
 
 /// Example Route for splitting into multiple files
 //
-// const hiHandler: RouteHandler<Env> = async () => {
+// const helloHandler: Handler = async () => {
 //    return new Response('Hello World')
 // }
 //
-// router.get('/hi', hiHandler)
+// router.get('/hellow', helloHandler)
-
 
 // TODO: add your routes here
 
@@ -336,6 +383,12 @@ import { Router } from '@tsndr/cloudflare-worker-router'
 
 const router = new Router()
 
+// Enable Debug Mode
+//router.debug()
+
+// Enabling build in CORS support
+//router.cors()
+
 /// Example Route
 //
 // router.get('/hi', async () => {

package-lock.json

@@ -1,28 +1,28 @@
 {
   "name": "@tsndr/cloudflare-worker-router",
-  "version": "3.0.0",
+  "version": "3.1.3",
   "lockfileVersion": 3,
   "requires": true,
   "packages": {
     "": {
       "name": "@tsndr/cloudflare-worker-router",
-      "version": "3.0.0",
+      "version": "3.1.3",
       "license": "MIT",
       "devDependencies": {
-        "@cloudflare/workers-types": "^4.20230814.0",
+        "@cloudflare/workers-types": "^4.20231025.0",
-        "typescript": "^5.1.6"
+        "typescript": "^5.2.2"
       }
     },
     "node_modules/@cloudflare/workers-types": {
-      "version": "4.20230814.0",
+      "version": "4.20231025.0",
-      "resolved": "https://registry.npmjs.org/@cloudflare/workers-types/-/workers-types-4.20230814.0.tgz",
+      "resolved": "https://registry.npmjs.org/@cloudflare/workers-types/-/workers-types-4.20231025.0.tgz",
-      "integrity": "sha512-+jHiGjZg2UpULZSSHmHLqUG45TLg1s+uppSMlGvMn0u/xyFsRX9HX6b8Ydg/oHSp3jfSuPtX05GSvtgRAmrWTg==",
+      "integrity": "sha512-TkcZkntUTOcvJ4vgmwpNfLTclpMbmbClZCe62B25/VTukmyv91joRa4eKzSjzCZUXTbFHNmVdOpmGaaJU2U3+A==",
       "dev": true
     },
     "node_modules/typescript": {
-      "version": "5.1.6",
+      "version": "5.2.2",
-      "resolved": "https://registry.npmjs.org/typescript/-/typescript-5.1.6.tgz",
+      "resolved": "https://registry.npmjs.org/typescript/-/typescript-5.2.2.tgz",
-      "integrity": "sha512-zaWCozRZ6DLEWAWFrVDz1H6FVXzUSfTy5FUMWsQlU8Ym5JP9eO4xkTIROFCQvhQf61z6O/G6ugw3SgAnvvm+HA==",
+      "integrity": "sha512-mI4WrpHsbCIcwT9cF4FZvr80QUeKvsUsUvKDoR+X/7XHQH98xYD8YHZg7ANtz2GtZt/CBq2QJ0thkGJMHfqc1w==",
       "dev": true,
       "bin": {
         "tsc": "bin/tsc",

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tsndr/cloudflare-worker-router",
-  "version": "3.0.0",
+  "version": "3.1.3",
   "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": "^4.20230814.0",
+    "@cloudflare/workers-types": "^4.20231025.0",
-    "typescript": "^5.1.6"
+    "typescript": "^5.2.2"
   }
 }

src/index.ts

@@ -20,7 +20,7 @@ export type Route<TEnv, TCtx, TReq> = {
 * @property {RouterRequest} req Request Object
 * @property {ExecutionContext} ctx Context Object
 */
-export type RouterContext<TEnv = any, TCtx = any, TReq = any> = TCtx & {
+export type RouterContext<TEnv = any, TCtx = {}, TReq = {}> = TCtx & {
 	env: TEnv
 	req: RouterRequest<TReq>
 	dbg: boolean
@@ -80,7 +80,7 @@ export type RouterRequestQuery = {
 * @param {RouterContext} ctx
 * @returns {Promise<Response | void> Response | void}
 */
-export type RouterHandler<TEnv = any, TCtx = any, TReq = any> = {
+export type RouterHandler<TEnv = any, TCtx = {}, TReq = {}> = {
 	(ctx: RouterContext<TEnv, TCtx, TReq>): Promise<Response | void> | Response | void
 }
 
@@ -91,6 +91,8 @@ export type RouterHandler<TEnv = any, TCtx = any, TReq = any> = {
 * @property {string} [allowOrigin="*"] Access-Control-Allow-Origin (default: `*`)
 * @property {string} [allowMethods="*"] Access-Control-Allow-Methods (default: `*`)
 * @property {string} [allowHeaders="*"] Access-Control-Allow-Headers (default: `*`)
+* @property {boolean} [allowCredentials="true"] Access-Control-Allow-Credentials (default: undefined)
+* @property {string} [vary="origin"] vary (default: undefined)
 * @property {number} [maxAge=86400] Access-Control-Max-Age (default: `86400`)
 * @property {number} [optionsSuccessStatus=204] Return status code for OPTIONS request (default: `204`)
 */
@@ -98,6 +100,8 @@ export type RouterCorsConfig = {
 	allowOrigin?: string
 	allowMethods?: string
 	allowHeaders?: string
+	allowCredentials?: boolean
+	vary?: string
 	maxAge?: number
 	optionsSuccessStatus?: number
 }
@@ -116,7 +120,7 @@ export type RouterBuffer = {
 * @public
 * @class
 */
-export class Router<TEnv = any, TCtx = any, TReq = any> {
+export class Router<TEnv = any, TCtx = {}, TReq = {}> {
 
 	/**
 	* Router Array
@@ -150,14 +154,6 @@ export class Router<TEnv = any, TCtx = any, TReq = any> {
 	*/
 	protected corsConfig: RouterCorsConfig = {}
 
-	/**
-	* Buffer
-	*
-	* @protected
-	* @type {RouterBuffer}
-	*/
-	protected buffer: RouterBuffer = {}
-
 	/**
 	* CORS enabled
 	*
@@ -312,6 +308,8 @@ export class Router<TEnv = any, TCtx = any, TReq = any> {
 			allowOrigin: config?.allowOrigin ?? '*',
 			allowMethods: config?.allowMethods ?? '*',
 			allowHeaders: config?.allowHeaders ?? '*',
+			allowCredentials: config?.allowCredentials ?? undefined,
+			vary: config?.vary ?? undefined,
 			maxAge: config?.maxAge ?? 86400,
 			optionsSuccessStatus: config?.optionsSuccessStatus ?? 204
 		}
@@ -325,6 +323,10 @@ export class Router<TEnv = any, TCtx = any, TReq = any> {
 			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.allowCredentials && !headers.has('Access-Control-Allow-Credentials'))
+			headers.set('Access-Control-Allow-Credentials', this.corsConfig.allowCredentials.toString())
+		if (this.corsConfig.vary && !headers.has('vary'))
+			headers.set('vary', this.corsConfig.vary.toString())
 		if (this.corsConfig.maxAge && !headers.has('Access-Control-Max-Age'))
 			headers.set('Access-Control-Max-Age', this.corsConfig.maxAge.toString())
 		return headers
@@ -400,6 +402,7 @@ export class Router<TEnv = any, TCtx = any, TReq = any> {
 	* @returns {Promise<Response>}
 	*/
 	public async handle(request: Request, env: TEnv, ctx?: ExecutionContext, extCtx?: TCtx, extReq?: TReq): Promise<Response> {
+		const buffer: RouterBuffer = {};
 		const req = {
 			...(extReq ?? {}),
 			method: request.method,
@@ -409,11 +412,11 @@ export class Router<TEnv = any, TCtx = any, TReq = any> {
 			raw: request,
 			params: {},
 			query: {},
-			arrayBuffer: async (): Promise<ArrayBuffer> => this.buffer.arrayBuffer ? this.buffer.arrayBuffer : this.buffer.arrayBuffer = await request.arrayBuffer(),
+			arrayBuffer: async (): Promise<ArrayBuffer> => buffer.arrayBuffer ? buffer.arrayBuffer : buffer.arrayBuffer = await request.clone().arrayBuffer(),
-			text: async (): Promise<string> => this.buffer.text ? this.buffer.text : this.buffer.text = await request.text(),
+			text: async (): Promise<string> => buffer.text ? buffer.text : buffer.text = await request.clone().text(),
-			json: async <T>(): Promise<T> => this.buffer.json ? this.buffer.json : this.buffer.json = await request.json<T>(),
+			json: async <T>(): Promise<T> => buffer.json ? buffer.json : buffer.json = await request.clone().json<T>(),
-			formData: async (): Promise<FormData> => this.buffer.formData ? this.buffer.formData : this.buffer.formData = await request.formData(),
+			formData: async (): Promise<FormData> => buffer.formData ? buffer.formData : buffer.formData = await request.clone().formData(),
-			blob: async (): Promise<Blob> => this.buffer.blob ? this.buffer.blob : this.buffer.blob = await request.blob(),
+			blob: async (): Promise<Blob> => buffer.blob ? buffer.blob : buffer.blob = await request.clone().blob(),
 			bearer: () => request.headers.get('Authorization')?.replace(/^(B|b)earer /, '').trim()
 		} as RouterRequest<TReq>