nodester 0.4.7 → 0.4.9

package/lib/middlewares/ql/sequelize/index.js

@@ -13,10 +13,6 @@ const { decodeQueryString } = require('./decoder');
 const QueryLexer = require('./interpreter/QueryLexer');
 const { createErrorResponse } = require('nodester/factories/responses/rest');
 
-const {
-	AST_ModelsTree
-} = require('nodester/tools/nql');
-
 
 module.exports = function initNodesterQL() {
 	return nqlHandle;
@@ -42,10 +38,6 @@ function nqlHandle(req, res, next) {
 		const decoded = decodeQueryString(queryString);
 		const lexer = new QueryLexer(decoded);
 
-		console.log(
-			AST_ModelsTree(lexer.tree)
-		);
-
 		// Go on!
 		req.nquery = lexer.query;
 		return next();

package/lib/query/traverse/index.js

@@ -345,7 +345,7 @@ function traverse(queryNode, filter=null, model=null, association=null) {
 
 	// Combine included orders into one at the top level:
 	// - Why?
-	// - Sequelize ingores included orders for association types like:
+	// - Sequelize ignores included orders for association types like:
 	//   • HasMany
 	_traverseIncludedOrders(newQuery, _model);
 

package/lib/structures/Filter.js

@@ -91,6 +91,7 @@ module.exports = class NodesterFilter {
 			const { associations } = this.model;
 			for (const [ includeName, includeFilter ] of Object.entries(includes)) {
 				const association = associations[includeName];
+				
 				// Validate association by name:
 				if (association === undefined) {
 					const error = new TypeError(`No include named '${ includeName }'.`);
@@ -98,10 +99,23 @@ module.exports = class NodesterFilter {
 					throw error;
 				}
 
+				const { associationType } = association;
+
 				// If singular association:
-				// Fix of "Only HasMany associations support include.separate"
-				if ('HasMany' !== association.associationType) {
-					// Empty bounds.
+				// (Fix of sequilize error "Only HasMany associations support include.separate")
+				if ('HasMany' !== associationType) {
+					// Empty bounds:
+					if (!!includeFilter.statics.clauses.limit) {
+						const msg = [
+							`(nodester) warning: include "${ includeName }" has`,
+							`association type of "${ associationType }", but has a filter clause "limit",`,
+							`which is forbidden on any association type except for "HasMany".`,
+							`It was automatically removed from clauses.`
+						].join(' ');
+						console.warn(msg);
+					}
+					delete includeFilter.statics.clauses.limit;
+
 					includeFilter.noBounds = true;
 				}
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nodester",
-  "version": "0.4.7",
+  "version": "0.4.9",
   "description": "A versatile REST framework for Node.js",
   "directories": {
     "docs": "docs",

package/lib/constants/Operators.js

@@ -1,23 +0,0 @@
-const Enum = require('nodester/enum');
-
-
-module.exports = new Enum({
-	and: Symbol.for('and'),
-	between: Symbol.for('between'),
-	contains: Symbol.for('contains'),
-	eq: Symbol.for('eq'),
-	ne: Symbol.for('ne'),
-	gte: Symbol.for('gte'),
-	gt: Symbol.for('gt'),
-	lte: Symbol.for('lte'),
-	lt: Symbol.for('lt'),
-	not: Symbol.for('not'),
-	is: Symbol.for('is'),
-	in: Symbol.for('in'),
-	notIn: Symbol.for('notIn'),
-	like: Symbol.for('like'),
-	notLike: Symbol.for('notLike'),
-	notBetween: Symbol.for('notBetween'),
-	or: Symbol.for('or'),
-	xor: Symbol.for('xor'),
-});

package/lib/middlewares/404/index.js

@@ -1,38 +0,0 @@
-/**
- * nodester
- * MIT Licensed
- */
- 
-'use strict';
-
-const {
-	HTTP_CODE_NOT_FOUND
-} = require('nodester/http/codes');
-
-const { createErrorResponse } = require('nodester/factories/responses/rest');
-
-
-/**
- * Initialize `404` middleware.
- *
- * @param {Object}  [options]
- *
- * @return {Function}
- *
- * @access public
- */
-module.exports = function init404Middleware(options={}) {
-	const context = {
-		options
-	}
-	return handle.bind(context);
-}
-
-function handle(req, res, next) {
-	const err = new Error('Route not found');
-	
-	return createErrorResponse(res, {
-		error: err,
-		status: HTTP_CODE_NOT_FOUND
-	});
-}

package/lib/middlewares/etag/index.js

@@ -1,81 +0,0 @@
-/**
- * nodester
- * MIT Licensed
- */
-
-'use strict';
-
-const calculate = require('etag');
-const Stream = require('stream');
-
-// Utils:
-const promisify = require('util').promisify;
-const fs = require('fs');
-const getFileStats = promisify(fs.stat);
-
-
-module.exports = initETagMiddleware;
-
-/**
- * Initialize `etag` middleware.
- *
- * @param {Object}  [options]
- * @param {boolean} options.weak
- *
- * @return {Function}
- *
- * @access public
- */
-function initETagMiddleware(options) {
-	const context = {
-		options
-	}
-	return handle.bind(context);
-}
-
-/**
- * Add ETag header field.
- */
-function handle(req, res, next) {
-	// console.log('e', req.headers);
-	return next();
-}
-
-async function _getResponseEntity(res) {
-	// If body is not defined:
-	const { body } = res;
-	if (!body || res.get('etag'))
-		return;
-
-	// Status code.
-	const status = res.statusCode / 100 | 0;
-
-	console.log('getResponseEntity', status, { tag: res.get('etag') });
-
-	// 2xx
-	if (status !== 2)
-		return;
-
-	if (body instanceof Stream) {
-		if (!body.path)
-			return;
-
-		const stats = await getFileStats(body.path);
-		return stats;
-	}
-	else if (typeof body === 'string' || Buffer.isBuffer(body)) {
-		return body;
-	}
-	else {
-		return JSON.stringify(body);
-	}
-}
-
-function _setEtag(res, entity, options) {
-	console.log('setEtag', typeof res, entity);
-
-	if (!entity)
-		return;
-
-	res.etag = calculate(entity, options);
-}

package/lib/middlewares/render/index.js

@@ -1,62 +0,0 @@
-/**
- * nodester
- * MIT Licensed
- */
- 
-'use strict';
-
-
-module.exports = function initRenderMiddleware() {
-	return handle;
-}
-
-
-function handle(req, res, next) {
-	const context = { req, res, next };
-	res.render = _render.bind(context);
-	next();
-}
-
-
-/**
- * Render `view` with the given `options` and optional callback `fn`.
- * When a callback function is given a response will _not_ be made
- * automatically, otherwise a response of _200_ and _text/html_ is given.
- *
- * Options:
- *
- *  - `cache`     boolean hinting to the engine it should cache
- *  - `filename`  filename of the view being rendered
- *
- * @alias render
- * @access public
- */
-function _render(view, options, callback) {
-	const app = this.req.app;
-	let done = callback;
-	let opts = options || {};
-	
-	const req = this.req;
-	const res = this.res;
-	const next = this.next;
-
-	// support callback function as second arg
-	if (typeof options === 'function') {
-		done = options;
-		opts = {};
-	}
-
-	// merge res.locals
-	opts._locals = res.locals;
-
-	// default callback to respond
-	done = done || function (err, str) {
-		if (err)
-			return next(err);
-		
-		res.send(str);
-	};
-
-	// render
-	app.render(view, opts, done);
-};

package/lib/utils/queries.util.js

@@ -1,240 +0,0 @@
-// Constants.
-const SubIncludesQueryRegex = /\([^)]*\)/g;
-
-// Sequelize.
-const Op = require('sequelize').Op;
-
-// Utils.
-const {
-	splitByDot,
-	splitByAmpersand
-} = require('nodester/utils/strings.util');
-
-
-module.exports = {
-	parseQueryParams: _parseQueryParams,
-	deleteQuerySortParams: _deleteQuerySortParams,
-
-	// SubIncludes Query:
-	hasSubIncludesQuery: _hasSubIncludesQuery,
-	cutSubIncludesQuery: _cutSubIncludesQuery,
-	parseSubIncludesQuery: _parseSubIncludesQuery
-}
-
-function _parseQueryParams(
-	requestQueryObject={},
-	sequilizeQuery=null
-) {
-	const skip = parseInt(requestQueryObject?.skip ?? 0);
-	const limit = parseInt(requestQueryObject?.limit ?? 50);
-
-	sequilizeQuery.offset = skip;
-	sequilizeQuery.limit = limit;
-
-	const order = requestQueryObject?.order;
-
-	// If order is set:
-	if (!!order) {
-		const orderBy = requestQueryObject?.order_by ?? 'id';
-
-		sequilizeQuery.order = [
-			[ orderBy, order ]
-		];
-	}
-
-	// Clear sort params.
-	_deleteQuerySortParams(requestQueryObject);
-
-	// Get include names.
-	const _includes = sequilizeQuery?.include?.map( include => include.association ) ?? [];
-
-	// Count query keys.
-	const keysCount = Object.keys(requestQueryObject).length;
-
-	// If query has no keys,
-	// stop further execution:
-	if (keysCount === 0) {
-		return;
-	}
-
-	// This container is a reference to current "where".
-	let container = null;
-	let isContainerArray = false;
-
-	// If query has only 1 key:
-	if (keysCount === 1) {
-		// Define empty query's where.
-		sequilizeQuery.where = {};
-		container = sequilizeQuery.where;
-	}
-	else {
-		// Define conjuction of params in query's where.
-		sequilizeQuery.where = {
-			[Op.and]: []
-		};
-		container = sequilizeQuery.where[Op.and];
-		isContainerArray = true;
-	}
-
-	// Go through query's keys:
-	Object.keys(requestQueryObject)
-				.forEach((queryKey) => {
-
-		// Parse value of this key:
-		const value = requestQueryObject[queryKey];
-		// If value is not a number, parse it further.
-		const parsedValue = isNaN( value ) ? _parseHTTPQueryValue( `${ requestQueryObject[queryKey] }` ) : value;
-		
-		// If we got nested key:
-		if (queryKey.indexOf('.') !== -1) {
-
-			// If this key is included as association:
-			const associationIndex = _includes.indexOf(queryKey.split('.')[0]);
-			if (associationIndex > -1) {
-				sequilizeQuery.include[associationIndex].where = { [`$${queryKey}$`]: parsedValue };
-			}
-			// Use special sequelize syntax for nested SELECT:
-			else if (isContainerArray) {
-				const selectObject = { [`$${queryKey}$`]: parsedValue };
-				container.push(selectObject);
-			}
-			else {
-				container[`$${queryKey}$`] = parsedValue;
-			}
-		}
-		// On regular key, set regular key-value pair:
-		else {
-			if (isContainerArray) {
-				const selectObject = { [queryKey]: parsedValue };
-				container.push(selectObject);
-			}
-			else {
-				container[queryKey] = parsedValue;
-			}
-		}
-	});
-}
-
-function _parseHTTPQueryValue(
-	value='',
-	isNumber=false
-) {
-	// If value matches "and()":
-	if (value.slice(0, 4) === 'and(') {
-		// Remove "and()".
-		const clearValuesString = value.substr(4, value.length - 'and()'.length);
-
-		const clearValues = clearValuesString.split(',');
-
-		return {
-			[Op.and]: clearValues.map(cv => _parseHTTPQueryValue(cv))
-		}
-	}
-	// If value matches "like(value)":
-	else if (value.slice(0, 5) === 'like(') {
-		// Remove "like()".
-		const clearValue = value.substr(5, value.length - 'like()'.length);
-
-		return {
-			[Op.like]: `%${ _parseHTTPQueryValue(clearValue) }%`
-		}
-	}
-	// If value matches "notLike(value)":
-	else if (value.slice(0, 8) === 'notLike(') {
-		// Remove "notLike()".
-		const clearValue = value.substr(8, value.length - 'notLike()'.length);
-
-		return {
-			[Op.notLike]: `%${ _parseHTTPQueryValue(clearValue) }%`
-		}
-	}
-	// If value matches "not(value)":
-	else if (value.slice(0, 4) === 'not(') {
-		// Remove "not()".
-		const clearValue = value.substr(4, value.length - 'not()'.length);
-
-		return {
-			[Op.not]: _parseHTTPQueryValue(clearValue)
-		};
-	}
-	// If value matches "or()":
-	else if (value.slice(0, 3) === 'or(') {
-		// Remove "or()".
-		const clearValuesString = value.substr(3, value.length - 'or()'.length);
-
-		const clearValues = clearValuesString.split(',');
-
-		return {
-			[Op.or]: clearValues.map(cv => _parseHTTPQueryValue(cv))
-		}
-	}
-	// If value is a number:
-	// else if (!isNaN(value)) {
-	// 	const number = parseFloat(value);
-	// 	return number;
-	// }
-	// For default, just set this value in "where"
-	return value;
-}
-
-function _deleteQuerySortParams(requestQueryObject={}) {
-	delete requestQueryObject.skip;
-	delete requestQueryObject.limit;
-	delete requestQueryObject.order;
-	delete requestQueryObject.order_by;
-}
-
-// If string has nested query "()":
-function _hasSubIncludesQuery(string='') {
-	return SubIncludesQueryRegex.test(string);
-}
-
-function _cutSubIncludesQuery(string='') {
-	const query = string.match(SubIncludesQueryRegex)[0];
-	const newString = string.replace(SubIncludesQueryRegex, '');
-
-	return [ query, newString ];
-}
-
-function _parseSubIncludesQuery(
-	associationName,
-	subIncludesQuery='',
-	sequilizeQuery=null
-) {
-	const query = {};
-
-	// Magic trick to make everything work (DO NOT REMOVE).
-	sequilizeQuery.separate = true;
-
-	// If first "("" & ")" are set, cut them:
-	const subIncludesQueryRegex = /\([^)]*\)/g;
-	const clearQuery = subIncludesQueryRegex.test(subIncludesQuery) ?
-												subIncludesQuery.substr(1, subIncludesQuery.length - 2)
-												:
-												subIncludesQuery;
-
-	const keyValues = splitByAmpersand(clearQuery).map(kv => {
-											const keyValue = kv.split('=');
-											query[keyValue[0]] = keyValue[1];
-										});
-
-
-	if (!!query.skip) {
-		const skip = parseInt(query.skip ?? 0);
-		sequilizeQuery[`$${ associationName }.offset$`] = skip;
-	}
-
-	if (!!query.limit) {
-		const limit = parseInt(query.limit ?? 50);
-		sequilizeQuery[`$${ associationName }.limit$`] = limit;
-	}
-
-	// If order is set:
-	if (!!query.order) {
-		const orderBy = query?.order_by ?? 'id';
-
-		sequilizeQuery.order = [
-			[ orderBy, query.order ]
-		];
-	}
-}

package/tests/ast.js

@@ -1,18 +0,0 @@
-const { ModelsTree } = require('../lib/middlewares/ql/sequelize/interpreter/ModelsTree');
-const { AST_ModelsTree } = require('../lib/tools/nql.tool');
-
-const tree = new ModelsTree();
-tree.node.addWhere({ id: ['1000'] });
-tree.include('comments').use('comments');
-tree.node.order = 'desc';
-tree.up();
-tree.include('users');
-tree.include('likes') && tree.use('likes');
-tree.node.order = 'rand';
-tree.up();
-tree.include('reposts');
-
-console.debug(
-	AST_ModelsTree(tree)
-);
-