nodester 0.1.4 → 0.2.0

package/lib/controllers/mixins/index.js

@@ -1,3 +1,10 @@
+/*!
+ * /nodester
+ * MIT Licensed
+ */
+ 
+'use strict';
+
 const {
 	NODESTER_QUERY_ERROR,
 	UNAUTHORIZED_ERROR,
@@ -16,6 +23,9 @@ const {
 	deleteOne
 } = require('../methods');
 
+// Arguments validator.
+const { ensure } = require('../../validators/arguments');
+
 
 module.exports = {
 	withDefaultCRUD: _withDefaultCRUD,
@@ -30,29 +40,27 @@ module.exports = {
  * Sets one of or all of CRUD methods to Controller.
  *
  * @param {Function|Object} controller
- * @param {Object} opts
- * - @param {Function|Object} facade
- * - @param {String} name
- * - @param {Array} only
+ * @param {Object} options
+ * @param {Function|Object} options.facade
+ * @param {String}					options.name
+ * @param {Array}						options.only
  *
  * @return {Function|Object} controller
  *
  * @api public
  * @alias withDefaultCRUD
  */
-function _withDefaultCRUD(controller, opts={}) {
+function _withDefaultCRUD(controller, options={}) {
+	ensure(controller, 'function|object,required', 'controller');
+	ensure(options, 'object,required', 'options');
+
 	const {
 		facade,
 
 		// Optional:
 		name,
 		only
-	} = opts;
-
-	if (!controller) {
-		const err = new TypeError(`'controller' argument is not provided.`);
-		throw err;
-	}
+	} = options;
 
 	_setFacade(controller, facade);
 
@@ -60,7 +68,7 @@ function _withDefaultCRUD(controller, opts={}) {
 	const model = facade.model;
 	// Extract plural name of this model.
 	const modelPluralName = model?.options?.name?.plural;
-	// Set name of this controller:
+	// Set read-only name of this controller:
 	Object.defineProperty(controller, 'name', {
 		value: name ?? `${ modelPluralName ?? controller.name }Controller`,
 		writable: false
@@ -120,18 +128,15 @@ function _withDefaultCRUD(controller, opts={}) {
  * Sets default error responses to Controller.
  *
  * @param {Function|Object} controller
- * @param {Object} opts
+ * @param {Object} options
  *
  * @return {Function|Object} controller
  *
  * @api public
  * @alias withDefaultErrorProcessing
  */
-function _withDefaultErrorProcessing(controller, opts={}) {
-	if (!controller) {
-		const err = new TypeError(`'controller' argument is not provided.`);
-		throw err;
-	}
+function _withDefaultErrorProcessing(controller, options={}) {
+	ensure(controller, 'function|object,required', 'controller');
 
 	// Set processError:
 	controller.processError = function (error, req, res) {
@@ -220,15 +225,8 @@ function _withDefaultErrorProcessing(controller, opts={}) {
  * @alias setFacade
  */
 function _setFacade(controller, facade, facadeName=null) {
-	if (!controller) {
-		const err = new TypeError(`'controller' argument is not provided.`);
-		throw err;
-	}
-
-	if (!facade) {
-		const err = new TypeError(`'facade' argument is invalid.`);
-		throw err;
-	}
+	ensure(controller, 'function|object,required', 'controller');
+	ensure(facade, 'function|object,required', 'facade');
 
 	// Set main facade:
 	if (facade.constructor.name === 'Function') {
@@ -237,25 +235,27 @@ function _setFacade(controller, facade, facadeName=null) {
 	else {
 		controller[facadeName ?? 'facade'] = facade;
 	}
+
+	return controller;
 }
 
 
 /**
  * Sets one of CRUD methods to Controller.
  *
- * @param {Function|Object} controller
- * @param {Object} opts
+ * @param {Controller} controller
+ * @param {Function} fn
  *
- * @return {Function|Object} controller
+ * @return {Controller} controller
  *
  * @api public
- * @alias withDefaultCRUD
+ * @alias setMethod
  */
-function _setMethod(controller,) {
-	if (!controller) {
-		const err = new TypeError(`'controller' argument is not provided.`);
-		throw err;
-	}
+function _setMethod(controller, fn) {
+	ensure(controller, 'function|object,required', 'controller');
+	ensure(fn, 'function,required', 'fn');
 
+	controller[fn] = fn.bind(controller);
 
+	return controller;
 }

package/lib/database/connection.js

@@ -1,3 +1,9 @@
+/*!
+ * /nodester
+ * MIT Licensed
+ */
+'use strict';
+
 // ORM.
 const Sequelize = require('sequelize');
 

package/lib/database/migration.js

@@ -1,4 +1,11 @@
-const { associateModels } = require('./utils');
+/*!
+ * /nodester
+ * MIT Licensed
+ */
+ 
+'use strict';
+
+const { associateModels } = require('nodester/models/associate');
 
 
 module.exports = {
@@ -19,10 +26,13 @@ async function _migrate(databaseConnection, force=false) {
 
 		const models = databaseConnection.models;
 		const modelNames = Object.keys(models);
-		console.info('Models to sync:', modelNames);
+		
+		console.info('Models list:', ...modelNames.map(name => `\n • ${ name }`), '\n');
+
 		console.info('Forcefully?', force);
 		console.info('Syncing...\n');
-		await associateModels(models);
+
+		await associateModels(databaseConnection);
 		await databaseConnection.sync({ force });
 		console.info('Successful migration!');
 
@@ -34,7 +44,7 @@ async function _migrate(databaseConnection, force=false) {
 		return Promise.resolve(output);
 	}
 	catch(error) {
-		console.error('Migration failed!');
+		console.error(' Migration failed!');
 		console.error(error);
 		return Promise.reject(error);
 	}

package/lib/facades/methods/index.js

@@ -1,3 +1,10 @@
+/*!
+ * /nodester
+ * MIT Licensed
+ */
+ 
+'use strict';
+
 const Params = require('nodester/params');
 
 const log = require('nodester/loggers/dev');
@@ -30,13 +37,13 @@ async function _getOne(params) {
 		const instance = await this.model.findOne(query);
 
 		const result = {
-			[this.modelName.singular]: instance,
+			[this.outputName.singular]: instance,
 			count: 0 + (instance !== null)
 		}
 		return Promise.resolve(result);
 	}
 	catch(error) {
-		log.error(`${ [this.modelName.singular] }Facade.getOne error:`, error);
+		log.error(`${ this.name }.getOne error:`, error);
 		return Promise.reject(error);
 	}
 }
@@ -60,13 +67,13 @@ async function _getMany(params) {
 		const instances = await this.model.findAll(query);
 
 		const result = {
-			[this.modelName.plural]: instances,
+			[this.outputName.plural]: instances,
 			count: instances.length
 		}
 		return Promise.resolve(result);
 	}
 	catch(error) {
-		log.error(`${ [this.modelName.singular] }Facade.getMany error:`, error);
+		log.error(`${ this.name }.getMany error:`, error);
 		return Promise.reject(error);
 	}
 }
@@ -83,23 +90,16 @@ async function _createOne(params) {
 	try {
 		const {
 			data,
-			includes,
 		} = Params(params, {
 			data: null,
-			includes: null,
 		});
 
 		const instance = await this.model.create({ ...data }, {
 			include: this.model.getIncludesList(data)
 		});
 
-		// If includes are set, "find" this record with includes:
-		if (!!includes && includes?.length > 0) {
-			await instance.reload({ include: includes });
-		}
-
 		const result = {
-			[this.modelName.singular]: instance,
+			[this.outputName.singular]: instance,
 			count: 0 + (instance !== null)
 		}
 
@@ -109,7 +109,7 @@ async function _createOne(params) {
 		return Promise.resolve(result);
 	}
 	catch(error) {
-		log.error(`${ [this.modelName.singular] }Facade.createOne error:`, error);
+		log.error(`${ this.name }.createOne error:`, error);
 		return Promise.reject(error);
 	}
 }
@@ -138,13 +138,13 @@ async function _updateOne(params) {
 
 		const result = {
 			success: isNewRecord === false,
-			[this.modelName.singular]: instance,
+			[this.outputName.singular]: instance,
 			count: 0 + (instance !== null)
 		}
 		return Promise.resolve(result);
 	}
 	catch(error) {
-		log.error(`${ [this.modelName.singular] }Facade.updateOne error:`, error);
+		log.error(`${ this.name }.updateOne error:`, error);
 		return Promise.reject(error);
 	}
 }
@@ -174,7 +174,7 @@ async function _deleteOne(params) {
 		return Promise.resolve(result);
 	}
 	catch(error) {
-		log.error(`${ [this.modelName.singular] }Facade.deleteOne error:`, error);
+		log.error(`${ this.name }.deleteOne error:`, error);
 		return Promise.reject(error);
 	}
 }

package/lib/facades/mixins/index.js

@@ -1,3 +1,10 @@
+/*!
+ * /nodester
+ * MIT Licensed
+ */
+ 
+'use strict';
+
 const {
 	getOne,
 	getMany,
@@ -5,41 +12,47 @@ const {
 	updateOne,
 	deleteOne
 } = require('../methods');
-// Utils,
+
+// Utils:
+const { Sequelize } = require('sequelize');
 const { lowerCaseFirstLetter } = require('nodester/utils/strings');
 
+// Arguments validator.
+const { ensure } = require('../../validators/arguments');
+
 
 module.exports = {
 	withDefaultCRUD: _withDefaultCRUD,
+
+	setMethod: _setMethod
 }
 
 /**
  * Sets one of or all of CRUD methods to Facade.
  *
  * @param {Function|Object} facade
- * @param {Object} opts
- * - @param {Function|Object} model
- * - @param {String} name
- * - @param {Array} only
+ * @param {Object} options
+ * @param {Function|Object} options.model
+ * @param {String} 					options.name
+ * @param {Array} 					options.only
  *
  * @return {Function|Object} facade
  *
  * @api public
  * @alias withDefaultCRUD
  */
-function _withDefaultCRUD(facade, opts={}) {
+function _withDefaultCRUD(facade, options={}) {
+	ensure(facade, 'function|object,required', 'facade');
+	ensure(options, 'object,required', 'options');
+	ensure(options.model, 'function|object,required', 'options.model');
+
 	const {
 		model,
 
 		// Optional:
 		name,
 		only
-	} = opts;
-
-	if (!facade) {
-		const err = new TypeError(`'facade' argument is not provided.`);
-		throw err;
-	}
+	} = options;
 	
 	// Set model info:
 	//	Set model:
@@ -58,7 +71,6 @@ function _withDefaultCRUD(facade, opts={}) {
 		writable: false
 	});
 
-
 	// Set name of this facade:
 	Object.defineProperty(facade, 'name', {
 		value: name ?? `${ modelName.plural ?? facade.name }Facade`,
@@ -66,6 +78,28 @@ function _withDefaultCRUD(facade, opts={}) {
 	});
 
 
+	// Set the name of the output:
+	const outputName = {
+		singular: Sequelize.Utils.underscore(modelName.singular),
+		plural: Sequelize.Utils.underscore(modelName.plural)
+	}
+
+	switch (model.options.nodester.output) {
+		case 'camelcased':
+			outputName.singular = this.modelName.singular;
+			outputName.plural = this.modelName.plural;
+			break;
+		case 'underscored':
+		default:
+			break;
+	}
+
+	Object.defineProperty(facade, 'outputName', {
+		value: outputName,
+		writable: false
+	});
+
+
 	// If only certain methods should be set:
 	if (!!only) {
 		for (const selectedMethod of only) {
@@ -109,3 +143,23 @@ function _withDefaultCRUD(facade, opts={}) {
 
 	return facade;
 }
+
+/**
+ * Sets one of CRUD methods to Facade.
+ *
+ * @param {Facade} facade
+ * @param {Function} fn
+ *
+ * @return {Facade} facade
+ *
+ * @api public
+ * @alias setMethod
+ */
+function _setMethod(facade, fn) {
+	ensure(facade, 'function|object,required', 'facade');
+	ensure(fn, 'function,required', 'fn');
+
+	facade[fn] = fn.bind(facade);
+
+	return facade;
+}

package/lib/factories/responses/rest.js

@@ -1,5 +1,12 @@
+/*!
+ * /nodester
+ * MIT Licensed
+ */
+ 
+'use strict';
+
 /*
- * Rest response factory.
+ * REST response factory.
  */
 
 const ResponseFormats = require('../../constants/ResponseFormats');
@@ -11,7 +18,6 @@ module.exports = {
 	createErrorResponse: _createErrorResponse,
 }
 
-
 /*
  * Format for all API responses will be JSON
  * {
@@ -25,6 +31,10 @@ module.exports = {
  *
  * @param {ServerResponse} res
  * @param {Object} options
+ * @param {Object} options.error
+ * @param {Object} options.content (optional)
+ * @param {Int}    options.status
+ * @param {String} options.format
  *
  * @alias createGenericResponse
  * @api public
@@ -45,12 +55,13 @@ function _createGenericResponse(
 		};
 
 		switch(options?.format) {
-			case ResponseFormats.JSON:
-				return options?.res.status(options?.status).json(data);
-			case ResponseFormats.XML:
+			case ResponseFormats.JSON: {
+				return res.json(data);
+			}
+			case ResponseFormats.XML: {
 				// TODO: format data into XML.
-				return options?.res.status(options?.status).send(data);
-				break;
+				return res.send(data);
+			}
 			default: {
 				const err = new TypeError("No format specified.");
 				throw err;
@@ -71,8 +82,8 @@ function _createGenericResponse(
  * Should be called on all successful respones.
  *
  * @param {ServerResponse} res
- * @param <Object> content
- * @param <String> format
+ * @param {Object} options.content (optional)
+ * @param {String} options.format
  *
  * @alias createOKResponse
  * @api public
@@ -92,10 +103,11 @@ function _createOKResponse(res, options={}) {
  * Should be called on all failed respones.
  *
  * @param {ServerResponse} res
- * @param <Object> error
- * @param <Object> content (optional)
- * @param <Int>		 status
- * @param <String> format
+ * @param {Object} options
+ * @param {Object} options.error
+ * @param {Object} options.content (optional)
+ * @param {Int}    options.status
+ * @param {String} options.format
  *
  * @alias createErrorResponse
  * @api public

package/lib/http/codes/descriptions.js

@@ -0,0 +1,82 @@
+/*!
+ * /nodester
+ * MIT Licensed
+ */
+'use strict';
+
+const Enum = require('nodester/enum');
+
+
+module.exports = new Enum({
+	// Informational:
+	100: 'Continue',
+	101: 'Switching Protocols',
+	102: 'Processing',
+	103: 'Early Hints',
+
+	// Success:
+	200: 'OK',
+	201: 'Created',
+	202: 'Accepted',
+	203: 'Non-Authoritative Information',
+	204: 'No Content',
+	205: 'Reset Content',
+	206: 'Partial Content',
+	207: 'Multi-Status',
+	208: 'Already Reported',
+	226: 'IM Used',
+
+	// Redirections:
+	300: 'Multiple Choices',
+	301: 'Moved Permanently',
+	302: 'Found',
+	303: 'See Other',
+	304: 'Not Modified',
+	305: 'Use Proxy',
+	307: 'Temporary Redirect',
+	308: 'Permanent Redirect',
+
+	// Client Errors:
+	400: 'Bad Request',
+	401: 'Unauthorized',
+	402: 'Payment Required',
+	403: 'Forbidden',
+	404: 'Not Found',
+	405: 'Method Not Allowed',
+	406: 'Not Acceptable',
+	407: 'Proxy Authentication Required',
+	408: 'Request Timeout',
+	409: 'Conflict',
+	410: 'Gone',
+	411: 'Length Required',
+	412: 'Precondition Failed',
+	413: 'Payload Too Large',
+	414: 'URI Too Long',
+	415: 'Unsupported Media Type',
+	416: 'Range Not Satisfiable',
+	417: 'Expectation Failed',
+	418: 'I\'m a teapot',
+	421: 'Misdirected Request',
+	422: 'Unprocessable Entity',
+	423: 'Locked',
+	424: 'Failed Dependency',
+	425: 'Too Early',
+	426: 'Upgrade Required',
+	428: 'Precondition Required',
+	429: 'Too Many Requests',
+	431: 'Request Header Fields Too Large',
+	451: 'Unavailable For Legal Reasons',
+
+	// Server Errors:
+	500: 'Internal Server Error',
+	501: 'Not Implemented',
+	502: 'Bad Gateway',
+	503: 'Service Unavailable',
+	504: 'Gateway Timeout',
+	505: 'HTTP Version Not Supported',
+	506: 'Variant Also Negotiates',
+	507: 'Insufficient Storage',
+	508: 'Loop Detected',
+	510: 'Not Extended',
+	511: 'Network Authentication Required'
+});