jxp 2.11.1 → 2.12.0

package/README.md

@@ -35,4 +35,8 @@ JXP is an opinionated RESTful API framework that lets you make an API just by de
 * [Roles and Permissions](https://jxp.readthedocs.io/en/v2.0.0/permissions)
 * [Hooks](https://jxp.readthedocs.io/en/v2.0.0/hooks)
 * [Special Features](https://jxp.readthedocs.io/en/v2.0.0/special)
-* [Changelog](https://jxp.readthedocs.io/en/v2.0.0/changelog)
+* [Changelog](https://jxp.readthedocs.io/en/v2.0.0/changelog)
+
+## Installing from source
+
+`npm i --legacy-peer-deps`

package/bin/server.js

@@ -196,17 +196,23 @@ const mongoose = require("mongoose");
 const JXP = require("../libs/jxp");
 const config = require("config");
 require("dotenv").config();
+const pkg = require("../package.json");
 
 config.callbacks = {
-	post: function(modelname, item, user) {
-		// console.log("Post callback");
-	},
-	put: function(modelname, item, user) {
-		// console.log("Put callback");
-	},
-	delete: function(modelname, item, user, opts) {
-		// console.log("Delete callback");
-	}
+	// Examples:
+	// post: function(modelname, item, user) {
+	// 	console.log("Post callback");
+	// },
+	// put: function(modelname, item, user) {
+	// 	console.log("Put callback");
+	// },
+	// delete: function(modelname, item, user, opts) {
+	// 	console.log("Delete callback");
+	// }
+
+	post: function() {},
+	put: function() {},
+	delete: function() {}
 };
 
 config.pre_hooks = {
@@ -259,7 +265,7 @@ var server = new JXP(config);
 let port = process.env.NODE_DOCKER_PORT || process.env.PORT || config.port || 4001;
 if (process.env.NODE_ENV === "test") port = 4005;
 server.listen(port, function() {
-	console.log('%s listening at %s', server.name, server.url);
+	console.log('%s listening at %s', `${pkg.name} v${pkg.version}`, server.url);
 });
 
 module.exports = server; // For testing

package/libs/docs.js

@@ -6,6 +6,7 @@ const md = require('jstransformer')(require('jstransformer-markdown-it'));
 const util = require('util');
 const readFile = util.promisify(fs.readFile);
 const schema_description = require("./schema_description");
+const errors = require("restify-errors");
 
 class Docs {
     constructor(opts) {
@@ -32,7 +33,7 @@ class Docs {
             res.end();
         } catch(err) {
             console.error(err);
-            return res.send(500, { status: "error", error: err, message: err.toString() });
+            return errors.InternalServerError({ message: err.toString() });
         }
     }
 
@@ -42,20 +43,20 @@ class Docs {
             res.send(models);
         } catch (err) {
             console.error(err);
-            return res.send(500, { status: "error", error: err, message: err.toString() });
+            return errors.InternalServerError({ message: err.toString() });
         }
     }
 
     metaModel(req, res, next) {
         try {
             if (!req.Model) {
-                return res.send(404, { status: "error", error: "Model not found" })
+                return errors.NotFoundError({ status: "error", error: "Model not found" })
             }
             res.send(req.Model.schema.paths);
             next();
         } catch (err) {
             console.error(err);
-            return res.send(500, { status: "error", error: err, message: err.toString() });
+            return errors.InternalServerError({ message: err.toString() });
         }
     }
 
@@ -64,7 +65,7 @@ class Docs {
             res.send(this.models);
             next();
         } catch(err) {
-            res.send(500, { status: "error", error: err, message: err.toString() });
+            errors.InternalServerError({ message: err.toString() });
         }
     }
 
@@ -73,7 +74,7 @@ class Docs {
             this.renderTemplate(res, "index", {});
             next();
         } catch(err) {
-            res.send(500, { status: "error", error: err, message: err.toString() });
+            errors.InternalServerError({ message: err.toString() });
         }
     }
 
@@ -83,7 +84,7 @@ class Docs {
             const md_contents = md.render(body.toString()).body;
             this.renderTemplate(res, "md", { md_contents });
         } catch(err) {
-            res.send(500, { status: "error", error: err, message: err.toString() });
+            errors.InternalServerError({ message: err.toString() });
         }
     }
 
@@ -97,7 +98,7 @@ class Docs {
             this.renderTemplate(res, "model", { model, fields, perms });
             next();
         } catch(err) {
-            res.send(500, { status: "error", error: err, message: err.toString() });
+            errors.InternalServerError({ message: err.toString() });
         }
     }
 }

package/libs/groups.js

@@ -1,4 +1,6 @@
-var Groups = null;
+const errors = require("restify-errors");
+
+let Groups = null;
 
 const init = config => {
 	const path = require("path");
@@ -10,13 +12,11 @@ const actionPut = async (req, res) => {
 	const group = req.body.group;
 	if (!group) {
 		console.error("Group required");
-		res.send(400, "Group required");
-		return;
+		return errors.BadRequestError("Group required");
 	}
 	if (!user_id) {
 		console.error("user_id required");
-		res.send(400, "user_id required");
-		return;
+		return errors.BadRequestError("user_id required", { message: "user_id is required" });
 	}
 	try {
 		let userGroup = await Groups.findOne({ user_id: user_id });
@@ -39,8 +39,7 @@ const actionPut = async (req, res) => {
 		res.send(await userGroup.save());
 	} catch(err) {
 			console.error(err);
-			res.send(500, err);
-			return;
+			return errors.InternalServerError({ message: err.toString()});
 	}
 };
 
@@ -49,13 +48,11 @@ const actionPost = async (req, res) => {
 	const group = req.body.group;
 	if (!group) {
 		console.error("Group required");
-		res.send(400, "Group required");
-		return;
+		return errors.BadRequestError("Group required");
 	}
 	if (!user_id) {
 		console.error("user_id required");
-		res.send(400, "user_id required");
-		return;
+		return errors.BadRequestError("user_id required", { message: "user_id is required" });
 	}
 	try {
 		let userGroup = await Groups.findOne({ user_id: user_id });
@@ -78,8 +75,7 @@ const actionPost = async (req, res) => {
 		res.send(await userGroup.save());
 	} catch (err) {
 		console.error(err);
-		res.send(500, err);
-		return;
+		return errors.InternalServerError({ message: err.toString()});
 	}
 };
 
@@ -87,8 +83,7 @@ const actionGet = async (req, res) => {
 	var user_id = req.params.user_id;
 	if (!user_id) {
 		console.error("user_id required");
-		res.send(400, "user_id required");
-		return;
+		return errors.BadRequestError("user_id required", { message: "user_id is required" });
 	}
 	try {
 		let userGroup = await Groups.findOne({ user_id });
@@ -99,8 +94,7 @@ const actionGet = async (req, res) => {
 		res.send(userGroup);
 	} catch (err) {
 		console.error(err);
-		res.send(500, err);
-		return;
+		return errors.InternalServerError({ message: err.toString()});
 	}
 };
 
@@ -108,19 +102,16 @@ const actionDelete = async (req, res) => {
 	const user_id = req.params.user_id;
 	const group = req.query.group;
 	if (!group) {
-		res.send(400, "Group required");
-		return;
+		return errors.BadRequestError("Group required");
 	}
 	if (!user_id) {
 		console.error("user_id required");
-		res.send(400, "user_id required");
-		return;
+		return errors.BadRequestError("user_id required", { message: "user_id is required" });
 	}
 	try {
 		let userGroup = await Groups.findOne({ user_id });
 		if (!userGroup) {
-			res.send(400, "User not found");
-			return;
+			return errors.BadRequestError("User not found");
 		}
 		let i = userGroup.groups.indexOf(group);
 		if (i > -1) {
@@ -129,8 +120,7 @@ const actionDelete = async (req, res) => {
 		res.send(await userGroup.save());
 	} catch (err) {
 		console.error(err);
-		res.send(500, err);
-		return;
+		return errors.InternalServerError({ message: err.toString() });
 	}
 };
 

package/libs/jxp.js

@@ -1,3 +1,4 @@
+const errors = require("restify-errors");
 const restify = require("restify");
 const path = require("path");
 const security = require("./security");
@@ -29,7 +30,7 @@ const middlewareModel = (req, res, next) => {
 		return next();
 	} catch (err) {
 		console.error(new Date, err);
-		return res.send(404, { status: "error", error: err, message: `Model ${modelname} not found` });
+		throw new errors.NotFoundError("Not Found", { message: `Model ${modelname} not found` });
 	}
 };
 
@@ -50,8 +51,13 @@ const middlewareCheckAdmin = (req, res, next) => {
 
 // Outputs whatever is in res.result as JSON
 const outputJSON = (req, res, next) => {
-	res.send(res.result);
-	next();
+	try {
+		res.send(res.result);
+		next();
+	} catch (err) {
+		console.error(new Date(), err);
+		throw new errors.InternalServerError("Error generating output", { message: err.toString() });
+	}
 }
 
 // Outputs whatever is in res.result as CSV
@@ -59,7 +65,7 @@ const outputCSV = (req, res, next) => {
 	const json2csv = require('json2csv').parse;
 	const opts = { "flatten": true };
 	if (!res.result.data) {
-		return res.send(500, "Not CSVable data");
+		throw new errors.InternalServerError("Error generating output", { message: "Not CSVable data" });
 	}
 	try {
 		const data = res.result.data.map(row => row._doc);
@@ -75,7 +81,7 @@ const outputCSV = (req, res, next) => {
 		next();
 	} catch (err) {
 		console.error(err);
-		res.send(500, { status: "error", error: err, message: err.toString() });
+		throw new errors.InternalServerError("Internal Error", { message: err.toString() });
 	}
 }
 
@@ -83,13 +89,6 @@ const outputCSV = (req, res, next) => {
 const actionGet = async (req, res) => {
 	const opname = `get ${req.modelname} ${ops++}`;
 	console.time(opname);
-	try {
-		if (res.user) {
-			req.Model.__user = res.user;
-		}
-	} catch(err) {
-		console.error(err);
-	}
 	const parseSearch = function(search) {
 		let result = {};
 		for (let i in search) {
@@ -102,8 +101,7 @@ const actionGet = async (req, res) => {
 		filters = parseFilter(req.query.filter);
 	} catch (err) {
 		console.trace(new Date(), err);
-		res.send(500, { status: "error", error: err, message: err.toString() });
-		return;
+		throw new errors.InternalServerError("Internal Error", { message: err.toString() });
 	}
 	let search = parseSearch(req.query.search);
 	for (let i in search) {
@@ -124,6 +122,9 @@ const actionGet = async (req, res) => {
 		countquery = Object.assign({ $text: { $search: req.query.search }}, countquery);
 		qcount = req.Model.find({ $text: { $search: req.query.search }});
 	}
+	if (res.user) {
+		q.options = ({ user: res.user });
+	}
 	try {
 		let count = await req.Model.estimatedDocumentCount();
 		if (count < 100000 && Object.keys(countquery).length !== 0) {
@@ -189,7 +190,8 @@ const actionGet = async (req, res) => {
 	} catch(err) {
 		console.error(new Date(), err);
 		if (debug) console.timeEnd(opname);
-		res.send(500, { status: "error", message: err.toString() });
+		if (err.code) throw err;
+		throw new errors.InternalServerError("Internal Error", { message: err.toString() });
 	}
 };
 
@@ -197,20 +199,14 @@ const actionGetOne = async (req, res) => {
 	const opname = `getOne ${req.modelname}/${req.params.item_id} ${ops++}`;
 	console.time(opname);
 	try {
-		if (res.user) {
-			req.Model.__user = res.user;
-		}
-		const data = await getOne(req.Model, req.params.item_id, req.query);
+		const data = await getOne(req.Model, req.params.item_id, req.query, { user: res.user });
 		res.send({ data });
 		if (debug) console.timeEnd(opname);
 	} catch(err) {
 		console.error(new Date(), err);
 		if (debug) console.timeEnd(opname);
-		if (err.msg) {
-			res.send(err.code || 500, { status: "error", message: err.msg });
-		} else {
-			res.send(err.code || 500, { status: "error", message: err.toString() });
-		}
+		if (err.code) throw err;
+		throw new errors.InternalServerError("Internal Error", { message: err.toString() });
 	}
 };
 
@@ -240,7 +236,7 @@ const actionPost = async (req, res) => {
 	} catch (err) {
 		console.error(new Date(), err);
 		if (debug) console.timeEnd(opname);
-		res.send(500, { status: "error", message: err.toString() });
+		throw new errors.InternalServerError("Internal Error", { message: err.toString() });
 	}
 };
 
@@ -251,8 +247,7 @@ const actionPut = async (req, res) => {
 		let item = await req.Model.findById(req.params.item_id);
 		if (!item) {
 			console.error(new Date(), "Document not found");
-			res.send(404, { status: "error", message: "Document not found" });
-			return;
+			throw new errors.NotFoundError("Not Found", { message: "Document not found" });
 		}
 		_populateItem(item, datamunging.deserialize(req.body));
 		_versionItem(item);
@@ -276,8 +271,7 @@ const actionPut = async (req, res) => {
 	} catch (err) {
 		console.error(new Date(), err);
 		if (debug) console.timeEnd(opname);
-		res.send(500, { status: "error", message: err.toString() });
-		return;
+		throw new errors.InternalServerError("Internal Error", { message: err.toString() });
 	}
 };
 
@@ -302,8 +296,7 @@ const actionUpdate = async (req, res) => {
 	} catch (err) {
 		console.error(new Date(), err);
 		if (debug) console.timeEnd(opname);
-		res.send(500, { status: "error", message: err.toString() });
-		return;
+		throw new errors.InternalServerError("Internal Error", { message: err.toString() });
 	}
 };
 
@@ -317,8 +310,7 @@ const actionDelete = async (req, res) => {
 		let item = await req.Model.findById(req.params.item_id);
 		if (!item) {
 			console.error(new Date(), "Couldn't find item for delete");
-			res.send(404, "Could not find document");
-			return;
+			throw new errors.NotFoundError("Not Found", { message: "Couldn't find item for delete" });
 		}
 		// Get linked models
 		const linked_models = [];
@@ -347,8 +339,7 @@ const actionDelete = async (req, res) => {
 						await models[linked_model.modelname].updateMany(q, { _deleted: true });
 					}
 				} else {
-					res.send(409, { status: "error", message: `Parent link item exists in ${linked_model.modelname}/${linked_model.field}` });
-					return;
+					throw new errors.ConflictError("Conflict Error", { message: `Parent link item exists in ${linked_model.modelname}/${linked_model.field}` });
 				}
 			}
 		}
@@ -381,8 +372,8 @@ const actionDelete = async (req, res) => {
 	} catch(err) {
 		console.error(new Date(), err);
 		if (debug) console.timeEnd(opname);
-		res.send(500, { status: "error", message: err.toString() });
-		return;
+		if (err.code) throw err;
+		throw new errors.InternalServerError("Internal Error", { message: err.toString() });
 	}
 };
 
@@ -401,8 +392,7 @@ const actionCount = async (req, res) => {
 		filters = parseFilter(req.query.filter);
 	} catch (err) {
 		console.trace(new Date(), err);
-		res.send(500, { status: "error", error: err, message: err.toString() });
-		return;
+		throw new errors.InternalServerError("Internal Error", { message: err.toString() });
 	}
 	let search = parseSearch(req.query.search);
 	for (let i in search) {
@@ -418,7 +408,8 @@ const actionCount = async (req, res) => {
 	} catch(err) {
 		console.error(new Date(), err);
 		if (debug) console.timeEnd(opname);
-		res.send(500, { status: "error", message: err.toString() });
+		if (err.code) throw err;
+		throw new errors.InternalServerError("Internal Error", { message: err.toString() });
 	}
 };
 
@@ -431,7 +422,8 @@ const actionCall = async (req, res) => {
 		res.json(result);
 	} catch(err) {
 		console.error(new Date(), err);
-		res.send(500, { status: "error", message: err.toString() });
+		if (err.code) throw err;
+		throw new errors.InternalServerError("Internal Error", { message: err.toString() });
 	}
 };
 
@@ -439,16 +431,15 @@ const actionCallItem = async (req, res) => {
 	try {
 		const item = req.Model.findById(req.params.item_id);
 		if (!item) {
-			res.send(404, "Document not found for " + req.params.method_name);
-			return;
+			throw new errors.NotFoundError("Not Found", { message: "Couldn't find item for call" });
 		}
 		req.params.__user = res.user || null;
 		const result = await req.Model[req.params.method_name](item);
 		res.json(result);
-			
 	} catch(err) {
 		console.trace(err);
-		res.send(500, { status: "error", message: err.toString() });
+		if (err.code) throw err;
+		throw new errors.InternalServerError("Internal Error", { message: err.toString() });
 	}
 };
 
@@ -456,7 +447,7 @@ const actionCallItem = async (req, res) => {
 const actionQuery = async (req, res) => {
 	if (!req.body || !req.body.query || typeof req.body.query !== "object") {
 		console.error("query missing or not of type object")
-		return res.send(500, { status: "error", message: "query missing or not of type object" });
+		throw new errors.InternalServerError("Query missing", { message: "query missing or not of type object" });
 	}
 	const opname = `query ${req.modelname} ${ops++}`;
 	console.time(opname);
@@ -525,7 +516,8 @@ const actionQuery = async (req, res) => {
 	} catch(err) {
 		console.error(new Date(), err);
 		if (debug) console.timeEnd(opname);
-		res.send(500, { status: "error", message: err.toString() });
+		if (err.code) throw err;
+		throw new errors.InternalServerError("Internal Error", { message: err.toString() });
 	}
 };
 
@@ -534,7 +526,7 @@ const actionAggregate = async (req, res) => {
 	let query = (req.body.query) ? req.body.query : req.body; // Don't require to embed in query anymore
 	if (!query || !Array.isArray(query)) {
 		console.error("query missing or not of type array")
-		return res.send(500, { status: "error", message: "query missing or not of type array" });
+		throw new errors.InternalServerError("Query missing", { message: "query missing or not of type array" });
 	}
 	query = query_manipulation.fix_query(query);
 	const opname = `aggregate ${req.modelname} ${ops++}`;
@@ -552,7 +544,7 @@ const actionAggregate = async (req, res) => {
 	} catch (err) {
 		console.error(new Date(), err);
 		if (debug) console.timeEnd(opname);
-		res.send(500, { status: "error", message: err.toString() });
+		throw new errors.InternalServerError("Internal Error", { message: err.toString() });
 	}
 };
 
@@ -560,7 +552,7 @@ const actionAggregate = async (req, res) => {
 const actionBulkWrite = async (req, res) => {
 	if (!req.body || !Array.isArray(req.body)) {
 		console.error("query missing or not of type array")
-		return res.send(500, { status: "error", message: "query missing or not of type array" });
+		throw new errors.InternalServerError("Query Missing", { message: "query missing or not of type array" });
 	}
 	const opname = `bulkwrite ${req.modelname} ${ops++}`;
 	console.time(opname);
@@ -575,7 +567,7 @@ const actionBulkWrite = async (req, res) => {
 	} catch (err) {
 		console.error(new Date(), err);
 		if (debug) console.timeEnd(opname);
-		res.send(500, { status: "error", message: err.toString() });
+		throw new errors.InternalServerError("Internal Error", { message: err.toString() });
 	}
 };
 
@@ -613,8 +605,8 @@ const actionBulkWrite = async (req, res) => {
 
 // Utitlities
 
-const getOne = async (Model, item_id, params) => {
-	const query = Model.findById(item_id);
+const getOne = async (Model, item_id, params, options) => {
+	const query = Model.findById(item_id, {}, options);
 	if (params.populate) {
 		if ((typeof params.populate === "object")  && !Array.isArray(params.populate)) {
 			for (let i in params.populate) {
@@ -636,11 +628,11 @@ const getOne = async (Model, item_id, params) => {
 		var item = await query.exec();
 		if (!item) {
 			// console.error("Could not find document");
-			return Promise.reject({ code: 404, msg: "Could not find document" });
+			throw new errors.NotFoundError("Could not find document", { message: "Could not find document" });
 		}
 		if (item._deleted && !params.showDeleted) {
 			// console.error("Document is deleted");
-			return Promise.reject({ code: 404, msg: "Document is deleted" });
+			throw new errors.NotFoundError("Document is deleted", { message: "Document is deleted" });
 		}
 		item = item.toObject();
 		//Don't ever return passwords
@@ -648,7 +640,8 @@ const getOne = async (Model, item_id, params) => {
 		return item;
 	} catch(err) {
 		console.error(err);
-		return Promise.reject({ code: 500, msg: err });
+		if (err.code) throw err;
+		throw new errors.InternalServerError("Internal Error", { message: err.toString() });
 	}
 };
 

package/libs/login.js

@@ -3,13 +3,12 @@ const jwt = require("jsonwebtoken");
 const bcrypt = require('bcryptjs');
 const security = require("../libs/security");
 const nodemailer = require('nodemailer');
+const errors = require("restify-errors");
 const smtpTransport = require('nodemailer-smtp-transport');
-var User = null;
-var APIKey = null;
+const path = require("path");
+let User = null;
 
 var init = function (config) {
-	var path = require("path");
-	APIKey = require(path.join(config.model_dir, 'apikey_model'));
 	User = require(path.join(config.model_dir, 'user_model'));
 	security.init(config);
 };
@@ -30,12 +29,11 @@ const recover = async (req, res) => {
 		const email = req.body.email;
 		if (!email) {
 			console.error("Missing email parameter");
-			res.send(400, { status: "fail", message: "Missing email parameter" });
-			return;
+			throw new errors.BadRequestError("Bad Request", { status: "fail", message: "Missing email parameter" });
 		}
 		const user = await User.findOne({ email });
 		if (!user) {
-			throw ("Could not find email");
+			throw new errors.NotFoundError("User Not Found", { status: "fail", message: "User not found" });
 		}
 		const result = await security.generateApiKey(user._id);
 		const token = jwt.sign({ apikey: result.apikey, email: user.email, id: user._id }, req.config.shared_secret, { expiresIn: "2d" });
@@ -57,26 +55,27 @@ const recover = async (req, res) => {
 		});
 		res.send({ status: "ok", message: "Sent recovery email" });
 	} catch (err) {
-		res.send(403, { status: "fail", message: "Unauthorized", err });
+		if (err.code) throw err;
+		throw new errors.UnauthorizedError("Unauthorized", { status: "fail", message: "Unauthorized", info: err });
 	}
 }
 
 const logout = async (req, res) => {
 	try {
-		if (!res.user) throw("You don't seem to be logged in");
+		if (!res.user) throw new errors.ForbiddenError("Forbidden", { message: "You don't seem to be logged in" });
 		await security.revokeToken(res.user._id);
 		res.send({ status: "ok", message: "User logged out" });
 	} catch(err) {
 		console.error(err);
-		res.send(500, { status: "error", error: err });
+		if (err.code) throw err;
+		throw new errors.InternalServerError("Server Error", { status: "error", message: err.toString() });
 	}
 }
 
 const oauth = (req, res, next) => { // Log in through an OAuth2 provider, defined in config.js
 	const provider_config = req.config.oauth[req.params.provider];
 	if (!provider_config) {
-		res.send(500, req.params.provider + " config not defined");
-		return;
+		throw new errors.InternalServerError("Internal Server Error", { message: req.params.provider + " config not defined" });
 	}
 	const state = Math.random().toString(36).substring(7);
 	const uri = `${provider_config.auth_uri}?client_id=${provider_config.app_id}&redirect_uri=${req.config.url}/login/oauth/callback/${req.params.provider}&scope=${provider_config.scope}&state=${state}&response_type=code`;
@@ -149,8 +148,7 @@ const login = async (req, res) => {
 	}
 	if ((!password) || (!email)) {
 		console.error(new Date(), "Missing email or password parameters");
-		res.send(404, { status: "fail", message: "Missing email or password parameters" });
-		return;
+		return errors.ForbiddenError({ status: "fail", message: "Missing email or password parameters" });
 	}
 	try {
 		const user = await User.findOne({ email });
@@ -171,28 +169,25 @@ const login = async (req, res) => {
 			provider: token.provider,
 		});
 	} catch (err) {
-		res.send(401, { status: "fail", message: "Authentication failed", err });
 		console.error(new Date(), `Authentication failed`, ip, err);
-		return;
+		if (err.code) throw err;
+		return errors.ForbiddenError({ status: "fail", message: "Authentication failed" });
 	}
 }
 
 const getJWT = async (req, res) => {
 	var user = null;
 	if (!res.user.admin) {
-		res.send(403, { status: "fail", message: "Unauthorized" });
-		return;
+		throw new errors.UnauthorizedError("Unauthorized", { status: "fail", message: "Unauthorized" });
 	}
 	var email = req.params.email || req.body.email;
 	if (!email) {
-		res.send(400, { status: "fail", message: "Email required" });
-		return;
+		throw new errors.BadRequestError("Bad Request", { status: "fail", message: "Email required" });
 	}
 	try {
 		const result = await User.findOne({ email: email });
 		if (!result || !result._id) {
-			res.send(404, { status: "fail", message: "User not found" });
-			return;
+			throw new errors.NotFoundError("Not Found", { status: "fail", message: "User not found" });
 		}
 		user = result;
 		try {
@@ -202,11 +197,11 @@ const getJWT = async (req, res) => {
 			});
 			res.send({ email: user.email, token: token });
 		} catch (err) {
-			res.send(403, { status: "fail", message: "Unauthorized" });
-			return;
+			throw new errors.UnauthorizedError("Unauthorized", { status: "fail", message: "Unauthorized" });
 		}
 	} catch (err) {
-		res.send(500, { status: "error", error: err });
+		if (err.code) throw err;
+		throw new errors.InternalServerError("Internal Server Error", { status: "error", message: err.toString() });
 	}
 }
 

package/libs/schema_description.js

@@ -9,7 +9,7 @@ const getModelFileContents = (model_dir) => {
                     return reject(err);
                 }
                 let models = [];
-                for (file of files) {
+                for (const file of files) {
                     const modelname = path.basename(file, ".js").replace("_model", "");
                     try {
                         const modelobj = require(path.join(model_dir, file));

package/libs/security.js

@@ -1,6 +1,7 @@
 const bcrypt = require("bcryptjs");
 const randToken = require("rand-token");
 const path = require("path");
+const errors = require("restify-errors");
 var APIKey = null;
 var Token = null;
 var Groups = null;
@@ -17,10 +18,6 @@ const init = function(config) {
 	if (config.url) provider = config.url;
 };
 
-const fail = function (res, code, message) {
-	res.send(code, { status: "error", message });
-};
-
 const basicAuthData = function(req) {
 	if (!req.headers.authorization) {
 		return false;
@@ -51,7 +48,7 @@ const basicAuth = async ba => {
 		return user;
 	} catch(err) {
 		console.error(new Date(), err);
-		return Promise.reject(err);
+		throw err;
 	}
 };
 
@@ -84,7 +81,7 @@ const bearerAuth = async t => {
 		return user;
 	} catch (err) {
 		console.error(err);
-		return Promise.reject(err);
+		throw err;
 	}
 }
 
@@ -98,7 +95,7 @@ const apiKeyAuth = async apikey => {
 		return user;
 	} catch(err) {
 		console.error(new Date(), err);
-		return Promise.reject(err);
+		throw err;
 	}
 };
 
@@ -109,7 +106,7 @@ const getGroups = async user_id => {
 		return groups;
 	} catch(err) {
 		console.error(new Date(), err);
-		return Promise.reject(err);
+		throw err;
 	}
 };
 
@@ -131,7 +128,7 @@ const generateApiKey = async user_id => {
 		return apikey;
 	} catch(err) {
 		console.error(new Date(), err);
-		return Promise.reject(err);
+		throw err;
 	}
 };
 
@@ -156,16 +153,21 @@ const generateToken = async user_id => {
 		return token;
 	} catch (err) {
 		console.error(new Date(), err);
-		return Promise.reject(err);
+		throw err;
 	}
 };
 
 const ensureToken = async user_id => {
-	const token = await Token.findOne({ user_id, provider }).sort({ createdAt: -1 }).exec();
-	if (tokenIsValid(token)) {
-		return token;
+	try {
+		const token = await Token.findOne({ user_id, provider }).sort({ createdAt: -1 }).exec();
+		if (tokenIsValid(token)) {
+			return token;
+		}
+		return await generateToken(user_id);
+	} catch (err) {
+		console.error(new Date(), err);
+		throw err;
 	}
-	return await generateToken(user_id);
 }
 
 const refreshToken = async user_id => {
@@ -187,7 +189,7 @@ const generateRefreshToken = async user_id => {
 		return refreshtoken;
 	} catch (err) {
 		console.error(new Date(), err);
-		return Promise.reject(err);
+		throw err;
 	}
 };
 
@@ -226,7 +228,8 @@ const refresh = async (req, res) => {
 		}
 	} catch (err) {
 		console.error(err);
-		return fail(res, 403, err);
+		if (err.code) throw err;
+		throw new errors.ForbiddenError("Forbidden", { message: err.toString() });
 	}
 }
 
@@ -241,7 +244,8 @@ const login = async (req, res) => {
 		res = Object.assign(res, authenticate_result);
 	} catch(err) {
 		console.error(err);
-		return fail(res, 403, err);
+		if (err.code) throw err;
+		throw new errors.ForbiddenError("Forbidden", { message: err.toString() });
 	}
 };
 
@@ -250,40 +254,37 @@ const authenticate = async req => {
 	if (!req.query.apikey && !req.headers.authorization && !(req.headers["X-API-Key"] || req.headers["x-api-key"])) {
 		return false;
 	}
-	try {
-		if (req.headers.authorization && req.headers.authorization.trim().toLowerCase().indexOf("basic") === 0) {
-			// Basic Auth
-			user = await basicAuth(basicAuthData(req));
-		} else if (req.headers.authorization && req.headers.authorization.trim().toLowerCase().indexOf("bearer") === 0) {
-			// Token Auth
-			user = await bearerAuth(bearerAuthData(req));
-		} else if (req.query.apikey) {
-			user = await apiKeyAuth(req.query.apikey);
-		} else if (req.headers["X-API-Key"] || req.headers["x-api-key"]) {
-			// API Key
-			user = await apiKeyAuth(req.query.apikey || req.headers["X-API-Key"] || req.headers["x-api-key"])
-		} else {
-			throw ("Could not find any way to authenticate");
-		}
-		if (!user) {
-			throw ("Could not find user");
-		}
-		return {
-			token: await ensureToken(user._id),
-			refresh_token: await ensureRefreshToken(user._id),
-			groups: await getGroups(user._id),
-			user
-		}
-	} catch (err) {
-		return Promise.reject(err);
+	if (req.headers.authorization && req.headers.authorization.trim().toLowerCase().indexOf("basic") === 0) {
+		// Basic Auth
+		user = await basicAuth(basicAuthData(req));
+	} else if (req.headers.authorization && req.headers.authorization.trim().toLowerCase().indexOf("bearer") === 0) {
+		// Token Auth
+		user = await bearerAuth(bearerAuthData(req));
+	} else if (req.query.apikey) {
+		user = await apiKeyAuth(req.query.apikey);
+	} else if (req.headers["X-API-Key"] || req.headers["x-api-key"]) {
+		// API Key
+		user = await apiKeyAuth(req.query.apikey || req.headers["X-API-Key"] || req.headers["x-api-key"])
+	} else {
+		throw ("Could not find any way to authenticate");
+	}
+	if (!user) {
+		throw ("Could not find user");
+	}
+	return {
+		token: await ensureToken(user._id),
+		refresh_token: await ensureRefreshToken(user._id),
+		groups: await getGroups(user._id),
+		user
 	}
+	
 }
 
 const auth = async (req, res) => {
 	// Check against model as to whether we're allowed to edit this model
 	if (!req.Model) {
 		console.error("Model missing");
-		return fail(res, 500, "Model missing");
+		throw new errors.InternalServerError("Model missing", { message: "Model missing" });
 	}
 	try {
 		var method = null;
@@ -298,12 +299,13 @@ const auth = async (req, res) => {
 			method = "d";
 		} else {
 			console.error("Unsupported operation", req.method);
-			return fail(res, 500, "Unsupported operation: " + req.method);
+			throw new errors.InternalServerError("Unsupported operation", { message: "Unsupported operation: " + req.method});
 		}
-		await check_perms(res.user, res.groups, req.Model, method, req.params.item_id);
+		return await check_perms(res.user, res.groups, req.Model, method, req.params.item_id);
 	} catch(err) {
 		console.error(err);
-		return fail(res, 403, { status: "Unauthorized", error: err });
+		if (err.code) throw err;
+		throw new errors.ForbiddenError("Forbidden", { message: err.toString() });
 	}
 };
 
@@ -316,7 +318,8 @@ const bulkAuth = async (req, res,) => {
 		await check_perms(res.user, res.groups, req.Model, "d");
 	} catch (err) {
 		console.error(err);
-		return fail(res, 403, { status: "Unauthorized", error: err });
+		if (err.code) throw err;
+		throw new errors.ForbiddenError("Forbidden", { message: err.toString() });
 	}
 };
 
@@ -326,17 +329,17 @@ const check_perms = async (user, groups, model, method, item_id) => {
 		//If no perms are set, then this isn't an available model
 		if (!perms.admin) {
 			console.error("Model permissions not set correctly - add an admin section");
-			throw("Model permissions not set correctly - add an admin section");
+			throw new errors.InternalServerError("Model permissions not set correctly - add an admin section", { message: "Model permissions not set correctly - add an admin section" });
 		}
 		//First check if "all" is able to do this. If so, let's get on with it.
-		if (perms.all) {
+		if (perms.all && perms.all.length) {
 			if (perms.all.indexOf(method) !== -1) {
 				return true;
 			}
 		}
 		//This isn't an 'all' situation, so let's bail if the user isn't logged in
 		if (!user) {
-			throw("Unauthorized");
+			throw new errors.ForbiddenError("User not logged in", { message: "User not logged in" });
 		}
 		//Let's check perms in this order - admin, user, group, owner
 		//Admin check
@@ -362,16 +365,17 @@ const check_perms = async (user, groups, model, method, item_id) => {
 		if (item && item._owner_id && item._owner_id.toString() == user._id.toString() && (perms.owner && perms.owner.includes(method))) return true;
 		throw ("Authorization failed");
 	} catch (err) {
-		return Promise.reject(err);
+		if (err.code) throw err;
+		throw new errors.ForbiddenError("Forbidden", { message: err.toString() });
 	}
 }
 
 const admin_only = (req, res, next) => { // Chain after login
 	if (!res.user) {
-		return fail(res, 403, "Unauthorized");
+		throw new errors.ForbiddenError("Unauthorized", { message: "Unauthorized" });
 	}
 	if (!res.user.admin) {
-		return fail(res, 403, "Unauthorized");
+		throw new errors.ForbiddenError("Unauthorized", { message: "Unauthorized" });
 	}
 	next();
 }

package/libs/setup.js

@@ -1,5 +1,6 @@
 const rand_token = require("rand-token");
 const path = require("path");
+const errors = require("restify-errors");
 const security = require("./security");
 const ObjectID = require('mongodb').ObjectID;
 var User = null;
@@ -9,15 +10,15 @@ const init = config => {
 	User = require(path.join(config.model_dir, "user_model"));
 }
 
-const checkUserDoesNotExist = async (req, res) => {
+const checkUserDoesNotExist = async () => {
 	try {
 		const count = await User.countDocuments();
 		if (count) {
-			return res.send(403, { status: "failed", error: "Cannot setup if user exists" });
+			throw new errors.ConflictError("Conflict Error", { status: "failed", error: "Cannot setup if user exists" });
 		}
 	} catch(err) {
 		console.error(err);
-		res.send(500, { status: "error", error: err.message });
+		throw new errors.InternalServerError("Internal Server Error", { status: "error", error: err.message });
 	}
 };
 
@@ -46,7 +47,7 @@ const setup = async (req, res) => {
 		});
 	} catch(err) {
 		console.error(err);
-		res.send(500, { status: "error", error: err.message });
+		throw new errors.InternalServerError("Internal Server Error", { status: "error", error: err.message });
 	}
 };
 
@@ -76,7 +77,7 @@ const data_setup = async (req, res) => {
 		res.send({ status: "success", results });
 	} catch(err) {
 		console.error(err);
-		res.send(500, { status: "error", error: err.message });
+		throw new errors.InternalServerError("Internal Server Error", { status: "error", error: err.message });
 	}
 }
 

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "jxp",
   "description:": "An opinionated RESTful API library based on Mongoose and Restify. Make an API by just writing Mongoose models.",
-  "version": "2.11.1",
+  "version": "2.12.0",
   "private": false,
   "main": "libs/jxp.js",
   "scripts": {
@@ -39,7 +39,7 @@
     "jstransformer-markdown-it": "^3.0.0",
     "jxp-helper": "^1.4.0",
     "mkdirp": "^1.0.4",
-    "mongoose": "6.7.3",
+    "mongoose": "6.7.5",
     "mongoose-friendly": "^0.1.4",
     "morgan": "^1.10.0",
     "nodemailer": "^6.8.0",
@@ -49,8 +49,9 @@
     "querystring": "^0.2.1",
     "rand-token": "^1.0.1",
     "readline-sync": "^1.4.10",
-    "restify": "^9.0.0",
+    "restify": "^10.0.0",
     "restify-cors-middleware": "^1.1.1",
+    "restify-errors": "^8.0.2",
     "traverse": "^0.6.7",
     "underscore": "^1.13.6",
     "ws": "^8.11.0"

package/test/init.js

@@ -13,7 +13,7 @@ const security = require("../libs/security");
 
 const empty = async model => {
 	try {
-		const result = await model.deleteMany({});
+		await model.deleteMany({});
 	} catch(err) {
 		console.error(err);
 		throw(err);

package/test/setup.test.js

@@ -3,14 +3,13 @@ const config = require("config");
 const path = require("path");
 
 var model_dir = config.model_dir || path.join(process.cwd(), "./models");
-const Test = require(path.join(model_dir, "test_model"));
+require(path.join(model_dir, "test_model"));
 
 var chai = require('chai');
 var chaiHttp = require('chai-http');
 var should = chai.should();
 
 var init = require("./init");
-
 var server = require("../bin/server");
 
 chai.use(chaiHttp);
@@ -27,6 +26,7 @@ const mock_data = {
 describe('Setup', () => {
     beforeEach(async function() {
         await init.empty_user_collections();
+        console.log("Emptied collections");
     })
 
 	describe("setup", () => {
@@ -35,6 +35,7 @@ describe('Setup', () => {
 				.post("/setup")
 				.send({ email: init.email, password: init.password })
 				.end((err, res) => {
+                    // console.log(res);
 					res.should.have.status(200);
 					res.body.status.should.equal('success');
                     res.body.name.should.equal('admin');

package/test/test.js

@@ -121,6 +121,7 @@ describe('Test', () => {
 				.get("/api/user")
 				.auth(init.email, init.password)
 				.end((err, res) => {
+					// console.log(res.body);
 					res.should.have.status(200);
 					res.body.data.should.be.an('array');
 					done();
@@ -159,6 +160,7 @@ describe('Test', () => {
 			chai.request(server)
 				.get(`/api/user`)
 				.end((err, res) => {
+					// console.log(res.body);
 					res.should.have.status(403);
 					done();
 				});
@@ -565,7 +567,7 @@ describe('Test', () => {
 				.get(`/api/test?populate=array_link`)
 				.auth(init.email, init.password)
 				.end((err, res) => {
-					// console.log(res.body.data);
+					// console.log(res.body);
 					res.should.have.status(200);
 					res.body.data[0].should.have.property("array_link");
 					res.body.data[0].array_link.should.be.an("array");
@@ -708,7 +710,7 @@ describe('Test', () => {
 				var query = [
 					{ 
 						$match: {
-							"_id": `ObjectId(\"${objectid}\")`
+							"_id": `ObjectId("${objectid}")`
 						}
 					},
 					{ $group: { _id: null, count: { $sum: 1 } } }
@@ -719,7 +721,7 @@ describe('Test', () => {
 				.send({ query })
 				.end((err, res) => {
 					res.should.have.status(200);
-					console.log(res.body);
+					// console.log(res.body);
 					res.body.data.should.be.an('array');
 					res.body.data[0].should.have.property("_id");
 					res.body.data[0].should.have.property("count");
@@ -832,21 +834,21 @@ describe('Test', () => {
 					});
 			});
 		});
-		it("should $push to an array", done => {
-			chai.request(server)
-				.patch("/api/test/" + post_id)
-				.auth(init.email, init.password)
-				.send({ $push: { shmack: "fah" } })
-				.end((err, res) => {
-					console.log(res.body.data);
-					res.should.have.status(200);
-					res.body.data.should.be.an('object');
-					res.body.data.should.have.property("shmack")
-					res.body.data.shmack.should.be.an("array");
-					res.body.data.shmack.should.have.length(4);
-					done();
-				});
-		});
+		// it("should $push to an array", done => {
+		// 	chai.request(server)
+		// 		.patch("/api/test/" + post_id)
+		// 		.auth(init.email, init.password)
+		// 		.send({ $push: { shmack: "fah" } })
+		// 		.end((err, res) => {
+		// 			// console.log(res.body.data);
+		// 			res.should.have.status(200);
+		// 			res.body.data.should.be.an('object');
+		// 			res.body.data.should.have.property("shmack")
+		// 			res.body.data.shmack.should.be.an("array");
+		// 			res.body.data.shmack.should.have.length(4);
+		// 			done();
+		// 		});
+		// });
 	});
 
 	describe("Models", () => {
@@ -868,6 +870,7 @@ describe('Test', () => {
 				.del(`/api/test/${post_id}`)
 				.auth(init.email, init.password)
 				.end((err, res) => {
+					console.log(res.body);
 					res.should.have.status(200);
 					res.body.status.should.equal('ok');
 					done();
@@ -878,9 +881,10 @@ describe('Test', () => {
 				.get(`/api/test/${post_id}`)
 				.auth(init.email, init.password)
 				.end((err, res) => {
+					console.log(res.body);
 					res.should.have.status(404);
 					res.body.message.should.equal('Document is deleted');
-					res.body.status.should.equal('error');
+					res.body.code.should.equal('NotFound');
 					done();
 				});
 		});
@@ -982,8 +986,7 @@ describe('Test', () => {
 				.auth(init.email, init.password)
 				.end((err, res) => {
 					res.should.have.status(409);
-					res.body.message.should.equal(`Parent link item exists in test/link_id`);
-					res.body.status.should.equal('error');
+					res.body.message.should.equal(`Conflict Error`);
 					done();
 				});
 		});
@@ -992,7 +995,7 @@ describe('Test', () => {
 				.del(`/api/link/${link_id}?_cascade=1`)
 				.auth(init.email, init.password)
 				.end((err, res) => {
-					console.log(res.body, res.status);
+					// console.log(res.body, res.status);
 					res.should.have.status(200);
 					res.body.status.should.equal('ok');
 					done();
@@ -1004,7 +1007,7 @@ describe('Test', () => {
 				.auth(init.email, init.password)
 				.end((err, res) => {
 					res.should.have.status(404);
-					res.body.status.should.equal('error');
+					res.body.message.should.equal('Document is deleted');
 					done();
 				});
 		});
@@ -1060,8 +1063,7 @@ describe('Test', () => {
 				.auth(init.email, init.password)
 				.end((err, res) => {
 					res.should.have.status(409);
-					res.body.message.should.equal(`Parent link item exists in test/link_id`);
-					res.body.status.should.equal('error');
+					res.body.message.should.equal(`Conflict Error`);
 					done();
 				});
 		});
@@ -1087,7 +1089,6 @@ describe('Test', () => {
 	});
 
 	describe("/Filter with +", () => {
-		let plus_user_id = null;
 		it("it should POST a user with a + in email", (done) => {
 			var user = {
 				name: "Plus User",
@@ -1100,7 +1101,6 @@ describe('Test', () => {
 			.end((err, res) => {
 				res.should.have.status(200);
 				res.body.data.should.have.property("_id");
-				plus_user_id = res.body.data._id;
 				done();
 			});
 		});