nodester 0.0.9 → 0.1.4

package/Readme.md

@@ -28,8 +28,22 @@ app.listen(8080, function() {
 
 ## Documentation
 
+
 ### Core concepts
-[Go to core concepts documentaion](docs/CoreConcepts.md)
+[Core concepts documentation ➡️](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:
+
+[NQR documentaion ➡️](docs/Queries.md)
+
+
+### Database
+Nodester is built upon a powerful [Sequelize](https://sequelize.org/).
+Supported drivers:
+- MySQL
+- PostgreSQL
 
 
 ### Extending Application functionality
@@ -95,7 +109,7 @@ The Philosophy of `nodester` is to provide a developer with a tool that can buil
 
 ### 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,19 +7,27 @@
 
 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 consl = require('nodester/loggers/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/constants/ErrorCodes.js

@@ -0,0 +1,19 @@
+const Enum = require('nodester/enum');
+
+const NODESTER_QUERY_ERROR = 'NodesterQueryError';
+const UNAUTHORIZED_ERROR = 'Unauthorized';
+const NOT_FOUND_ERROR = 'NotFound';
+const VALIDATION_ERROR = 'ValidationError';
+const CONFLICT_ERROR = 'ConflictError';
+const SEQUELIZE_UNIQUE_CONSTRAINT_ERROR = 'SequelizeUniqueConstraintError';
+const INTERNAL_VALIDATION_ERROR = 'InternalValidationError';
+
+module.exports = new Enum({
+	NODESTER_QUERY_ERROR,
+	UNAUTHORIZED_ERROR,
+	NOT_FOUND_ERROR,
+	VALIDATION_ERROR,
+	CONFLICT_ERROR,
+	SEQUELIZE_UNIQUE_CONSTRAINT_ERROR,
+	INTERNAL_VALIDATION_ERROR,
+});

package/lib/constants/Operations.js

@@ -1,4 +1,4 @@
-const Enum = require('../enums/Enum');
+const Enum = require('nodester/enum');
 
 
 module.exports = new Enum({

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

@@ -1,3 +1,13 @@
+const {
+	NODESTER_QUERY_ERROR,
+	UNAUTHORIZED_ERROR,
+	NOT_FOUND_ERROR,
+	VALIDATION_ERROR,
+	CONFLICT_ERROR,
+	SEQUELIZE_UNIQUE_CONSTRAINT_ERROR,
+	INTERNAL_VALIDATION_ERROR
+} = require('nodester/constants/ErrorCodes');
+
 const {
 	getOne,
 	getMany,
@@ -10,6 +20,8 @@ const {
 module.exports = {
 	withDefaultCRUD: _withDefaultCRUD,
 	withDefaultErrorProcessing: _withDefaultErrorProcessing,
+
+	setFacade: _setFacade,
 	setMethod: _setMethod
 }
 
@@ -42,18 +54,7 @@ function _withDefaultCRUD(controller, opts={}) {
 		throw err;
 	}
 
-	if (!facade) {
-		const err = new TypeError(`'opts.facade' argument is invalid.`);
-		throw err;
-	}
-
-	// Set main facade:
-	if (facade.constructor.name === 'Function') {
-		controller.facade = new facade();
-	}
-	else {
-		controller.facade = facade;
-	}
+	_setFacade(controller, facade);
 
 	// Set model info:
 	const model = facade.model;
@@ -134,6 +135,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.
@@ -142,56 +144,102 @@ function _withDefaultErrorProcessing(controller, opts={}) {
 		let errorResponse = {};
 
 		switch(error.name) {
-			case('Unauthorized'): {
+			case UNAUTHORIZED_ERROR: {
 				statusCode = 401;
 				errorResponse.details = { message: 'Unauthorized' };
 				break;
 			}
-			case('NotFound'): {
+			case NOT_FOUND_ERROR: {
 				statusCode = 404;
 				errorResponse.details = { message: errorMessage };
 				break;
 			}
-			case('ValidationError'): {
-				statusCode = 406;
+			case NODESTER_QUERY_ERROR: {
+				statusCode = 422;
+				errorResponse.details = { message: errorMessage };
+				break;
+			}
+			case VALIDATION_ERROR: {
+				statusCode = 422;
 				errorResponse.details = error?.details;
 				break;
 			}
-			case('ConflictError'): {
+			case CONFLICT_ERROR: {
 				statusCode = 409;
 				errorResponse.details = error?.details ?? error?.message;
 				break;
 			}
-			case('SequelizeUniqueConstraintError'): {
+			case SEQUELIZE_UNIQUE_CONSTRAINT_ERROR: {
 				statusCode = 409;
 				errorResponse.details = error?.errors;
 				break;
 			}
-			case('InternalValidationError'): {
+			case INTERNAL_VALIDATION_ERROR: {
 				statusCode = 500;
-				errorResponse.details = { message:'Error' };
+				errorResponse.details = { message: errorMessage };
 				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;
 }
 
 
+/**
+ * Sets one of or all of CRUD methods to Controller.
+ *
+ * @param {Function|Object} controller
+ * @param {Function|Object} facade
+ * @param {String} facadeName
+ *
+ * @return {Function|Object} controller
+ *
+ * @api public
+ * @alias setFacade
+ */
+function _setFacade(controller, facade, facadeName=null) {
+	if (!controller) {
+		const err = new TypeError(`'controller' argument is not provided.`);
+		throw err;
+	}
+
+	if (!facade) {
+		const err = new TypeError(`'facade' argument is invalid.`);
+		throw err;
+	}
+
+	// Set main facade:
+	if (facade.constructor.name === 'Function') {
+		controller[facadeName ?? 'facade'] = new facade();
+	}
+	else {
+		controller[facadeName ?? 'facade'] = facade;
+	}
+}
+
+
 /**
  * Sets one of CRUD methods to 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,180 @@
+const Params = require('nodester/params');
+
+const log = require('nodester/loggers/dev');
+
+
+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) {
+		log.error(`${ [this.modelName.singular] }Facade.getOne error:`, 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) {
+		log.error(`${ [this.modelName.singular] }Facade.getMany error:`, 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: 0 + (instance !== null)
+		}
+
+		// Call after create.
+		await this.afterCreateOne(instance, params, result);
+
+		return Promise.resolve(result);
+	}
+	catch(error) {
+		log.error(`${ [this.modelName.singular] }Facade.createOne error:`, 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: 0 + (instance !== null)
+		}
+		return Promise.resolve(result);
+	}
+	catch(error) {
+		log.error(`${ [this.modelName.singular] }Facade.updateOne error:`, 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) {
+		log.error(`${ [this.modelName.singular] }Facade.deleteOne error:`, error);
+		return Promise.reject(error);
+	}
+}