nodester 0.2.5 → 0.2.8

package/lib/database/migration.js

@@ -1,5 +1,5 @@
-/*!
- * /nodester
+/**
+ * nodester
  * MIT Licensed
  */
  
@@ -15,6 +15,13 @@ module.exports = {
 	migrate: _migrate
 }
 
+/**
+ * @param {Sequelize} connection
+ * @param {boolean} force
+ *
+ * @alias migrate
+ * @access public
+ */
 async function _migrate(databaseConnection, force=false) {
 	try {
 		ensure(force, 'boolean', 'force');
@@ -48,4 +55,3 @@ async function _migrate(databaseConnection, force=false) {
 		return Promise.reject(error);
 	}
 }
-

package/lib/errors/CustomError.js

@@ -1,11 +1,16 @@
-/*!
- * /nodester
+/**
+ * nodester
  * MIT Licensed
  */
 
 'use strict';
 
 
+/**
+ * @class
+ *
+ * @access public
+ */
 module.exports = class CustomError extends Error {
 	constructor(message) {
 		super(message);

package/lib/errors/NodesterError.js

@@ -1,11 +1,19 @@
-/*!
- * /nodester
+/**
+ * nodester
  * MIT Licensed
  */
 
 'use strict';
 
 
+/**
+ * @class
+ *
+ * @param {string} [message]
+ * @param {string|Int} [status]
+ *
+ * @access public
+ */
 module.exports = class NodesterError extends Error {
 	constructor(message, status) {
 		super(message);

package/lib/errors/NodesterQueryError.js

@@ -1,5 +1,5 @@
-/*!
- * /nodester
+/**
+ * nodester
  * MIT Licensed
  */
 
@@ -15,6 +15,13 @@ const {
 const NodesterError = require('./NodesterError');
 
 
+/**
+ * @class
+ *
+ * @param {string} [message]
+ *
+ * @access public
+ */
 module.exports = class NodesterQueryError extends NodesterError {
 	constructor(message) {
 		super(message);

package/lib/errors/index.js

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

package/lib/facades/methods/index.js

@@ -1,5 +1,5 @@
-/*!
- * /nodester
+/**
+ * nodester
  * MIT Licensed
  */
  
@@ -11,21 +11,21 @@ const log = require('nodester/loggers/dev');
 
 
 module.exports = {
-	getOne: _getOne,
-	getMany: _getMany,
+	getOne:    _getOne,
+	getMany:   _getMany,
 	createOne: _createOne,
 	updateOne: _updateOne,
 	deleteOne: _deleteOne
 }
 
 
-/*
+/**
  *
  * @param {Object} [params]
  * @param {Object} params.query
  *
  * @alias getOne
- * @api public
+ * @access public
  */
 async function _getOne(params) {
 	try {
@@ -54,13 +54,13 @@ async function _getOne(params) {
 }
 
 
-/*
+/**
  *
  * @param {Object} [params]
  * @param {Object} params.query
  *
  * @alias getMany
- * @api public
+ * @access public
  */
 async function _getMany(params) {
 	try {
@@ -89,13 +89,13 @@ async function _getMany(params) {
 }
 
 
-/*
+/**
  *
  * @param {Object} [params]
  * @param {Object} params.data
  *
  * @alias createOne
- * @api public
+ * @access public
  */
 async function _createOne(params) {
 	try {
@@ -106,7 +106,7 @@ async function _createOne(params) {
 		});
 
 		const instance = await this.model.create({ ...data }, {
-			include: this.model.getIncludesList(data)
+			include: this.model.getIncludesTree(data)
 		});
 
 		const result = {
@@ -126,14 +126,14 @@ async function _createOne(params) {
 }
 
 
-/*
+/**
  *
  * @param {Object} [params]
  * @param {Object} params.query
  * @param {Object} params.data
  *
  * @alias updateOne
- * @api public
+ * @access public
  */
 async function _updateOne(params) {
 	try {
@@ -167,13 +167,13 @@ async function _updateOne(params) {
 }
 
 
-/*
+/**
  *
  * @param {Object} [params]
  * @param {Object} params.query
  *
  * @alias deleteOne
- * @api public
+ * @access public
  */
 async function _deleteOne(params) {
 	try {

package/lib/facades/mixins/index.js

@@ -1,5 +1,5 @@
-/*!
- * /nodester
+/**
+ * nodester
  * MIT Licensed
  */
  
@@ -30,16 +30,16 @@ module.exports = {
 /**
  * Sets one of or all of CRUD methods to Facade.
  *
- * @param {Function|Object} facade
+ * @param {NodesterFacade} facade
  * @param {Object} options
- * @param {Function|Object} options.model
- * @param {String} 					options.name
- * @param {Array} 					options.only
+ * @param {Model}  options.model
+ * @param {string} options.name
+ * @param {Array}  options.only
  *
- * @return {Function|Object} facade
+ * @return {NodesterFacade} facade
  *
- * @api public
  * @alias withDefaultCRUD
+ * @access public
  */
 function _withDefaultCRUD(facade, options={}) {
 	ensure(facade, 'function|object,required', 'facade');
@@ -146,15 +146,15 @@ function _withDefaultCRUD(facade, options={}) {
 }
 
 /**
- * Sets one of CRUD methods to Facade.
+ * Sets one of CRUD methods to a Facade.
  *
- * @param {Facade} facade
+ * @param {NodesterFacade} facade
  * @param {Function} fn
  *
- * @return {Facade} facade
+ * @return {NodesterFacade} facade
  *
- * @api public
  * @alias setMethod
+ * @access public
  */
 function _setMethod(facade, fn) {
 	ensure(facade, 'function|object,required', 'facade');

package/lib/factories/responses/html.js

@@ -1,21 +1,32 @@
-/*
+/**
+ * nodester
+ * MIT Licensed
+ */
+ 
+'use strict';
+
+/**
  * WARNING: Unfinihsed. Do not use!
  *
  */
 
-const Params = require('../../params/Params');
+
+const Params = require('nodester/params');
+
+
+module.exports = HtmlResponseFactory
 
 
-module.exports = class HtmlResponseFactory {
+class HtmlResponseFactory {
 	constructor() {}
 
 	/**
 	 * Sends rendererd HTML view with status code 200.
 	 * Should be called on all successful respones.
 	 *
-	 * @param <Object> res
-	 * @param <String> viewName
-	 * @param <Object> params
+	 * @param {Object} res
+	 * @param {string} viewName
+	 * @param {Object} params
 	 */
 	createOKResponse(params) {
 		const {
@@ -35,9 +46,9 @@ module.exports = class HtmlResponseFactory {
 	 * Sends response with provided error code.
 	 * Should be called on all failed respones.
 	 *
-	 * @param <Object> res
-	 * @param <Object> error
-	 * @param <Int>		 code
+	 * @param {Object} res
+	 * @param {Object} error
+	 * @param {Int}		 code
 	 */
 	createErrorResponse(params) {
 		const {

package/lib/factories/responses/rest.js

@@ -1,11 +1,11 @@
-/*!
- * /nodester
+/**
+ * nodester
  * MIT Licensed
  */
  
 'use strict';
 
-/*
+/**
  * REST response factory.
  */
 const Params = require('nodester/params');
@@ -18,26 +18,28 @@ module.exports = {
 	createErrorResponse: _createErrorResponse,
 }
 
-/*
+/**
  * Format for all API responses will be JSON
+ * Status code is sent in header.
+ *
+ * @example
  * {
- * 	content: {...}
- * 	error: {...}
+ *   content: {...}
+ *   error: {...}
  * }
- * Status code is sent in header.
  * 	
  * If error is not present, error must be null.
  * If error is present, content can be null (But it's not required).
  *
  * @param {ServerResponse} res
  * @param {Object} [options]
- * @param {Object} options.error
- * @param {Object} options.content (optional)
- * @param {Int}    options.status
+ * @param {Object} [options.error]
+ * @param {Object} [options.content]
+ * @param {Int}    [options.status]
  *
  * @alias createGenericResponse
- * @api public
-*/
+ * @access public
+ */
 function _createGenericResponse(res, options) {
 	try {
 		let {
@@ -112,11 +114,11 @@ function _createGenericResponse(res, options) {
  *
  * @param {ServerResponse} res
  * @param {Object} [options]
- * @param {Object} options.content (optional)
- * @param {Object} options.status (optional)
+ * @param {Object} [options.content]
+ * @param {Object} [options.status]
  *
  * @alias createOKResponse
- * @api public
+ * @access public
  */
 function _createOKResponse(res, options={}) {
 	return _createGenericResponse(res, { 
@@ -132,12 +134,12 @@ function _createOKResponse(res, options={}) {
  *
  * @param {ServerResponse} res
  * @param {Object} [options]
- * @param {Object} options.error
- * @param {Object} options.content (optional)
- * @param {Int}    options.status
+ * @param {Object} [options.error]
+ * @param {Object} [options.content]
+ * @param {Int}    [options.status]
  *
  * @alias createErrorResponse
- * @api public
+ * @access public
  */
 function _createErrorResponse(res, options) {
 	return _createGenericResponse(res, {

package/lib/http/codes/descriptions.js

@@ -1,5 +1,5 @@
-/*!
- * /nodester
+/**
+ * nodester
  * MIT Licensed
  */
 'use strict';
@@ -79,4 +79,5 @@ module.exports = new Enum({
 	508: 'Loop Detected',
 	510: 'Not Extended',
 	511: 'Network Authentication Required'
-});
+})
+.withKeyPrefix('HTTP_CODE_DESCRIPTION_');

package/lib/http/codes/index.js

@@ -1,7 +1,8 @@
-/*!
- * /nodester
+/**
+ * nodester
  * MIT Licensed
  */
+ 
 'use strict';
 
 const Enum = require('nodester/enum');

package/lib/http/codes/symbols.js

@@ -1,7 +1,8 @@
-/*!
- * /nodester
+/**
+ * nodester
  * MIT Licensed
  */
+ 
 'use strict';
 
 const Enum = require('nodester/enum');