nodester 0.0.8 → 0.1.0

package/lib/router/routes.util.js

@@ -11,10 +11,21 @@ const { parseRouteHandler } = require('./handlers.util');
 
 
 module.exports = {
+	validateParsedRouteMethood: _validateParsedRouteMethood,
 	wrapRouteHandler: _wrapRouteHandler
 }
 
 
+function _validateParsedRouteMethood(parsedRoute) {
+	if (!parsedRoute || parsedRoute?.method === undefined) {
+		const err = new TypeError(`"route" should start with one of the following methods: [GET, POST, PUT, DELETE, QUERY, HEADER, OPTIONS]`);
+		throw err;
+	}
+
+	return true;
+}
+
+
 /**
 	 * Wraps route handler.
 	 *
@@ -48,17 +59,36 @@ function _wrapRouteHandler(routeInstance, handler) {
 		else {
 			const parsedHandler = parseRouteHandler(handler);
 
-			// Get provided method from controller:
-			const controller = this._controllers.get(parsedHandler.controllerName);
-			const controllerAction = controller[parsedHandler.actionName];
+			let providedAction = null;
+
+			// If Controller:
+			if (parsedHandler.controllerName !== undefined) {
+				// Get method (action) from Controller:
+				const controller = this._controllers.get(parsedHandler.controllerName);
+				const controllerAction = controller[parsedHandler.actionName];
 
-			// If User set any middleware before, call it first:
+				providedAction = controllerAction;
+			}
+			// If Controller\
+
+			// If Provider:
+			else {
+				// Get method (action) from Provider:
+				const provider = this._providers.get(parsedHandler.providerName);
+				const providerAction = provider[parsedHandler.actionName];
+
+				providedAction = providerAction;
+			}
+			// If Provider\
+			
+			// If User set any handler before,
+			// call it first:
 			if (typeOf(parsedHandler.before) === 'function') {
 				// Expose nquery first.
 				await parsedHandler.before(req.nquery, req, res);
 			}
 
-			await controllerAction(req, res);
+			await providedAction(req, res);
 		}
 	};
 

package/lib/router/utils.js

@@ -0,0 +1,30 @@
+
+module.exports = {
+	parseProviderFileNames: _parseProviderFileNames
+}
+
+function _parseProviderFileNames(fileNames, availableFileExtensions, term='controller') {
+	const resultNames = [];
+
+	for (const fileName of fileNames) {
+
+		const nameParts = fileName.split('.');
+		const extension = nameParts.pop();
+		if (availableFileExtensions.indexOf(extension) === -1) {
+			continue;
+		}
+
+		// If the name format is <model>.<term>,
+		// but second part is not "term":
+		if (nameParts.length > 1 && nameParts[1] !== term)
+			continue;
+
+		const result = {
+			fileName: fileName,
+			[`${ term }Name`]: nameParts[0]
+		}
+		resultNames.push(result);
+	}
+
+	return resultNames;
+}

package/package.json

@@ -1,20 +1,30 @@
 {
   "name": "nodester",
-  "version": "0.0.8",
+  "version": "0.1.0",
   "description": "A boilerplate framework for Node.js",
   "exports": {
     ".": "./lib/application/index.js",
+    "./controllers/methods": "./lib/controllers/methods/index.js",
     "./controllers/mixins": "./lib/controllers/mixins/index.js",
-    "./controllers/methods": "./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",
+    "./middlewares/formidable": "./lib/middlewares/formidable/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"
+    "./router": "./lib/router/index.js",
+    "./utils/strings": "./lib/utils/strings.util.js"
   },
   "directories": {
     "doc": "docs"
@@ -23,9 +33,8 @@
     "lib"
   ],
   "scripts": {
-    "examples:rest": "node ./examples/rest/index.js",
-    "examples:nql": "node ./examples/nql/index.js",
-    "test": "jest"
+    "test": "jest",
+    "examples:rest": "node ./examples/rest/index.js"
   },
   "author": "Mark Khramko <markkhramko@gmail.com>",
   "license": "MIT",
@@ -49,6 +58,7 @@
   "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",
@@ -57,10 +67,13 @@
     "debug": "^4.3.4",
     "etag": "^1.8.1",
     "finalhandler": "^1.2.0",
-    "formidable": "^1.2.6",
+    "formidable": "^3.5.1",
     "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/nql.test.js

@@ -73,7 +73,7 @@ describe('nodester Query Language', () => {
 		tree.node.limit = 3;
 		tree.node.skip = 10;
 		tree.node.order = 'desc';
-		tree.node.orderBy = 'index';
+		tree.node.order_by = 'index';
 		const expected = tree.root.toObject();
 
 		expect(result).toMatchObject(expected);
@@ -103,7 +103,7 @@ describe('nodester Query Language', () => {
 		tree.node.limit = 3;
 		tree.node.skip = 10;
 		tree.node.order = 'desc';
-		tree.node.orderBy = 'index';
+		tree.node.order_by = 'index';
 		const expected = tree.root.toObject();
 
 		expect(result).toMatchObject(expected);
@@ -157,7 +157,7 @@ describe('nodester Query Language', () => {
 		tree.include('users');
 		tree.include('likes') && tree.use('likes');
 		tree.node.order = 'rand';
-		tree.node.orderBy = 'position';
+		tree.node.order_by = 'position';
 		tree.up();
 		const expected = tree.root.toObject();
 

package/lib/_/n_controllers/Controller.js

@@ -1,474 +0,0 @@
-// Constants.
-const VISITOR = 'visitor';
-// Data extractor:
-const Extractor = require('nodester/models/Extractor');
-// Preprocessors:
-const QueryPreprocessor = require('nodester/preprocessors/QueryPreprocessor');
-const BodyPreprocessor = require('nodester/preprocessors/BodyPreprocessor');
-// Reponse protocol generator.
-const APIResponseFactory = require('nodester/factories/responses/api');
-// Custom error.
-const { Err } = require('nodester/factories/errors');
-
-
-module.exports = class Controller {
-	constructor({
-		modelFacade,
-
-		queryPreprocessor,
-		bodyPreprocessor,
-
-		apiResponseFactory,
-
-		// Options.
-		withFiles,
-	}) {
-		if (!modelFacade) {
-			throw new Error('"modelFacade" argument is invalid.');
-		}
-		
-		// Main model.
-		const model = modelFacade?.model;
-		
-		// Set main services & utils:
-		this.extractor = new Extractor(model, { withFiles: !!withFiles });
-		this.facade = modelFacade;
-
-		// Set preprocessors:
-		// TODO: includes preprocessor.
-		this.queryPreprocessor = queryPreprocessor ?? new QueryPreprocessor();
-		this.bodyPreprocessor = bodyPreprocessor ?? null;
-
-		// Extract plural name of model.
-		const modelPluralName = model?.options?.name?.plural;
-		// Set private name of this controller.
-		this.name = `${modelPluralName ?? '_INVALID_NAME_'}Controller`;
-		
-		// Init standard API response factory.
-		const standardAPIResponseFactory = new APIResponseFactory();
-		// Set response factory:
-		this.createOKResponse = apiResponseFactory?.createOKResponse ?? 
-														standardAPIResponseFactory.createOKResponse.bind(standardAPIResponseFactory);
-		this.createErrorResponse = apiResponseFactory?.createErrorResponse ??
-															 standardAPIResponseFactory.createErrorResponse.bind(standardAPIResponseFactory);
-	}
-
-	processError(error, req, res) {
-		// Default error message.
-		let errorMessage = error?.message ?? 'Internal server error';
-		// Default HTTP status code.
-		let statusCode = error?.status ?? error?.statusCode ?? 500;
-		// Error response object.
-		let errorResponse = {};
-
-		switch(error.name) {
-			case('Unauthorized'): {
-				statusCode = 401;
-				errorResponse.details = { message: 'Unauthorized' };
-				break;
-			}
-			case('NotFound'): {
-				statusCode = 404;
-				errorResponse.details = { message: errorMessage };
-				break;
-			}
-			case('ValidationError'): {
-				statusCode = 406;
-				errorResponse.details = error?.details;
-				break;
-			}
-			case('ConflictError'): {
-				statusCode = 409;
-				errorResponse.details = error?.details ?? error?.message;
-				break;
-			}
-			case('SequelizeUniqueConstraintError'): {
-				statusCode = 409;
-				errorResponse.details = error?.errors;
-				break;
-			}
-			case('InternalValidationError'): {
-				statusCode = 500;
-				errorResponse.details = { message:'Error' };
-				break;
-			}
-			default: {
-				errorResponse.details = { message:errorMessage };
-				break;
-			}
-		}
-
-		// Send error response with provided status code.
-		return this.createErrorResponse({
-			res,
-			error: {
-				...errorResponse,
-				code: statusCode
-			},
-			status: statusCode
-		});
-	}
-
-	/* POST: */
-	async createOne(req, res) {
-		try {
-			// Extract all required info:
-			const {
-				// query,
-				includes
-			} = await this.extractQuery(req, res);
-
-			// Extract request's body.
-			const { body } = await this.extractBody(req, res);
-
-			// Extract new instance data.
-			const data = this.extractor.extractInstanceDataFromObject(
-										body,
-										includes,
-										{
-											skipIdValidation: true
-										});
-
-			const result = await this.facade.createOne({ data, includes });
-
-			// Hook.
-			await this.afterCreateOne(req, res, result);
-			
-			return this.createOKResponse({
-				res, 
-				content: { ...result }
-			});
-		}
-		catch(error) {
-			console.error(`${ this.name }.createOne error:`, error);
-			return this.processError(error, req, res);
-		}
-	}
-	/* POST\ */
-
-	/* GET: */
-	async getOne(req, res) {
-		try {
-			// Extract all required info:
-			const {
-				query,
-				includes
-			} = await this.extractQuery(req, res);
-
-			const params = {
-				query,
-				includes,
-			}
-
-			// If Query or Params contains main identifier (id),
-			// validate it:
-			if (!!query.id) {
-				// Extract main identifier.
-				const { id } = this.extractor.extractInstanceDataFromObject(
-												query,
-												null,
-												{
-													skipValidation: true
-												});
-				params.id = id;
-			}
-			// If Request's Params contains main identifier (id),
-			// validate it:
-			else if (!!req.params.id) {
-				// Extract main identifier.
-				const { id } = this.extractor.extractInstanceDataFromObject(
-												req.params,
-												null,
-												{
-													skipValidation: true
-												});
-				params.id = id;
-			}
-
-			const result = await this.facade.getOne(params);
-
-			return this.createOKResponse({
-				res, 
-				content: { ...result }
-			});
-		}
-		catch(error) {
-			console.error(`${ this.name }.getOne error:`, error);
-			return this.processError(error, req, res);
-		}
-	}
-
-	async getMany(req, res) {
-		try {
-			// Extract all required info:
-			const {
-				query,
-				includes
-			} = await this.extractQuery(req, res);
-
-			const params = {
-				query,
-				includes,
-			}
-
-			// If Query contains main identifier (id),
-			// validate it:
-			if (!!query.id) {
-				// Extract main identifier.
-				const { id } = this.extractor.extractInstanceDataFromObject(
-												query,
-												null,
-												{
-													skipValidation: true
-												});
-				params.query.id = id;
-			}
-			// If Request's Params contains main identifier (id),
-			// validate it:
-			else if (!!req.params.id) {
-				// Extract main identifier.
-				const { id } = this.extractor.extractInstanceDataFromObject(
-												req.params,
-												null,
-												{
-													skipValidation: true
-												});
-				params.query.id = id;
-			}
-
-			const result = await this.facade.getMany(params);
-
-			return this.createOKResponse({
-				res, 
-				content: { ...result }
-			});
-		}
-		catch(error) {
-			console.error(`${ this.name }.getMany error:`, error);
-			return this.processError(error, req, res);
-		}
-	}
-	/* GET\ */
-
-	/* PUT: */
-	async updateOne(req, res) {
-		try {
-			// Extract all required info:
-			const {
-				query,
-				includes
-			} = await this.extractQuery(req, res);
-
-			// Extract request's body.
-			const { body } = await this.extractBody(req, res);
-
-			// Init facade params.
-			const facadeParams = {
-				query,
-				includes,
-			};
-
-			// If request params contain main identifier (id),
-			// extract & validate it:
-			if (!!req.params.id) {
-				// Extract main identifier.
-				facadeParams.query.id = parseInt(req.params.id);
-			}
-			// If Query contains main identifier (id),
-			// validate it:
-			else if (!!query.id) {
-				// Extract main identifier.
-				const { id } = this.extractor.extractInstanceDataFromObject(
-												query,
-												null,
-												{
-													skipValidation: true
-												});
-				facadeParams.query.id = id;
-			}
-			// Extract instance data.
-			const data = this.extractor.extractInstanceDataFromObject(
-										body,
-										includes,
-										{
-											skipIdValidation: true,
-											skipValidation: true
-										});
-			facadeParams.data = data;
-
-			const result = await this.facade.updateOne(facadeParams);
-
-			// Hook.
-			await this.afterUpdateOne(req, res, result);
-			
-			return this.createOKResponse({
-				res, 
-				content: { ...result }
-			});
-		}
-		catch(error) {
-			console.error(`${ this.name }.updateOne error:`, error);
-			return this.processError(error, req, res);
-		}
-	}
-
-	/* ! Warning !
-	 * Unfinished method
-	 * Do not use!
-	 */
-	async updateMany(req, res) {
-		try {
-			// Extract all required info:
-			const {
-				query,
-				includes
-			} = await this.extractQuery(req, res);
-
-			// If Query contains main identifier (id),
-			// extract & validate it:
-			if (!!query.id) {
-				// Extract main identifier.
-				const { id } = this.extractor.extractInstanceDataFromObject(
-												query,
-												null,
-												{
-													skipValidation: true
-												});
-				query.id = id;
-			}
-			
-			// Extract data array:
-			const data = this.extractor.extractArrayDataFromObject(
-										req.body,
-										{
-											skipIdValidation: true,
-											skipValidation: true
-										});
-
-			console.log("Controller.updateMany", { data });
-
-			// TODO: Finish procedure
-			return;
-			// const result = await this.facade.updateMany({ data, includes });
-
-			// return this.createOKResponse({
-			// 	res,
-			// 	content: { ...result }
-			// });
-		}
-		catch(error) {
-			console.error(`${ this.name }.updateMany error:`, error);
-			return this.processError(error, req, res);
-		}
-	}
-	/* PUT\ */
-
-	/* DELETE: */
-	async deleteOne(req, res) {
-		try {
-			// Extract main identifier.
-			const { id } = this.extractor.extractInstanceDataFromObject(
-											req.params,
-											null,
-											{
-												skipValidation: true
-											});
-
-			const result = await this.facade.deleteOne({ id });
-
-			// Hook.
-			await this.afterDeleteOne(req, res, result);
-			
-			return this.createOKResponse({
-				res, 
-				content: { ...result }
-			});
-		}
-		catch(error) {
-			console.error(`${ this.name }.deleteOne error:`, error);
-			return this.processError(error, req, res);
-		}
-	}
-	/* DELETE\ */
-
-	/*
-	 * Hooks:
-	 */
-	async afterCreateOne(
-		req, res,
-		facadeResult
-	) {
-		// This method is empty, as it should be overwritten.
-		const content = { ...facadeResult };
-		return Promise.resolve(content);
-	}
-
-	async afterUpdateOne(
-		req, res,
-		facadeResult
-	) {
-		// This method is empty, as it should be overwritten.
-		const content = { ...facadeResult };
-		return Promise.resolve(content);
-	}
-
-	async afterDeleteOne(
-		req, res,
-		facadeResult
-	) {
-		// This method is empty, as it should be overwritten.
-		const content = { ...facadeResult };
-		return Promise.resolve(content);
-	}
-	/*
-	 * Hooks\
-	 */
-
-	// Preprocessors:
-	async extractQuery(req, res) {
-		try {
-			// Extract role.
-			const role = req?.token?.parsed?.role ?? VISITOR;
-
-			// Extract query:
-			const query = await this.queryPreprocessor.extract(
-											req,
-											role,
-										);
-			const { includes } = req.query;
-
-			return Promise.resolve({
-				query,
-				includes,
-			});
-		}
-		catch(error) {
-			return Promise.reject(error);
-		}
-	}
-
-	async extractBody(req, res, externalBodyObject=null) {
-		try {
-			// Extract role.
-			const role = req?.token?.parsed?.role ?? VISITOR;
-
-			// Extract body:
-			let body = externalBodyObject ?? req.body;
-
-			if (!!this.bodyPreprocessor) {
-				body = await this.bodyPreprocessor.extract(
-												req,
-												role,
-											);
-			}
-
-			return Promise.resolve({
-				body,
-			});
-		}
-		catch(error) {
-			return Promise.reject(error);
-		}
-	}
-	// Preprocessors\
-}