nodester 0.1.0 → 0.1.5

package/lib/http/codes/index.js

@@ -1,157 +1,82 @@
-const symbolsByTag = {
-	// Informational:
-	CONTINUE: Symbol('100: Continue'),
-	SWITCHING_PROTOCOLS: Symbol('101: Switching Protocols'),
-	PROCESSING: Symbol('102: Processing'),
-	EARLY_HINTS: Symbol('103: Early Hints'),
+/*!
+ * /nodester
+ * MIT Licensed
+ */
+'use strict';
 
-	// Success:
-	OK: Symbol('200: OK'),
-	CREATED: Symbol('201: Created'),
-	ACCEPTED: Symbol('202: Accepted'),
-	NON_AUTHORITATIVE_INFORMATION: Symbol('203: Non-Authoritative Information'),
-	NO_CONTENT: Symbol('204: No Content'),
-	RESET_CONTENT: Symbol('205: Reset Content'),
-	PARTIAL_CONTENT: Symbol('206: Partial Content'),
-	MULTI_STATUS: Symbol('207: Multi-Status'),
-	ALREADY_REPORTED: Symbol('208: Already Reported'),
-	IM_USED: Symbol('226: IM Used'),
+const Enum = require('nodester/enum');
 
-	// Redirections:
-	MULTIPLE_CHOICES: Symbol('300: Multiple Choices'),
-	MOVED_PERMANENTLY: Symbol('301: Moved Permanently'),
-	FOUND: Symbol('302: Found'),
-	SEE_OTHER: Symbol('303: See Other'),
-	NOT_MODIFIED: Symbol('304: Not Modified'),
-	USE_PROXY: Symbol('305: Use Proxy'),
-	TEMPORARY_REDIRECT: Symbol('307: Temporary Redirect'),
-	PERMANENT_REDIRECT: Symbol('308: Permanent Redirect'),
-
-	// Client Errors:
-	BAD_REQUEST: Symbol('400: Bad Request'),
-	UNAUTHORIZED: Symbol('401: Unauthorized'),
-	PAYMENT_REQUIRED: Symbol('402: Payment Required'),
-	FORBIDDEN: Symbol('403: Forbidden'),
-	NOT_FOUND: Symbol('404: Not Found'),
-	METHOD_NOT_ALLOWED: Symbol('405: Method Not Allowed'),
-	NOT_ACCEPTABLE: Symbol('406: Not Acceptable'),
-	PROXY_AUTHENTICATION_REQUIRED: Symbol('407: Proxy Authentication Required'),
-	REQUEST_TIMEOUT: Symbol('408: Request Timeout'),
-	CONFLICT: Symbol('409: Conflict'),
-	GONE: Symbol('410: Gone'),
-	LENGTH_REQUIRED: Symbol('411: Length Required'),
-	PRECONDITION_FAILED: Symbol('412: Precondition Failed'),
-	PAYLOAD_TOO_LARGE: Symbol('413: Payload Too Large'),
-	URI_TOO_LONG: Symbol('414: URI Too Long'),
-	UNSUPPORTED_MEDIA_TYPE: Symbol('415: Unsupported Media Type'),
-	RANGE_NOT_SATISFIABLE: Symbol('416: Range Not Satisfiable'),
-	EXPECTATION_FAILED: Symbol('417: Expectation Failed'),
-	IM_A_TEAPOT: Symbol("418: I'm a teapot"),
-	MISDIRECTED_REQUEST: Symbol('421: Misdirected Request'),
-	UNPROCESSABLE_ENTITY: Symbol('422: Unprocessable Entity'),
-	LOCKED: Symbol('423: Locked'),
-	FAILED_DEPENDENCY: Symbol('424: Failed Dependency'),
-	TOO_EARLY: Symbol('425: Too Early'),
-	UPGRADE_REQUIRED: Symbol('426: Upgrade Required'),
-	PRECONDITION_REQUIRED: Symbol('428: Precondition Required'),
-	TOO_MANY_REQUESTS: Symbol('429: Too Many Requests'),
-	REQUEST_HEADER_FIELDS_TOO_LARGE: Symbol('431: Request Header Fields Too Large'),
-	UNAVAILABLE_FOR_LEGAL_REASONS: Symbol('451: Unavailable For Legal Reasons'),
 
-	// Server Errors:
-	INTERNAL_SERVER_ERROR: Symbol('500: Internal Server Error'),
-	NOT_IMPLEMENTED: Symbol('501: Not Implemented'),
-	BAD_GATEWAY: Symbol('502: Bad Gateway'),
-	SERVICE_UNAVAILABLE: Symbol('503: Service Unavailable'),
-	GATEWAY_TIMEOUT: Symbol('504: Gateway Timeout'),
-	HTTP_VERSION_NOT_SUPPORTED: Symbol('505: HTTP Version Not Supported'),
-	VARIANT_ALSO_NEGOTIATES: Symbol('506: Variant Also Negotiates'),
-	INSUFFICIENT_STORAGE: Symbol('507: Insufficient Storage'),
-	LOOP_DETECTED: Symbol('508: Loop Detected'),
-	NOT_EXTENDED: Symbol('510: Not Extended'),
-	NETWORK_AUTHENTICATION_REQUIRED: Symbol('511: Network Authentication Required')
-}
-
-const descriptionsByCode = {
+module.exports = new Enum({
 	// Informational:
-	100: 'Continue',
-	101: 'Switching Protocols',
-	102: 'Processing',
-	103: 'Early Hints',
+	CONTINUE: 100,
+	SWITCHING_PROTOCOLS: 101,
+	PROCESSING: 102,
+	EARLY_HINTS: 103,
 
 	// Success:
-	200: 'OK',
-	201: 'Created',
-	202: 'Accepted',
-	203: 'Non-Authoritative Information',
-	204: 'No Content',
-	205: 'Reset Content',
-	206: 'Partial Content',
-	207: 'Multi-Status',
-	208: 'Already Reported',
-	226: 'IM Used',
+	OK: 200,
+	CREATED: 201,
+	ACCEPTED: 202,
+	NON_AUTHORITATIVE_INFORMATION: 203,
+	NO_CONTENT: 204,
+	RESET_CONTENT: 205,
+	PARTIAL_CONTENT: 206,
+	MULTI_STATUS: 207,
+	ALREADY_REPORTED: 208,
+	IM_USED: 226,
 
 	// Redirections:
-	300: 'Multiple Choices',
-	301: 'Moved Permanently',
-	302: 'Found',
-	303: 'See Other',
-	304: 'Not Modified',
-	305: 'Use Proxy',
-	307: 'Temporary Redirect',
-	308: 'Permanent Redirect',
+	MULTIPLE_CHOICES: 300,
+	MOVED_PERMANENTLY: 301,
+	FOUND: 302,
+	SEE_OTHER: 303,
+	NOT_MODIFIED: 304,
+	USE_PROXY: 305,
+	TEMPORARY_REDIRECT: 307,
+	PERMANENT_REDIRECT: 308,
 
 	// Client Errors:
-	400: 'Bad Request',
-	401: 'Unauthorized',
-	402: 'Payment Required',
-	403: 'Forbidden',
-	404: 'Not Found',
-	405: 'Method Not Allowed',
-	406: 'Not Acceptable',
-	407: 'Proxy Authentication Required',
-	408: 'Request Timeout',
-	409: 'Conflict',
-	410: 'Gone',
-	411: 'Length Required',
-	412: 'Precondition Failed',
-	413: 'Payload Too Large',
-	414: 'URI Too Long',
-	415: 'Unsupported Media Type',
-	416: 'Range Not Satisfiable',
-	417: 'Expectation Failed',
-	418: 'I\'m a teapot',
-	421: 'Misdirected Request',
-	422: 'Unprocessable Entity',
-	423: 'Locked',
-	424: 'Failed Dependency',
-	425: 'Too Early',
-	426: 'Upgrade Required',
-	428: 'Precondition Required',
-	429: 'Too Many Requests',
-	431: 'Request Header Fields Too Large',
-	451: 'Unavailable For Legal Reasons',
+	BAD_REQUEST: 400,
+	UNAUTHORIZED: 401,
+	PAYMENT_REQUIRED: 402,
+	FORBIDDEN: 403,
+	NOT_FOUND: 404,
+	METHOD_NOT_ALLOWED: 405,
+	NOT_ACCEPTABLE: 406,
+	PROXY_AUTHENTICATION_REQUIRED: 407,
+	REQUEST_TIMEOUT: 408,
+	CONFLICT: 409,
+	GONE: 410,
+	LENGTH_REQUIRED: 411,
+	PRECONDITION_FAILED: 412,
+	PAYLOAD_TOO_LARGE: 413,
+	URI_TOO_LONG: 414,
+	UNSUPPORTED_MEDIA_TYPE: 415,
+	RANGE_NOT_SATISFIABLE: 416,
+	EXPECTATION_FAILED: 417,
+	IM_A_TEAPOT: 418,
+	MISDIRECTED_REQUEST: 421,
+	UNPROCESSABLE_ENTITY: 422,
+	LOCKED: 423,
+	FAILED_DEPENDENCY: 424,
+	TOO_EARLY: 425,
+	UPGRADE_REQUIRED: 426,
+	PRECONDITION_REQUIRED: 428,
+	TOO_MANY_REQUESTS: 429,
+	REQUEST_HEADER_FIELDS_TOO_LARGE: 431,
+	UNAVAILABLE_FOR_LEGAL_REASONS: 451,
 
 	// Server Errors:
-	500: 'Internal Server Error',
-	501: 'Not Implemented',
-	502: 'Bad Gateway',
-	503: 'Service Unavailable',
-	504: 'Gateway Timeout',
-	505: 'HTTP Version Not Supported',
-	506: 'Variant Also Negotiates',
-	507: 'Insufficient Storage',
-	508: 'Loop Detected',
-	510: 'Not Extended',
-	511: 'Network Authentication Required'
-};
-
-module.exports = {
-	descriptions: {
-		byCode: descriptionsByCode
-	},
-
-	symbols: {
-		byTag: symbolsByTag
-	}
-}
+	INTERNAL_SERVER_ERROR: 500,
+	NOT_IMPLEMENTED: 501,
+	BAD_GATEWAY: 502,
+	SERVICE_UNAVAILABLE: 503,
+	GATEWAY_TIMEOUT: 504,
+	HTTP_VERSION_NOT_SUPPORTED: 505,
+	VARIANT_ALSO_NEGOTIATES: 506,
+	INSUFFICIENT_STORAGE: 507,
+	LOOP_DETECTED: 508,
+	NOT_EXTENDED: 510,
+	NETWORK_AUTHENTICATION_REQUIRED: 511,
+});

package/lib/http/codes/symbols.js

@@ -0,0 +1,82 @@
+/*!
+ * /nodester
+ * MIT Licensed
+ */
+'use strict';
+
+const Enum = require('nodester/enum');
+
+
+module.exports = new Enum({
+	// Informational:
+	CONTINUE: Symbol('100: Continue'),
+	SWITCHING_PROTOCOLS: Symbol('101: Switching Protocols'),
+	PROCESSING: Symbol('102: Processing'),
+	EARLY_HINTS: Symbol('103: Early Hints'),
+
+	// Success:
+	OK: Symbol('200: OK'),
+	CREATED: Symbol('201: Created'),
+	ACCEPTED: Symbol('202: Accepted'),
+	NON_AUTHORITATIVE_INFORMATION: Symbol('203: Non-Authoritative Information'),
+	NO_CONTENT: Symbol('204: No Content'),
+	RESET_CONTENT: Symbol('205: Reset Content'),
+	PARTIAL_CONTENT: Symbol('206: Partial Content'),
+	MULTI_STATUS: Symbol('207: Multi-Status'),
+	ALREADY_REPORTED: Symbol('208: Already Reported'),
+	IM_USED: Symbol('226: IM Used'),
+
+	// Redirections:
+	MULTIPLE_CHOICES: Symbol('300: Multiple Choices'),
+	MOVED_PERMANENTLY: Symbol('301: Moved Permanently'),
+	FOUND: Symbol('302: Found'),
+	SEE_OTHER: Symbol('303: See Other'),
+	NOT_MODIFIED: Symbol('304: Not Modified'),
+	USE_PROXY: Symbol('305: Use Proxy'),
+	TEMPORARY_REDIRECT: Symbol('307: Temporary Redirect'),
+	PERMANENT_REDIRECT: Symbol('308: Permanent Redirect'),
+
+	// Client Errors:
+	BAD_REQUEST: Symbol('400: Bad Request'),
+	UNAUTHORIZED: Symbol('401: Unauthorized'),
+	PAYMENT_REQUIRED: Symbol('402: Payment Required'),
+	FORBIDDEN: Symbol('403: Forbidden'),
+	NOT_FOUND: Symbol('404: Not Found'),
+	METHOD_NOT_ALLOWED: Symbol('405: Method Not Allowed'),
+	NOT_ACCEPTABLE: Symbol('406: Not Acceptable'),
+	PROXY_AUTHENTICATION_REQUIRED: Symbol('407: Proxy Authentication Required'),
+	REQUEST_TIMEOUT: Symbol('408: Request Timeout'),
+	CONFLICT: Symbol('409: Conflict'),
+	GONE: Symbol('410: Gone'),
+	LENGTH_REQUIRED: Symbol('411: Length Required'),
+	PRECONDITION_FAILED: Symbol('412: Precondition Failed'),
+	PAYLOAD_TOO_LARGE: Symbol('413: Payload Too Large'),
+	URI_TOO_LONG: Symbol('414: URI Too Long'),
+	UNSUPPORTED_MEDIA_TYPE: Symbol('415: Unsupported Media Type'),
+	RANGE_NOT_SATISFIABLE: Symbol('416: Range Not Satisfiable'),
+	EXPECTATION_FAILED: Symbol('417: Expectation Failed'),
+	IM_A_TEAPOT: Symbol("418: I'm a teapot"),
+	MISDIRECTED_REQUEST: Symbol('421: Misdirected Request'),
+	UNPROCESSABLE_ENTITY: Symbol('422: Unprocessable Entity'),
+	LOCKED: Symbol('423: Locked'),
+	FAILED_DEPENDENCY: Symbol('424: Failed Dependency'),
+	TOO_EARLY: Symbol('425: Too Early'),
+	UPGRADE_REQUIRED: Symbol('426: Upgrade Required'),
+	PRECONDITION_REQUIRED: Symbol('428: Precondition Required'),
+	TOO_MANY_REQUESTS: Symbol('429: Too Many Requests'),
+	REQUEST_HEADER_FIELDS_TOO_LARGE: Symbol('431: Request Header Fields Too Large'),
+	UNAVAILABLE_FOR_LEGAL_REASONS: Symbol('451: Unavailable For Legal Reasons'),
+
+	// Server Errors:
+	INTERNAL_SERVER_ERROR: Symbol('500: Internal Server Error'),
+	NOT_IMPLEMENTED: Symbol('501: Not Implemented'),
+	BAD_GATEWAY: Symbol('502: Bad Gateway'),
+	SERVICE_UNAVAILABLE: Symbol('503: Service Unavailable'),
+	GATEWAY_TIMEOUT: Symbol('504: Gateway Timeout'),
+	HTTP_VERSION_NOT_SUPPORTED: Symbol('505: HTTP Version Not Supported'),
+	VARIANT_ALSO_NEGOTIATES: Symbol('506: Variant Also Negotiates'),
+	INSUFFICIENT_STORAGE: Symbol('507: Insufficient Storage'),
+	LOOP_DETECTED: Symbol('508: Loop Detected'),
+	NOT_EXTENDED: Symbol('510: Not Extended'),
+	NETWORK_AUTHENTICATION_REQUIRED: Symbol('511: Network Authentication Required')
+});

package/lib/loggers/dev.js

@@ -0,0 +1,28 @@
+/*!
+ * /nodester
+ * MIT Licensed
+ */
+
+'use strict';
+
+
+exports = module.exports = {
+	error: _error
+}
+
+/**
+ * Log error using console.error.
+ *
+ * @param {Array} args
+ *
+ * @alias error
+ * @public
+ */
+
+function _error(...args) {
+	const activeEnv = process.env.NODE_ENV
+
+	if (activeEnv === 'development' || activeEnv === 'testing') {
+  	console.error(...args);
+	}
+}

package/lib/middlewares/ql/sequelize/index.js

@@ -1,4 +1,5 @@
 const QueryLexer = require('./interpreter/QueryLexer');
+const httpCodes = require('nodester/http/codes');
 
 
 module.exports = NodesterQL;
@@ -18,7 +19,6 @@ async function NodesterQL(req, res, next) {
 	}
 
 	try {
-		// Convert to URLSearchParams.
 		const queryString = req.url.split('?')[1];
 
 		const lexer = new QueryLexer(queryString);
@@ -28,7 +28,7 @@ async function NodesterQL(req, res, next) {
 		next();
 	}
 	catch(error) {
-		res.status(422);
+		res.status(error.status ?? httpCodes.UNPROCESSABLE_ENTITY);
 		res.json({ error: error.toString() });
 	}
 }

package/lib/middlewares/ql/sequelize/interpreter/ModelsTree.js

@@ -1,3 +1,9 @@
+/*!
+ * /nodester
+ * MIT Licensed
+ */
+'use strict';
+
 const debug = require('debug')('nodester:interpreter:ModelsTree');
 
 
@@ -7,10 +13,12 @@ class ModelsTreeNode {
 		this.parent = parent;
 		this.activeParam = null;
 		this.op = null;
+		this.fn = null;
 
 		// for override:
 		this.fields = [];
 		this._where = {};
+		this._functions = [];
 		this.skip = 0;
 		this.limit = -1; // No limit
 
@@ -35,6 +43,10 @@ class ModelsTreeNode {
 		return this._where;
 	}
 
+	get functions() {
+		return this._functions;
+	}
+
 	resetActiveParam() {
 		this.activeParam = null;
 	}
@@ -43,6 +55,10 @@ class ModelsTreeNode {
 		this.op = null;
 	}
 
+	resetFN() {
+		this.fn = null;
+	}
+
 	addWhere(condition={}) {
 		this._where = {
 			...this.where,
@@ -50,6 +66,10 @@ class ModelsTreeNode {
 		}
 	}
 
+	addFunction(fnParams={}) {
+		this._functions.push(fnParams);
+	}
+
 	include(modelTreeNode) {
 		modelTreeNode.parent = this;
 		this.includes.push(modelTreeNode);
@@ -60,13 +80,16 @@ class ModelsTreeNode {
 		return {
 			model: this.model,
 
+			fields: this.fields,
+			functions: this.functions,
+
 			where: this.where,
+
 			skip: this.skip,
 			limit: this.limit,
 			order: this.order,
 			order_by: this.order_by,
 			
-			fields: this.fields,
 
 			includes: this.includes.map(i => i.toObject())
 		}

package/lib/middlewares/ql/sequelize/interpreter/QueryLexer.js

@@ -1,4 +1,11 @@
-const Enum = require('../../../../enums/Enum');
+/*!
+ * /nodester
+ * MIT Licensed
+ */
+'use strict';
+
+
+const Enum = require('nodester/enum');
 const { ModelsTree, ModelsTreeNode } = require('./ModelsTree');
 const util = require('util');
 const debug = require('debug')('nodester:interpreter:QueryLexer');
@@ -21,6 +28,10 @@ const OP_TOKENS = new Enum({
 	LOWER_OR_EQUAL: 'lte'
 });
 
+const FN_TOKENS = new Enum({
+	COUNT: 'count',
+});
+
 
 module.exports = class QueryLexer {
 	constructor(queryString='') {
@@ -49,7 +60,7 @@ module.exports = class QueryLexer {
 		const isSubQuery = tree.node.model !== 'root';
 		debug({ isSubQuery, startAt });
 
-		// Token is accumulated char-by-char.
+		// Token is String, accumulated char-by-char.
 		let token = '';
 		// Value of param ('id=10' OR 'fields=id,text').
 		let value = [];
@@ -71,22 +82,29 @@ module.exports = class QueryLexer {
 					token = '';
 					continue;
 				}
-				// If model subquery:
-				else {
-					const model = token;
-					tree.use(model) ?? tree.include(model).use(model);
+				
+				// If FN token:
+				if (FN_TOKENS.asArray.indexOf(token) > -1) {
+					// Set function token.
+					tree.node.fn = token;
 					token = '';
+					continue;
+				}
 
-					// Process subquery:
-					i++;
-					const [ charsCount ] = this.parseIsolatedQuery(queryString, i, tree);
-					i += charsCount;
+				// If model subquery:
+				const model = token;
+				tree.use(model) ?? tree.include(model).use(model);
+				token = '';
 
-					previousActive = model;
-					tree.up();
+				// Process subquery:
+				i++;
+				const [ charsCount ] = this.parseIsolatedQuery(queryString, i, tree);
+				i += charsCount;
 
-					continue;
-				}
+				previousActive = model;
+				tree.up();
+
+				continue;
 			}
 
 			// ) can mean end of OP token params,
@@ -126,6 +144,40 @@ module.exports = class QueryLexer {
 					continue;
 				}
 
+				// If end of FN token:
+				if (!!tree.node.fn) {
+					// If token is empty, error:
+					if (token === '') {
+						const err = UnexpectedCharError(i, char);
+						throw err;
+					}
+
+					let fnParams = {};
+					switch (tree.node.fn) {
+						case 'count':
+							fnParams = {
+								fn: 'count',
+								args: [token]
+							};
+							break;
+						default:
+							fnParams = {
+								fn: [tree.node.fn],
+								args: [token]
+							};
+							break;
+					}
+
+					tree.node.addFunction(fnParams);
+
+					// Reset:
+					tree.node.resetFN();
+					tree.node.activeParam = 'includes';
+					token = '';
+					value = [];
+					continue;
+				}
+
 				// If end of subquery:
 				if (!!tree.node.activeParam && tree.node.activeParam !== 'includes') {
 					// Set value.
@@ -323,7 +375,7 @@ module.exports = class QueryLexer {
 				const param = this.parseParamFromToken(token);
 
 				if (isSubQuery === true && param === 'includes') {
-					const err = new TypeError(`'include' is forbidden inside subquery (position ${ i }). Use: 'model.model' or 'model.model+model'.`);
+					const err = new TypeError(`'include' is forbidden inside subquery (position ${ i }). Use: 'model.model1' or 'model.model1+model2'.`);
 					throw err;
 				}
 

package/lib/models/define.js

@@ -1,9 +1,13 @@
+/*!
+ * /nodester
+ * MIT Licensed
+ */
+'use strict';
+
 // CRUD mixins.
 const { implementsCRUD } = require('./mixins');
 // ORM.
 const { DataTypes } = require('sequelize');
-// NQL.
-const Colander = require('../queries/Colander');
 
 
 module.exports = defineModel;
@@ -52,7 +56,7 @@ function defineModel(
 		implementsCRUD(model);
 	}
 
-	// Association helpers:
+	// Associations:
 	model.associate = (models) => {};
 	model.getIncludesList = _getIncludesList.bind(model);
 
@@ -61,7 +65,6 @@ function defineModel(
 		const values = { ...this.get() };
 		return values;
 	}
-	// Instance methods\
 
 	return model;
 }

package/lib/models/mixins.js

@@ -10,7 +10,7 @@ const {
 
 // Nodester query:
 const NQLexer = require('../middlewares/ql/sequelize/interpreter/QueryLexer');
-const traverseNQuery = require('../queries/traverse');
+const traverseNQuery = require('nodester/query/traverse');
 
 
 module.exports = {