nodester 0.0.2 → 0.0.3

package/lib/controllers/mixins/index.js

@@ -170,7 +170,7 @@ function _withDefaultErrorProcessing(controller, opts={}) {
 			}
 			case('InternalValidationError'): {
 				statusCode = 500;
-				errorResponse.details = { message:'Error' };
+				errorResponse.details = { message: 'Error' };
 				break;
 			}
 			default: {
@@ -181,7 +181,7 @@ function _withDefaultErrorProcessing(controller, opts={}) {
 
 		// Send error response with provided status code:
 		const data = {
-				error: {
+			error: {
 				...errorResponse,
 				code: statusCode
 			},

package/lib/router/handlers.util.js

@@ -26,19 +26,24 @@ function _parseRouteHandler(routeHandler={}) {
 	}
 
 	const result = {
+		actionName: undefined,
 		before: null,
 		controllerName: undefined,
-		actionName: undefined,
+		providerName: undefined
 	};
 
 	const {
+		action,
 		before,
 
 		controller,
 		controlledBy,
-		action
+
+		provider,
+		providedBy,
 	} = routeHandler;
 
+	// Controllers:
 	if (!!controlledBy) {
 		const parts = controlledBy.split('.');
 		const controllerName = parts[0];
@@ -49,6 +54,21 @@ function _parseRouteHandler(routeHandler={}) {
 	else if (!!controller) {
 		result.controllerName = `${ controller }`;
 	}
+	// Controllers\
+
+	// Providers:
+	else if (!!providedBy) {
+		const parts = providedBy.split('.');
+		const providerName = parts[0];
+		const actionName = parts[1];
+		result.providerName = providerName;
+		result.actionName = actionName;
+	}
+	else if (!!provider) {
+		result.providerName = `${ provider }`;
+	}
+	// Providers\
+	
 	else if (!!action) {
 		result.actionName = `${ action }`;
 	}

package/lib/router/index.js

@@ -11,6 +11,7 @@ const Route = require('./route');
 // Utils:
 const { typeOf } = require('../utils/types.util');
 const { wrapRouteHandler } = require('./routes.util');
+const { parseProviderFileNames } = require('./utils');
 //	File system:
 const Path = require('path');
 const fs = require('fs');
@@ -34,14 +35,17 @@ module.exports = class NodesterRouter {
 	 * @api public
 	 */
 	constructor(opts={}) {
+		// Reference to the controllers stack.
+		this._controllers = new Map();
+
 		// Reference to middlewares stack.
 		this._middlewares = new MiddlewareStack({ finalhandlerEnabled: !!opts.finalhandlerEnabled });
 
 		// Reference to the markers stack.
 		this._markers = new MarkersStack();
 
-		// Reference to the controllers stack.
-		this._controllers = new Map();
+		// Reference to the providers stack.
+		this._providers = new Map();
 
 		this.codeFileExtensions = commonExtensions.code;
 		this.paths = {};
@@ -55,29 +59,20 @@ module.exports = class NodesterRouter {
 			this.codeFileExtensions = [...opts.codeFileExtensions];
 		}
 
-		//	If "controllersPath" was set, cache all controllers in directory:
+		//	If "controllersPath" was set,
+		//	cache all controllers in directory:
 		if (!!opts.controllersPath) {
 			// Save path.
 			this.paths.controllers = opts.controllersPath;
 
-			const availableFileExtensions = this.codeFileExtensions;
 			// Only get files, which have available file extensions:
+			const availableFileExtensions = this.codeFileExtensions;
 			const fileNames = fs.readdirSync(this.paths.controllers);
-			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>.<controller>,
-				// but second part is not "controller":
-				if (nameParts.length > 1 && nameParts[1] !== 'controller')
-					continue;
+			const controllersNames = parseProviderFileNames(fileNames, availableFileExtensions, 'controller');
 
+			for (const { fileName, controllerName } of controllersNames) {
 				const controller = require(Path.join(this.paths.controllers, fileName));
-				const controllerName = nameParts[0];
 				this.addController(controller, controllerName);
 			}
 		}
@@ -94,6 +89,37 @@ module.exports = class NodesterRouter {
 				this.addController(controllerDefinition, controllerName);
 			}
 		}
+
+		//	If "providersPath" was set,
+		//	cache all providers in directory:
+		if (!!opts.providersPath) {
+			// Save path.
+			this.paths.providers = opts.providersPath;
+
+			// Only get files, which have available file extensions:
+			const availableFileExtensions = this.codeFileExtensions;
+			const fileNames = fs.readdirSync(this.paths.providers);
+
+			const providersNames = parseProviderFileNames(fileNames, availableFileExtensions, 'provider');
+
+			for (const { fileName, providerName } of providersNames) {
+				const provider = require(Path.join(this.paths.providers, fileName));
+				this.addProvider(provider, providerName);
+			}
+		}
+
+		//	If "providers" were provided as an Object:
+		if (!!opts.providers) {
+			if (typeOf(opts.providers) !== 'Object') {
+				const err = new TypeError(`"providers" must be an Object.`);
+				throw err;
+			}
+
+			const entities = Object.entities(opts.providers);
+			for (const [providerName, providerDefinition] of entities) {
+				this.addProvider(providerDefinition, providerName);
+			}
+		}
 	}
 
 
@@ -111,6 +137,7 @@ module.exports = class NodesterRouter {
 			controller: this.addController.bind(this),
 			middleware: this.addMiddleware.bind(this),
 			marker: this.addMarker.bind(this),
+			provider: this.addProvider.bind(this),
 			route: this.addRoute.bind(this),
 			routes: this.addRoutes.bind(this),
 		}
@@ -182,6 +209,33 @@ module.exports = class NodesterRouter {
 	}
 
 
+	/*
+	 * Adds new provider to the providers stack.
+	 *
+	 * @param {Function|Object} provider
+	 * @param {String} providerName
+	 *
+	 * @api public
+	 */
+	addProvider(fnOrObject, providerName=null) {
+		const providerType = typeOf(fnOrObject);
+		const name = providerName ?? fnOrObject?.name ?? fnOrObject.constructor.name;
+
+		// If provider was exported as Object:
+		if (providerType === 'Object') {
+			this._providers.set(name, fnOrObject);
+		}
+		// If provider was exported as a constructor function:
+		else if (providerType === 'function') {
+			this._providers.set(name, new fnOrObject());
+		}
+		else {
+			const err = new TypeError(`Please check how you exported ${ name }, it should be either Object or constructor function.`);
+			throw err;
+		}
+	}
+
+
 	/*
 	 * Creates route middleware and adds it to the stack.
 	 *
@@ -200,8 +254,9 @@ module.exports = class NodesterRouter {
 			throw err;
 		}
 
-		if (handlerType === 'Object' && !this.paths.controllers) {
-			const err = new TypeError(`Please set "controllersPath" during Router initialization.`);
+		if (handlerType === 'Object' && !this.paths.controllers && !this.paths.providers) {
+			const msg = `Please set "controllersPath" or "providersPath" during Router initialization.`;
+			const err = new TypeError(msg);
 			throw err;
 		}
 

package/lib/router/routes.util.js

@@ -48,17 +48,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 User set any middleware before, call it first:
+			// If Controller:
+			if (parsedHandler.controllerName !== undefined) {
+				// Get method (action) from Controller:
+				const controller = this._controllers.get(parsedHandler.controllerName);
+				const controllerAction = controller[parsedHandler.actionName];
+
+				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,6 +1,6 @@
 {
   "name": "nodester",
-  "version": "0.0.2",
+  "version": "0.0.3",
   "description": "A boilerplate framework for Node.js",
   "exports": {
     ".": "./lib/application/index.js",