nodester 0.0.1 → 0.0.2

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/models/DisabledRefreshToken.js

@@ -1,68 +0,0 @@
-const defineModel = require('./define');
-// ORM.
-const { DataTypes } = require('sequelize');
-
-
-module.exports = _defineDisabledRefreshToken;
-
-function _defineDisabledRefreshToken(
-	database,
-	roleIds=[],
-	options={}
-) {
-
-	const fields = {
-		id: {
-			type: DataTypes.INTEGER.UNSIGNED,
-			allowNull: false,
-			primaryKey: true,
-			autoIncrement: true,
-			_autoGenerated: true
-		},
-		
-		token: {
-			type: DataTypes.STRING,
-			required: true,
-			allowNull: false,
-			unique: true
-		}
-	};
-
-	roleIds.forEach(roleId => fields[roleId] = {
-		type: DataTypes.INTEGER.UNSIGNED,
-		allowNull: true
-	});
-
-	const disabledRefreshToken = defineModel(database, 'DisabledRefreshToken',
-		(DataTypes) => ( fields ),
-		{ ...options }
-	);
-
-	disabledRefreshToken.createOrFind = function({ 
-		token,
-		...roleInfo
-	}) {
-		const where = {
-			token
-		};
-
-		const defaults = {
-			token: token,
-			...roleInfo
-		};
-
-		const query = {
-			where,
-			defaults
-		};
-		return this.findOrCreate(query);
-	}
-
-	disabledRefreshToken.selectAll = function({ token }) {
-		const where = { token };
-		const query = { where };
-		return this.findAll(query);
-	}
-
-	return disabledRefreshToken;
-}

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/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;