nodester 0.0.8 → 0.1.0

package/Readme.md

@@ -4,13 +4,13 @@
 ## Table of Contents
 
 - [Usage](#usage)
-- [Markers](#markers)
-- [Router](#router)
+- [Documentation](#documentation)
 - [Extending App](#extending-application-functionality)
 - [Philosophy](#philosophy)
 - [License](#license)
 - [Copyright](#copyright)
 
+
 ## Usage
 
 ```js
@@ -25,72 +25,30 @@ app.listen(8080, function() {
 });
 ```
 
-## Markers
-
-Marker is a functional condition that returns `true | false`, based on data in request/response.
-
-Markers are more powerful indicators than simple route definitions as any parameter in request/response can be used.
-
-For example: our application has 2 domains:
-`admin.awesomeapp.com`
-`api.awesomeapp.com`
-
-You add markers and handlers specifically for those domains:
-
-```js
-app.add.marker('ADMIN', (req) => req.hostname === 'admin.awesomeapp.com');
-app.add.marker('API', (req) => req.hostname === 'api.awesomeapp.com');
-```
-
-And then use them:
-
-```js
-app.only('ADMIN').route('get /payments', <handler/>);
-app.only('API').route('get /payments', <handler/>);
-// Or:
-app.only('ADMIN').use(<handler/>);
-app.only('API').use(<handler/>);
-```
-
-The same can be done for any parameter in request/response:
-
-```js
-app.add.marker('admin_role', (req) => req.role === 'admin');
-app.only('admin_role').route('get /secrets', <handler/>);
-app.only('admin_role').use(<handler/>);
-```
-
-## Router
 
-Router is a built-in middleware.
+## Documentation
 
-```js
-const Router = require('nodester/router');
 
-const controllersPath = <path_to_controllers_directory/>;
-const router = new Router({ controllersPath });
+### Core concepts
+[Go to core concepts documentaion](docs/CoreConcepts.md)
 
-router.add.route('get /books', function(req, res) { ... } );
-// Or:
-router.add.route('get /books', { controlledBy: 'BooksController.getMany' } );
-router.add.route('get /books/:id', { controlledBy: 'BooksController.getOne' } );
-```
+### 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 Router:
+[Go to NQR documentaion](docs/Queries.md)
 
-```js
-const nodester = require('nodester');
-const router = require(<path_to_router_definition/>);
 
-const app = new nodester();
-app.use(router());
-```
+### 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');
@@ -124,7 +82,7 @@ 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 extend default Application class:
 
@@ -143,13 +101,14 @@ class MyApp extends NodesterApp {
 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 and flexible framework 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

@@ -7,17 +7,25 @@
 
 const Emitter = require('events');
 const DefaultRouter = require('../router');
+
 // Server:
 const http = require('http');
 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,
 	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');
@@ -52,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;
 	}
@@ -104,7 +119,7 @@ module.exports = class Application extends Emitter {
 	 *
 	 * @public
 	 */
-	setDatabase(sequilizeConnection, crashOnError=true) {
+	async setDatabase(sequilizeConnection, crashOnError=true) {
 		try {
 			if (!sequilizeConnection) {
 				const err = new TypeError('Connection to database (Sequilize) can not be null or undefined.');
@@ -116,10 +131,14 @@ module.exports = class Application extends Emitter {
 				throw err;
 			}
 
-			const result = sequilizeConnection.authenticate();
+			// Test connection.
+			const result = await sequilizeConnection.authenticate();
+			// Associate models.
+			await associateModels(sequilizeConnection.models);
+			// Set database.
 			this._database = sequilizeConnection;
 
-			return result;
+			return Promise.resolve(result);
 		}
 		catch(error) {
 			if (crashOnError === true) {
@@ -128,6 +147,8 @@ module.exports = class Application extends Emitter {
 			else {
 				consl.error(error);
 			}
+
+			return Promise.reject(error);
 		}
 	}
 
@@ -188,14 +209,14 @@ module.exports = class Application extends Emitter {
 
 
 	/*
-	 * Proxy to .add.middleware()
+	 * Proxy to router.use()
 	 *
-	 * @param {Function} fn
+	 * @param {Function|NodesterRouter} fnOrRouter
 	 *
 	 * @api public
 	 */
-	use(fn) {
-		return this._router.add.middleware(fn);
+	use(fnOrRouter) {
+		return this._router.use(fnOrRouter);
 	}
 
 

package/lib/controllers/methods/index.js

@@ -14,8 +14,13 @@ module.exports = {
  */
 async function _getOne(req, res) {
 	try {
-
-		const result = await this.facade.getOne();
+		const params = {
+			query: {
+				...req.query,
+				where: req.params
+			}
+		}
+		const result = await this.facade.getOne(params);
 
 		if (this.afterGetOne) {
 			await this.afterGetOne(req, res, result);
@@ -26,7 +31,6 @@ async function _getOne(req, res) {
 		});
 	}
 	catch(error) {
-		console.error('getOne', error);
 		if (this.processError) {
 			return this.processError(error, req, res);
 		}
@@ -47,7 +51,10 @@ async function _getOne(req, res) {
  */
 async function _getMany(req, res) {
 	try {
-		const result = await this.facade.getMany();
+		const params = {
+			query: req.query
+		}
+		const result = await this.facade.getMany(params);
 
 		if (this.afterGetMany) {
 			await this.afterGetMany(req, res, result);
@@ -78,8 +85,14 @@ async function _getMany(req, res) {
  */
 async function _createOne(req, res) {
 	try {
-
-		const result = await this.facade.createOne();
+		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);
@@ -110,8 +123,14 @@ async function _createOne(req, res) {
  */
 async function _updateOne(req, res) {
 	try {
-
-		const result = await this.facade.updateOne();
+		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);
@@ -142,8 +161,13 @@ async function _updateOne(req, res) {
  */
 async function _deleteOne(req, res) {
 	try {
-
-		const result = await this.facade.deleteOne();
+		const params = {
+			query: {
+				...req.query,
+				where: req.params
+			}
+		}
+		const result = await this.facade.deleteOne(params);
 
 		if (this.afterDeleteOn) {
 			await this.afterDeleteOne(req, res, result);

package/lib/controllers/mixins/index.js

@@ -134,6 +134,7 @@ function _withDefaultErrorProcessing(controller, opts={}) {
 
 	// Set processError:
 	controller.processError = function (error, req, res) {
+		
 		// Default error message.
 		let errorMessage = error?.message ?? 'Internal server error';
 		// Default HTTP status code.
@@ -169,23 +170,31 @@ function _withDefaultErrorProcessing(controller, opts={}) {
 			}
 			case('InternalValidationError'): {
 				statusCode = 500;
-				errorResponse.details = { message:'Error' };
+				errorResponse.details = { message: 'Error' };
 				break;
 			}
 			default: {
-				errorResponse.details = { message:errorMessage };
+				errorResponse.details = { message: errorMessage };
 				break;
 			}
 		}
 
-		// Send error response with provided status code.
-		return this.respondNotOk(res, {
+		// Send error response with provided status code:
+		const data = {
 			error: {
 				...errorResponse,
 				code: statusCode
 			},
 			status: statusCode
-		});
+		}
+
+		if (!!this.respondNotOk) {
+			return this.respondNotOk(res, data);
+		}
+
+		// Barebones response:
+		res.status(statusCode);
+		res.json(data);
 	}
 
 	return controller;

package/lib/database/connection.js

@@ -0,0 +1,34 @@
+// ORM.
+const Sequelize = require('sequelize');
+
+
+module.exports = {
+	buildConnection: _buildConnection
+};
+
+function _buildConnection(opts={}) {
+	
+
+	const dbName = opts.name;
+	const username = opts.username;
+	const password = opts.password;
+
+
+	const connection = new Sequelize(
+		dbName,
+		username,
+		password,
+		{
+			host: opts.host,
+			port: opts.port,
+			dialect: opts.dialect,
+			pool: opts.pool,
+			charset: opts.charset,
+			collate: opts.collate, 
+			timestamps: opts.timestamps,
+			logging: opts.logging
+		}
+	);
+
+	return connection;
+}

package/lib/database/migration.js

@@ -0,0 +1,42 @@
+const { associateModels } = require('./utils');
+
+
+module.exports = {
+	migrate: _migrate
+}
+
+async function _migrate(databaseConnection, force=false) {
+	try {
+		// Validation of 'force' parameter.
+		if (typeof force !== 'boolean') {
+			const err = new Error('Wrong "force" parameter; must be boolean.');
+			throw err;
+		}
+
+		// Test connection.
+		await databaseConnection.authenticate();
+
+
+		const models = databaseConnection.models;
+		const modelNames = Object.keys(models);
+		console.info('Models to sync:', modelNames);
+		console.info('Forcefully?', force);
+		console.info('Syncing...\n');
+		await associateModels(models);
+		await databaseConnection.sync({ force });
+		console.info('Successful migration!');
+
+		const output = {
+			synced: true,
+			modelNames: modelNames,
+			models: models
+		}
+		return Promise.resolve(output);
+	}
+	catch(error) {
+		console.error('Migration failed!');
+		console.error(error);
+		return Promise.reject(error);
+	}
+}
+

package/lib/database/utils.js

@@ -0,0 +1,19 @@
+
+module.exports = {
+	associateModels: _associateModels
+}
+
+async function _associateModels(models) {
+	return new Promise((resolve, reject) => {
+		try {
+			Object.keys(models).map(modelName => (
+				models[modelName].associate(models)
+			));
+
+			return resolve(models);
+		}
+		catch(error) {
+			reject(error);
+		}
+	});
+}

package/lib/facades/methods/index.js

@@ -0,0 +1,173 @@
+const Params = require('nodester/params');
+
+
+module.exports = {
+	getOne: _getOne,
+	getMany: _getMany,
+	createOne: _createOne,
+	updateOne: _updateOne,
+	deleteOne: _deleteOne
+}
+
+
+/*
+ *
+ * @param {Object} params
+ *
+ * @alias getOne
+ * @api public
+ */
+async function _getOne(params) {
+	try {
+		const {
+			query
+		} = Params(params, {
+			query: {}
+		});
+
+		const instance = await this.model.findOne(query);
+
+		const result = {
+			[this.modelName.singular]: instance,
+			count: 0 + instance !== null
+		}
+		return Promise.resolve(result);
+	}
+	catch(error) {
+		return Promise.reject(error);
+	}
+}
+
+
+/*
+ *
+ * @param {Object} params
+ *
+ * @alias getMany
+ * @api public
+ */
+async function _getMany(params) {
+	try {
+		const {
+			query
+		} = Params(params, {
+			query: {}
+		});
+
+		const instances = await this.model.findAll(query);
+
+		const result = {
+			[this.modelName.plural]: instances,
+			count: instances.length
+		}
+		return Promise.resolve(result);
+	}
+	catch(error) {
+		return Promise.reject(error);
+	}
+}
+
+
+/*
+ *
+ * @param {Object} params
+ *
+ * @alias createOne
+ * @api public
+ */
+async function _createOne(params) {
+	try {
+		const {
+			data,
+			includes,
+		} = Params(params, {
+			data: null,
+			includes: null,
+		});
+
+		const instance = await this.model.create({ ...data }, {
+			include: this.model.getIncludesList(data)
+		});
+
+		// If includes are set, "find" this record with includes:
+		if (!!includes && includes?.length > 0) {
+			await instance.reload({ include: includes });
+		}
+
+		const result = {
+			[this.modelName.singular]: instance,
+			count: instance === null ? 0 : 1
+		}
+
+		// Call after create.
+		await this.afterCreateOne(instance, params, result);
+
+		return Promise.resolve(result);
+	}
+	catch(error) {
+		return Promise.reject(error);
+	}
+}
+
+
+/*
+ *
+ * @param {Object} params
+ *
+ * @alias updateOne
+ * @api public
+ */
+async function _updateOne(params) {
+	try {
+		const {
+			query,
+			data
+		} = Params(params, {
+			query: {},
+			data: null
+		});
+
+		const updateResult = await this.model.updateOne(query.where, data);;
+
+		const [ isNewRecord, instance ] = updateResult;
+
+		const result = {
+			success: isNewRecord === false,
+			[this.modelName.singular]: instance,
+			count: !!instance ? 1 : 0
+		}
+		return Promise.resolve(result);
+	}
+	catch(error) {
+		return Promise.reject(error);
+	}
+}
+
+
+/*
+ *
+ * @param {Object} params
+ *
+ * @alias deleteOne
+ * @api public
+ */
+async function _deleteOne(params) {
+	try {
+		const {
+			query
+		} = Params(params, {
+			query: null
+		});
+
+		const count = await this.model.deleteOne(query);
+
+		const result = {
+			success: count > 0,
+			count: count
+		};
+		return Promise.resolve(result);
+	}
+	catch(error) {
+		return Promise.reject(error);
+	}
+}