nodester 0.1.4 → 0.2.0

package/lib/router/index.js

@@ -5,11 +5,13 @@
 
 'use strict';
 
-const MiddlewareStack = require('../stacks/MiddlewareStack');
+const MiddlewaresStack = require('nodester/stacks/middlewares');
 const Route = require('./route');
+
 // Markers:
 const MarkersStack = require('../stacks/MarkersStack');
 const MarkerMethods = require('./markers');
+
 // Utils:
 const { typeOf } = require('../utils/types.util');
 const {
@@ -21,7 +23,11 @@ const { parseProviderFileNames } = require('./utils');
 const Path = require('path');
 const fs = require('fs');
 const commonExtensions = require('common-js-file-extensions');
-//	Debug & console:
+
+// Arguments validator.
+const { ensure } = require('../validators/arguments');
+
+// Console:
 const consl = require('nodester/loggers/console');
 const debug = require('debug')('nodester:router');
 
@@ -31,11 +37,11 @@ module.exports = class NodesterRouter {
 	/**
 	 * Initialize a new `NodesterRouter`.
 	 *
-	 * @param {Object} opts
-	 * - {Array} codeFileExtensions
-	 * - {String} controllersPath
-	 * - {Object} controllers
-	 * - {Boolean} finalhandlerEnabled
+	 * @param {Object}  [opts]
+	 * @param {Array} 	opts.codeFileExtensions
+	 * @param {String} 	opts.controllersPath
+	 * @param {Object} 	opts.controllers
+	 * @param {Boolean} opts.finalhandlerEnabled
 	 *
 	 * @api public
 	 */
@@ -44,7 +50,7 @@ module.exports = class NodesterRouter {
 		this._controllers = new Map();
 
 		// Reference to middlewares stack.
-		this._middlewares = new MiddlewareStack({ finalhandlerEnabled: !!opts.finalhandlerEnabled });
+		this._middlewares = new MiddlewaresStack({ finalhandlerEnabled: !!opts.finalhandlerEnabled });
 
 		// Reference to the markers stack.
 		this._markers = new MarkersStack();
@@ -55,9 +61,6 @@ module.exports = class NodesterRouter {
 		this.codeFileExtensions = commonExtensions.code;
 		this.paths = {};
 
-		// Indicates whether we can add more middlewares or no.
-		this.isLocked = false;
-
 		// Options:
 		//	if "codeFileExtensions" was set:
 		if (!!opts.codeFileExtensions && Array.isArray(opts.codeFileExtensions)) {
@@ -84,10 +87,7 @@ module.exports = class NodesterRouter {
 
 		//	If "controllers" were provided as an Object:
 		if (!!opts.controllers) {
-			if (typeOf(opts.controllers) !== 'Object') {
-				const err = new TypeError(`"controllers" must be an Object.`);
-				throw err;
-			}
+			ensure(opts.controllers, 'object,required', 'opts.controllers');
 
 			const entities = Object.entities(opts.controllers);
 			for (const [controllerName, controllerDefinition] of entities) {
@@ -115,10 +115,7 @@ module.exports = class NodesterRouter {
 
 		//	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;
-			}
+			ensure(opts.providers, 'object,required', 'opts.providers');
 
 			const entities = Object.entities(opts.providers);
 			for (const [providerName, providerDefinition] of entities) {
@@ -127,13 +124,38 @@ module.exports = class NodesterRouter {
 		}
 	}
 
+	// Getters:
+
+	/**
+	 * @return {MiddlewaresStack}
+	 *
+	 * @api public
+	 */
+	get middlewaresStack() {
+		return this._middlewares;
+	}
+
+	/**
+	 * Indicates whether user can add more middlewares or not.
+	 *
+	 * @return {Boolean} isLocked
+	 *
+	 * @api public
+	 */
+	get isLocked() {
+		return this._middlewares.isLocked;
+	}
+
+	// Getters\
 
 	/*
 	 * Adds:
-	 * - (controller) new controller to the stack;
-	 * - (middleware) new middleware to the stack;
-	 * - (marker) new marker to the stack;
-	 * - (route) new route to the stack;
+	 * - (controller) new Controller to the stack;
+	 * - (middleware) new Middleware to the stack;
+	 * - (provider) new Provicer to the stack;
+	 * - (marker) new Marker to the stack;
+	 * - (route) new Route to the stack;
+	 * - (routes) array[Route] to the stack;
 	 *
 	 * @api public
 	 */
@@ -157,21 +179,29 @@ module.exports = class NodesterRouter {
 	 *
 	 * @api public
 	 */
-	addController(fnOrObject, controllerName=null) {
-		const controllerType = typeOf(fnOrObject);
-		const name = controllerName ?? fnOrObject?.name ?? fnOrObject.constructor.name;
+	addController(controller, controllerName=null) {
+		try {
+			ensure(controller, 'object|function,required', 'controller');
 
-		// If controller was exported as Object:
-		if (controllerType === 'Object') {
-			this._controllers.set(name, fnOrObject);
-		}
-		// If controller was exported as a constructor function:
-		else if (controllerType === 'function') {
-			this._controllers.set(name, new fnOrObject());
+			const controllerType = typeOf(controller);
+			const name = controllerName ?? controller?.name ?? controller.constructor.name;
+
+			// If controller was exported as Object:
+			if (controllerType === 'Object') {
+				this._controllers.set(name, controller);
+			}
+			// If controller was exported as a constructor function:
+			else if (controllerType === 'function') {
+				this._controllers.set(name, new controller());
+			}
+			else {
+				const err = new TypeError(`Please check how you exported '${ name }', it should be either Object or a constructor function.`);
+				throw err;
+			}
 		}
-		else {
-			const err = new TypeError(`Please check how you exported ${ name }, it should be either Object or constructor function.`);
-			throw err;
+		catch(error) {
+			Error.captureStackTrace(error, this.addController);
+			throw error;
 		}
 	}
 
@@ -182,12 +212,21 @@ module.exports = class NodesterRouter {
 	 * @param {Function} fn
 	 * @param {Integer} index (0 or undefined)
 	 *
-	 * @return {Integer} index of new middleware
+	 * @return {Integer} index of the new middleware
 	 *
 	 * @api public
 	 */
 	addMiddleware(fn, index) {
-		return this._middlewares.add(fn, index);
+		try {
+			ensure(fn, 'function,required', 'fn');
+			ensure(index, 'number', 'index');
+
+			return this._middlewares.add(fn, index);
+		}
+		catch(error) {
+			Error.captureStackTrace(error, this.addMiddleware);
+			throw error;
+		}
 	}
 
 
@@ -200,17 +239,26 @@ module.exports = class NodesterRouter {
 	 * @api public
 	 */
 	addMarker(markerName='', fn) {
-		if (markerName.length > 0 && markerName.indexOf('/') > -1) {
-			const err = new TypeError(`"markerName" can't contain slashes "/"`);
-			throw err;
-		}
+		try {
+			ensure(markerName, 'string,required', 'markerName');
+			ensure(fn, 'function,required', 'fn');
 
-		if (this._markers.get(markerName)) {
-			const err = new Error(`Marker with name ${ markerName } is already set.`);
-			throw err;
-		}
+			if (markerName.length > 0 && markerName.indexOf('/') > -1) {
+				const err = new TypeError(`'markerName' can't contain slashes '/'.`);
+				throw err;
+			}
 
-		this._markers.add(markerName, fn);
+			if (this._markers.get(markerName)) {
+				const err = new Error(`Marker with a name '${ markerName }' is already set.`);
+				throw err;
+			}
+
+			this._markers.add(markerName, fn);
+		}
+		catch(error) {
+			Error.captureStackTrace(error, this.addMarker);
+			throw error;
+		}
 	}
 
 
@@ -222,21 +270,30 @@ module.exports = class NodesterRouter {
 	 *
 	 * @api public
 	 */
-	addProvider(fnOrObject, providerName=null) {
-		const providerType = typeOf(fnOrObject);
-		const name = providerName ?? fnOrObject?.name ?? fnOrObject.constructor.name;
+	addProvider(provider, providerName=null) {
+		try {
+			ensure(provider, 'object|function,required', 'provider');
+			ensure(providerName, 'string', 'providerName');
 
-		// 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());
+			const providerType = typeOf(provider);
+			const name = providerName ?? provider?.name ?? provider.constructor.name;
+
+			// If provider was exported as Object:
+			if (providerType === 'Object') {
+				this._providers.set(name, provider);
+			}
+			// If provider was exported as a constructor function:
+			else if (providerType === 'function') {
+				this._providers.set(name, new provider());
+			}
+			else {
+				const err = new TypeError(`Please check how you exported ${ name }, it should be either Object or constructor function.`);
+				throw err;
+			}
 		}
-		else {
-			const err = new TypeError(`Please check how you exported ${ name }, it should be either Object or constructor function.`);
-			throw err;
+		catch(error) {
+			Error.captureStackTrace(error, this.addProvider);
+			throw error;
 		}
 	}
 
@@ -250,20 +307,29 @@ module.exports = class NodesterRouter {
 	 * @api public
 	 */
 	addRoute(route='', handler) {
-		const parsedRoute = new Route(route);
-		// Will throw exception if not valid.
-		validateParsedRouteMethood(parsedRoute);
-		
-		const handlerType = typeOf(handler);
-
-		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;
-		}
+		try {
+			ensure(route, 'string,required', 'route');
+			ensure(handler, 'object|function,required', 'handler');
+
+			const parsedRoute = new Route(route);
+			// Will throw exception if not valid.
+			validateParsedRouteMethood(parsedRoute);
+			
+			const handlerType = typeOf(handler);
+
+			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;
+			}
 
-		const wrapped = wrapRouteHandler.call(this, parsedRoute, handler);
-		return this.addMiddleware(wrapped);
+			const wrapped = wrapRouteHandler.call(this, parsedRoute, handler);
+			return this.addMiddleware(wrapped);
+		}
+		catch(error) {
+			Error.captureStackTrace(error, this.addRoute);
+			throw error;
+		}
 	}
 
 
@@ -276,8 +342,16 @@ module.exports = class NodesterRouter {
 	 * @api public
 	 */
 	addRoutes(routes={}) {
-		for (const [route, handler] of Object.entries(routes)) {
-			this.addRoute(route, handler);
+		try {
+			ensure(routes, 'object,required', 'routes');
+
+			for (const [route, handler] of Object.entries(routes)) {
+				this.addRoute(route, handler);
+			}
+		}
+		catch(error) {
+			Error.captureStackTrace(error, this.addRoutes);
+			throw error;
 		}
 	}
 
@@ -290,14 +364,22 @@ module.exports = class NodesterRouter {
 	 * @api public
 	 */
 	use(fnOrRouter) {
-		let fn = fnOrRouter;
+		try {
+			ensure(fnOrRouter, 'object|function,required', 'fnOrRouter');
 
-		// If Router:
-		if (fnOrRouter instanceof NodesterRouter) {
-			fn = fnOrRouter.handle.bind(fnOrRouter);
-		}
+			let fn = fnOrRouter;
 
-		return this.add.middleware(fn);
+			// If Router:
+			if (fnOrRouter instanceof NodesterRouter) {
+				fn = fnOrRouter.handle.bind(fnOrRouter);
+			}
+
+			return this.add.middleware(fn);
+		}
+		catch(error) {
+			Error.captureStackTrace(error, this.use);
+			throw error;
+		}
 	}
 
 
@@ -309,12 +391,20 @@ module.exports = class NodesterRouter {
 	 * @api public
 	 */
 	only(markerName='') {
-		const self = this;
-		const markerFn = this._markers.get(markerName);
+		try {
+			ensure(markerName, 'string,required', 'markerName');
 
-		return {
-			route: (route, fn) => MarkerMethods.onlyRoute.call(self, route, fn, markerFn),
-			use: (fnOrRouter) => MarkerMethods.onlyUse.call(self, fnOrRouter, markerFn),
+			const self = this;
+			const markerFn = this._markers.get(markerName);
+
+			return {
+				route: (route, fn) => MarkerMethods.onlyRoute.call(self, route, fn, markerFn),
+				use: (fnOrRouter) => MarkerMethods.onlyUse.call(self, fnOrRouter, markerFn),
+			}
+		}
+		catch(error) {
+			Error.captureStackTrace(error, this.only);
+			throw error;
 		}
 	}
 
@@ -336,11 +426,8 @@ module.exports = class NodesterRouter {
 	 */
 	lock() {
 		// Stack is ready.
-		this.isLocked = true;
-
-		debug(`router is locked`);
-
 		this._middlewares.lock();
+		debug(`router is locked`);
 	}
 
 
@@ -350,11 +437,8 @@ module.exports = class NodesterRouter {
 	 * @api public
 	 */
 	unlock() {
-		this.isLocked = false;
-
-		debug(`router is unlocked`);
-
 		this._middlewares.unlock();
+		debug(`router is unlocked`);
 	}
 
 
@@ -378,8 +462,16 @@ module.exports = class NodesterRouter {
 	 * @api public
 	 */
 	removeMiddleware(index=-1) {
-		this._middlewares.remove(index);
-		return this._middlewares.length;
+		try {
+			ensure(index, 'number,required', 'index');
+			
+			this._middlewares.remove(index);
+			return this._middlewares.length;
+		}
+		catch(error) {
+			Error.captureStackTrace(error, this.removeMiddleware);
+			throw error;
+		}
 	}
 	
 
@@ -389,14 +481,17 @@ module.exports = class NodesterRouter {
 	 *
 	 * @param {String} key
 	 * @param {Any} fnOrProperty
+	 *
 	 * @return {Any} fnOrProperty in Router
 	 *
 	 * @api public
 	 */
 	extend(key='', fnOrProperty) {
-		const keys = Object.keys(this);
-		if (keys.indexOf(key) > -1) {
-			const err = new TypeError(`Key ${ key } is already present in Router instance`);
+		ensure(key, 'string,required', 'key');
+		ensure(fnOrProperty, 'required', 'fnOrProperty');
+
+		if (typeof this[key] !== 'undefined') {
+			const err = new TypeError(`Key '${ key }' is already present in Router instance.`);
 			throw err;
 		}
 

package/lib/router/markers.js

@@ -1,3 +1,10 @@
+/*!
+ * /nodester
+ * MIT Licensed
+ */
+ 
+'use strict';
+
 const Route = require('./route');
 // Utils.
 const {

package/lib/router/route.js

@@ -8,6 +8,9 @@
 // Utils.
 const { typeOf } = require('../utils/types.util');
 
+// Arguments validator.
+const { ensure } = require('../validators/arguments');
+
 
 module.exports = class NodesterRoute {
 	
@@ -23,6 +26,8 @@ module.exports = class NodesterRoute {
 	 * @api public
 	 */
 	constructor(routeStringOrOpts={}) {
+		ensure(routeStringOrOpts, 'object|string,required', 'routeStringOrOpts');
+		
 		if (typeOf(routeStringOrOpts) === 'Object') {
 			this.method = opts.method ?? undefined;
 			this.route = opts.route ?? null;

package/lib/router/routes.util.js

@@ -27,14 +27,14 @@ function _validateParsedRouteMethood(parsedRoute) {
 
 
 /**
-	 * Wraps route handler.
-	 *
-	 * @param {Route} routeInstance
-	 * @param {Function} handler
-	 *
-	 * @alias wrapRouteHandler
-	 * @api public
-	 */
+ * Wraps route handler.
+ *
+ * @param {Route} routeInstance
+ * @param {Function} handler
+ *
+ * @alias wrapRouteHandler
+ * @api public
+ */
 function _wrapRouteHandler(routeInstance, handler) {
 	const handlerType = typeOf(handler);
 
@@ -81,14 +81,16 @@ function _wrapRouteHandler(routeInstance, handler) {
 			}
 			// If Provider\
 			
-			// If User set any handler before,
-			// call it first:
+			// If User set any middleware before:
 			if (typeOf(parsedHandler.before) === 'function') {
-				// Expose nquery first.
-				await parsedHandler.before(req.nquery, req, res);
+				const _next = () => providedAction(req, res);
+				await parsedHandler.before(req, res, _next);
+			}
+			// If response was not sent,
+			// perform action
+			else if (res.headersSent === false) {
+				await providedAction(req, res);
 			}
-
-			await providedAction(req, res);
 		}
 	};
 

package/lib/router/utils.js

@@ -1,3 +1,10 @@
+/*!
+ * /nodester
+ * MIT Licensed
+ */
+
+'use strict';
+
 
 module.exports = {
 	parseProviderFileNames: _parseProviderFileNames

package/lib/stacks/MarkersStack.js

@@ -1,24 +1,54 @@
+/*!
+ * /nodester
+ * MIT Licensed
+ */
+
+'use strict';
+
+// Arguments validator.
+const { ensure } = require('../validators/arguments');
+
+// Console:
 const consl = require('nodester/loggers/console');
 const debug = require('debug')('nodester:MiddlewareStack');
 
 
+/*
+ * Creates new MarkersStack.
+ *
+ * @return {MarkersStack}
+ *
+ */
 module.exports = class MarkersStack {
 	constructor() {
-		this.markers = new Map();
+		this._markers = new Map();
 	}
 
+	get markers() {
+		return this._markers;
+	}
 
 	/**
 	 * Add the given middleware `fn` to the stack.
 	 *
 	 * @param {String} markerName
 	 * @param {Function} fn
+	 *
 	 * @return {Integer} index of new middleware
 	 *
 	 * @api public
 	 */
 	add(markerName='', fn) {
-		return this.markers.set(markerName, fn);
+		try {
+			ensure(markerName, 'string,required', 'markerName');
+			ensure(fn, 'function,required', 'fn');
+
+			return this._markers.set(markerName, fn);
+		}
+		catch(error) {
+			Error.captureStackTrace(error, this.add);
+			throw error;
+		}
 	}
 
 
@@ -30,6 +60,14 @@ module.exports = class MarkersStack {
 	 * @api public
 	 */
 	get(markerName='') {
-		return this.markers.get(markerName);
+		try {
+			ensure(markerName, 'string,required', 'markerName');
+
+			return this._markers.get(markerName);
+		}
+		catch(error) {
+			Error.captureStackTrace(error, this.get);
+			throw error;
+		}
 	}
 }