nodester 0.4.8 → 0.5.0

package/lib/application/index.js

@@ -478,17 +478,26 @@ module.exports = class NodesterApplication extends Emitter {
 	/**
 	 * Stops server
 	 *
+	 * @param {Function} callback
+	 *
 	 * @access public
 	 */
-	stop() {
+	stop(callback) {
 		if (this._isListening !== true) {
-			console.warn('Nothing to stop. Server is not listening.');
+			consl.warn('nothing to stop. Server is not listening.');
 			return;
 		}
 
-		this.server.close();
-		this._isListening = false;
+		this.server.close(() => {
+			this._isListening = false;
+			this._router.unlock();
 
-		this._router.unlock();
+			if (typeof callback === 'function') {
+				callback();
+			}
+			else if (!!callback) {
+				consl.warn(`argument 'callback' in stop() must be of type: function.`);
+			}
+		});
 	}
 }

package/lib/http/request/index.js

@@ -8,11 +8,8 @@
 const { IncomingMessage } = require('http');
 
 const isIP = require('net').isIP;
-const typeis = require('type-is');
 const fresh = require('fresh');
-const parseRange = require('range-parser');
 const parse = require('parseurl');
-const proxyaddr = require('proxy-addr');
 
 const { defineGetter } = require('./utils');
 

package/lib/loggers/console.js

@@ -7,7 +7,8 @@
 
 
 exports = module.exports = {
-	error: _error
+	error: _error,
+	warn: _warn
 }
 
 /**
@@ -19,5 +20,19 @@ exports = module.exports = {
  * @access public
  */
 function _error(err) {
-  console.error(err.stack || err.toString());
+	console.error(err.stack || err.toString());
+}
+
+
+/**
+ * Log warning with nodester prefix using console.warning.
+ *
+ * @param {Error} err
+ *
+ * @alias error
+ * @access public
+ */
+function _warn(...args) {
+	const prefix = '[nodester] warning:';
+	console.warn(prefix, ...args);
 }

package/lib/query/traverse/index.js

@@ -345,7 +345,7 @@ function traverse(queryNode, filter=null, model=null, association=null) {
 
 	// Combine included orders into one at the top level:
 	// - Why?
-	// - Sequelize ingores included orders for association types like:
+	// - Sequelize ignores included orders for association types like:
 	//   • HasMany
 	_traverseIncludedOrders(newQuery, _model);
 

package/lib/structures/Filter.js

@@ -11,6 +11,9 @@ const CLAUSES = require('../constants/Clauses');
 const { isModel } = require('../utils/models');
 const { ensure } = require('nodester/validators/arguments');
 
+// Console:
+const consl = require('nodester/loggers/console');
+
 
 /**
  * @class
@@ -91,6 +94,7 @@ module.exports = class NodesterFilter {
 			const { associations } = this.model;
 			for (const [ includeName, includeFilter ] of Object.entries(includes)) {
 				const association = associations[includeName];
+				
 				// Validate association by name:
 				if (association === undefined) {
 					const error = new TypeError(`No include named '${ includeName }'.`);
@@ -98,10 +102,24 @@ module.exports = class NodesterFilter {
 					throw error;
 				}
 
+				const { associationType } = association;
+
 				// If singular association:
-				// Fix of "Only HasMany associations support include.separate"
-				if ('HasMany' !== association.associationType) {
-					// Empty bounds.
+				// (Fix of sequilize error "Only HasMany associations support include.separate")
+				if ('HasMany' !== associationType) {
+					// Empty bounds:
+					if (!!includeFilter.statics.clauses.limit) {
+						const msg = [
+							`include "${ includeName }" has association type of`,
+							`"${ associationType }", but has a filter clause "limit",`,
+							`which is forbidden on any association type except for "HasMany".`,
+							`It was automatically removed from clauses.`,
+							`Consider also removing it from your code.`
+						].join(' ');
+						consl.warn(msg);
+					}
+					delete includeFilter.statics.clauses.limit;
+
 					includeFilter.noBounds = true;
 				}
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nodester",
-  "version": "0.4.8",
+  "version": "0.5.0",
   "description": "A versatile REST framework for Node.js",
   "directories": {
     "docs": "docs",
@@ -79,7 +79,7 @@
     "@js-temporal/polyfill": "^0.4.3",
     "body-parser": "^1.20.2",
     "common-js-file-extensions": "^1.0.4",
-    "cookie": "^0.5.0",
+    "cookie": "^1.0.0",
     "cookie-signature": "^1.2.0",
     "debug": "^4.3.4",
     "etag": "^1.8.1",
@@ -92,17 +92,13 @@
     "mysql2": "^3.6.0",
     "pg": "^8.11.3",
     "pg-hstore": "^2.3.4",
-    "proxy-addr": "^2.0.7",
     "qs": "^6.11.0",
-    "range-parser": "^1.2.1",
-    "sequelize": "^6.6.5",
-    "type-is": "^1.6.18",
-    "vary": "^1.1.2"
+    "sequelize": "^6.6.5"
   },
   "devDependencies": {
     "eslint": "^8.55.0",
     "eslint-plugin-jsdoc": "^46.9.0",
-    "jest": "^29.4.2"
+    "jest": "^29.7.0"
   },
   "engines": {
     "node": ">= 12.17.0"

package/tests/index.test.js

@@ -31,10 +31,10 @@ describe('nodester application', () => {
 			expect(app.isListening).toBe(true);
 			expect(app.middlewaresStack.length).toBe(4);
 
-			app.stop();
-
-			expect(app.isLocked).toBe(false);
-			expect(app.isListening).toBe(false);
+			app.stop(() => {
+				expect(app.isLocked).toBe(false);
+				expect(app.isListening).toBe(false);
+			});
 		});
 	});
 });

package/lib/utils/queries.util.js

@@ -1,240 +0,0 @@
-// Constants.
-const SubIncludesQueryRegex = /\([^)]*\)/g;
-
-// Sequelize.
-const Op = require('sequelize').Op;
-
-// Utils.
-const {
-	splitByDot,
-	splitByAmpersand
-} = require('nodester/utils/strings.util');
-
-
-module.exports = {
-	parseQueryParams: _parseQueryParams,
-	deleteQuerySortParams: _deleteQuerySortParams,
-
-	// SubIncludes Query:
-	hasSubIncludesQuery: _hasSubIncludesQuery,
-	cutSubIncludesQuery: _cutSubIncludesQuery,
-	parseSubIncludesQuery: _parseSubIncludesQuery
-}
-
-function _parseQueryParams(
-	requestQueryObject={},
-	sequilizeQuery=null
-) {
-	const skip = parseInt(requestQueryObject?.skip ?? 0);
-	const limit = parseInt(requestQueryObject?.limit ?? 50);
-
-	sequilizeQuery.offset = skip;
-	sequilizeQuery.limit = limit;
-
-	const order = requestQueryObject?.order;
-
-	// If order is set:
-	if (!!order) {
-		const orderBy = requestQueryObject?.order_by ?? 'id';
-
-		sequilizeQuery.order = [
-			[ orderBy, order ]
-		];
-	}
-
-	// Clear sort params.
-	_deleteQuerySortParams(requestQueryObject);
-
-	// Get include names.
-	const _includes = sequilizeQuery?.include?.map( include => include.association ) ?? [];
-
-	// Count query keys.
-	const keysCount = Object.keys(requestQueryObject).length;
-
-	// If query has no keys,
-	// stop further execution:
-	if (keysCount === 0) {
-		return;
-	}
-
-	// This container is a reference to current "where".
-	let container = null;
-	let isContainerArray = false;
-
-	// If query has only 1 key:
-	if (keysCount === 1) {
-		// Define empty query's where.
-		sequilizeQuery.where = {};
-		container = sequilizeQuery.where;
-	}
-	else {
-		// Define conjuction of params in query's where.
-		sequilizeQuery.where = {
-			[Op.and]: []
-		};
-		container = sequilizeQuery.where[Op.and];
-		isContainerArray = true;
-	}
-
-	// Go through query's keys:
-	Object.keys(requestQueryObject)
-				.forEach((queryKey) => {
-
-		// Parse value of this key:
-		const value = requestQueryObject[queryKey];
-		// If value is not a number, parse it further.
-		const parsedValue = isNaN( value ) ? _parseHTTPQueryValue( `${ requestQueryObject[queryKey] }` ) : value;
-		
-		// If we got nested key:
-		if (queryKey.indexOf('.') !== -1) {
-
-			// If this key is included as association:
-			const associationIndex = _includes.indexOf(queryKey.split('.')[0]);
-			if (associationIndex > -1) {
-				sequilizeQuery.include[associationIndex].where = { [`$${queryKey}$`]: parsedValue };
-			}
-			// Use special sequelize syntax for nested SELECT:
-			else if (isContainerArray) {
-				const selectObject = { [`$${queryKey}$`]: parsedValue };
-				container.push(selectObject);
-			}
-			else {
-				container[`$${queryKey}$`] = parsedValue;
-			}
-		}
-		// On regular key, set regular key-value pair:
-		else {
-			if (isContainerArray) {
-				const selectObject = { [queryKey]: parsedValue };
-				container.push(selectObject);
-			}
-			else {
-				container[queryKey] = parsedValue;
-			}
-		}
-	});
-}
-
-function _parseHTTPQueryValue(
-	value='',
-	isNumber=false
-) {
-	// If value matches "and()":
-	if (value.slice(0, 4) === 'and(') {
-		// Remove "and()".
-		const clearValuesString = value.substr(4, value.length - 'and()'.length);
-
-		const clearValues = clearValuesString.split(',');
-
-		return {
-			[Op.and]: clearValues.map(cv => _parseHTTPQueryValue(cv))
-		}
-	}
-	// If value matches "like(value)":
-	else if (value.slice(0, 5) === 'like(') {
-		// Remove "like()".
-		const clearValue = value.substr(5, value.length - 'like()'.length);
-
-		return {
-			[Op.like]: `%${ _parseHTTPQueryValue(clearValue) }%`
-		}
-	}
-	// If value matches "notLike(value)":
-	else if (value.slice(0, 8) === 'notLike(') {
-		// Remove "notLike()".
-		const clearValue = value.substr(8, value.length - 'notLike()'.length);
-
-		return {
-			[Op.notLike]: `%${ _parseHTTPQueryValue(clearValue) }%`
-		}
-	}
-	// If value matches "not(value)":
-	else if (value.slice(0, 4) === 'not(') {
-		// Remove "not()".
-		const clearValue = value.substr(4, value.length - 'not()'.length);
-
-		return {
-			[Op.not]: _parseHTTPQueryValue(clearValue)
-		};
-	}
-	// If value matches "or()":
-	else if (value.slice(0, 3) === 'or(') {
-		// Remove "or()".
-		const clearValuesString = value.substr(3, value.length - 'or()'.length);
-
-		const clearValues = clearValuesString.split(',');
-
-		return {
-			[Op.or]: clearValues.map(cv => _parseHTTPQueryValue(cv))
-		}
-	}
-	// If value is a number:
-	// else if (!isNaN(value)) {
-	// 	const number = parseFloat(value);
-	// 	return number;
-	// }
-	// For default, just set this value in "where"
-	return value;
-}
-
-function _deleteQuerySortParams(requestQueryObject={}) {
-	delete requestQueryObject.skip;
-	delete requestQueryObject.limit;
-	delete requestQueryObject.order;
-	delete requestQueryObject.order_by;
-}
-
-// If string has nested query "()":
-function _hasSubIncludesQuery(string='') {
-	return SubIncludesQueryRegex.test(string);
-}
-
-function _cutSubIncludesQuery(string='') {
-	const query = string.match(SubIncludesQueryRegex)[0];
-	const newString = string.replace(SubIncludesQueryRegex, '');
-
-	return [ query, newString ];
-}
-
-function _parseSubIncludesQuery(
-	associationName,
-	subIncludesQuery='',
-	sequilizeQuery=null
-) {
-	const query = {};
-
-	// Magic trick to make everything work (DO NOT REMOVE).
-	sequilizeQuery.separate = true;
-
-	// If first "("" & ")" are set, cut them:
-	const subIncludesQueryRegex = /\([^)]*\)/g;
-	const clearQuery = subIncludesQueryRegex.test(subIncludesQuery) ?
-												subIncludesQuery.substr(1, subIncludesQuery.length - 2)
-												:
-												subIncludesQuery;
-
-	const keyValues = splitByAmpersand(clearQuery).map(kv => {
-											const keyValue = kv.split('=');
-											query[keyValue[0]] = keyValue[1];
-										});
-
-
-	if (!!query.skip) {
-		const skip = parseInt(query.skip ?? 0);
-		sequilizeQuery[`$${ associationName }.offset$`] = skip;
-	}
-
-	if (!!query.limit) {
-		const limit = parseInt(query.limit ?? 50);
-		sequilizeQuery[`$${ associationName }.limit$`] = limit;
-	}
-
-	// If order is set:
-	if (!!query.order) {
-		const orderBy = query?.order_by ?? 'id';
-
-		sequilizeQuery.order = [
-			[ orderBy, query.order ]
-		];
-	}
-}