nodester 0.0.8 → 0.1.0

package/lib/facades/mixins/index.js

@@ -0,0 +1,111 @@
+const {
+	getOne,
+	getMany,
+	createOne,
+	updateOne,
+	deleteOne
+} = require('../methods');
+// Utils,
+const { lowerCaseFirstLetter } = require('nodester/utils/strings');
+
+
+module.exports = {
+	withDefaultCRUD: _withDefaultCRUD,
+}
+
+/**
+ * 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
+ *
+ * @return {Function|Object} facade
+ *
+ * @api public
+ * @alias withDefaultCRUD
+ */
+function _withDefaultCRUD(facade, opts={}) {
+	const {
+		model,
+
+		// Optional:
+		name,
+		only
+	} = opts;
+
+	if (!facade) {
+		const err = new TypeError(`'facade' argument is not provided.`);
+		throw err;
+	}
+	
+	// Set model info:
+	//	Set model:
+	Object.defineProperty(facade, 'model', {
+		value: model,
+		writable: false
+	});
+
+	//	Model name:
+	const modelName = model.options.name;
+	Object.defineProperty(facade, 'modelName', {
+		value: {
+			singular: lowerCaseFirstLetter(modelName.singular),
+			plural: lowerCaseFirstLetter(modelName.plural)
+		},
+		writable: false
+	});
+
+
+	// Set name of this facade:
+	Object.defineProperty(facade, 'name', {
+		value: name ?? `${ modelName.plural ?? facade.name }Facade`,
+		writable: false
+	});
+
+
+	// If only certain methods should be set:
+	if (!!only) {
+		for (const selectedMethod of only) {
+			switch(selectedMethod) {
+				case 'getOne':
+					facade.getOne    = getOne.bind(facade);
+					break;
+				case 'getMany':
+					facade.getMany   = getMany.bind(facade);
+					break;
+				case 'createOne':
+					facade.createOne = createOne.bind(facade);
+					break;
+				case 'updateOne':
+					facade.updateOne = updateOne.bind(facade);
+					break;
+				case 'deleteOne':
+					facade.deleteOne = deleteOne.bind(facade);
+					break;
+
+				default:
+					break;
+			}
+		}
+	}
+	// Or set all methods:
+	else {
+		facade.getOne    = getOne.bind(facade);
+		facade.getMany   = getMany.bind(facade);
+		facade.createOne = createOne.bind(facade);
+		facade.updateOne = updateOne.bind(facade);
+		facade.deleteOne = deleteOne.bind(facade);
+
+		// Set empty hooks:
+		facade.afterGetOne    = async () => {};
+		facade.afterGetMany   = async () => {};
+		facade.afterCreateOne = async () => {};
+		facade.afterUpdateOne = async () => {};
+		facade.afterDeleteOe  = async () => {};
+	}
+
+	return facade;
+}

package/lib/middlewares/formidable/index.js

@@ -0,0 +1,37 @@
+/*!
+ * /nodester
+ * MIT Licensed
+ */
+'use strict';
+
+const { formidable } = require('formidable');
+
+
+module.exports = function FormidableMiddleware(formidableOptions={}) {
+	return async function(req, res, next) {
+		try {
+			const form = formidable(formidableOptions);
+			const [fields, files] = await form.parse(req);
+
+			// Add to request:
+			req.form = {
+				fields,
+				files
+			};
+
+			next();
+		}
+		catch(error) {
+			const statusCode = error.status || 406;
+			res.status(statusCode);
+			res.json({
+				error: {
+					message: error.message,
+					code: statusCode
+				},
+				status: statusCode
+			});
+		}
+	}
+};
+

package/lib/middlewares/ql/sequelize/interpreter/ModelsTree.js

@@ -16,7 +16,7 @@ class ModelsTreeNode {
 
 		this.includes = opts.includes ?? [];
 		this.order = opts.order ?? 'asc';
-		this.orderBy = opts.orderBy ?? 'id';
+		this.order_by = opts.order_by ?? 'id';
 	}
 
 	get hasParent() {
@@ -64,7 +64,7 @@ class ModelsTreeNode {
 			skip: this.skip,
 			limit: this.limit,
 			order: this.order,
-			orderBy: this.orderBy,
+			order_by: this.order_by,
 			
 			fields: this.fields,
 

package/lib/middlewares/ql/sequelize/interpreter/QueryLexer.js

@@ -378,7 +378,7 @@ module.exports = class QueryLexer {
 				return 'order';
 			case 'order_by':
 			case 'o_by':
-				return 'orderBy';
+				return 'order_by';
 			case 'fields':
 			case 'f':
 				return 'fields';
@@ -406,8 +406,8 @@ module.exports = class QueryLexer {
 			case 'order':
 				treeNode.order = token;
 				break;
-			case 'orderBy':
-				treeNode.orderBy = token;
+			case 'order_by':
+				treeNode.order_by = token;
 				break;
 			case 'fields':
 				if (token)

package/lib/models/associate.js

@@ -0,0 +1,17 @@
+
+module.exports = async function associateModels(databaseConnection) {
+	try {
+		const models = databaseConnection.models;
+
+		const modelNames = Object.keys(models);
+
+		for (let modelName of modelNames) {
+			await models[modelName].associate(models);
+		}
+
+		return Promise.resolve(models);
+	}
+	catch(error) {
+		return Promise.reject(error);
+	}
+}

package/lib/models/define.js

@@ -2,6 +2,8 @@
 const { implementsCRUD } = require('./mixins');
 // ORM.
 const { DataTypes } = require('sequelize');
+// NQL.
+const Colander = require('../queries/Colander');
 
 
 module.exports = defineModel;
@@ -37,13 +39,23 @@ function defineModel(
 		// Add user-defined options (they can override upper ones).
 		...options
 	};
+
 	const model = databaseConnection.define(modelName, definitionObject, _options);
 
 	if (options.noCRUD !== true) {
-		// Add createWithIncludes, findById, updateById, deleteById, etc.
+		// Add:
+		// - createWithIncludes;
+		// - findById;
+		// - updateById;
+		// - deleteById;
+		// - etc.
 		implementsCRUD(model);
 	}
 
+	// Association helpers:
+	model.associate = (models) => {};
+	model.getIncludesList = _getIncludesList.bind(model);
+
 	// Instance methods:
 	model.prototype.toJSON = function() {
 		const values = { ...this.get() };
@@ -53,3 +65,40 @@ function defineModel(
 
 	return model;
 }
+
+/* Association mixins: */
+function _getIncludesList(facadeData=null) {
+	const result = [];
+
+	const associations = this.associations;
+	const associationEntries = Object.entries(associations);
+
+	associationEntries.forEach(([
+		associationName,
+		associationDefinition
+	]) => {
+		const a = { association: associationName };
+
+		if (!!facadeData) {
+			// If facade data is set, go deeper:
+			const keys = Object.keys( facadeData );
+			if (keys.indexOf(associationName) > 0) {
+				const associationModel = associationDefinition.target;
+
+				const a = { association: associationName };
+				if (Object.entries(associationModel.associations).length > 0) {
+					const deepData = facadeData[ associationName ];
+					a.include = associationModel.getIncludesList(Array.isArray(deepData) ? deepData[0] : deepData);
+				}
+
+				result.push( a );
+			}
+		}
+		else {
+			result.push( a );
+		}
+	});
+
+	return result;
+}
+/* Association mixins\ */

package/lib/models/mixins.js

@@ -6,7 +6,11 @@ const {
 	modelHasAssociations,
 	getModelAssociationProps,
 	compileModelAssociationData,
-} = require('nodester/utils/modelAssociations.util');
+} = require('../utils/modelAssociations.util');
+
+// Nodester query:
+const NQLexer = require('../middlewares/ql/sequelize/interpreter/QueryLexer');
+const traverseNQuery = require('../queries/traverse');
 
 
 module.exports = {
@@ -17,15 +21,15 @@ module.exports = {
 /**
  * Sets all of CRUD methods to Model.
  *
- * @param {Object} controller
+ * @param {Object} modelDefinition
  *
  *
  * @api public
  * @alias implementsCRUD
  */
-function _implementsCRUD(model) {
-	if (!model) {
-		const err = new TypeError(`'model' argument is not provided.`);
+function _implementsCRUD(modelDefinition) {
+	if (!modelDefinition) {
+		const err = new TypeError(`"modelDefinition" argument is not provided.`);
 		throw err;
 	}
 
@@ -34,17 +38,15 @@ function _implementsCRUD(model) {
 
 	// Read:
 	modelDefinition.findById = _findById.bind(modelDefinition);
-	modelDefinition.findOneWithIncludes = _findOneWithIncludes.bind(modelDefinition);
+	modelDefinition.findMany = _findMany.bind(modelDefinition);
 
 	// Update:
 	modelDefinition.updateOne = _updateOne.bind(modelDefinition);
 	modelDefinition.updateById = _updateById.bind(modelDefinition);
 
-	// Delete.
+	// Delete:
+	modelDefinition.deleteOne = _deleteOne.bind(modelDefinition);
 	modelDefinition.deleteById = _deleteById.bind(modelDefinition);
-
-	// Associations:
-	modelDefinition.getIncludesList = _getIncludesList.bind(modelDefinition);
 }
 
 
@@ -114,37 +116,76 @@ async function _createWithIncludes(
 
 function _findById(
 	id=null,
-	include=[],
-	paranoid=true
+	opts={}
 ) {
-	const query = {
-		where: { id },
-		include: include,
-		paranoid: !!paranoid
-	};
-	return this.findOne(query);
+	const { query } = opts;
+
+	let _query = {};
+
+	if (typeof query === 'string') {
+		const lexer = new NQLexer(query);
+		const nquery = lexer.query;
+		_query = traverseNQuery(nquery, null, this);
+		_query.where = {
+			..._query.where,
+			id: id
+		}
+	}
+	else {
+		const {
+			include,
+			paranoid
+		} = opts;
+
+		_query = {
+			where: { id },
+			include: include,
+			paranoid: !!paranoid
+		};
+	}
+
+	return this.findOne(_query);
 }
 
-function _findOneWithIncludes(
-	where={},
-	include=[],
-	paranoid=true
-) {
-	const query = {
-		where: where,
-		include: include,
-		paranoid: !!paranoid
-	};
-	return this.findOne(query);
+function _findMany(opts={}) {
+	const { query } = opts;
+
+	let _query = {};
+
+	if (typeof query === 'string') {
+		const lexer = new NQLexer(query);
+		const nquery = lexer.query;
+		_query = traverseNQuery(nquery, null, this);
+		_query.where = {
+			..._query.where,
+			id: id
+		}
+	}
+	else {
+		const {
+			include,
+			paranoid
+		} = opts;
+
+		_query = {
+			where: { id },
+			include: include,
+			paranoid: !!paranoid
+		};
+	}
+
+
+	return this.findAll(_query);
 }
 
+
 async function _updateOne(
 	where,
 	data,
 	include=[]
 ) {
 	try {
-		const instance = await this.findOneWithIncludes(where, include);
+		const instance = await this.findOne({ where, include });
 
 		if (!instance) {
 			const err = new Error(`Model not found`);
@@ -201,7 +242,7 @@ async function _updateOne(
 		
 		// Select this instance again, if includes was set:
 		if (include?.length > 0) {
-			const updatedInstance = await this.findOneWithIncludes(where, include);
+			const updatedInstance = await this.findOne({ where, include });
 			fullInstanceData = updatedInstance.toJSON();
 		}
 
@@ -225,6 +266,15 @@ async function _updateById(
 	);
 }
 
+
+function _deleteOne(query={}) {
+	const _query = {
+		...query,
+		limit: 1
+	}
+	return this.destroy(_query);
+}
+
 function _deleteById(
 	id=null
 ) {
@@ -235,47 +285,6 @@ function _deleteById(
 }
 /* Main mixinis\ */
 
-/* Association mixins: */
-function _getIncludesList(facadeData=null) {
-	// console.log({ facadeData, model: this });
-
-	const result = [];
-
-	const associations = this.associations;
-	const associationEntries = Object.entries(associations);
-
-	associationEntries.forEach(([
-		associationName,
-		associationDefinition
-	]) => {
-		const a = { association: associationName };
-
-		if (!!facadeData) {
-			// If facade data is set, go deeper:
-			const keys = Object.keys( facadeData );
-			if (keys.indexOf(associationName) > 0) {
-				const associationModel = associationDefinition.target;
-
-				const a = { association: associationName };
-				if (Object.entries(associationModel.associations).length > 0) {
-					const deepData = facadeData[ associationName ];
-					a.include = associationModel.getIncludesList(Array.isArray(deepData) ? deepData[0] : deepData);
-				}
-
-				result.push( a );
-			}
-		}
-		else {
-			result.push( a );
-		}
-	});
-
-	// console.log('getIncludesList', result);
-
-	return result;
-}
-/* Association mixins\ */
-
 /* Subfunctions: */
 async function _updateOrCreateOrDelete(
 	modelDefinition,

package/lib/params/Params.js

@@ -10,10 +10,9 @@ module.exports = Params;
  * @param {Object} sourceObj
  * @param {Object} defaultValuesList
  *
- * @return {Function|Object} controller
+ * @return {Object} result
  *
  * @api public
- * @alias withDefaultCRUD
  */
 function Params(
 	sourceObj={},
@@ -23,11 +22,15 @@ function Params(
 
 	const keys = Object.keys(defaultValuesList);
 	for (const key of keys) {
-		// If value is not set, use default one from 'defaultValuesList'.
-		result[key] = !(key in sourceObj[key]) ?
-										defaultValuesList[key]
-										:
-										sourceObj[key];
+
+		// 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/queries/Colander.js

@@ -0,0 +1,84 @@
+const CLAUSES = ['limit', 'skip', 'order', 'order_by'];
+
+
+module.exports = class Colander {
+
+	/*
+	 *
+	 * @param {Object|Model} optsOrModelDefinition
+	 * - @param {Array} fields
+	 * - @param {Array} clauses
+	 * - @param {Object} includes
+	 * - @param {Object} statics
+	 * -- @param {Object} attributes
+	 * -- @param {Object} clauses
+	 *
+	 */
+	constructor(optsOrModelDefinition) {
+		this._fields = [];
+		this._clauses = [];
+		this._includes = {};
+		
+		this._statics = {
+			attributes: {},
+			clauses: {
+				limit: 3
+			}
+		}
+
+		// If model:
+		if (!!optsOrModelDefinition.tableName && typeof optsOrModelDefinition._schema === 'object') {
+			this._fields = Object.keys(optsOrModelDefinition.tableAttributes);
+			this._clauses = CLAUSES;
+		}
+		// If options:
+		else {
+			const {
+				fields,
+				clauses,
+				includes,
+				statics,
+			} = optsOrModelDefinition;
+
+			if (Array.isArray(fields)) {
+				this._fields = fields;
+			}
+
+			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\
+}