nodester 0.1.4 → 0.2.0

package/lib/http/utils.js

@@ -1,254 +0,0 @@
-/*!
- * /nodester
- * MIT Licensed
- */
-'use strict';
-
-const contentType = require('content-type');
-const mime = require('send').mime;
-const etag = require('etag');
-const proxyaddr = require('proxy-addr');
-const qs = require('qs');
-const querystring = require('querystring');
-
-
-exports = module.exports = {
-	acceptParams: _acceptParams,
-	normalizeType: _normalizeType,
-	normalizeTypes: _normalizeTypes,
-	compileETag: _compileETag,
-	setCharset: _setCharset
-}
-
-
-/**
- * Parse accept params `str` returning an
- * object with `.value`, `.quality` and `.params`.
- * also includes `.originalIndex` for stable sorting
- *
- * @param {String} str
- * @param {Number} index
- * @return {Object}
- *
- * @api private
- */
-function _acceptParams(str, index) {
-	const parts = str.split(/ *; */);
-	let result = { value: parts[0], quality: 1, params: {}, originalIndex: index };
-
-	for (let i = 1; i < parts.length; i++) {
-		const pms = parts[i].split(/ *= */);
-		if ('q' === pms[0]) {
-			result.quality = parseFloat(pms[1]);
-		} else {
-			result.params[pms[0]] = pms[1];
-		}
-	}
-
-	return result;
-}
-
-
-/**
- * Create an ETag generator function, generating ETags with
- * the given options.
- *
- * @param {object} options
- * @return {function}
- *
- * @private
- */
-function _createETagGenerator (options) {
-	return function generateETag (body, encoding) {
-		const buf = !Buffer.isBuffer(body)
-			? Buffer.from(body, encoding)
-			: body
-
-		return etag(buf, options)
-	}
-}
-
-
-/**
- * Normalize the given `type`, for example "html" becomes "text/html".
- *
- * @param {String} type
- * @return {Object}
- *
- * @api private
- */
-function _normalizeType(type){
-	return ~type.indexOf('/')
-		? acceptParams(type)
-		: { value: mime.lookup(type), params: {} };
-};
-
-
-/**
- * Normalize `types`, for example "html" becomes "text/html".
- *
- * @param {Array} types
- * @return {Array}
- *
- * @api private
- */
-function _normalizeTypes(types){
-	const ret = [];
-
-	for (let i = 0; i < types.length; ++i) {
-		ret.push(
-			_normalizeType(types[i])
-		);
-	}
-
-	return ret;
-};
-
-
-/**
- * Compile "etag" value to function.
- *
- * @param  {Boolean|String|Function} val
- * @return {Function}
- *
- * @alias compileETag
- * @api public
- */
-function _compileETag(val) {
-	let fn;
-
-	if (typeof val === 'function') {
-		return val;
-	}
-
-	switch (val) {
-		case true:
-		case 'weak':
-			fn = _createETagGenerator({ weak: true });
-			break;
-		case false:
-			break;
-		case 'strong':
-			fn = _createETagGenerator({ weak: false });
-			break;
-		default:
-			throw new TypeError('unknown value for etag function: ' + val);
-	}
-
-	return fn;
-}
-
-/**
- * Compile "query parser" value to function.
- *
- * @param  {String|Function} val
- * @return {Function}
- *
- * @api private
- */
-
-exports.compileQueryParser = function compileQueryParser(val) {
-	let fn;
-
-	if (typeof val === 'function') {
-		return val;
-	}
-
-	switch (val) {
-		case true:
-		case 'simple':
-			fn = querystring.parse;
-			break;
-		case false:
-			fn = newObject;
-			break;
-		case 'extended':
-			fn = parseExtendedQueryString;
-			break;
-		default:
-			throw new TypeError('unknown value for query parser function: ' + val);
-	}
-
-	return fn;
-}
-
-/**
- * Compile "proxy trust" value to function.
- *
- * @param  {Boolean|String|Number|Array|Function} val
- * @return {Function}
- *
- * @api private
- */
-exports.compileTrust = function(val) {
-	if (typeof val === 'function') return val;
-
-	if (val === true) {
-		// Support plain true/false
-		return function(){ return true };
-	}
-
-	if (typeof val === 'number') {
-		// Support trusting hop count
-		return function(a, i){ return i < val };
-	}
-
-	if (typeof val === 'string') {
-		// Support comma-separated values
-		val = val.split(',')
-			.map(function (v) { return v.trim() })
-	}
-
-	return proxyaddr.compile(val || []);
-}
-
-
-/**
- * Set the charset in a given Content-Type string.
- *
- * @param {String} type
- * @param {String} charset
- * @return {String}
- *
- * @api private
- */
-function _setCharset(type, charset) {
-	if (!type || !charset) {
-		return type;
-	}
-
-	// parse type
-	const parsed = contentType.parse(type);
-
-	// set charset
-	parsed.parameters.charset = charset;
-
-	// format type
-	return contentType.format(parsed);
-};
-
-
-/**
- * Parse an extended query string with qs.
- *
- * @return {Object}
- * @private
- */
-function parseExtendedQueryString(str) {
-	return qs.parse(str, {
-		allowPrototypes: true
-	});
-}
-
-
-/**
- * Return new empty object.
- *
- * @return {Object}
- *
- * @api private
- */
-function newObject() {
-	return {};
-}
-

package/lib/params/Params.js

@@ -1,37 +0,0 @@
-
-module.exports = Params;
-
-/**
- * Extracts only values in second argument
- * from first argument.
- * If such values is missing in first atgument,
- * will fallback to the value in second argument.
- *
- * @param {Object} sourceObj
- * @param {Object} defaultValuesList
- *
- * @return {Object} result
- *
- * @api public
- */
-function Params(
-	sourceObj={},
-	defaultValuesList={}
-) {
-	const result = {};
-
-	const keys = Object.keys(defaultValuesList);
-	for (const key of keys) {
-
-		// If value is not set,
-		// use default one from 'defaultValuesList':
-		if (sourceObj[key] === undefined) {
-			result[key] = defaultValuesList[key];
-			continue;
-		}
-
-		result[key] = sourceObj[key];
-	}
-
-	return result;
-}

package/lib/policies/Role.js

@@ -1,77 +0,0 @@
-// Reponse protocol generator.
-const APIResponseFactory = require('nodester/factories/responses/api');
-
-
-module.exports = class RolePolicy {
-	constructor({
-		roleName,
-		jwtFacade,
-		apiResponseFactory,
-	}) {
-		if (!roleName)
-			throw new Error('"roleName" argument is invalid.');
-		
-		if (!jwtFacade)
-			throw new Error('"jwtFacade" argument is invalid.');
-
-		this.roleName = roleName;
-		this.jwtFacade = jwtFacade;
-
-		// 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);;
-	}
-
-	async dryRun(req, res, next) {
-		try {
-			const jwtService = this.jwtFacade.service;
-
-			// Get token either from header, query or body.
-			const token = jwtService.extractTokenFromRequest(req);
-
-			// Verifys and parses token. On failed validation will throw error.
-			const parsedToken = await jwtService.verifyAccessToken(token);
-
-			// Check role:
-			if (parsedToken.role !== this.roleName) {
-				const err = new Error(`Unauthorized.`);
-				err.name = 'UnauthorizedError';
-				err.status = 401;
-				throw err;
-			}
-
-			// Everything's good, procceed:
-			req.token = {
-				parsed: parsedToken,
-				initial: token
-			}
-			
-			return Promise.resolve();
-		}
-		catch(error) {
-			// If error is not 401
-			// or
-			// error is not "NoToken",
-			// log it:
-			if (
-				['NoToken', 'UnauthorizedError'].indexOf(error?.name) === -1
-			) {
-				console.error(`${ this.roleName }.policy error:`, error);
-			}
-
-			const statusCode = error?.status ?? 401;
-
-			const err = new Error(error.message);
-			err.name = error.name ?? 'UnknownError';
-			err.details = { message: 'Unauthorized.' }
-			err.status = statusCode;
-
-			return Promise.reject(err);
-		}
-	}
-}

package/lib/policies/RoleExtracting.js

@@ -1,97 +0,0 @@
-// Format for Role header.
-const CLAIMED_ROLE_HEADER_NAME = 'x-claimed-role';
-// Reponse protocol generator.
-const APIResponseFactory = require('nodester/factories/responses/api');
-
-
-module.exports = class RoleExtractingPolicy {
-	constructor({
-		jwtFacade,
-		apiResponseFactory,
-		name
-	}) {
-		
-		if (!jwtFacade)
-			throw new Error('"jwtFacade" argument is invalid.');
-
-		this.jwtFacade = jwtFacade;
-		this.name = name ?? 'RoleExtracting';
-
-		// 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);;
-	}
-
-	async dryRun(req, res, next) {
-		try {
-			// Get claimed role.
-			const claimedRole = req.header(CLAIMED_ROLE_HEADER_NAME);
-
-			// If claimed role is not set or it's a visitor:
-			if (!claimedRole || claimedRole === 'visitor') {
-				// Set role as 'visitor'.
-				req.user = { role: 'visitor' };
-
-				return Promise.resolve();
-			}
-
-			// Unwrap JWT service.
-			const jwtService = this.jwtFacade.service;
-
-			try {
-				// Get access token either from header, query or body.
-				const token = jwtService.extractTokenFromRequest(req);
-
-				// Verifys and parses token. On failed validation will throw error.
-				const parsedToken = await jwtService.verifyAccessToken(token);
-
-				// If parsed token's role is not the same as claimed role,
-				// immediately throw error:
-				if ( parsedToken?.role !== claimedRole ) {
-					const err = new Error('Roles do not match');
-					err.name = 'RolesMismatch';
-					err.details = { message: 'Unauthorized.' }
-					err.status = 401;
-					return Promise.reject(err);
-				}
-
-				// Everything's good, procceed:
-				req.token = {
-					parsed: parsedToken,
-					initial: token
-				}
-
-				req.user = { role: parsedToken?.role };
-			}
-			catch(accessTokenError) {
-				// If error is not "NoToken", something bad has happened:
-				if (accessTokenError?.name !== 'NoToken') {
-					throw accessTokenError;
-				}
-
-				// If error is "NoToken":
-				//	Set role as 'visitor'.
-				req.user = { role: 'visitor' };
-			}
-			
-			return Promise.resolve();
-		}
-		catch(error) {
-			console.error(`${ this.name }.policy error:`, error);
-
-			const statusCode = error?.status ?? 401;
-
-			const err = new Error(error.message);
-			err.name = error.name ?? 'UnknownError';
-			err.details = { message: 'Unauthorized.' }
-			err.status = statusCode;
-
-			return Promise.reject(err);
-		}
-	}
-}

package/lib/preprocessors/BodyPreprocessor.js

@@ -1,61 +0,0 @@
-// Constants.
-const VISITOR = 'visitor';
-
-// Custom error.
-const { Err } = require('nodester/factories/errors');
-
-
-module.exports = class BodyPreprocessor {
-	constructor(
-		availableParamsForRoles,
-		staticParamsForRoles,
-		customProcessFunction
-	) {
-		this.availableParamsForRoles = availableParamsForRoles ?? {};
-		this.staticParamsForRoles = staticParamsForRoles ?? {};
-
-		this.customProcessFunction = customProcessFunction ? customProcessFunction : ()=>{};
-	}
-
-	async extract(
-		req,
-		role
-	) {
-		try {
-			const requestBody = req.body;
-
-			if (!requestBody || typeof requestBody !== 'object') {
-				const err = new Err();
-				err.name = 'ValidationError';
-				throw err;
-			}
-
-			// Get role or set "visitor"
-			const _role = typeof role === 'string' && role.length > 1 ? role : VISITOR;
-
-			const resultBody = {};
-
-			const params = this.availableParamsForRoles[_role] ?? [];
-			const staticValues = this.staticParamsForRoles[_role] ?? {};
-
-			params.forEach((param) => {
-				// If such param is set in body:
-				if (!!requestBody[param]) {
-					resultBody[param] = staticValues[param] ?? requestBody[param];
-				}
-				// If such param is not set, but we have a "static" for it:
-				else if (!requestBody[param] && !!staticValues[param]) {
-					resultBody[param] = staticValues[param];
-				}
-			});
-
-			// Make further preprocessing using customly defined function.
-			await this.customProcessFunction.call(this, req, role, resultBody);
-
-			return Promise.resolve(resultBody);
-		}
-		catch(error) {
-			return Promise.reject(error);
-		}
-	}
-}

package/lib/queries/Colander.js

@@ -1,107 +0,0 @@
-/*!
- * /nodester
- * MIT Licensed
- */
-'use strict';
-
-const CLAUSES = ['limit', 'skip', 'order', 'order_by'];
-
-const { isModel } = require('../utils/models');
-
-
-module.exports = class Colander {
-
-	/*
-	 *
-	 * @param {Object|Model} optsOrModelDefinition
-	 @ - @param {Model} model
-	 * - @param {Array} fields
-	 * - @param {Array} clauses
-	 * - @param {Object} includes
-	 * - @param {Object} statics
-	 * -- @param {Object} attributes
-	 * -- @param {Object} clauses
-	 *
-	 * @param {Boolean} noLimit
-	 *
-	 */
-	constructor(optsOrModelDefinition, noLimit=false) {
-		this._fields = [];
-		this._clauses = [];
-		this._includes = {};
-		
-		this._statics = {
-			attributes: {},
-			clauses: {
-				limit: 3
-			}
-		}
-		if (noLimit === true) {
-			delete this._statics.clauses.limit;
-		}
-
-		// If model:
-		if (isModel(optsOrModelDefinition)) {
-			this._fields = Object.keys(optsOrModelDefinition.tableAttributes);
-			this._clauses = CLAUSES;
-		}
-		// If options:
-		else {
-			const {
-				model,
-				fields,
-				clauses,
-				includes,
-				statics,
-			} = optsOrModelDefinition;
-
-
-			// If fields are array:
-			if (Array.isArray(fields)) {
-				this._fields = fields;
-			}
-			// If fields were not provided,
-			// but we have full model definition:
-			else if (isModel(model)) {
-				this._fields = Object.keys(model.tableAttributes);
-			}
-
-
-			if (Array.isArray(clauses)) {
-				this._clauses = clauses;
-			}
-
-			if (typeof includes === 'object') {
-				this._includes = includes;
-			}
-
-			if (typeof statics === 'object') {
-				if (typeof statics.attributes === 'object') {
-					this._statics.attributes = statics.attributes;
-				}
-
-				if (typeof statics.clauses === 'object') {
-					this._statics.clauses = statics.clauses;
-				}
-			}
-		}
-	}
-
-	// Getters:
-	get fields() {
-		return this._fields;
-	}
-
-	get clauses() {
-		return this._clauses;
-	}
-
-	get includes() {
-		return this._includes;
-	}
-
-	get statics() {
-		return this._statics;
-	}
-	// Getters\
-}