nodester 0.0.9 → 0.1.0

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;
@@ -41,10 +43,19 @@ function defineModel(
 	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() };
@@ -54,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

@@ -8,6 +8,10 @@ const {
 	compileModelAssociationData,
 } = require('../utils/modelAssociations.util');
 
+// Nodester query:
+const NQLexer = require('../middlewares/ql/sequelize/interpreter/QueryLexer');
+const traverseNQuery = require('../queries/traverse');
+
 
 module.exports = {
 	implementsCRUD: _implementsCRUD
@@ -34,17 +38,15 @@ function _implementsCRUD(modelDefinition) {
 
 	// 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\
+}

package/lib/queries/traverse.js

@@ -0,0 +1,311 @@
+const { Op } = require('sequelize');
+
+
+module.exports = traverse;
+
+function traverse(queryNode, colander=null, model) {
+
+	const fieldsAvailable = Object.keys(model.tableAttributes);
+	const includesAvailable = model.getIncludesList();
+
+	const newQuery = {
+		attributes: [],
+		where: {},
+		include: []
+	};
+	
+	const {
+		where,
+		includes,
+		fields,
+		clauses,
+	} = _disassembleQueryNode(queryNode);
+
+
+	// Fields:
+	//
+	//	If Colander is not set,
+	//	use every available field:
+	if (colander === null) {
+		for (let field of fieldsAvailable) {
+			// If no query filter or field is requested:
+			if (fields.length === 0 || fields.indexOf(field) > -1) {
+				newQuery.attributes.push(field);
+				continue;
+			}
+		}
+	}
+	//	Colander is present:
+	else {
+		// If no query fields were set,
+		//	use the ones from Colander,
+		// If query fields were set,
+		//	put them through Colander:
+		for (let field of colander.fields) {
+			if (fieldsAvailable.indexOf(field) === -1) {
+				const err = new TypeError(`field ${ field } is not present in model.`);
+				throw err;
+			}
+
+			// If field is not in available set:
+			// if (colander.fields.indexOf(field) === -1) {
+			// 	continue;
+			// }
+
+			// If no query filter or field is requested:
+			if (fields.length === 0 || fields.indexOf(field) > -1) {
+				newQuery.attributes.push(field);
+				continue;
+			}
+		}
+	}
+	
+	//	At least 1 field is mandatory:
+	if (newQuery.attributes.length === 0) {
+		const err = new TypeError(`No fields were selected.`);
+		throw err;
+	}
+	// Fields\
+
+
+	// Clauses:
+	const order = {};
+
+	const clausesEntries = Object.entries(clauses);
+	for (let [clauseName, value] of clausesEntries) {
+		// If clause is not available:
+		if (colander != null) {
+			if (colander.clauses.indexOf(clauseName) === -1)
+				continue;
+		}
+
+		switch(clauseName) {
+			case 'limit':
+				// Do not set if -1:
+				if (value === -1) 
+					continue;
+
+				newQuery.limit = value;
+				continue;
+			case 'skip':
+				// Do not set if 0:
+				if (value === 0)
+					continue;
+
+				newQuery.offset = value;
+				continue;
+			case 'order':
+				order.order = value;
+				continue;
+			case 'order_by':
+				order.by = value;
+				continue;
+			default:
+				continue;
+		}
+	}
+
+	//	"statics" override or set any query Clause:
+	if (colander !== null) {
+		for (let [clauseName, staticClauseValue] of Object.entries(colander.statics.clauses)) {
+			switch(clauseName) {
+				case 'limit':
+					newQuery.limit = staticClauseValue;
+					continue;
+				case 'skip':
+					newQuery.offset = staticClauseValue;
+					continue;
+				case 'order':
+					order.order = staticClauseValue;
+					continue;
+				case 'order_by':
+					order.by = staticClauseValue;
+					continue;
+				default:
+					break;
+			}
+		}
+	}
+	// Clauses\
+
+
+	// Order:
+	const sequelize = model.sequelize;
+	if ( ['rand', 'random'].indexOf(order.order) > -1) {
+		newQuery.order = sequelize.random();
+	}
+	else {
+		const column = sequelize.col( order.by );
+		switch (order.order) {
+			// MAX/MIN:
+			case 'max-asc':
+			case 'max':
+			case 'min-desc':
+				newQuery.order = sequelize.fn('max', column);
+				break;
+			case 'min':
+			case 'min-asc':
+			case 'max-desc':
+				newQuery.order = [ sequelize.fn('max', column), 'DESC' ];
+				break;
+			// MAX/MIN\
+
+			default:
+				newQuery.order = [ [order.by, order.order] ];
+				break;
+		}
+	}
+	// Order\
+
+
+	// Includes:
+	// 	If requested includes are not available:
+	const leftIncludes = includesAvailable.map(i => i.association);
+	for (let include of includes) {
+		const includeName = include.model;
+
+		const includeIndex = leftIncludes.indexOf(includeName);
+		if (includeIndex === -1) {
+			const err = new TypeError(`No include named ${ includeName }`);
+			throw err;
+		}
+
+		leftIncludes.splice(includeIndex, 1);
+	}
+
+	_traverseIncludes(includes, model, colander, newQuery)
+	// Includes\
+
+
+	// Where:
+	const whereEntries = Object.entries(where);
+	for (let [attribute, value] of whereEntries) {
+		_parseWhereEntry(attribute, value, newQuery.where, colander.statics.attributes);
+	}
+
+	// If "where" was not set:
+	if (whereEntries.length === 0) {
+		delete newQuery.where;
+	}
+	// Where\
+
+
+	return newQuery;
+}
+
+
+function _traverseIncludes(includes, model, colander, resultQuery) {
+	// If no Colander:
+	if (colander === null) {
+		for (let include of includes) {
+			const includeName = include.model;
+			const association = model.associations[includeName];
+
+			// If no such association:
+			if (!association) {
+				const err = new TypeError(`No include ${ includeName }`);
+				throw err;
+			}
+
+			const includeModel = association.target;
+			// Build query for this include.
+			const associationQuery = traverse(include, null, includeModel);
+
+			_addAssociationQuery(associationQuery, includeName, resultQuery);
+		}
+	}
+	//	Colander is present:
+	else {
+		const colanderIncludeEntries = Object.entries(colander.includes);
+		for (let [includeName, includeColander] of colanderIncludeEntries) {			
+			const association = model.associations[includeName];
+			// If no such association:
+			if (!association) {
+				const err = new TypeError(`No include ${ includeName }`);
+				throw err;
+			}
+
+			// If include was not requested:
+			const include = includes.find(({ model }) => model === includeName);
+			if (!include)
+				continue;
+
+			const includeModel = association.target;
+			// Build query for this include.
+			const associationQuery = traverse(include, colander.includes[includeName], includeModel);
+
+			_addAssociationQuery(associationQuery, includeName, resultQuery);
+		}
+	}
+}
+
+
+function _addAssociationQuery(associationQuery, includeName, resultQuery) {
+
+	// Add all association info into query.
+	resultQuery.include.push({
+		association: includeName,
+		...associationQuery
+	});
+}
+
+
+function _parseWhereEntry(attribute, value, whereHolder, staticAttributes) {
+	let _value = value;
+	const static = staticAttributes[attribute];
+
+	// If attribute is Op (like, or, not, etc.):
+	if (attribute in Op) {
+		// Parse value:
+		_value = _parseValue(_value, attribute);
+
+		const op = Op[attribute];
+		whereHolder[op] = _value;
+		return;
+	}
+	
+	// Static value overrides any other:
+	if (!!static) {
+		whereHolder[attribute] = static;
+		return;
+	}
+
+	whereHolder[attribute] = _parseValue(_value, attribute);
+}
+
+function _disassembleQueryNode(queryNode) {
+	// Disassemble current query node:
+	const {
+		where,
+		includes,
+		fields,
+		...clauses
+	} = queryNode;
+	// delete queryNode.model;
+
+	return {
+		where: where ?? {},
+		includes: includes ?? [],
+		fields: fields ?? [],
+		clauses: clauses ?? []
+	};
+}
+
+function _parseValue(value, attribute) {
+	// If value is Object:
+	if (typeof value === 'object' && Array.isArray(value) === false) {
+		const [opKey, rawValue] = (Object.entries(value))[0];
+
+		// If operation is "in":
+		if (opKey === 'in') {
+			// Unwrap rawValue.
+			return rawValue[0][attribute];
+		}
+		else {
+			const op = Op[opKey];
+			return { [op]: rawValue };
+		}
+	}
+
+	return value;
+}