nodester 0.0.9 → 0.1.4

package/lib/router/index.js

@@ -6,17 +6,23 @@
 'use strict';
 
 const MiddlewareStack = require('../stacks/MiddlewareStack');
-const MarkersStack = require('../stacks/MarkersStack');
 const Route = require('./route');
+// Markers:
+const MarkersStack = require('../stacks/MarkersStack');
+const MarkerMethods = require('./markers');
 // Utils:
 const { typeOf } = require('../utils/types.util');
-const { wrapRouteHandler } = require('./routes.util');
+const {
+	validateParsedRouteMethood,
+	wrapRouteHandler
+} = require('./routes.util');
+const { parseProviderFileNames } = require('./utils');
 //	File system:
 const Path = require('path');
 const fs = require('fs');
 const commonExtensions = require('common-js-file-extensions');
 //	Debug & console:
-const consl = require('../logger/console');
+const consl = require('nodester/loggers/console');
 const debug = require('debug')('nodester:router');
 
 
@@ -34,14 +40,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 +64,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 +94,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 +142,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 +214,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.
 	 *
@@ -191,21 +250,19 @@ module.exports = class NodesterRouter {
 	 * @api public
 	 */
 	addRoute(route='', handler) {
-		const parsed = new Route(route);
-		const handlerType = typeOf(handler);
+		const parsedRoute = new Route(route);
+		// Will throw exception if not valid.
+		validateParsedRouteMethood(parsedRoute);
 		
-		// ToDo: move it to separate validator:
-		if (parsed.method === undefined) {
-			const err = new TypeError(`"route" should start with one of the following methods: [GET, POST, PUT, DELETE, QUERY, HEADER, OPTIONS]`);
-			throw err;
-		}
+		const handlerType = typeOf(handler);
 
-		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;
 		}
 
-		const wrapped = wrapRouteHandler.call(this, parsed, handler);
+		const wrapped = wrapRouteHandler.call(this, parsedRoute, handler);
 		return this.addMiddleware(wrapped);
 	}
 
@@ -228,11 +285,18 @@ module.exports = class NodesterRouter {
 	/*
 	 * Proxy to .add.middleware()
 	 *
-	 * @param {Function} fn
+	 * @param {Function|NodesterRouter} fnOrRouter
 	 *
 	 * @api public
 	 */
-	use(fn) {
+	use(fnOrRouter) {
+		let fn = fnOrRouter;
+
+		// If Router:
+		if (fnOrRouter instanceof NodesterRouter) {
+			fn = fnOrRouter.handle.bind(fnOrRouter);
+		}
+
 		return this.add.middleware(fn);
 	}
 
@@ -249,51 +313,8 @@ module.exports = class NodesterRouter {
 		const markerFn = this._markers.get(markerName);
 
 		return {
-			route: (route, fn) => {
-				const parsed = new Route(route);
-				// ToDo: move it to separate validator:
-				if (parsed.method === undefined) {
-					const err = new TypeError(`"route" should start with one of the following methods: [GET, POST, PUT, DELETE, QUERY, HEADER, OPTIONS]`);
-					throw err;
-				}
-
-				const wrapped = async (req, res, next) => {
-					const matched = await markerFn.call(self, req, res);
-					// Skip, if marker's condition was not matched:
-					if (!matched) {
-						return next();
-					}
-
-					// Wrap and call:
-					const routeHandler = wrapRouteHandler.call(self, parsed, fn);
-					await routeHandler.call(self, req, res, next);
-
-					// If response was not sent,
-					// go to next one:
-					if (res.headersSent === false) {
-						next();
-					}
-				};
-				return self.add.route(wrapped);
-			},
-			use: (fn) => {
-				const wrapped = async (req, res, next) => {
-					const matched = await markerFn.call(self, req, res);
-					// Skip, if marker's condition was not matched:
-					if (!matched) {
-						return next();
-					}
-
-					await fn.call(self, req, res, next);
-
-					// If response was not sent,
-					// go to next one:
-					if (res.headersSent === false) {
-						next();
-					}
-				};
-				return self.use(wrapped);
-			}
+			route: (route, fn) => MarkerMethods.onlyRoute.call(self, route, fn, markerFn),
+			use: (fnOrRouter) => MarkerMethods.onlyUse.call(self, fnOrRouter, markerFn),
 		}
 	}
 

package/lib/router/markers.js

@@ -0,0 +1,78 @@
+const Route = require('./route');
+// Utils.
+const {
+	validateParsedRouteMethood,
+	wrapRouteHandler
+} = require('./routes.util');
+
+
+module.exports = {
+	onlyRoute: _onlyRoute,
+	onlyUse: _onlyUse
+}
+
+/*
+ * 
+ * @param {String} route
+ * @param {Function} fn
+ * @param {Function} markerFn
+ *
+ */
+function _onlyRoute(route, fn, markerFn) {
+	const parsedRoute = new Route(route);
+	// Will throw exception if not valid.
+	validateParsedRouteMethood(parsedRoute);
+
+	const wrapped = async (req, res, next) => {
+		const matched = await markerFn.call(this, req, res);
+		// Skip, if marker's condition was not matched:
+		if (!matched) {
+			return next();
+		}
+
+		// Wrap and call:
+		const routeHandler = wrapRouteHandler.call(this, parsedRoute, fn);
+		await routeHandler.call(this, req, res, next);
+
+		// If response was not sent,
+		// go to the next one:
+		if (res.headersSent === false) {
+			next();
+		}
+	};
+	return this.add.route(route, wrapped);
+}
+
+
+/*
+ * 
+ * @param {Function} fnOrRouter
+ * @param {Function} markerFn
+ *
+ */
+function _onlyUse(fnOrRouter, markerFn) {
+
+	const wrapped = async (req, res, next) => {
+		const matched = await markerFn.call(this, req, res);
+
+		// Skip, if marker's condition was not matched:
+		if (!matched) {
+			return next();
+		}
+
+		const isRouter = fnOrRouter.constructor.name === 'NodesterRouter';
+
+		const fn = isRouter ? fnOrRouter.handle.bind(fnOrRouter) : fnOrRouter;
+		await fn.call(this, req, res, next);
+
+		// If regular handler function:
+		if (!isRouter) {
+			// If response was not sent,
+			// go to the next one:
+			if (res.headersSent === false) {
+				next();
+			}
+		}
+	};
+	return this.use(wrapped);
+}

package/lib/router/route.js

@@ -40,17 +40,17 @@ module.exports = class NodesterRoute {
 			}
 
 			// Parse:
+			const collapsedSpaces = routeStringOrOpts.replace(/\s\s+/g, ' ');
 			const parts = routeStringOrOpts.split(' ');
-			const cleared = parts.filter(p => p.length > 0);
 
 			// Set method:
-			if (cleared[0].indexOf('/') === -1) {
-				const method = cleared.shift().toUpperCase();
+			if (parts[0].indexOf('/') === -1) {
+				const method = parts.shift().toUpperCase();
 				this.method = method;
 			}
 
 			// Build route one again and set it:
-			const clearRoute = cleared.join('');
+			const clearRoute = parts.join('');
 			this.route = clearRoute;
 
 			// Parse path parts:

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/lib/stacks/MarkersStack.js

@@ -1,4 +1,4 @@
-const consl = require('../logger/console');
+const consl = require('nodester/loggers/console');
 const debug = require('debug')('nodester:MiddlewareStack');
 
 

package/lib/stacks/MiddlewareStack.js

@@ -1,5 +1,5 @@
 const finalhandler = require('finalhandler');
-const consl = require('../logger/console');
+const consl = require('nodester/loggers/console');
 const debug = require('debug')('nodester:MiddlewareStack');
 
 

package/lib/utils/models.js

@@ -0,0 +1,14 @@
+/*!
+ * /nodester
+ * MIT Licensed
+ */
+'use strict';
+
+
+module.exports = {
+	isModel: _isModel
+};
+
+function _isModel(arg=null) {
+	return !!arg.tableName && typeof arg._schema === 'object';
+}

package/package.json

@@ -1,21 +1,47 @@
 {
   "name": "nodester",
-  "version": "0.0.9",
+  "version": "0.1.4",
   "description": "A boilerplate framework for Node.js",
   "exports": {
     ".": "./lib/application/index.js",
+
+    "./constants/ErrorCodes": "./lib/constants/ErrorCodes.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",
+    "./loggers/console": "./lib/loggers/console.js",
+    "./loggers/dev": "./lib/loggers/dev.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/sql": "./lib/utils/sql.util.js",
+    "./utils/strings": "./lib/utils/strings.util.js"
   },
   "directories": {
     "doc": "docs"
@@ -24,9 +50,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",
@@ -50,6 +75,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",
@@ -58,10 +84,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();