nodester 0.0.9 → 0.1.4

package/lib/_facades/jwt.facade.js

@@ -1,273 +0,0 @@
-// Access to database.
-const Sequelize = require('sequelize');
-// JWT service.
-const JWT = require('nodester/services/jwt.service');
-// Utils:
-const { lowerCaseFirstLetter } = require('nodester/utils/strings.util');
-const { addSeconds } = require('nodester/utils/dates.util');
-const Params = require('nodester/facades/FacadeParams');
-
-
-module.exports = class JWTFacade {
-	constructor(
-		disabledRefreshToken,
-		roleModels=[],
-		accessTokenConfigs=null,
-		refreshTokenConfigs=null
-	) {
-		if (!disabledRefreshToken)
-			throw new Erroror('"disabledRefreshToken" argument is invalid.');
-
-		this.disabledRefreshToken = disabledRefreshToken;
-
-		this.roleModels = {};
-		roleModels.forEach(model => {
-			const name = lowerCaseFirstLetter(model?.options?.name?.singular);
-			this.roleModels[name] = model;
-		});
-
-		this.service = new JWT(accessTokenConfigs, refreshTokenConfigs);
-	}
-
-	async login(params) {
-		try {
-			const {
-				email,
-				password,
-				role
-			} = Params(params, {
-				email: null,
-				password: null,
-				role: null
-			});
-
-			if (Object.keys(this.roleModels).indexOf(role) === -1)
-				throw new Error();
-
-			// Extract model difinition of this type.
-			const modelDefinition = this.roleModels[role];
-			const instance = await modelDefinition?.findOneByEmail(email);
-
-			if (!instance)
-				throw new Error();
-
-			const compareResult = await instance?.comparePasswords(password);
-
-			if (compareResult === false)
-				throw new Error();
-
-			const result = {
-				role: role,
-				[role]: instance.toJSON(),
-				tokens: await this.issueTokens({ modelInstance: instance, modelName: role })
-			}
-
-			// Send output.
-			return Promise.resolve(result);
-		}
-		catch(error) {
-			console.error(error);
-
-			// Unauthorized on any error:
-			const err = new Error();
-			err.name = 'Unauthorized';
-			return Promise.reject(err);
-		}
-	}
-
-	async issueAccessToken(params) {
-		try {
-			const {
-				parsedRefreshToken,
-				modelInstance,
-				modelName
-			} = Params(params, {
-				parsedRefreshToken: null,
-				modelInstance: null,
-				modelName: null,
-			});
-
-			let newAccessToken = null;
-
-			if (!modelName && !parsedRefreshToken.role) {
-				const err = new Error('No "modelName" provided for JWT issue.');
-				err.name = "ValidationError";
-				err.status = 403;
-				throw err;
-			}
-
-			// If parsed refresh token was provided:
-			if (!!parsedRefreshToken) {
-				const payload = {
-					id: parsedRefreshToken?.id,
-					role: parsedRefreshToken.role,
-				};
-				newAccessToken = await this.service.issueAccessToken(payload);
-			}
-			// If modelInstance was provided:
-			else if (!!modelInstance) {
-				const payload = {
-					id: modelInstance?.id,
-					role: modelName
-				};
-				newAccessToken = await this.service.issueAccessToken(payload);
-			}
-			else {
-				const err = new Error('No "modelInstance" or "parsedRefreshToken" provided for JWT issue.');
-				err.name = "ValidationError";
-				err.status = 403;
-				throw err;
-			}
-
-			// Check if issue was successful.
-			if (!newAccessToken) {
-				const err = new Error("Could not issue new access token.");
-				err.status = 401;
-				throw err;
-			}
-
-			// Send output.
-			return Promise.resolve(newAccessToken);
-		}
-		catch(error) {
-			return Promise.reject(error);
-		}
-	}
-
-	async issueTokens(params) {
-		try {
-			const {
-				modelInstance,
-				modelName,
-				noAccessToken,
-				noRefreshToken
-			} = Params(params, {
-				modelInstance: null,
-				modelName: null,
-				noAccessToken: false,
-				noRefreshToken: false
-			});
-
-			// Prepare payload container.
-			let payload = {};
-
-			if (!!modelInstance && !!modelName) {
-				payload = {
-					id: modelInstance?.id,
-					role: modelName
-				};
-			}
-			else {
-				const err = new Error('No "modelInstance" and "modelName" provided for JWT issue.');
-				err.name = "ValidationError";
-				err.status = 403;
-				throw err;
-			}
-
-			const accessToken = await this.service.issueAccessToken(payload);
-			const refreshToken = await this.service.issueRefreshToken(payload);
-
-			// Prepare output,
-			const tokens = {
-				accessToken,
-				refreshToken
-			};
-
-			if (noAccessToken)
-				delete tokens.accessToken;
-
-			if (noRefreshToken)
-				delete tokens.refreshToken;
-			
-			// Send output.
-			return Promise.resolve(tokens);
-		}
-		catch(error) {
-			return Promise.reject(error);
-		}
-	}
-
-	async refreshAccessToken(params) {
-		try {
-			const {
-				refreshToken,
-				parsedRefreshToken
-			} = Params(params, {
-				refreshToken: null,
-				parsedRefreshToken: null
-			});
-
-			// Check if token is not blocked:
-			const isActive = await this.isRefreshTokenActive({ refreshToken });
-			if (!isActive) {
-				const err = new Error('Invalid Token!');
-				err.name = 'InvalidToken';
-				throw err;
-			}
-
-			// Issue new access token, based on refresh token:
-			const accessToken = await this.issueAccessToken({ parsedRefreshToken });
-
-			// Send output.
-			return Promise.resolve(accessToken);
-		}
-		catch(error) {
-			return Promise.reject(error);
-		}
-	}
-
-	async isRefreshTokenActive(params) {
-		try {
-			const {
-				refreshToken
-			} = Params(params, {
-				refreshToken: null
-			});
-
-			const foundTokens = await this.disabledRefreshToken.selectAll({ token: refreshToken });
-
-			// Prepare output. Check if provided token was not disabled.
-			const isActive = foundTokens.length === 0;
-
-			// Send output.
-			return Promise.resolve(isActive);
-		}
-		catch(error) {
-			return Promise.reject(error);
-		}
-	}
-
-	async disableRefreshToken(params) {
-		try {
-			const {
-				refreshToken,
-				parsedToken
-			} = Params(params, {
-				refreshToken: null,
-				parsedToken: null
-			});
-
-			// Unwrap nessessary data.
-			const { id, role } = parsedToken;
-
-			// Find or create:
-			const cofParams = {
-				[`${ role }_id`]: id,
-				token: refreshToken
-			};
-			const [ disabledRefreshToken, created ] = await this.disabledRefreshToken.createOrFind(cofParams);
-
-			// Check result,
-			const createdStatus = created === true || !!disabledRefreshToken;
-
-			// Send output.
-			const result = {
-				status: createdStatus
-			}
-			return Promise.resolve(result);
-		}
-		catch(error) {
-			return Promise.reject(error);
-		}
-	}
-}

package/lib/models/Extractor.js

@@ -1,320 +0,0 @@
-/*
- * ModelDataExtractor (/models/Extractor.js)
- * Reads data from Express's request and filters it,
- * based on model parameters and always-present query parameters (limit, skip, etc.).
- */
-// Constants:
-const { DataTypes } = require('sequelize');
-const IGNORED_KEYS = [
-	// Sequilize keys:
-	'createdAt',
-	'updatedAt',
-	'deletedAt',
-
-	'created_at',
-	'updated_at',
-	'deleted_at',
-	// Procedural keys.
-	'should_delete',
-];
-const PROCEDURAL_KEYS = {
-	'should_delete': new DataTypes.BOOLEAN()
-};
-// Utils:
-const sntz = require('nodester/utils/sanitizations.util');
-const Params = require('nodester/facades/FacadeParams');
-
-
-module.exports = class ModelDataExtractor {
-
-	constructor(
-		modelDefinition,
-		options,
-	) {
-		if (!modelDefinition) {
-			throw new Error('"modelDefinition" attribute is invalid.');
-		}
-
-		const {
-			withFiles
-		} = Params(options, {
-			withFiles: false
-		});
-
-		this.model = modelDefinition;
-		this.attributes = modelDefinition.tableAttributes;
-		this.options = {
-			withFiles: !!withFiles,
-			fileInstanceName: 'file',
-			filesArrayName: 'files',
-		};
-	}
-
-	extractData(
-		modelDefinition,
-		parentModelDefinition=null,
-		holder={},
-		includes=[],
-		skipIdValidation=false,
-		skipValidation=false,
-	) {
-		if (!modelDefinition) {
-			const err = new Error('"modelDefinition" attribute is invalid.');
-			err.name = 'InternalValidationError';
-			throw err;
-		}
-
-		const data = {};
-		const errors = {};
-
-		const attributes = modelDefinition.tableAttributes;
-
-		// Table attributes minus "special" keys.
-		const keysToCheck = Object.keys(attributes)
-												.filter(key => !IGNORED_KEYS.includes(key));
-
-		keysToCheck.forEach((key) => {
-			const {
-				type,
-				allowNull,
-				defaultValue,
-				primaryKey,
-				references
-			} = attributes[key];
-
-			// Extract raw value from passed object.
-			const dataValue = holder[key];
-
-			if (!!primaryKey && !!skipIdValidation) {
-				// Just put id to data object:
-				if (!!dataValue)
-					data[key] = dataValue;
-
-				// Skip further validation.
-				return;
-			}
-
-			// If this field references some other model:
-			if (!!references) {
-				const modelReferenced = references.model;
-
-				// If referenced model is the same as parentModel,
-				// skip (Sequilize will handle it):
-				if (modelReferenced === parentModelDefinition?.tableName) {
-					// Skip further validation.
-					return;
-				}
-			}
-
-			// If value is undefined, and null is allowed skip:
-			if (dataValue === undefined && allowNull) {
-				// Skip further validation.
-				return;
-			}
-
-			// If value is undefined, and null is allowed,
-			// set and skip:
-			if (dataValue === null && allowNull) {
-				data[key] = null;
-				// Skip further validation.
-				return;
-			}
-
-			if (allowNull === false && (dataValue === undefined || dataValue === null)) {
-
-				// If default value can be set,
-				// or we're allowed to skip validation,
-				// skip:
-				if (defaultValue !== undefined || (!primaryKey && skipValidation === true)) {
-					// Skip further validation.
-					return;
-				}
-
-				return errors[key] = { message: `Field "${key}" can not be null.` };
-			}
-
-			data[key] = _sanitizeValue(dataValue, type);
-		});
-
-		// Check procedural keys:
-		for (const [ key, dataType ] of Object.entries(PROCEDURAL_KEYS)) {
-			// Extract raw value from passed object.
-			const dataValue = holder[key];
-
-			// If value is defined:
-			if (dataValue !== undefined) {
-				data[key] = _sanitizeValue(dataValue, dataType);
-			}
-		};
-
-		// If model has associations:
-		if (Object.keys(modelDefinition?.associations)?.length > 0) {
-			
-			// Go through association entries:
-			const associationEntries = Object.entries( modelDefinition.associations );
-			associationEntries.forEach(([
-				associationName,
-				associationDefinition
-			]) => {
-
-				// If data of this association is present:
-				if (!!holder[associationName]) {
-					
-					const associatedModel = associationDefinition.target;
-
-					const isSingleInstance = Array.isArray( holder[associationName] ) === false;
-
-					// If single instance of associated model:
-					if (isSingleInstance) {
-						data[associationName] = this.extractData(
-																			associatedModel,
-																			modelDefinition,
-																			holder[associationName],
-																			[], // Includes
-																			skipIdValidation,
-																			skipValidation
-																		);
-					}
-					// If multiple instances of associated model:
-					else {
-						data[associationName] = holder[associationName].map((associationData) => {
-							return this.extractData(
-								associatedModel,
-								modelDefinition,
-								associationData,
-								[], // Includes
-								skipIdValidation,
-								skipValidation
-							);
-						});
-					}
-				}
-			});
-		}
-
-		// If options for "withFiles" is true,
-		// also check files in object.
-		if (this.options.withFiles === true) {
-			// Check for single file & array of files.
-			const keysToCheck = [
-				this.options.fileInstanceName,
-				this.options.filesArrayName,
-			];
-
-			keysToCheck.filter(key => holder[key] !== undefined)
-								 .forEach(key => data[key] = holder[key]);
-		}
-
-		// If errors were set, throw ValidationError:
-		if (Object.keys(errors).length > 0) {
-			const err = new Error('');
-			err.name = 'ValidationError';
-			err.details = { ...errors };
-			throw err;
-		}
-		
-		return data;
-	}
-
-	extractInstanceDataFromObject(
-		holder={},
-		includes,
-		options,
-	) {
-		const {
-			skipIdValidation,
-			skipValidation
-		} = Params(options, {
-			skipIdValidation: false,
-			skipValidation: false,
-		});
-
-		return this.extractData(
-			this.model,
-			null,
-			holder,
-			includes,
-			skipIdValidation,
-			skipValidation
-		);
-	}
-
-	/* ! Warning !
-	 * Not finished method
-	 * Do not use!
-	 */
-	extractArrayDataFromObject(
-		holder={},
-		includes,
-		options,
-	) {
-		const {
-			skipIdValidation,
-			skipValidation
-		} = Params(options, {
-			skipIdValidation: false,
-			skipValidation: false,
-		});
-
-		const { instances } = holder;
-
-		// All model instances must be in an array by key "instances".
-		// If "instances" is not array, throw error:
-		if (Array.isArray(instances) === false) {
-			const err = new Error('');
-			err.name = 'ValidationError';
-			err.details = { message: 'Field "instances" must be an array' };
-			throw err;
-		}
-
-		const results = instances.map((instance) => 
-			this.extractData(
-				this.model,
-				null,
-				instance,
-				skipIdValidation,
-				skipValidation
-			)
-		);
-
-		return results;
-	}
-}
-
-function _sanitizeValue(
-	value,
-	dataType,
-	fallback=null,
-) {
-	let result = null;
-
-	if (dataType instanceof DataTypes.INTEGER) {
-		result = sntz.INT(value, { fallback });
-	}
-	else if (dataType instanceof DataTypes.DECIMAL) {
-		result = sntz.NUMBER(value, { fallback });
-	}
-	else if (dataType instanceof DataTypes.FLOAT) {
-		result = sntz.NUMBER(value, { fallback });
-	}
-	else if (dataType instanceof DataTypes.STRING) {
-		result = sntz.STRING(value, { fallback });
-	}
-	else if (dataType instanceof DataTypes.TEXT) {
-		result = sntz.STRING(value, { fallback });
-	}
-	else if (dataType instanceof DataTypes.ENUM) {
-		result = sntz.STRING(value, { fallback });
-	}
-	else if (dataType instanceof DataTypes.JSON) {
-		result = sntz.JSON(value, { fallback });
-	}
-	else if (dataType instanceof DataTypes.BOOLEAN) {
-		result = sntz.BOOLEAN(value, { fallback });
-	}
-	else if (dataType instanceof DataTypes.DATE || dataType instanceof DataTypes.DATEONLY) {
-		result = sntz.DATE(value, { fallback });
-	}
-
-	return result;
-}

package/lib/preprocessors/IncludesPreprocessor.js

@@ -1,55 +0,0 @@
-// Constants:
-const VISITOR = 'visitor';
-const DefaultAvailableParamsForRoles = { [VISITOR]: [] };
-const DefaultStaticParamsForRoles = { [VISITOR]: [] };
-
-// Custom error.
-const { Err } = require('nodester/factories/errors');
-
-
-module.exports = class IncludesPreprocessor {
-
-	constructor(
-		availableParamsForRoles,
-		staticParamsForRoles,
-		customProcessFunction=()=>{}
-	) {
-		this.availableParamsForRoles = availableParamsForRoles ?? DefaultAvailableParamsForRoles;
-		this.staticParamsForRoles = staticParamsForRoles ?? DefaultStaticParamsForRoles;
-
-		this.customProcessFunction = customProcessFunction ? customProcessFunction : ()=>{};
-	}
-
-	async extract(
-		req,
-		role
-	) {
-		const requestIncludes = req.query?.includes ?? [];
-
-		if (!requestQuery || typeof requestQuery !== '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 resultIncludes = [];
-
-		const params = this.availableParamsForRoles[_role] ?? [];
-		const staticValues = this.staticParamsForRoles[_role] ?? [];
-
-		params.forEach((param) => {
-			// If such param is set in query:
-			if (requestIncludes.indexOf(param) !== -1) {
-				resultIncludes.push(param);
-			}
-		});
-
-		// Make further preprocessing using custom defined function.
-		await this.customProcessFunction.call(this, req, role, resultIncludes);
-
-		return resultIncludes;
-	}
-}

package/lib/preprocessors/QueryPreprocessor.js

@@ -1,64 +0,0 @@
-// Constants:
-const VISITOR = 'visitor';
-const DefaultAvailableParamsForRoles = { [VISITOR]: [ 'skip', 'limit', 'order' ] };
-const DefaultStaticParamsForRoles = { [VISITOR]: { limit: 50 } };
-
-// Custom error.
-const { Err } = require('nodester/factories/errors');
-
-
-module.exports = class QueryPreprocessor {
-
-	constructor(
-		availableParamsForRoles,
-		staticParamsForRoles,
-		customProcessFunction
-	) {
-		this.availableParamsForRoles = availableParamsForRoles ?? DefaultAvailableParamsForRoles;
-		this.staticParamsForRoles = staticParamsForRoles ?? DefaultStaticParamsForRoles;
-
-		this.customProcessFunction = customProcessFunction ? customProcessFunction : ()=>{};
-	}
-
-	async extract(
-		req,
-		role
-	) {
-		try {
-			const requestQuery = req.query;
-
-			if (!requestQuery || typeof requestQuery !== '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 resultQuery = {};
-
-			const params = this.availableParamsForRoles[_role] ?? [];
-			const staticValues = this.staticParamsForRoles[_role] ?? {};
-
-			params.forEach((param) => {
-				// If such param is set in query:
-				if (!!requestQuery[param]) {
-					resultQuery[param] = staticValues[param] ?? requestQuery[param];
-				}
-				// If such param is not set, but we have a "static" for it:
-				else if (!requestQuery[param] && !!staticValues[param]) {
-					resultQuery[param] = staticValues[param];
-				}
-			});
-
-			// Make further preprocessing using customly defined function.
-			await this.customProcessFunction.call(this, req, role, resultQuery);
-
-			return Promise.resolve(resultQuery);
-		}
-		catch(error) {
-			return Promise.reject(error);
-		}
-	}
-}