nodester 0.0.1 → 0.0.2

package/lib/{application → stacks}/MiddlewareStack.js

@@ -4,12 +4,13 @@ const debug = require('debug')('nodester:MiddlewareStack');
 
 
 module.exports = class MiddlewareStack {
-	constructor() {
+	constructor(opts={}) {
 		// This array MUST stay flat!
 		this.middlewares = [];
 
 		// Indicates whether we can add more middlewares or no.
 		this.isLocked = false;
+		this.finalhandlerEnabled = !!opts.finalhandlerEnabled;
 
 
 		const env = process.env.NODE_ENV || 'development';
@@ -25,11 +26,12 @@ module.exports = class MiddlewareStack {
 	 * Add the given middleware `fn` to the stack.
 	 *
 	 * @param {Function} fn
+	 * @param {Integer} index (0 or undefined)
 	 * @return {Integer} index of new middleware
 	 *
 	 * @api public
 	 */
-	add(fn) {
+	add(fn, index) {
 		if (this.isLocked) {
 			const err = new Error(`Can't add more middlewares while stack is locked.`);
 			throw err;
@@ -40,9 +42,23 @@ module.exports = class MiddlewareStack {
 			throw err;
 		}
 
-		const index = this.middlewares.push(fn);
-		debug(`added middleware (${ index })`);
-		return index;
+		if (!!index && isNaN(index)) {
+			const err = new TypeError('"index" must be an Integer!');
+			throw err;
+		}
+
+		let pushedIndex = -1;
+
+		if (index === 0) {
+			this.middlewares.unshift(fn);
+			pushedIndex = 0;
+		}
+		else {
+			pushedIndex = this.middlewares.push(fn);
+		}
+
+		debug(`added middleware (${ pushedIndex })`);
+		return pushedIndex;
 	}
 
 
@@ -65,7 +81,7 @@ module.exports = class MiddlewareStack {
 			throw err;
 		}
 
-		this.middlewares.splice(middlewareIndex, 1);
+		this.middlewares.splice(index, 1);
 		debug(`removed middleware (${ index })`);
 		return this;
 	}
@@ -77,8 +93,10 @@ module.exports = class MiddlewareStack {
 	 * @api public
 	 */
 	lock() {
-		// Add final handler to the stack.
-		this.add((req, res)=>this.finalhandler(req, res)());
+		if (this.finalhandlerEnabled) {
+			// Add final handler to the stack.
+			this.add((req, res)=>this.finalhandler(req, res)());
+		}
 
 		// Stack is ready.
 		this.isLocked = true;
@@ -94,7 +112,10 @@ module.exports = class MiddlewareStack {
 	 */
 	unlock() {
 		this.isLocked = false;
-		this.middlewares.pop();
+		
+		if (this.finalhandlerEnabled) {
+			this.middlewares.pop();
+		}
 
 		debug(`stack is unlocked`);
 	}
@@ -105,21 +126,34 @@ module.exports = class MiddlewareStack {
 	 *
 	 * @api public
 	 */
-	process(req, res) {
+	process(req, res, next) {
 		let middlewareOffset = -1;
 
-		const next = (...args) => {
+		const _next = (...args) => {
 			middlewareOffset += 1;
 			const fn = this.middlewares[middlewareOffset];
 
 			try {
-				return fn.call(null, req, res, next, ...args);
+				if (!fn && !next) {
+					const err = new TypeError(`Handler for ${ req.method } ${ req.url } is not defined.`);
+					throw err;
+				}
+				else if (!fn && !!next) {
+					return next.call(null, req, res, next, ...args);
+				}
+
+				return fn.call(null, req, res, _next, ...args);
 			}
 			catch(error) {
 				return this.finalhandler(req, res)(error);
 			}
 		}
 
-		return next();
+		return _next();
+	}
+
+
+	get length() {
+		return this.middlewares.length;
 	}
 }

package/lib/utils/path.util.js

@@ -7,8 +7,10 @@ exports = module.exports = {
  * Check if `path` looks absolute.
  *
  * @param {String} path
+ *
  * @return {Boolean}
- * @api private
+ *
+ * @api public
  * @alias isAbsolute
  */
 function _isAbsolute(path) {

package/lib/utils/types.util.js

@@ -2,7 +2,10 @@ const objectRegExp = /^\[object (\S+)\]$/;
 
 
 module.exports = {
-	typeOf: _typeOf
+	typeOf: _typeOf,
+	isAsync: _isAsync,
+	isRegExp: _isRegExp,
+	isConstructor: _isConstructor
 }
 
 
@@ -24,3 +27,50 @@ function _typeOf(obj) {
 							 .call(obj)
 							 .replace(objectRegExp, '$1');
 }
+
+
+/**
+ *
+ * @alias isAsync
+ * @public
+ */
+function _isAsync(fn) {
+	if (!fn) {
+		const err = new TypeError('"fn" is not defined.');
+		throw err;
+	}
+
+	return fn.constructor.name === 'AsyncFunction';
+}
+
+
+/**
+ *
+ * @alias isRegExp
+ * @public
+ */
+function _isRegExp(obj) {
+	if (!obj) {
+		const err = new TypeError('"obj" is not defined.');
+		throw err;
+	}
+
+	return obj instanceof RegExp;
+}
+
+
+/**
+ *
+ * @alias isConstructor
+ * @public
+ */
+function _isConstructor(fn) {
+	try {
+		new fn();
+	}
+	catch (err) {
+		return false;
+	}
+
+	return true;
+}

package/lib/validators/dates.js

@@ -0,0 +1,25 @@
+
+module.exports = {
+	isValidDate: _isValidDate
+}
+
+
+/**
+ * @param {Any} dateToTest
+ *
+ * @alias isValidDate
+ * @api public
+ */
+function _isValidDate(dateToTest) {
+	// If number:
+	if (!isNaN(dateToTest)) {
+		return false;
+	}
+
+	if (typeof dateToTest === 'string') {
+		const date = new Date(dateToTest);
+		return date.toString() !== 'Invalid Date';
+	}
+
+  return dateToTest instanceof Date;
+}

package/lib/validators/numbers.js

@@ -0,0 +1,14 @@
+
+module.exports = {
+	isValidNumber: _isValidNumber
+}
+
+/**
+ * @param {Any} numToTest
+ *
+ * @alias isValidNumber
+ * @api public
+ */
+function _isValidNumber(numToTest){
+	return !isNaN(numToTest);
+}

package/package.json

@@ -1,9 +1,29 @@
 {
   "name": "nodester",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "description": "A boilerplate framework for Node.js",
   "exports": {
-    ".": "./lib/application/index.js"
+    ".": "./lib/application/index.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",
+    "./http/codes": "./lib/http/codes/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",
+    "./route": "./lib/router/route.js",
+    "./router": "./lib/router/index.js",
+    "./utils/strings": "./lib/utils/strings.util.js"
   },
   "directories": {
     "doc": "docs"
@@ -12,8 +32,8 @@
     "lib"
   ],
   "scripts": {
-    "examples:rest": "node ./examples/rest/index.js",
-    "test": "jest"
+    "test": "jest",
+    "examples:rest": "node ./examples/rest/index.js"
   },
   "author": "Mark Khramko <markkhramko@gmail.com>",
   "license": "MIT",
@@ -35,17 +55,24 @@
     "api"
   ],
   "dependencies": {
+    "@js-temporal/polyfill": "^0.4.3",
     "accepts": "^1.3.8",
+    "body-parser": "^1.20.2",
+    "common-js-file-extensions": "^1.0.4",
     "content-disposition": "^0.5.4",
     "content-type": "^1.0.5",
     "cookie": "^0.5.0",
     "cookie-signature": "^1.2.0",
     "debug": "^4.3.4",
+    "etag": "^1.8.1",
     "finalhandler": "^1.2.0",
     "formidable": "^1.2.6",
     "fresh": "^0.5.2",
     "http-errors": "^2.0.0",
     "inflection": "^2.0.1",
+    "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",

package/tests/index.test.js

@@ -1,4 +1,4 @@
-// Test utils:
+// Test utils.
 const {
 	describe,
 	it,
@@ -24,11 +24,16 @@ describe('nodester application', () => {
 	// app.setDatabase();
 	// app.set.database();
 
-	test('listening port', () => {
+	test('Application start', () => {
 		app.listen(PORT, function() {
 			expect(app.port).toBe(PORT);
+			expect(app.router._middlewares.isLocked).toBe(true);
+			expect(app.router._middlewares.length).toBe(2);
 
 			app.stop();
+
+			expect(app.router._middlewares.length).toBe(0);
+			expect(app.router._middlewares.isLocked).toBe(false);
 			expect(app.isListening).toBe(false);
 		});
 	});

package/tests/nql.test.js

@@ -0,0 +1,277 @@
+// Test utils.
+const {
+	describe,
+	it,
+	expect,
+	test
+} = require('@jest/globals');
+
+// Parser:
+const { ModelsTree } = require('../lib/middlewares/ql/sequelize/interpreter/ModelsTree');
+const QueryLexer = require('../lib/middlewares/ql/sequelize/interpreter/QueryLexer');
+
+describe('nodester Query Language', () => {
+	const queryStrings = [
+		// Simple where.
+		'id=10',
+		// All possible params.
+		'id=10&position=4&limit=3&skip=10&order=desc&order_by=index&fields=id,content,position,created_at',
+		// Simple includes.
+		'includes=comments&id=7',
+		// Include with All possible params.
+		'includes=comments(id=10&position=4&limit=3&skip=10&order=desc&order_by=index&fields=id,content,position)',
+		
+		// Subinclude horizontal.
+		'includes=comments,users&id=1000',
+		// Subinclude horizontal (more entries).
+		'includes=comments(order=desc),users,likes(order=rand),reposts&id=1000',
+		// Subinclude horizontal (+ syntaxis).
+		'includes=comments(order=desc).users+likes(order=rand&order_by=position)&id=1000',
+
+		// Subinclude vertical.
+		'includes=comments.users&id=1000',
+		// Subinclude vertical (more entries).
+		'in=comments.users.avatars.sizes&position=200',
+
+		// Complex includes.
+		'includes=comments.users.avatars(fields=id,content&order=rand)&id=7&limit=3',
+
+		// Broken includes.
+		'includes=comments(order=rand)&id=7&limit=3&includes=users(fields=id,content)',
+
+		// OR simple.
+		'or(index=2,position=5)',
+		// OR shortened.
+		'|(index=2,position=5)',
+
+		// NOT inside include.
+		'includes=comments(id=not(7))',
+
+		// Like simple.
+		'title=like(some_text)',
+	];
+
+	it('query "Simple where"', () => {
+		const lexer = new QueryLexer( queryStrings[0] );
+		const result = lexer.query;
+
+		const tree = new ModelsTree();
+		tree.node.addWhere({ id: ['10'] });
+		const expected = tree.root.toObject();
+
+		expect(result).toMatchObject(expected);
+	});
+
+	test('query "All possible params"', () => {
+		const lexer = new QueryLexer( queryStrings[1] );
+		const result = lexer.query;
+
+
+		const tree = new ModelsTree();
+		tree.node.addWhere({ id: ['10'], position: ['4'] });
+		tree.node.fields = [ 'id', 'content', 'position', 'created_at' ];
+		tree.node.limit = 3;
+		tree.node.skip = 10;
+		tree.node.order = 'desc';
+		tree.node.order_by = 'index';
+		const expected = tree.root.toObject();
+
+		expect(result).toMatchObject(expected);
+	});
+
+	test('query "Simple includes"', () => {
+		const lexer = new QueryLexer( queryStrings[2] );
+		const result = lexer.query;
+
+
+		const tree = new ModelsTree();
+		tree.node.addWhere({ id: ['7'] });
+		tree.include('comments');
+		const expected = tree.root.toObject();
+
+		expect(result).toMatchObject(expected);
+	});
+
+	test('query "Include with all possible params"', () => {
+		const lexer = new QueryLexer( queryStrings[3] );
+		const result = lexer.query;
+
+		const tree = new ModelsTree();
+		tree.include('comments').use('comments');
+		tree.node.addWhere({ id: ['10'], position: ['4'] });
+		tree.node.fields = [ 'id', 'content', 'position' ];
+		tree.node.limit = 3;
+		tree.node.skip = 10;
+		tree.node.order = 'desc';
+		tree.node.order_by = 'index';
+		const expected = tree.root.toObject();
+
+		expect(result).toMatchObject(expected);
+	});
+
+
+	test('query "Subinclude horizontal"', () => {
+		const lexer = new QueryLexer( queryStrings[4] );
+		const result = lexer.query;
+
+
+		const tree = new ModelsTree();
+		tree.node.addWhere({ id: ['1000'] });
+		tree.include('comments');
+		tree.include('users');
+		const expected = tree.root.toObject();
+
+		expect(result).toMatchObject(expected);
+	});
+
+	test('query "Subinclude horizontal (complex)"', () => {
+		const lexer = new QueryLexer( queryStrings[5] );
+		const result = lexer.query;
+
+
+		const tree = new ModelsTree();
+		tree.node.addWhere({ id: ['1000'] });
+		tree.include('comments').use('comments');
+		tree.node.order = 'desc';
+		tree.up();
+		tree.include('users');
+		tree.include('likes') && tree.use('likes');
+		tree.node.order = 'rand';
+		tree.up();
+		tree.include('reposts');
+		const expected = tree.root.toObject();
+
+		expect(result).toMatchObject(expected);
+	});
+
+
+	test('query "Subinclude horizontal (+ syntaxis)"', () => {
+		const lexer = new QueryLexer( queryStrings[6] );
+		const result = lexer.query;
+
+
+		const tree = new ModelsTree();
+		tree.node.addWhere({ id: ['1000'] });
+		tree.include('comments').use('comments');
+		tree.node.order = 'desc';
+		tree.include('users');
+		tree.include('likes') && tree.use('likes');
+		tree.node.order = 'rand';
+		tree.node.order_by = 'position';
+		tree.up();
+		const expected = tree.root.toObject();
+
+		expect(result).toMatchObject(expected);
+	});
+
+
+	test('query "Subinclude vertical"', () => {
+		const lexer = new QueryLexer( queryStrings[7] );
+		const result = lexer.query;
+
+
+		const tree = new ModelsTree();
+		tree.node.addWhere({ id: ['1000'] });
+		tree.include('comments').use('comments');
+		tree.include('users');
+		const expected = tree.root.toObject();
+
+		expect(result).toMatchObject(expected);
+	});
+
+	test('query "Subinclude vertical (complex)"', () => {
+		const lexer = new QueryLexer( queryStrings[8] );
+		const result = lexer.query;
+
+
+		const tree = new ModelsTree();
+		tree.node.addWhere({ position: ['200'] });
+		tree.include('comments').use('comments');
+		tree.include('users').use('users');
+		tree.include('avatars').use('avatars');
+		tree.include('sizes').use('sizes');
+		const expected = tree.root.toObject();
+
+		expect(result).toMatchObject(expected);
+	});
+
+	test('query "Complex includes"', () => {
+		const lexer = new QueryLexer( queryStrings[9] );
+		const result = lexer.query;
+
+		const tree = new ModelsTree();
+		tree.node.addWhere({ id: ['7'] });
+		tree.node.limit = 3;
+		tree.include('comments').use('comments');
+		tree.include('users').use('users');
+		tree.include('avatars').use('avatars');
+		tree.node.fields = [ 'id', 'content' ];
+		tree.node.order = 'rand';
+		const expected = tree.root.toObject();
+
+		expect(result).toMatchObject(expected);
+	});
+
+	test('query "Broken includes"', () => {
+		const lexer = new QueryLexer( queryStrings[10] );
+		const result = lexer.query;
+
+		const tree = new ModelsTree();
+		tree.node.addWhere({ id: ['7'] });
+		tree.node.limit = 3;
+		tree.include('comments').use('comments');
+		tree.node.order = 'rand';
+		tree.up();
+		tree.include('users').use('users');
+		tree.node.fields = [ 'id', 'content' ];
+		const expected = tree.root.toObject();
+
+		expect(result).toMatchObject(expected);
+	});
+
+	test('Token "OR" simple', () => {
+		const lexer = new QueryLexer( queryStrings[11] );
+		const result = lexer.query;
+
+		const tree = new ModelsTree();
+		tree.node.addWhere({ or: [ { index: ['2'] }, { position: ['5'] } ] });
+		const expected = tree.root.toObject();
+
+		expect(result).toMatchObject(expected);
+	});
+
+	test('Token "OR" shortened', () => {
+		const lexer = new QueryLexer( queryStrings[12] );
+		const result = lexer.query;
+
+		const tree = new ModelsTree();
+		tree.node.addWhere({ or: [ { index: ['2'] }, { position: ['5'] } ] });
+		const expected = tree.root.toObject();
+
+		expect(result).toMatchObject(expected);
+	});
+
+	test('Token "NOT"', () => {
+		const lexer = new QueryLexer( queryStrings[13] );
+		const result = lexer.query;
+
+		const tree = new ModelsTree();
+		tree.include('comments').use('comments');
+		tree.node.addWhere({ id: { not: ['7'] }});
+		const expected = tree.root.toObject();
+
+		expect(result).toMatchObject(expected);
+	});
+	
+
+	test('Token "Like" simple', () => {
+		const lexer = new QueryLexer( queryStrings[14] );
+		const result = lexer.query;
+
+		const tree = new ModelsTree();
+		tree.node.addWhere({ title: { like: ['some_text'] }});
+		const expected = tree.root.toObject();
+
+		expect(result).toMatchObject(expected);
+	});
+});

package/docs/App.md

@@ -1,13 +0,0 @@
-# nodester Application
-
-## Init
-
-```js
-	const nodester = require('nodester');
-	
-	const app = new nodester();
-
-	app.listen(8080, function() {
-		console.log('listening on port', app.port);
-	});
-```

package/docs/Queries.md

@@ -1,61 +0,0 @@
-# nodester Queries API
-
-## Like value
-
-To emulate MySQL's `like %value% ` query in URL,
-pass `?key=like(value)` in the query.
-
-* Example:
-`http://localhost:5001/api/v1/countries?name=like(Engl)`
-
-
-## NotLike value
-
-* Example:
-`http://localhost:5001/api/v1/countries?name=notLike(Engl)`
-
-
-## Or
-
-To emulate MySQL's `where key=value or key=value` query in URL,
-pass `?key=or(value1,value2)` in the query.
-* ! Note: don't use `spaces` between values.
-
-* Example:
-`http://localhost:5001/api/v1/countries?name=or(England,Germany)`
-
-
-## Count
-
-MySQL's `select count(value)` query is run by default in facade's `getMany` function
-
-* Response Example:
-```JSON
-{
-	"count": 10,
-	"countries": [ ... ],
-	"limit": 10,
-	"skip": 0,
-	"total_count": 195
-}
-```
-
-## Order (Sorting)
-
-
-#### Top level
-
-`order_by` & `order` arguments can be set in `query`
-`http://localhost:5001/api/v1/countries?order_by=id&order=desc`
-
-Above `query` will sort Countries[] by it's id.
-
-
-#### Nested (Includes)
-
-`http://localhost:5001/api/v1/countries?includes=cities(order_by=id&order=desc)`
-
-Above `query` will sort Cities[] by it's id inside every Country object.
-
-It can also do this:
-`http://localhost:5001/api/v1/countries?includes=cities(order_by=id&order=desc).areas`

package/docs/Readme.md

@@ -1,2 +0,0 @@
-# nodester API description
-