nodester 0.0.1 → 0.0.5

package/lib/factories/responses/api.js

@@ -1,90 +0,0 @@
-const ResponseFormats = require('nodester/constants/ResponseFormats');
-
-
-module.exports = class APIResponseFactory {
-	constructor() {}
-
-	/*
-		Format for all API responses will be JSON
-		{
-			content: {...}
-			error: {...}
-		}
-		Status code is sent in header.
-
-		If error is not present, error should be null.
-		If error is present, content can be null (But it's not required).
-	*/
-	createGenericResponse(
-		options = {
-			res: null,
-			status: 200,
-			content: {},
-			error: null,
-			format: ResponseFormats.JSON
-		}
-	) {
-		try {
-			const data = {
-				content: options?.content ?? null,
-				error: options?.error ?? null
-			};
-
-			switch(options?.format) {
-				case ResponseFormats.JSON:
-					return options?.res.status(options?.status).json(data);
-				case ResponseFormats.XML:
-					break;
-				default: {
-					const err = new Error("No response format specified.");
-					throw err;
-				}
-			}
-		}
-		catch(error) {
-			const err = new Error(`Could not create generic response: ${error.message}`);
-			err.name = error?.name;
-			err.code = error?.code;
-
-			console.error(err);
-
-			throw err;
-		}
-	}
-
-	/**
-	 * Sends response with status code 200.
-	 * Should be called on all successful respones.
-	 *
-	 * @param <Object> res
-	 * @param <Object> content
-	 * @param <String> format
-	 */
-	createOKResponse(options) {
-
-		return this.createGenericResponse({ 
-			...options,
-			status: 200,
-			format: options?.format ?? ResponseFormats.JSON
-		});
-	}
-
-	/**
-	 * Sends response with provided error code.
-	 * Should be called on all failed respones.
-	 *
-	 * @param <Object> res
-	 * @param <Object> error
-	 * @param <Object> content (optional)
-	 * @param <Int>		 status
-	 * @param <String> format
-	 */
-	createErrorResponse(options) {
-
-		return this.createGenericResponse({
-			...options,
-			status: options?.status ?? 500,
-			format: options?.format ?? ResponseFormats.JSON
-		});
-	}
-}

package/lib/routers/Default/index.js

@@ -1,143 +0,0 @@
-const Layer = require('./layer');
-
-// Utils:
-const { getType } = require('../../utils/types.util');
-
-
-module.exports = function NodesterDefaultRouter(app=null) {
-	this.markers = {};
-	this.layer = new Layer();
-
-	if (!!app) {
-		this.app = app
-	}
-
-	// Expose methods:
-	// 	Markers:
-	this.addMarker = _addMarker;
-	this.getMarker = _getMarker;
-
-	//	Routing:
-	this.handle = _handle;
-	this.only = _only;
-	this.route = _route;
-}
-
-/**
- * Adds marker to the stack.
- * Returns itself for chaining.
- * @return {NodesterDefaultRouter}
- *
- * @alias addMarker
- * @public
- */
-function _addMarker(nameOrSymbol='', fn=()=>{}) {
-	if (typeof fn !== 'function') {
-		const err = new TypeError(`Router.addMarker() requires a middleware function but got a ${ getType(fn) }`);
-    throw err;
-  }
-
-  const marker = this.getMarker(nameOrSymbol);
-  if (marker.marker.index > -1) {
-  	const err = new TypeError(`Marker with key ${ nameOrSymbol } is already set.`);
-  	throw err;
-  }
-
-  this.markers[nameOrSymbol] = fn;
-
-  return this;
-}
-
-
-/**
- * Tries to find marker's data by provided key.
- * @return {Object}
- *
- * @alias getMarker
- * @public
- */
-function _getMarker(nameOrSymbol='') {
-	const result = {
-		marker: {
-			key: nameOrSymbol,
-			index: -1,
-		},
-		middleware: undefined		
-	}
-	try {
-		const keys = Object.keys(this.markers);
-
-		const index = keys.indexOf(nameOrSymbol);
-		if (keys.indexOf(nameOrSymbol) === -1) {
-			const err = new Error('NotFound');
-			throw err;
-		}
-
-		// Marker found:
-		result.marker.index = index;
-		result.middleware = this.markers[nameOrSymbol];
-	}
-	catch(error) {
-		result.marker.index = -1;
-	}
-
-	return result;
-}
-
-/**
- * Start routes pipeline processing.
- *
- * If no callback is provided, then default error handlers will respond
- * in the event of an error bubbling through the stack.
- *
- * @alias handle
- * @public
- */
-function _handle(req, res, callback) {
-	const method = req.method;
-	const requestPath = req.url;
-
-	console.log(method, requestPath);
-
-	let markerName = null;
-
-	// Check if this request satisfies any markers:
-	const markers = Object.entries(this.markers);
-	console.log({ markers });
-
-	for (const [marker, fn] of markers) {
-		const result = fn(req, res, callback);
-		console.log(result);
-
-		if (result === true) {
-			markerName = marker;
-			break;
-		}
-	}
-
-	console.log({ markerName });
-
-	return res.send(markerName ?? 'Hi!');
-}
-
-
-/**
- *
- * @alias only
- * @public
- */
-function _only(condition) {
-	this.layer.push('condition', condition);
-	// Return layer for chaining.
-	return this.layer;
-}
-
-
-/**
- *
- * @alias route
- * @public
- */
-function _route() {
-
-}

package/lib/routers/Default/layer.js

@@ -1,50 +0,0 @@
-
-module.exports = function NodesterDefaultRouterLayer() {
-	this.conditions = [];
-	this.routesList = {};
-
-	this.push = _push;
-	this.route = _route;
-}
-
-
-/**
- *
- * @alias push
- * @public
- */
-function _push(key='condition') {
-	let args = [...arguments].shift();
-
-	switch(key) {
-		case 'condition':
-			// this.conditions[]
-			break;
-		case 'route':
-			const route = args.shift();
-			this.routesList[route] = args;
-			break;
-		break;
-	}
-
-	return this;
-}
-
-
-/**
- *
- * @alias route
- * @public
- */
-function _route(path='/') {
-	const middlewares = [...arguments].shift();
-
-	console.log({ path });
-}
-
-
-/**
- *
- * @alias push
- * @public
- */

package/lib/routers/Main/index.js

@@ -1,10 +0,0 @@
-const express = require('express');
-
-
-class MainRouter extends express.Router {
-	constructor() {
-		super();
-	}
-}
-
-module.exports = MainRouter;

package/lib/routers/Roles/index.js

@@ -1,81 +0,0 @@
-const express = require('express');
-// Utils:
-const cwd = process.cwd();
-const Path = require('path');
-// Custom error.
-const { Err } = require('nodester/factories/errors');
-
-
-class RolesRouter extends express.Router {
-	constructor(
-		rolesToRoutesMap={},
-		pathToControllers=null
-	) {
-		super();
-
-		// rolesToRoutesMap is a map of role -> route -> controller:
-		if (!rolesToRoutesMap) {
-			const err = new Err('"rolesToRoutesMap" argument is required.');
-			throw err;
-		}
-
-		if (!pathToControllers) {
-			const err = new Err('"pathToControllers" argument is required.');
-			throw err;
-		}
-
-		// Extract all available roles.
-		const roles = Object.keys(rolesToRoutesMap);
-
-		// Flip map (Make it route -> role -> controller):
-		const routesToRolesMap = {};
-		for (const role of roles) {
-			const roleRoutes = rolesToRoutesMap[role]
-			
-			for (const route in roleRoutes) {
-				// If this route is set:
-				if (!!routesToRolesMap[route]) {
-					// Add role to set.
-					routesToRolesMap[route][role] = roleRoutes[route];
-				}
-				else {
-					// Create set for this role.
-					routesToRolesMap[route] = { [role]: roleRoutes[route] };
-				}
-			}
-		}
-
-		// At this point we have a map of route -> role -> controller.
-		// Let's now set these routes to this Router:
-		for (const route in routesToRolesMap) {
-			const rolesAndControllersMap = routesToRolesMap[route];
-
-			// Split route by space, as it has structure [<Rest method> <Route>]
-			const routeParts = route.split(/\s+/);
-			const routeMethod = routeParts[0].toLocaleLowerCase();
-			const routePath = routeParts[1].replace(/\s\s+/g, ' ');
-
-			// Set up this route:
-			this.route(routePath)[routeMethod]((req, res, next) => {
-				// Extract role:
-				const role = req?.user?.role ?? 'visitor';
-
-				// If no handler for this role-route, skip:
-				if (!rolesAndControllersMap[role]) {
-					return next();
-				}
-
-				const controllerAndMethod = rolesAndControllersMap[role].split('.');
-				const controllerName = controllerAndMethod[0];
-				const controllerMethod = controllerAndMethod[1];
-
-				// Get controller from path.
-				const controller = require(Path.join(cwd, pathToControllers, controllerName));
-
-				return controller[controllerMethod](req, res, next);
-			});
-		}
-	}
-}
-
-module.exports = RolesRouter;

package/lib/utils/params.util.js

@@ -1,19 +0,0 @@
-
-module.exports = Params;
-
-function Params(
-	sourceObject={},
-	defaultValuesList={}
-) {
-	const result = {};
-
-	const keys = Object.keys(defaultValuesList);
-	for (const key of keys) {
-		result[key] = typeof sourceObject[key] !== 'boolean' && !sourceObject[key] ?
-										defaultValuesList[key]
-										:
-										sourceObject[key];
-	}
-
-	return result;
-}