nodester 0.1.0 → 0.1.5

package/lib/{queries → query}/traverse.js

@@ -1,10 +1,19 @@
+/*!
+ * /nodester
+ * MIT Licensed
+ */
+'use strict';
+
 const { Op } = require('sequelize');
+const NQueryError = require('../factories/errors/NodesterQueryError');
+const httpCodes = require('nodester/http/codes');
 
 
 module.exports = traverse;
 
-function traverse(queryNode, colander=null, model) {
+function traverse(queryNode, filter=null, model) {
 
+	const sequelize = model.sequelize;
 	const fieldsAvailable = Object.keys(model.tableAttributes);
 	const includesAvailable = model.getIncludesList();
 
@@ -18,15 +27,16 @@ function traverse(queryNode, colander=null, model) {
 		where,
 		includes,
 		fields,
+		functions,
 		clauses,
 	} = _disassembleQueryNode(queryNode);
 
 
 	// Fields:
 	//
-	//	If Colander is not set,
+	//	If Filter is not set,
 	//	use every available field:
-	if (colander === null) {
+	if (filter === null) {
 		for (let field of fieldsAvailable) {
 			// If no query filter or field is requested:
 			if (fields.length === 0 || fields.indexOf(field) > -1) {
@@ -35,20 +45,21 @@ function traverse(queryNode, colander=null, model) {
 			}
 		}
 	}
-	//	Colander is present:
+	//	Filter is present:
 	else {
 		// If no query fields were set,
-		//	use the ones from Colander,
+		//	use the ones from Filter,
 		// If query fields were set,
-		//	put them through Colander:
-		for (let field of colander.fields) {
+		//	put them through Filter:
+		for (let field of filter.fields) {
 			if (fieldsAvailable.indexOf(field) === -1) {
-				const err = new TypeError(`field ${ field } is not present in model.`);
+				const err = new TypeError(`Field '${ field }' is not present in model.`);
+				err.status = httpCodes.NOT_ACCEPTABLE;
 				throw err;
 			}
 
 			// If field is not in available set:
-			// if (colander.fields.indexOf(field) === -1) {
+			// if (filter.fields.indexOf(field) === -1) {
 			// 	continue;
 			// }
 
@@ -63,10 +74,61 @@ function traverse(queryNode, colander=null, model) {
 	//	At least 1 field is mandatory:
 	if (newQuery.attributes.length === 0) {
 		const err = new TypeError(`No fields were selected.`);
+		err.status = httpCodes.NOT_ACCEPTABLE;
 		throw err;
 	}
 	// Fields\
 
+	// Functions:
+	for (const fnParams of functions) {
+
+		// If COUNT() is requested:
+		if (fnParams.fn === 'count') {
+			const countParams = fnParams.args;
+
+			const [ countTarget ] = countParams;
+			const RootModelName = model.options.name;
+			// Count can be requested for this model,
+			// or for any of the available uncludes.
+			const isForRootModel = countTarget === RootModelName.plural.toLowerCase();
+
+			// Compile request:
+			//	Example:
+			// `(SELECT COUNT(*) FROM comments WHERE comments.morph_id=Morph.id)`
+
+			// Params for attribute:
+			let rawSQL = '(SELECT COUNT(*) FROM ';
+			let countAttribute = '_count';
+
+			// If request to count one of includes:
+			if (!isForRootModel) {
+				// Check if it's available:
+				if (
+						!filter
+						||
+						!filter?.includes[countTarget]
+						||
+						model.associations[countTarget] === undefined
+					) {
+					const err = new NQueryError(`Count for '${ countTarget }' is not available.`);
+					err.status = httpCodes.NOT_ACCEPTABLE;
+					throw err;
+				}
+
+				const {
+					foreignKey,
+					sourceKey
+				} = model.associations[countTarget];
+				rawSQL += `${ countTarget } where ${ countTarget }.${ foreignKey }=${ RootModelName.singular }.${ sourceKey })`;
+				countAttribute = `${ countTarget }_count`;
+			}
+
+			newQuery.attributes.push(
+				[sequelize.literal(rawSQL), countAttribute]
+			);
+		}
+	}
+	// Functions\
 
 	// Clauses:
 	const order = {};
@@ -74,8 +136,8 @@ function traverse(queryNode, colander=null, model) {
 	const clausesEntries = Object.entries(clauses);
 	for (let [clauseName, value] of clausesEntries) {
 		// If clause is not available:
-		if (colander != null) {
-			if (colander.clauses.indexOf(clauseName) === -1)
+		if (filter != null) {
+			if (filter.clauses.indexOf(clauseName) === -1)
 				continue;
 		}
 
@@ -87,6 +149,7 @@ function traverse(queryNode, colander=null, model) {
 
 				newQuery.limit = value;
 				continue;
+
 			case 'skip':
 				// Do not set if 0:
 				if (value === 0)
@@ -94,20 +157,27 @@ function traverse(queryNode, colander=null, model) {
 
 				newQuery.offset = value;
 				continue;
+
 			case 'order':
 				order.order = value;
 				continue;
+
 			case 'order_by':
 				order.by = value;
 				continue;
+				
 			default:
 				continue;
 		}
 	}
 
 	//	"statics" override or set any query Clause:
-	if (colander !== null) {
-		for (let [clauseName, staticClauseValue] of Object.entries(colander.statics.clauses)) {
+	if (filter !== null) {
+		const staticClausesEntries = Object.entries(filter.statics.clauses);
+
+		for (let entry of staticClausesEntries) {
+			const [clauseName, staticClauseValue] = entry;
+
 			switch(clauseName) {
 				case 'limit':
 					newQuery.limit = staticClauseValue;
@@ -130,7 +200,6 @@ function traverse(queryNode, colander=null, model) {
 
 
 	// Order:
-	const sequelize = model.sequelize;
 	if ( ['rand', 'random'].indexOf(order.order) > -1) {
 		newQuery.order = sequelize.random();
 	}
@@ -150,6 +219,11 @@ function traverse(queryNode, colander=null, model) {
 				break;
 			// MAX/MIN\
 
+			case null:
+			case undefined:
+				newQuery.order = [ ['id', 'desc'] ];
+				break;
+
 			default:
 				newQuery.order = [ [order.by, order.order] ];
 				break;
@@ -166,21 +240,22 @@ function traverse(queryNode, colander=null, model) {
 
 		const includeIndex = leftIncludes.indexOf(includeName);
 		if (includeIndex === -1) {
-			const err = new TypeError(`No include named ${ includeName }`);
+			const err = new TypeError(`No include named '${ includeName }'`);
+			err.status = httpCodes.NOT_ACCEPTABLE;
 			throw err;
 		}
 
 		leftIncludes.splice(includeIndex, 1);
 	}
 
-	_traverseIncludes(includes, model, colander, newQuery)
+	_traverseIncludes(includes, model, filter, newQuery)
 	// Includes\
 
 
 	// Where:
 	const whereEntries = Object.entries(where);
 	for (let [attribute, value] of whereEntries) {
-		_parseWhereEntry(attribute, value, newQuery.where, colander.statics.attributes);
+		_parseWhereEntry(attribute, value, newQuery.where, filter.statics.attributes);
 	}
 
 	// If "where" was not set:
@@ -189,21 +264,21 @@ function traverse(queryNode, colander=null, model) {
 	}
 	// Where\
 
-
 	return newQuery;
 }
 
 
-function _traverseIncludes(includes, model, colander, resultQuery) {
-	// If no Colander:
-	if (colander === null) {
+function _traverseIncludes(includes, model, filter=null, resultQuery) {
+	// If no Filter:
+	if (filter === null) {
 		for (let include of includes) {
 			const includeName = include.model;
 			const association = model.associations[includeName];
 
 			// If no such association:
 			if (!association) {
-				const err = new TypeError(`No include ${ includeName }`);
+				const err = new TypeError(`No include '${ includeName }'`);
+				err.status = httpCodes.NOT_ACCEPTABLE;
 				throw err;
 			}
 
@@ -214,14 +289,15 @@ function _traverseIncludes(includes, model, colander, resultQuery) {
 			_addAssociationQuery(associationQuery, includeName, resultQuery);
 		}
 	}
-	//	Colander is present:
+	//	Filter is present:
 	else {
-		const colanderIncludeEntries = Object.entries(colander.includes);
-		for (let [includeName, includeColander] of colanderIncludeEntries) {			
+		const filterIncludeEntries = Object.entries(filter.includes);
+		for (let [includeName, includeFilter] of filterIncludeEntries) {			
 			const association = model.associations[includeName];
 			// If no such association:
 			if (!association) {
 				const err = new TypeError(`No include ${ includeName }`);
+				err.status = httpCodes.NOT_ACCEPTABLE;
 				throw err;
 			}
 
@@ -232,7 +308,7 @@ function _traverseIncludes(includes, model, colander, resultQuery) {
 
 			const includeModel = association.target;
 			// Build query for this include.
-			const associationQuery = traverse(include, colander.includes[includeName], includeModel);
+			const associationQuery = traverse(include, filter.includes[includeName], includeModel);
 
 			_addAssociationQuery(associationQuery, includeName, resultQuery);
 		}
@@ -252,9 +328,9 @@ function _addAssociationQuery(associationQuery, includeName, resultQuery) {
 
 function _parseWhereEntry(attribute, value, whereHolder, staticAttributes) {
 	let _value = value;
-	const static = staticAttributes[attribute];
+	const staticAttribute = staticAttributes[attribute];
 
-	// If attribute is Op (like, or, not, etc.):
+	// If attribute is Op (not, like, or, etc.):
 	if (attribute in Op) {
 		// Parse value:
 		_value = _parseValue(_value, attribute);
@@ -265,8 +341,8 @@ function _parseWhereEntry(attribute, value, whereHolder, staticAttributes) {
 	}
 	
 	// Static value overrides any other:
-	if (!!static) {
-		whereHolder[attribute] = static;
+	if (!!staticAttribute) {
+		whereHolder[attribute] = staticAttribute;
 		return;
 	}
 
@@ -279,6 +355,7 @@ function _disassembleQueryNode(queryNode) {
 		where,
 		includes,
 		fields,
+		functions,
 		...clauses
 	} = queryNode;
 	// delete queryNode.model;
@@ -287,6 +364,7 @@ function _disassembleQueryNode(queryNode) {
 		where: where ?? {},
 		includes: includes ?? [],
 		fields: fields ?? [],
+		functions: functions ?? [],
 		clauses: clauses ?? []
 	};
 }

package/lib/router/index.js

@@ -22,7 +22,7 @@ const Path = require('path');
 const fs = require('fs');
 const commonExtensions = require('common-js-file-extensions');
 //	Debug & console:
-const consl = require('../logger/console');
+const consl = require('nodester/loggers/console');
 const debug = require('debug')('nodester:router');
 
 
@@ -257,7 +257,7 @@ module.exports = class NodesterRouter {
 		const handlerType = typeOf(handler);
 
 		if (handlerType === 'Object' && !this.paths.controllers && !this.paths.providers) {
-			const msg = `Please set "controllersPath" or "providersPath" during Router initialization.`;
+			const msg = `Please set 'controllersPath' or 'providersPath' during Router initialization.`;
 			const err = new TypeError(msg);
 			throw err;
 		}
@@ -396,7 +396,7 @@ module.exports = class NodesterRouter {
 	extend(key='', fnOrProperty) {
 		const keys = Object.keys(this);
 		if (keys.indexOf(key) > -1) {
-			const err = new TypeError(`Key ${ key } is already present in Router instance`);
+			const err = new TypeError(`Key '${ key }' is already present in Router instance.`);
 			throw err;
 		}
 

package/lib/router/routes.util.js

@@ -88,7 +88,11 @@ function _wrapRouteHandler(routeInstance, handler) {
 				await parsedHandler.before(req.nquery, req, res);
 			}
 
-			await providedAction(req, res);
+			// If response was not sent,
+			// perform action
+			if (res.headersSent === false) {
+				await providedAction(req, res);
+			}
 		}
 	};
 

package/lib/stacks/MarkersStack.js

@@ -1,4 +1,4 @@
-const consl = require('../logger/console');
+const consl = require('nodester/loggers/console');
 const debug = require('debug')('nodester:MiddlewareStack');
 
 

package/lib/stacks/MiddlewareStack.js

@@ -1,5 +1,5 @@
 const finalhandler = require('finalhandler');
-const consl = require('../logger/console');
+const consl = require('nodester/loggers/console');
 const debug = require('debug')('nodester:MiddlewareStack');
 
 

package/lib/utils/models.js

@@ -0,0 +1,14 @@
+/*!
+ * /nodester
+ * MIT Licensed
+ */
+'use strict';
+
+
+module.exports = {
+	isModel: _isModel
+};
+
+function _isModel(arg=null) {
+	return !!arg.tableName && typeof arg._schema === 'object';
+}

package/package.json

@@ -1,30 +1,54 @@
 {
   "name": "nodester",
-  "version": "0.1.0",
+  "version": "0.1.5",
   "description": "A boilerplate framework for Node.js",
   "exports": {
     ".": "./lib/application/index.js",
+
+    "./body/extract": "./lib/body/extract.js",
+
+    "./constants/ErrorCodes": "./lib/constants/ErrorCodes.js",
+
     "./controllers/methods": "./lib/controllers/methods/index.js",
     "./controllers/mixins": "./lib/controllers/mixins/index.js",
+
     "./database/connection": "./lib/database/connection.js",
     "./database/migration": "./lib/database/migration.js",
     "./database/utils": "./lib/database/utils.js",
+
     "./enum": "./lib/enums/Enum.js",
+
     "./facades/methods": "./lib/facades/methods/index.js",
     "./facades/mixins": "./lib/facades/mixins/index.js",
+
     "./factories/errors": "./lib/factories/errors/index.js",
     "./factories/responses/rest": "./lib/factories/responses/rest/index.js",
+
+    "./filter": "./lib/filters/Filter.js",
+
     "./http/codes": "./lib/http/codes/index.js",
+    "./http/codes/descriptions": "./lib/http/codes/descriptions.js",
+    "./http/codes/symbols": "./lib/http/codes/symbols.js",
+
+    "./loggers/console": "./lib/loggers/console.js",
+    "./loggers/dev": "./lib/loggers/dev.js",
+
     "./middlewares/formidable": "./lib/middlewares/formidable/index.js",
+
     "./models/associate": "./lib/models/associate.js",
     "./models/define": "./lib/models/define.js",
+
     "./params": "./lib/params/Params.js",
+
     "./ql/sequelize": "./lib/middlewares/ql/sequelize",
-    "./queries/Colander": "./lib/queries/Colander.js",
-    "./queries/traverse": "./lib/queries/traverse.js",
+    "./query/traverse": "./lib/query/traverse.js",
+
     "./route": "./lib/router/route.js",
     "./router": "./lib/router/index.js",
-    "./utils/strings": "./lib/utils/strings.util.js"
+
+    "./utils/sql": "./lib/utils/sql.util.js",
+    "./utils/strings": "./lib/utils/strings.util.js",
+    "./utils/sanitizations": "./lib/utils/sanitizations.util.js"
   },
   "directories": {
     "doc": "docs"

package/lib/preprocessors/BodyPreprocessor.js

@@ -1,61 +0,0 @@
-// Constants.
-const VISITOR = 'visitor';
-
-// Custom error.
-const { Err } = require('nodester/factories/errors');
-
-
-module.exports = class BodyPreprocessor {
-	constructor(
-		availableParamsForRoles,
-		staticParamsForRoles,
-		customProcessFunction
-	) {
-		this.availableParamsForRoles = availableParamsForRoles ?? {};
-		this.staticParamsForRoles = staticParamsForRoles ?? {};
-
-		this.customProcessFunction = customProcessFunction ? customProcessFunction : ()=>{};
-	}
-
-	async extract(
-		req,
-		role
-	) {
-		try {
-			const requestBody = req.body;
-
-			if (!requestBody || typeof requestBody !== 'object') {
-				const err = new Err();
-				err.name = 'ValidationError';
-				throw err;
-			}
-
-			// Get role or set "visitor"
-			const _role = typeof role === 'string' && role.length > 1 ? role : VISITOR;
-
-			const resultBody = {};
-
-			const params = this.availableParamsForRoles[_role] ?? [];
-			const staticValues = this.staticParamsForRoles[_role] ?? {};
-
-			params.forEach((param) => {
-				// If such param is set in body:
-				if (!!requestBody[param]) {
-					resultBody[param] = staticValues[param] ?? requestBody[param];
-				}
-				// If such param is not set, but we have a "static" for it:
-				else if (!requestBody[param] && !!staticValues[param]) {
-					resultBody[param] = staticValues[param];
-				}
-			});
-
-			// Make further preprocessing using customly defined function.
-			await this.customProcessFunction.call(this, req, role, resultBody);
-
-			return Promise.resolve(resultBody);
-		}
-		catch(error) {
-			return Promise.reject(error);
-		}
-	}
-}

package/lib/preprocessors/IncludesPreprocessor.js

@@ -1,55 +0,0 @@
-// Constants:
-const VISITOR = 'visitor';
-const DefaultAvailableParamsForRoles = { [VISITOR]: [] };
-const DefaultStaticParamsForRoles = { [VISITOR]: [] };
-
-// Custom error.
-const { Err } = require('nodester/factories/errors');
-
-
-module.exports = class IncludesPreprocessor {
-
-	constructor(
-		availableParamsForRoles,
-		staticParamsForRoles,
-		customProcessFunction=()=>{}
-	) {
-		this.availableParamsForRoles = availableParamsForRoles ?? DefaultAvailableParamsForRoles;
-		this.staticParamsForRoles = staticParamsForRoles ?? DefaultStaticParamsForRoles;
-
-		this.customProcessFunction = customProcessFunction ? customProcessFunction : ()=>{};
-	}
-
-	async extract(
-		req,
-		role
-	) {
-		const requestIncludes = req.query?.includes ?? [];
-
-		if (!requestQuery || typeof requestQuery !== 'object') {
-			const err = new Err();
-			err.name = 'ValidationError';
-			throw err;
-		}
-
-		// Get role or set "visitor"
-		const _role = typeof role === 'string' && role.length > 1 ? role : VISITOR;
-
-		const resultIncludes = [];
-
-		const params = this.availableParamsForRoles[_role] ?? [];
-		const staticValues = this.staticParamsForRoles[_role] ?? [];
-
-		params.forEach((param) => {
-			// If such param is set in query:
-			if (requestIncludes.indexOf(param) !== -1) {
-				resultIncludes.push(param);
-			}
-		});
-
-		// Make further preprocessing using custom defined function.
-		await this.customProcessFunction.call(this, req, role, resultIncludes);
-
-		return resultIncludes;
-	}
-}

package/lib/preprocessors/QueryPreprocessor.js

@@ -1,64 +0,0 @@
-// Constants:
-const VISITOR = 'visitor';
-const DefaultAvailableParamsForRoles = { [VISITOR]: [ 'skip', 'limit', 'order' ] };
-const DefaultStaticParamsForRoles = { [VISITOR]: { limit: 50 } };
-
-// Custom error.
-const { Err } = require('nodester/factories/errors');
-
-
-module.exports = class QueryPreprocessor {
-
-	constructor(
-		availableParamsForRoles,
-		staticParamsForRoles,
-		customProcessFunction
-	) {
-		this.availableParamsForRoles = availableParamsForRoles ?? DefaultAvailableParamsForRoles;
-		this.staticParamsForRoles = staticParamsForRoles ?? DefaultStaticParamsForRoles;
-
-		this.customProcessFunction = customProcessFunction ? customProcessFunction : ()=>{};
-	}
-
-	async extract(
-		req,
-		role
-	) {
-		try {
-			const requestQuery = req.query;
-
-			if (!requestQuery || typeof requestQuery !== 'object') {
-				const err = new Err();
-				err.name = 'ValidationError';
-				throw err;
-			}
-
-			// Get role or set "visitor"
-			const _role = typeof role === 'string' && role.length > 1 ? role : [VISITOR];
-
-			const resultQuery = {};
-
-			const params = this.availableParamsForRoles[_role] ?? [];
-			const staticValues = this.staticParamsForRoles[_role] ?? {};
-
-			params.forEach((param) => {
-				// If such param is set in query:
-				if (!!requestQuery[param]) {
-					resultQuery[param] = staticValues[param] ?? requestQuery[param];
-				}
-				// If such param is not set, but we have a "static" for it:
-				else if (!requestQuery[param] && !!staticValues[param]) {
-					resultQuery[param] = staticValues[param];
-				}
-			});
-
-			// Make further preprocessing using customly defined function.
-			await this.customProcessFunction.call(this, req, role, resultQuery);
-
-			return Promise.resolve(resultQuery);
-		}
-		catch(error) {
-			return Promise.reject(error);
-		}
-	}
-}