nodester 0.0.1 → 0.0.3

package/Readme.md

@@ -1,14 +1,16 @@
 # nodester
->  A robust boilerplate framework that makes iterative development easy.
+>  A robust and flexible boilerplate framework that makes iterative development easy.
 
 ## Table of Contents
 
 - [Usage](#usage)
-- [Extending](#extending-application-functionality)
+- [Documentation](#documentation)
+- [Extending App](#extending-application-functionality)
 - [Philosophy](#philosophy)
 - [License](#license)
 - [Copyright](#copyright)
 
+
 ## Usage
 
 ```js
@@ -19,52 +21,43 @@ const app = new nodester();
 app.set.database(db);
 
 app.listen(8080, function() {
-	console.log('listening on port', app.port);
+  console.log('listening on port', app.port);
 });
 ```
 
-## Markers
-
-Marker is a functional condition that returns `true | false`, based on data in request.
 
+## Documentation
 
-### Adding a Marker
 
-```js
-app.add.marker('admin', (req) => req.role === 'admin');
-```
+### Core concepts
+[Go to core concepts documentaion](docs/CoreConcepts.md)
 
+### Queries & Querying - Nodester Query Language (NQR)
+One of the main power points of nodester is it's query language. It's an extension of a REST API syntaxis for a broader integration with a database SQL. Read more about it in the documentation:
 
-### Using a Marker
-
-```js
-app.only('admin').route('get /payments', <handler>);
-app.only('/api').route('get /payments', <handler>);
-```
-
+[Go to NQR documentaion](docs/Queries.md)
 
-## Router
 
-```js
-app.route('get /books', function(req, res) { ... } );
-app.route('get /books', { controlledBy: 'BooksController.getMany' } );
-app.route('get /books/:id', { controlledBy: 'BooksController.getOne' } );
-```
+### Database
+Nodester is built upon a powerful [Sequelize](https://sequelize.org/).
+Supported drivers:
+- MySQL
+- PostgreSQL
 
 
-## Extending Application functionality
+### Extending Application functionality
 
 
-### Extending instance (safe way):
+#### Extending instance (safe way):
 
 ```js
 const serveStatic = require('serve-static');
 
 const nodester = require('nodester');
 
-const app = nodester();
+const app = new nodester();
 app.extend('static', serveStatic);
-app.static(<path_to_static_directory>);
+app.static(<path_to_static_directory/>);
 ```
 
 Short:
@@ -73,8 +66,8 @@ const serveStatic = require('serve-static');
 
 const nodester = require('nodester');
 
-const app = nodester();
-app.extend('static', serveStatic)(<path_to_static_directory>);
+const app = new nodester();
+app.extend('static', serveStatic)(<path_to_static_directory/>);
 ```
 
 Of course you might just do this:
@@ -83,38 +76,39 @@ const serveStatic = require('serve-static');
 
 const nodester = require('nodester');
 
-const app = nodester();
+const app = new nodester();
 app.static = serveStatic;
 ````
 But you'll never know if you did override any of the app's properties or did not.
 
 
-### Extending class:
+#### Extending class:
 
-If you really want to override properties or use `nodester` as a boilerplate, you should better extend default Application class:
+If you really want to override properties or use `nodester` as a boilerplate, you should extend default Application class:
 
 ```js
-const DefaultApplication = require('nodester');
+const NodesterApp = require('nodester');
 
-class MyApp extends DefaultApplication {
-	constructor(opts) {
-		super(opts)
-	}
+class MyApp extends NodesterApp {
+  constructor(opts) {
+    super(opts)
+  }
 
-	// Override everything you want here...
+  // Override everything you want here...
 }
 
 // Don't forget to expose.
 module.exports = MyApp;
 ```
 
+
 ## Philosophy
 
 The Philosophy of `nodester` is to provide a developer with a tool that can build an app (or feature) in hours and scale it with ease for years.
 
 ### Goal
 
-The goal of `nodester` is to be a robust boilerplate that makes iterative development easy.
+The goal of `nodester` is to be a robust and flexible framework that makes development in iteratations easy, and further scale possible.
 
 
 ## LICENSE

package/lib/application/index.js

@@ -6,13 +6,26 @@
 'use strict';
 
 const Emitter = require('events');
-const MiddlewareStack = require('./MiddlewareStack');
+const DefaultRouter = require('../router');
+
 // Server:
 const http = require('http');
-const request = require('./http/request');
-const response = require('./http/response');
+const request = require('../http/request');
+const response = require('../http/response');
+
+// Middlewares:
+const nodesterQL = require('../middlewares/ql/sequelize');
+const bodyParser = require('body-parser');
+
 // Utils:
-const { typeOf } = require('../utils/types.util');
+const {
+	typeOf,
+	isConstructor
+} = require('../utils/types.util');
+const {
+	associateModels
+} = require('../database/utils');
+
 const { merge } = require('../utils/objects.util');
 const consl = require('../logger/console');
 const debug = require('debug')('nodester:application');
@@ -31,11 +44,14 @@ module.exports = class Application extends Emitter {
 		// Fallback port.
 		this.port = opts?.port ?? 8080;
 
-		// Reference to middlewares stack.
-		this._middlewares = new MiddlewareStack();
+		// Reference to router.
+		this._router = new DefaultRouter({ finalhandlerEnabled: true });
 
 		// Reference to the database connection.
-		this.database = null;
+		this._database = null;
+
+		// Reference to the Query parser.
+		this._queryParser = nodesterQL;
 
 		// Reference to the http(s) server,
 		this.server = null;
@@ -44,6 +60,13 @@ module.exports = class Application extends Emitter {
 			beforeStart: ()=>{}
 		};
 
+		// Default middlewares:
+		const _withoutMiddlewares = opts?.middlewares?.without ?? [];
+
+		if (_withoutMiddlewares.indexOf('body-parser') === -1) {
+			this.use(bodyParser.json());
+		}
+
 		// Indicatorors.
 		this.isListening = false;
 	}
@@ -55,7 +78,7 @@ module.exports = class Application extends Emitter {
 	 */
 	get request() {
 		return Object.create(request, {
-			app: { configurable: true, enumerable: true, writable: true, value: app }
+			app: { configurable: true, enumerable: true, writable: true, value: this }
 		})
 	}
 
@@ -67,7 +90,7 @@ module.exports = class Application extends Emitter {
 	 */
 	get response() {
 		return Object.create(response, {
-			app: { configurable: true, enumerable: true, writable: true, value: app }
+			app: { configurable: true, enumerable: true, writable: true, value: this }
 		})
 	}
 
@@ -89,23 +112,33 @@ module.exports = class Application extends Emitter {
 
 	/**
 	 * Sets (or overrides) main database of the application and tries to make connection.
+	 *
 	 * @param {Sequilize} sequilizeConnection
 	 * @param {Boolean} crashOnError
 	 * @return {sequilizeConnection.authenticate}
 	 *
 	 * @public
 	 */
-	setDatabase(sequilizeConnection, crashOnError=true) {
+	async setDatabase(sequilizeConnection, crashOnError=true) {
 		try {
 			if (!sequilizeConnection) {
-				const err = new Error('Connection to database (Sequilize) can not be null or undefined.');
+				const err = new TypeError('Connection to database (Sequilize) can not be null or undefined.');
 				throw err;
 			}
 
-			const result = sequilizeConnection.authenticate();
-			this.database = sequilizeConnection;
+			if (this.isListening === true) {
+				const err = new Error(`Can't set database after application start.`);
+				throw err;
+			}
 
-			return result;
+			// Test connection.
+			const result = await sequilizeConnection.authenticate();
+			// Associate models.
+			await associateModels(sequilizeConnection.models);
+			// Set database.
+			this._database = sequilizeConnection;
+
+			return Promise.resolve(result);
 		}
 		catch(error) {
 			if (crashOnError === true) {
@@ -114,17 +147,48 @@ module.exports = class Application extends Emitter {
 			else {
 				consl.error(error);
 			}
+
+			return Promise.reject(error);
 		}
 	}
 
 
+	/*
+	 * Returns main database of the application.
+	 *
+	 * @return {SequilizeConnection}
+	 *
+	 * @public
+	 */
+	get database() {
+		return this._database;
+	}
+
+
 	/**
 	 * Overrides default Router.
 	 *
 	 * @public
 	 */
 	setRouter(newRouter) {
-		this.router = newRouter.init(this);
+		if (isConstructor(newRouter)) {
+			this._router = new newRouter();
+		}
+		else {
+			this._router = newRouter;
+		}
+	}
+
+
+	/*
+	 * Returns NodesterRouter object.
+	 *
+	 * @return {NodesterRouter}
+	 *
+	 * @public
+	 */
+	get router() {
+		return this._router;
 	}
 
 
@@ -136,40 +200,39 @@ module.exports = class Application extends Emitter {
 	 */
 	get add() {
 		return {
-			middleware: this.addMiddleware.bind(this)
+			controller: this._router.add.controller,
+			middleware: this._router.add.middleware,
+			marker: this._router.add.marker,
+			route: this._router.add.route,
 		}
 	}
 
 
 	/*
-	 * Adds new middleware to the stack.
+	 * Proxy to .add.middleware()
+	 *
+	 * @param {Function} fn
 	 *
 	 * @api public
 	 */
-	addMiddleware(fn) {
-		if (this._middlewares.isLocked === true) {
-			const err = new Error(`Can't add more middlewares after application has been started.`);
-			throw err;
-		}
-
-		this._middlewares.add(fn);
+	use(fn) {
+		return this._router.add.middleware(fn);
 	}
 
 
 	/*
-	 * Proxy to .add().
 	 *
-	 * @param {Function} fn
+	 * @param {String} markerName
 	 *
 	 * @api public
 	 */
-	use(fn) {
-		return this.add(fn);
+	only(markerName='') {
+		return this._router.only(markerName);
 	}
 
 
 	/**
-	 * Adds to hooks stack (beforeStart).
+	 * Sets beforeStart hook.
 	 *
 	 * @api public
 	 */
@@ -192,20 +255,24 @@ module.exports = class Application extends Emitter {
 	 *
 	 * @api public
 	 */
-	start() {
+	async start() {
 		try {
-			this._hooks.beforeStart.call(this);
+			await this._hooks.beforeStart.call(this);
 		}
 		catch(error) {
 			console.error('Application did not start due to error.');
 			consl.error(error);
-			return;
+			return Promise.reject(error);
 		}
 
-		// Lock middlewares stack.
-		this._middlewares.lock();
+		// Add query parser.
+		this._router.add.middleware(this._queryParser, 0);
 
-		return this.handle.bind(this);
+		// Prepare router for processing.
+		this._router.lock();
+
+		const handler = this.handle.bind(this);
+		return handler;
 	}
 
 
@@ -220,7 +287,7 @@ module.exports = class Application extends Emitter {
 	 *
 	 * @api public
 	 */
-	listen(port, ...args) {
+	async listen(port, ...args) {
 		// Remember port:
 		const _port = port ?? this.port;
 		this.port = _port;
@@ -228,7 +295,8 @@ module.exports = class Application extends Emitter {
 		debug(`listen on port ${ this.port }`);
 
 		if (!this.server) {
-			this.server = http.createServer(this.start());
+			const handler = await this.start();
+			this.server = http.createServer(handler);
 		}
 
 		this.isListening = true;
@@ -250,7 +318,7 @@ module.exports = class Application extends Emitter {
 		req.res = res;
 		res.req = req;
 
-		return this._middlewares.process(req, res)
+		return this._router.handle(req, res);
 	}
 
 
@@ -288,5 +356,9 @@ module.exports = class Application extends Emitter {
 
 		this.server.close();
 		this.isListening = false;
+
+		this._router.unlock();
+		// Remove query parser.
+		this._router.remove.middleware(0);
 	}
 }

package/lib/constants/Operations.js

@@ -0,0 +1,23 @@
+const Enum = require('../enums/Enum');
+
+
+module.exports = new Enum({
+	and: Symbol.for('and'),
+	between: Symbol.for('between'),
+	contains: Symbol.for('contains'),
+	eq: Symbol.for('eq'),
+	ne: Symbol.for('ne'),
+	gte: Symbol.for('gte'),
+	gt: Symbol.for('gt'),
+	lte: Symbol.for('lte'),
+	lt: Symbol.for('lt'),
+	not: Symbol.for('not'),
+	is: Symbol.for('is'),
+	in: Symbol.for('in'),
+	notIn: Symbol.for('notIn'),
+	like: Symbol.for('like'),
+	notLike: Symbol.for('notLike'),
+	notBetween: Symbol.for('notBetween'),
+	or: Symbol.for('or'),
+	xor: Symbol.for('xor'),
+});

package/lib/controllers/methods/index.js

@@ -0,0 +1,194 @@
+
+module.exports = {
+	getOne: _getOne,
+	getMany: _getMany,
+	createOne: _createOne,
+	updateOne: _updateOne,
+	deleteOne: _deleteOne
+}
+
+
+/*
+ * @alias getOne
+ * @api public
+ */
+async function _getOne(req, res) {
+	try {
+		const params = {
+			query: {
+				...req.query,
+				where: req.params
+			}
+		}
+		const result = await this.facade.getOne(params);
+
+		if (this.afterGetOne) {
+			await this.afterGetOne(req, res, result);
+		}
+
+		return this.respondOk(res, {
+			content: { ...result }
+		});
+	}
+	catch(error) {
+		if (this.processError) {
+			return this.processError(error, req, res);
+		}
+		else {
+			res.status(500);
+			res.json({ error: error.toString() });
+		}
+	}
+	finally {
+		return Promise.resolve();
+	}
+}
+
+
+/*
+ * @alias getMany
+ * @api public
+ */
+async function _getMany(req, res) {
+	try {
+		const params = {
+			query: req.query
+		}
+		const result = await this.facade.getMany(params);
+
+		if (this.afterGetMany) {
+			await this.afterGetMany(req, res, result);
+		}
+
+		return this.respondOk(res, {
+			content: { ...result }
+		});
+	}
+	catch(error) {
+		if (this.processError) {
+			return this.processError(error, req, res);
+		}
+		else {
+			res.status(500);
+			res.json({ error: error.toString() });
+		}
+	}
+	finally {
+		return Promise.resolve();
+	}
+}
+
+
+/*
+ * @alias createOne
+ * @api public
+ */
+async function _createOne(req, res) {
+	try {
+		const params = {
+			query: {
+				...req.query,
+				where: req.params
+			},
+			data: req.body,
+		}
+		const result = await this.facade.createOne(params);
+
+		if (this.afterCreateOne) {
+			await this.afterCreateOne(req, res, result);
+		}
+
+		return this.respondOk(res, {
+			content: { ...result }
+		});
+	}
+	catch(error) {
+		if (this.processError) {
+			return this.processError(error, req, res);
+		}
+		else {
+			res.status(500);
+			res.json({ error: error.toString() });
+		}
+	}
+	finally {
+		return Promise.resolve();
+	}
+}
+
+
+/*
+ * @alias updateOne
+ * @api public
+ */
+async function _updateOne(req, res) {
+	try {
+		const params = {
+			query: {
+				...req.query,
+				where: req.params
+			},
+			data: req.body,
+		}
+		const result = await this.facade.updateOne(params);
+
+		if (this.afterUpdateOne) {
+			await this.afterUpdateOne(req, res, result);
+		}
+
+		return this.respondOk(res, {
+			content: { ...result }
+		});
+	}
+	catch(error) {
+		if (this.processError) {
+			return this.processError(error, req, res);
+		}
+		else {
+			res.status(500);
+			res.json({ error: error.toString() });
+		}
+	}
+	finally {
+		return Promise.resolve();
+	}
+}
+
+
+/*
+ * @alias deleteOne
+ * @api public
+ */
+async function _deleteOne(req, res) {
+	try {
+		const params = {
+			query: {
+				...req.query,
+				where: req.params
+			}
+		}
+		const result = await this.facade.deleteOne(params);
+
+		if (this.afterDeleteOn) {
+			await this.afterDeleteOne(req, res, result);
+		}
+
+		return this.respondOk(res, {
+			content: { ...result }
+		});
+	}
+	catch(error) {
+		if (this.processError) {
+			return this.processError(error, req, res);
+		}
+		else {
+			res.status(500);
+			res.json({ error: error.toString() });
+		}
+	}
+	finally {
+		return Promise.resolve();
+	}
+}
+
+