@momsfriendlydevco/cowboy 1.0.13 → 1.0.15

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

@@ -130,7 +130,7 @@ export class Cowboy {
 
 		// Exec all earlyMiddleware - every time
 		await this.execMiddleware({
-			req, res,
+			req, res, env,
 			middleware: this.earlyMiddleware,
 		});
 
@@ -152,7 +152,7 @@ export class Cowboy {
 
 		// Exec route middleware
 		let response = await this.execMiddleware({
-			req, res,
+			req, res, env,
 			middleware: route.middleware,
 		});
 
@@ -162,7 +162,7 @@ export class Cowboy {
 	}
 
 
-	async execMiddleware({middleware, req, res}) {
+	async execMiddleware({middleware, req, res, env}) {
 		let middlewareStack = middleware
 			.map(m => {
 				let mFunc =
@@ -179,7 +179,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/middleware/validate.js

@@ -1,10 +1,15 @@
 import joyful from '@momsfriendlydevco/joyful';
 
+/**
+* Run a Joi / Joyful validation function against a specific subkey within `req
+*
+* @param {String} subkey The subkey to run against
+* @param {Function|Object} Callback to use with Joyful to validate with
+* @returns {Void} Either a successful middleware cycle (if validatio succeeds) or a call to `res.status(400)` if failed
+*/
 export default function CowboyMiddlewareValidate(subkey, validator) {
 	return (req, res) => {
-		let joyfulResult = joyful({
-			[subkey]: validator,
-		});
+		let joyfulResult = joyful(req[subkey], validator);
 
 		if (joyfulResult !== true) { // Failed body validation?
 			return res

package/middleware/validateBody.js

@@ -1,7 +1,5 @@
 import CowboyMiddlewareValidate from '#middleware/validate';
 
 export default function CowboyMiddlewareValidateBody(validator) {
-	return CowboyMiddlewareValidate('body', {
-		body: validator,
-	})
+	return CowboyMiddlewareValidate('body', validator);
 }

package/middleware/validateParams.js

@@ -1,7 +1,5 @@
 import CowboyMiddlewareValidate from '#middleware/validate';
 
 export default function CowboyMiddlewareValidateParams(validator) {
-	return CowboyMiddlewareValidate('params', {
-		params: validator,
-	})
+	return CowboyMiddlewareValidate('params', validator);
 }

package/middleware/validateQuery.js

@@ -1,7 +1,5 @@
 import CowboyMiddlewareValidate from '#middleware/validate';
 
 export default function CowboyMiddlewareValidateQuery(validator) {
-	return CowboyMiddlewareValidate('query', {
-		query: validator,
-	})
+	return CowboyMiddlewareValidate('query', validator);
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@momsfriendlydevco/cowboy",
-  "version": "1.0.13",
+  "version": "1.0.15",
   "description": "Wrapper around Cloudflare Wrangler to provide a more Express-like experience",
   "scripts": {
     "lint": "eslint ."