@momsfriendlydevco/cowboy 1.0.14 → 1.0.16

package/README.md

@@ -45,7 +45,7 @@ export default cowboy()
 	.get('/widgets', ()=> // Fetch a list of widgets
 		widgetStore.fetchAll()
 	)
-	.post('/widgets', async (req, res) => { // Create a new widget
+	.post('/widgets', async (req, res, env) => { // Create a new widget
 		let newWidget = await widgetStore.create(req.body);
 		res.send({id: newWidget.id}); // Explicitly send response
 	})
@@ -56,7 +56,7 @@ export default cowboy()
 		req => widgetStore.fetch(req.params.id),
 	)
 	.delete('/widgets/:id', // Try to delete a widget
-		(req, res) => { // Apply custom middleware
+		(req, res, env) => { // Apply custom middleware
 			let isAllowed = await widgetStore.userIsValid(req.headers.auth);
 			if (!isAllowed) return res.sendStatus(403); // Stop bad actors
 		},
@@ -265,7 +265,7 @@ import cowboy from '@momsfriendlydevco/cowboy';
 cowboy()
 	.get('/path',
 		'cors',
-		(req, res) => /* ... */
+		(req, res, env) => /* ... */
 	)
 
 // Name + options - specify an array with an optional options object
@@ -275,7 +275,7 @@ cowboy()
 			option1: value1,
 			/* ... */
 		}],
-		(req, res) => /* ... */
+		(req, res, env) => /* ... */
 	)
 
 
@@ -287,7 +287,7 @@ cowboy()
 			option1: value1,
 			/* ... */
 		}),
-		(req, res) => /* ... */
+		(req, res, env) => /* ... */
 	)
 ```
 
@@ -312,7 +312,7 @@ cowboy()
 			widget: joi.string().required().valid('froody', 'doodad'),
 			size: joi.number().optional(),
 		})],
-		(req, res) => /* ... */
+		(req, res, env) => /* ... */
 	)
 ```
 
@@ -331,7 +331,7 @@ cowboy()
 			widget: joi.string().required().valid('froody', 'doodad'),
 			size: joi.number().optional(),
 		})],
-		(req, res) => /* ... */
+		(req, res, env) => /* ... */
 	)
 ```
 
@@ -348,9 +348,9 @@ import cowboy from '@momsfriendlydevco/cowboy';
 cowboy()
 	.get('/widgets/:id',
 		['validateParams', joi => {
-			id: joi.string().requried(),
+			id: joi.string().required(),
 		})],
-		(req, res) => /* ... */
+		(req, res, env) => /* ... */
 	)
 ```
 
@@ -369,6 +369,6 @@ cowboy()
 		['validateQuery', joi => {
 			q: joi.string().requried(),
 		})],
-		(req, res) => /* ... */
+		(req, res, env) => /* ... */
 	)
 ```

package/lib/cowboy.js

@@ -2,6 +2,7 @@ import debug from '#lib/debug';
 import CowboyMiddleware from '#middleware';
 import CowboyRequest from '#lib/request';
 import CowboyResponse from '#lib/response';
+import {compile as compileRoutePaths} from '@momsfriendlydevco/path-match';
 
 export class Cowboy {
 	/**
@@ -70,9 +71,10 @@ export class Cowboy {
 	route(methods, paths, ...middleware) {
 		this.routes.push({
 			methods: Array.isArray(methods) ? methods : [methods],
-			paths: Array.isArray(paths) ? paths : [paths],
+			matcher: compileRoutePaths(paths),
 			middleware,
 		})
+
 		return this;
 	}
 
@@ -96,11 +98,7 @@ export class Cowboy {
 	resolve(req) {
 		return this.routes.find(route =>
 			route.methods.includes(req.method) // Method matches
-			&& route.paths.some(path => // Path matches
-				typeof path == 'string' ? req.path == path
-				: path instanceof RegExp ? path.test(req.path)
-				: (()=> { throw new Error('Path is not a String or RegExp') })()
-			)
+			&& route.matcher.isMatch(req.path)
 		);
 	}
 
@@ -130,7 +128,7 @@ export class Cowboy {
 
 		// Exec all earlyMiddleware - every time
 		await this.execMiddleware({
-			req, res,
+			req, res, env,
 			middleware: this.earlyMiddleware,
 		});
 
@@ -152,7 +150,7 @@ export class Cowboy {
 
 		// Exec route middleware
 		let response = await this.execMiddleware({
-			req, res,
+			req, res, env,
 			middleware: route.middleware,
 		});
 
@@ -162,7 +160,7 @@ export class Cowboy {
 	}
 
 
-	async execMiddleware({middleware, req, res}) {
+	async execMiddleware({middleware, req, res, env}) {
 		let middlewareStack = middleware
 			.map(m => {
 				let mFunc =
@@ -179,7 +177,7 @@ export class Cowboy {
 		while (middlewareStack.length > 0) {
 			let middleware = middlewareStack.shift();
 			try {
-				response = await middleware(req, res);
+				response = await middleware(req, res, env);
 				if (response?.hasSent) { // Stop middleware chain as some intermediate has signalled the chain should end
 					response = res;
 					break;

package/lib/request.js

@@ -54,6 +54,9 @@ export default class CowboyRequest {
 		this.hostname = url.hostname;
 		this.query = Object.fromEntries(url.searchParams);
 
+		this.routePath = ''; // Eventually matching routePath segment
+		this.params = {}; // Set empty object for path extraction
+
 		// Slurp the headers
 		this.headers = Object.fromEntries(cfReq.headers.entries());
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@momsfriendlydevco/cowboy",
-  "version": "1.0.14",
+  "version": "1.0.16",
   "description": "Wrapper around Cloudflare Wrangler to provide a more Express-like experience",
   "scripts": {
     "lint": "eslint ."
@@ -36,6 +36,7 @@
   },
   "dependencies": {
     "@momsfriendlydevco/joyful": "^1.0.1",
+    "@momsfriendlydevco/path-match": "^1.0.0",
     "toml": "^3.0.0"
   },
   "devDependencies": {