nodester 0.2.4 → 0.2.5

package/Readme.md

@@ -3,9 +3,9 @@
 [![NPM version](https://img.shields.io/npm/v/nodester)](https://www.npmjs.com/package/nodester)
 [![License](https://img.shields.io/npm/l/nodester)](https://www.npmjs.com/package/nodester)
 
-> **nodester** is a modern and versatile Node.js framework designed to streamline the development of robust and scalable web applications.
+> **nodester** is a Node.js framework designed to solve the problem of a complex data querying over HTTP.
 
-The main reason of nodester's existence is the [nodester Query Language (NQL)](docs/Queries.md), an extension of standard REST API syntax, it lets you craft complex queries with hierarchical associations.
+The main reason of nodester's existence is the [nodester Query Language (NQL)](docs/nql/Introduction.md), an extension of standard REST API syntax, it lets you craft complex queries with hierarchical associations.
 
 
 ## Installation
@@ -49,11 +49,11 @@ app.listen(8080, function() {
 [Core concepts documentation ➡️](docs/CoreConcepts.md)
 
 
-### Queries & Querying - Nodester Query Language (NQL)
+### Queries & Querying - nodester Query Language (NQL)
 The true strength of nodester lies in its query language. Serving as an extension of standard REST API syntax, it brings many aspects of SQL into REST requests, providing developers with a simple yet potent tool for expressive and efficient data querying.
 
 Read more about it in the documentation:
-[NQL documentaion ➡️](docs/Queries.md)
+[NQL documentaion ➡️](docs/nql/Introduction.md)
 
 
 ### Database

package/lib/factories/responses/rest.js

@@ -62,29 +62,27 @@ function _createGenericResponse(res, options) {
 
 			switch(error.name) {
 				case 'Unauthorized': {
-					statusCode = 401;
+					status = 401;
 					break;
 				}
 				case 'NotFound': {
-					statusCode = 404;
+					status = 404;
 					break;
 				}
 				case 'ValidationError': {
-					statusCode = 422;
+					status = 422;
 					break;
 				}
 				case 'ConflictError': {
-					statusCode = 409;
+					status = 409;
 					break;
 				}
 				case 'SequelizeUniqueConstraintError': {
-					statusCode = 409;
+					status = 409;
 					details.errors = error?.errors;
 					break;
 				}
 				default:
-					statusCode = status;
-
 					if (!!error?.errors) {
 						details.errors = error?.errors;
 					}
@@ -121,8 +119,7 @@ function _createGenericResponse(res, options) {
  * @api public
  */
 function _createOKResponse(res, options={}) {
-
-	return this.createGenericResponse(res, { 
+	return _createGenericResponse(res, { 
 		...options,
 		status: options?.status ?? 200,
 	});
@@ -143,8 +140,7 @@ function _createOKResponse(res, options={}) {
  * @api public
  */
 function _createErrorResponse(res, options) {
-
-	return this.createGenericResponse(res, {
+	return _createGenericResponse(res, {
 		...options,
 		status: options?.status ?? 500,
 	});

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

@@ -30,8 +30,14 @@ const OP_TOKENS = new Enum({
 	XOR: 'xor',
 	NOT: 'not',
 	NOT_MARK: '!',
+
+	IN: 'in',
 	NOT_IN: 'notIn',
+	
 	LIKE: 'like',
+	NOT_LIKE: 'notLike',
+	NOT_LIKE_SHORT: '!like',
+	
 	GREATER: 'gt',
 	GREATER_OR_EQUAL: 'gte',
 	LOWER: 'lt',
@@ -86,7 +92,7 @@ module.exports = class QueryLexer {
 
 				// If OP token:
 				if (OP_TOKENS.asArray.indexOf(token) > -1) {
-					// Set operation token.
+					// Set operator token.
 					tree.node.op = this.parseOP(token);
 					token = '';
 					continue;
@@ -135,6 +141,7 @@ module.exports = class QueryLexer {
 					switch (tree.node.op) {
 						case OP_TOKENS.NOT:
 						case OP_TOKENS.LIKE:
+						case OP_TOKENS.NOT_LIKE:
 						case OP_TOKENS.GREATER:
 						case OP_TOKENS.GREATER_OR_EQUAL:
 						case OP_TOKENS.LOWER:
@@ -214,9 +221,19 @@ module.exports = class QueryLexer {
 
 				// If OP token:
 				if (!!tree.node.op) {
-					value.push({
-						[tree.node.activeParam]: [token]
-					});
+					switch(tree.node.op) {
+						case OP_TOKENS.NOT_IN:
+						case OP_TOKENS.IN:
+							value.push(token);
+							break;
+						default:
+							value.push({
+								[tree.node.activeParam]: [token]
+							});
+							break;
+					}
+
+					// Reset.
 					token = '';
 					continue;
 				}
@@ -374,27 +391,51 @@ module.exports = class QueryLexer {
 				throw err;
 			}
 			
-			// [ can only mean start of 'in':
+			// [ can mean start of 'in'/'notIn',
+			// or 'notIn':
 			if (char === '[') {
-				tree.node.op = 'in';
+				tree.node.op = OP_TOKENS.IN;
+				if (token.length > 0) {
+					if (token === '!' || token === 'not') {
+						tree.node.op = OP_TOKENS.NOT_IN;
+					}
+					else {
+						const err = UnexpectedCharError(i - token.length, token);
+						throw err;
+					}
+				}
+
+				// Reset:
+				token = '';
 				continue;
 			}
 
-			// ] can only mean end if 'in':
+			// ] can mean end of 'in'/'notIn':
 			if (char === ']') {
 				// User missed first '[' :
-				if (tree.node.op !== 'in') {
+				if (
+					tree.node.op !== OP_TOKENS.IN
+					&&
+					tree.node.op !== OP_TOKENS.NOT_IN
+				) {
 					const err = UnexpectedCharError(i, char);
 					throw err;
 				}
 
+				// Token is the last element in this array:
+				if (token.length > 0) {
+					value.push(token);
+				}
+
 				tree.node.addWhere({
 					[tree.node.activeParam]: {
 						[tree.node.op]: value
 					}
 				});
+
 				// Reset:
 				tree.node.resetOP();
+				tree.node.resetActiveParam();
 				value = [];
 				token = '';
 				continue;
@@ -521,10 +562,16 @@ module.exports = class QueryLexer {
 		switch(opToken) {
 			case '|':
 			case 'or':
-				return 'or';
+				return OP_TOKENS.OR;
+
+			case '!like':
+			case 'notLike':
+				return OP_TOKENS.NOT_LIKE;
+
 			case 'not':
 			case '!':
-				return 'not';
+				return OP_TOKENS.NOT;
+
 			default:
 				return opToken;
 		}

package/lib/query/traverse.js

@@ -397,17 +397,10 @@ function _disassembleQueryNode(queryNode) {
 function _parseValue(value, attribute) {
 	// If value is Object:
 	if (typeof value === 'object' && Array.isArray(value) === false) {
-		const [opKey, rawValue] = (Object.entries(value))[0];
+		const [ opKey, rawValue ] = (Object.entries(value))[0];
 
-		// If operation is "in":
-		if (opKey === 'in') {
-			// Unwrap rawValue.
-			return rawValue[0][attribute];
-		}
-		else {
-			const op = Op[opKey];
-			return { [op]: rawValue };
-		}
+		const op = Op[opKey];
+		return { [op]: rawValue };
 	}
 
 	return value;

package/lib/tools/nql.tool.js

@@ -5,41 +5,54 @@
 
 'use strict';
 
+// Arguments validator.
+const { ensure } = require('nodester/validators/arguments');
+
 
 module.exports = {
-	toAST_ModelsTreeNode: _toAST_ModelsTreeNode
+	AST_ModelsTree: _AST_ModelsTree,
+	AST_ModelsTreeNode: _AST_ModelsTreeNode
+}
+
+function _AST_ModelsTree(modelsTree) {
+	ensure(modelsTree, 'object,required', 'modelsTree');
+	return _AST_ModelsTreeNode(modelsTree.root);
 }
 
-function _toAST_ModelsTreeNode(node, spacing=0) {
-	let spaces = '';
+function _AST_ModelsTreeNode(node, spacing=0) {
+	ensure(node, 'object,required', 'node');
+	ensure(spacing, 'number,required', 'spacing');
+
+	let spaces = ' ';
 	for (let i = 0; i < spacing; i++) {
 		spaces += ' ';
 	}
 
-	let ast = `${ spaces }[TreeNode]\n`;
-
-	spaces += ' ';
+	let ast = `${ spaces }┏ TreeNode\n`;
+	ast += `${ spaces }┃\n`;
 
-	ast += `${ spaces }model: ${ node.model }\n\n`;
+	ast += `${ spaces }┣ model: ${ node.model }\n`;
+	ast += `${ spaces }┃\n`;
 
-	ast += `${ spaces }fields (${ node.fields.length }): [\n${ node.fields.map(f => ` • ${ f },\n`) }`;
-	ast += `${ spaces }]\n\n`;
+	ast += `${ spaces }┣ fields (${ node.fields.length }): [\n${ node.fields.map(f => ` • ${ f },\n`) }`;
+	ast += `${ spaces }┃ ]\n`;
+	ast += `${ spaces }┃\n`;
 
-	ast += `${ spaces }functions (${ node.functions.length }): [\n${ node.functions.map(f => ` • ${ f },\n`) }`;
-	ast += `${ spaces }]\n\n`;
+	ast += `${ spaces }┣ functions (${ node.functions.length }): [\n${ node.functions.map(f => ` • ${ f },\n`) }`;
+	ast += `${ spaces }┃ ]\n`;
+	ast += `${ spaces }┃\n`;
 
-	ast += `${ spaces }where: ${ JSON.stringify(node.where) }\n\n`;
+	ast += `${ spaces }┣ where: ${ JSON.stringify(node.where) }\n`;
+	ast += `${ spaces }┃\n`;
 
-	['skip','limit','order','order_by'].map(
-		c =>  ast += `${ spaces }${ c }: ${ node[c] }\n\n`
-	);
+	['skip','limit','order','order_by'].map(c => {
+		ast += `${ spaces }┣ ${ c }: ${ node[c] }\n`;
+		ast += `${ spaces }┃\n`;
+	});
 	
-	ast += `${ spaces }includes (${ node.includes.length }): [\n`
-	node.includes.map(n => ast += _toAST_ModelsTreeNode(n, spacing + 2));
-	ast += `${ spaces }]\n`;
-
-	spaces.slice(-1);
-	ast += `${ spaces }[TreeNode END]\n\n`;
+	ast += `${ spaces }┗ includes (${ node.includes.length }): [\n`
+	node.includes.map(n => ast += _AST_ModelsTreeNode(n, spacing + 2));
+	ast += `${ spaces }  ]\n`;
 
 	return ast;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nodester",
-  "version": "0.2.4",
+  "version": "0.2.5",
   "description": "A versatile REST framework for Node.js",
   "exports": {
     ".": "./lib/application/index.js",

package/tests/ast.js

@@ -1,5 +1,5 @@
 const { ModelsTree } = require('../lib/middlewares/ql/sequelize/interpreter/ModelsTree');
-const { toAST_ModelsTreeNode } = require('../lib/tools/nql.tool');
+const { AST_ModelsTree } = require('../lib/tools/nql.tool');
 
 const tree = new ModelsTree();
 tree.node.addWhere({ id: ['1000'] });
@@ -12,5 +12,7 @@ tree.node.order = 'rand';
 tree.up();
 tree.include('reposts');
 
-console.debug(toAST_ModelsTreeNode(tree.root));
+console.debug(
+	AST_ModelsTree(tree)
+);
 

package/tests/nql.test.js

@@ -274,22 +274,12 @@ describe('nodester Query Language', () => {
 		});
 	});
 
-	describe('operations', () => {
+	describe('operators:or', () => {
 		const queryStrings = [
 			// OR simple.
 			'or(index=2,position=5)',
 			// OR short.
 			'|(index=2,position=5)',
-
-			// Not simple.
-			'key=not(main)',
-			// Not short.
-			'key=!(main)',
-			// NOT inside include.
-			'includes=comments(id=not(7))',
-
-			// Like simple.
-			'title=like(some_text)',
 		];
 
 		test('"OR" simple', () => {
@@ -313,9 +303,20 @@ describe('nodester Query Language', () => {
 
 			expect(result).toMatchObject(expected);
 		});
+	});
+
+	describe('operators:not', () => {
+		const queryStrings = [
+			// Not simple.
+			'key=not(main)',
+			// Not short.
+			'key=!(main)',
+			// NOT inside include.
+			'includes=comments(id=not(7))'
+		];
 
 		test('"NOT" simple', () => {
-			const lexer = new QueryLexer( queryStrings[2] );
+			const lexer = new QueryLexer( queryStrings[0] );
 			const result = lexer.query;
 
 			const tree = new ModelsTree();
@@ -326,7 +327,7 @@ describe('nodester Query Language', () => {
 		});
 
 		test('"NOT" short', () => {
-			const lexer = new QueryLexer( queryStrings[3] );
+			const lexer = new QueryLexer( queryStrings[1] );
 			const result = lexer.query;
 
 			const tree = new ModelsTree();
@@ -337,7 +338,7 @@ describe('nodester Query Language', () => {
 		});
 
 		test('"NOT" inside includes', () => {
-			const lexer = new QueryLexer( queryStrings[4] );
+			const lexer = new QueryLexer( queryStrings[2] );
 			const result = lexer.query;
 
 			const tree = new ModelsTree();
@@ -348,8 +349,21 @@ describe('nodester Query Language', () => {
 			expect(result).toMatchObject(expected);
 		});
 
+	});
+
+	describe('operators:like', () => {
+		const queryStrings = [
+			// Like simple.
+			'title=like(some_text)',
+
+			// Not like simple.
+			'title=notLike(some_text)',
+			// Not like short.
+			'title=!like(some_text)',
+		];
+
 		test('"Like" simple', () => {
-			const lexer = new QueryLexer( queryStrings[5] );
+			const lexer = new QueryLexer( queryStrings[0] );
 			const result = lexer.query;
 
 			const tree = new ModelsTree();
@@ -358,6 +372,141 @@ describe('nodester Query Language', () => {
 
 			expect(result).toMatchObject(expected);
 		});
+
+		test('"NotLike" simple', () => {
+			const lexer = new QueryLexer( queryStrings[1] );
+			const result = lexer.query;
+
+			const tree = new ModelsTree();
+			tree.node.addWhere({ title: { notLike: ['some_text'] }});
+			const expected = tree.root.toObject();
+
+			expect(result).toMatchObject(expected);
+		});
+
+		test('"NotLike" short', () => {
+			const lexer = new QueryLexer( queryStrings[2] );
+			const result = lexer.query;
+
+			const tree = new ModelsTree();
+			tree.node.addWhere({ title: { notLike: ['some_text'] }});
+			const expected = tree.root.toObject();
+
+			expect(result).toMatchObject(expected);
+		});
+	});
+
+	describe('operators:in', () => {
+		const queryStrings = [
+			// IN simple.
+			'status=[REVIEWED,ANSWERED]',
+
+			// IN and limit clause.
+			'status=[REVIEWED,ANSWERED]&limit=3',
+		];
+
+		test('"IN" simple', () => {
+			const lexer = new QueryLexer( queryStrings[0] );
+			const result = lexer.query;
+
+			const tree = new ModelsTree();
+			tree.node.addWhere({ status: { in: ['REVIEWED', 'ANSWERED'] }});
+			const expected = tree.root.toObject();
+
+			expect(result).toMatchObject(expected);
+		});
+
+		test('"IN" and "limit" clause', () => {
+			const lexer = new QueryLexer( queryStrings[1] );
+			const result = lexer.query;
+
+			const tree = new ModelsTree();
+			tree.node.limit = 3;
+			tree.node.addWhere({ status: { in: ['REVIEWED', 'ANSWERED'] }});
+			const expected = tree.root.toObject();
+
+			expect(result).toMatchObject(expected);
+		});
 	});
 
+	describe('operators:inequality', () => {
+		const queryStrings = [
+			// Greater than.
+			'created_at=gt(2022)',
+
+			// Greater than or equal to.
+			'created_at=gte(2023-12-08)',
+
+			// Lower than.
+			'index=lt(10)',
+
+			// Lower than or equal to.
+			'index=lte(9)',
+
+			// Greater than in subinclude.
+			'in=comments.likes(index=gt(60))'
+		];
+
+		test('Greater than', () => {
+			const lexer = new QueryLexer( queryStrings[0] );
+			const result = lexer.query;
+
+
+			const tree = new ModelsTree();
+			tree.node.addWhere({ created_at: { gt: ['2022'] }});
+			const expected = tree.root.toObject();
+
+			expect(result).toMatchObject(expected);
+		});
+
+		test('Greater than or equal to', () => {
+			const lexer = new QueryLexer( queryStrings[1] );
+			const result = lexer.query;
+
+
+			const tree = new ModelsTree();
+			tree.node.addWhere({ created_at: { gte: ['2023-12-08'] }});
+			const expected = tree.root.toObject();
+
+			expect(result).toMatchObject(expected);
+		});
+
+		test('Lower than', () => {
+			const lexer = new QueryLexer( queryStrings[2] );
+			const result = lexer.query;
+
+
+			const tree = new ModelsTree();
+			tree.node.addWhere({ index: { lt: ['10'] }});
+			const expected = tree.root.toObject();
+
+			expect(result).toMatchObject(expected);
+		});
+
+		test('Lower than or equal to', () => {
+			const lexer = new QueryLexer( queryStrings[3] );
+			const result = lexer.query;
+
+
+			const tree = new ModelsTree();
+			tree.node.addWhere({ index: { lte: ['9'] }});
+			const expected = tree.root.toObject();
+
+			expect(result).toMatchObject(expected);
+		});
+
+		test('Greater than in subinclude', () => {
+			const lexer = new QueryLexer( queryStrings[4] );
+			const result = lexer.query;
+
+
+			const tree = new ModelsTree();
+			tree.include('comments').use('comments');
+			tree.include('likes').use('likes');
+			tree.node.addWhere({ index: { gt: ['60'] }});
+			const expected = tree.root.toObject();
+
+			expect(result).toMatchObject(expected);
+		});
+	});
 });