nodester 0.2.6 → 0.2.8

package/lib/middlewares/cookies/index.js

@@ -1,5 +1,5 @@
-/*!
- * /nodester
+/**
+ * nodester
  * MIT Licensed
  */
  

package/lib/middlewares/etag/index.js

@@ -1,5 +1,5 @@
-/*!
- * /nodester
+/**
+ * nodester
  * MIT Licensed
  */
 
@@ -14,29 +14,31 @@ const fs = require('fs');
 const getFileStats = promisify(fs.stat);
 
 
+module.exports = initETagMiddleware;
+
 /**
  * Initialize `etag` middleware.
  *
- * @param {Object}  options
- * @param {Boolean} options.weak
+ * @param {Object}  [options]
+ * @param {boolean} options.weak
  *
  * @return {Function}
  *
- * @api public
+ * @access public
  */
-module.exports = function initETagMiddleware(options) {
+function initETagMiddleware(options) {
 	const context = {
 		options
 	}
 	return handle.bind(context);
 }
 
-/*
+/**
  * Add ETag header field.
  */
 function handle(req, res, next) {
 	// console.log('e', req.headers);
-	next();
+	return next();
 }
 
 async function _getResponseEntity(res) {

package/lib/middlewares/formidable/index.js

@@ -1,5 +1,5 @@
-/*!
- * /nodester
+/**
+ * nodester
  * MIT Licensed
  */
  

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

@@ -1,5 +1,5 @@
-/*!
- * /nodester
+/**
+ * nodester
  * MIT Licensed
  */
  

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

@@ -1,5 +1,5 @@
-/*!
- * /nodester
+/**
+ * nodester
  * MIT Licensed
  */
 
@@ -8,6 +8,11 @@
 const debug = require('debug')('nodester:interpreter:ModelsTree');
 
 
+/**
+ * @class
+ *
+ * @access public
+ */
 class ModelsTreeNode {
 	constructor(model, parent=null, opts={}) {
 		this.model = model;
@@ -112,6 +117,11 @@ class ModelsTreeNode {
 	}
 }
 
+/**
+ * @class
+ *
+ * @access public
+ */
 class ModelsTree {
 	constructor() {
 		this.root = new ModelsTreeNode('root', null);

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

@@ -1,5 +1,5 @@
-/*!
- * /nodester
+/**
+ * nodester
  * MIT Licensed
  */
 
@@ -54,6 +54,14 @@ const FN_TOKENS = new Enum({
 });
 
 
+/**
+ * @class
+ * @classdef constructs ModelTree based on the querystring
+ *
+ * @param {string} queryString
+ * 
+ * @access public
+ */
 module.exports = class QueryLexer {
 	constructor(queryString='') {
 		this.tree = new ModelsTree();

package/lib/middlewares/render/index.js

@@ -1,5 +1,5 @@
-/*!
- * /nodester
+/**
+ * nodester
  * MIT Licensed
  */
  
@@ -29,7 +29,7 @@ function handle(req, res, next) {
  *  - `filename`  filename of the view being rendered
  *
  * @alias render
- * @api public
+ * @access public
  */
 function _render(view, options, callback) {
 	const app = this.req.app;

package/lib/models/associate.js

@@ -1,5 +1,5 @@
-/*!
- * /nodester
+/**
+ * nodester
  * MIT Licensed
  */
  
@@ -11,6 +11,7 @@ module.exports = {
 	associateModelsSync: _associateModelsSync
 }
 
+
 async function _associateModels(databaseConnection) {
 	try {
 		const models = databaseConnection.models;

package/lib/models/define.js

@@ -1,5 +1,5 @@
-/*!
- * /nodester
+/**
+ * nodester
  * MIT Licensed
  */
  
@@ -13,13 +13,15 @@ const { DataTypes } = require('sequelize');
 
 module.exports = defineModel;
 
-/*
+/**
  * @param {SequilizeConnection} databaseConnection
- * @param {String} modelName
+ * @param {string}   modelName
  * @param {Function} definition
- * @param {Object} options
- *   - ... Sequilize model options
- *   - @param {Boolean} noCRUD
+ * @param {Object}   [options]
+ * ... Sequilize model options
+ * @param {Object}   [options.nodester]
+ * @param {boolean}  [options.nodester.noCRUD]
+ * @param {string}   [options.nodester.output]
  */
 function defineModel(
 	databaseConnection,
@@ -46,16 +48,18 @@ function defineModel(
 
 		// Configs related to nodester:
 		nodester: {
+			noCRUD: false,
 			output: 'underscored'
 		},
 
-		// Add user-defined options (they can override upper ones).
+		// Add user-defined options
+		// (they can fully override upper ones).
 		...options
 	};
 
 	const model = databaseConnection.define(modelName, definitionObject, _options);
 
-	if (options.noCRUD !== true) {
+	if (_options.nodester.noCRUD !== true) {
 		// Add:
 		// - createWithIncludes;
 		// - findById;
@@ -67,7 +71,7 @@ function defineModel(
 
 	// Associations:
 	model.associate = (models) => {};
-	model.getIncludesList = _getIncludesList.bind(model);
+	model.getIncludesTree = _getIncludesTree.bind(model);
 
 	// Instance methods:
 	model.prototype.toJSON = function() {
@@ -78,8 +82,22 @@ function defineModel(
 	return model;
 }
 
-/* Association mixins: */
-function _getIncludesList(facadeData=null) {
+// Associations mixins:
+/**
+ * @example
+ * [
+ *    <include_name_0>: {
+ *      <subinclude_name_0>: { ... }
+ *    },
+ *    <include_name_1>: { ... }
+ * ]
+ * @param {Object|null} data
+ *
+ * @return {Array} associationsTree
+ *
+ * @alias getIncludesTree
+ */
+function _getIncludesTree(data=null) {
 	const result = [];
 
 	const associations = this.associations;
@@ -88,15 +106,16 @@ function _getIncludesList(facadeData=null) {
 	for (const [ associationName, associationDefinition ] of associationEntries) {
 		const formatted = { association: associationName };
 
-		if (!!facadeData) {
-			// If facade data is set, go deeper:
-			const keys = Object.keys( facadeData );
+		if (typeof data === 'object') {
+			// If data (for example during create)
+			// is set, go deeper:
+			const keys = Object.keys( data );
 			if (keys.indexOf(associationName) > 0) {
 				const associationModel = associationDefinition.target;
 
 				if (Object.entries(associationModel.associations).length > 0) {
-					const deepData = facadeData[ associationName ];
-					formatted.include = associationModel.getIncludesList(
+					const deepData = data[ associationName ];
+					formatted.include = associationModel.getIncludesTree(
 												Array.isArray(deepData) ? deepData[0] : deepData
 											);
 				}
@@ -108,4 +127,4 @@ function _getIncludesList(facadeData=null) {
 
 	return result;
 }
-/* Association mixins\ */
+// Associations mixins\

package/lib/models/mixins.js

@@ -1,13 +1,14 @@
-/*!
- * /nodester
+/**
+ * nodester
  * MIT Licensed
  */
  
 'use strict';
 
-/*
+/**
  *	CRUD mixins for any model:
  */
+ 
 // Utils:
 const {
 	modelHasAssociations,
@@ -30,8 +31,7 @@ module.exports = {
  *
  * @param {Object} modelDefinition
  *
- *
- * @api public
+ * @access public
  * @alias implementsCRUD
  */
 function _implementsCRUD(modelDefinition) {
@@ -57,7 +57,7 @@ function _implementsCRUD(modelDefinition) {
 }
 
 
-/* Main mixinis: */
+/** Main mixinis: */
 async function _createWithIncludes(
 	data={}
 ) {
@@ -290,9 +290,9 @@ function _deleteById(
 	};
 	return this.destroy(query);
 }
-/* Main mixinis\ */
+/** Main mixinis\ */
 
-/* Subfunctions: */
+/** Subfunctions: */
 async function _updateOrCreateOrDelete(
 	modelDefinition,
 	data
@@ -395,4 +395,4 @@ function _unwrapUpdateOrCreateOrDeleteOperationsResults(
 
 	return result;
 }
-/* Subfunctions\ */
+/** Subfunctions\ */

package/lib/query/traverse.js

@@ -1,5 +1,5 @@
-/*!
- * /nodester
+/**
+ * nodester
  * MIT Licensed
  */
  
@@ -16,6 +16,14 @@ const { ensure } = require('nodester/validators/arguments');
 
 module.exports = traverse;
 
+/**
+ *
+ * @param {ModelsTreeNode} queryNode
+ * @param {NodesterFilter} filter
+ * @param {Model} model
+ *
+ * @access public
+ */
 function traverse(queryNode, filter=null, model=null) {
 	const _model = model ?? filter.model;
 
@@ -313,7 +321,7 @@ function traverse(queryNode, filter=null, model=null) {
  * @param {NodesterFilter} filter
  * @param {Object} resultQuery
  *
- * @api private
+ * @access private
  */
 function _traverseIncludes(includes, rootModel, filter, resultQuery) {
 	const filterIncludesEntries = Object.entries(filter.includes);

package/lib/router/handlers.util.js

@@ -1,11 +1,11 @@
-/*!
- * /nodester
+/**
+ * nodester
  * MIT Licensed
  */
  
 'use strict';
 
-const { typeOf } = require('../utils/types.util');
+const { typeOf } = require('nodester/utils/types');
 
 
 module.exports = {
@@ -13,12 +13,12 @@ module.exports = {
 }
 
 
-/*
+/**
  * @param {Object} routeHandler
  * @return {Object} parsedRouteHandler
  *
  * @alias parseRouteHandler
- * @public
+ * @access public
  */
 function _parseRouteHandler(routeHandler={}) {
 	if (!routeHandler) {