nodester 0.2.5 → 0.2.8

package/lib/structures/Filter.js

@@ -1,5 +1,5 @@
-/*!
- * /nodester
+/**
+ * nodester
  * MIT Licensed
  */
  
@@ -12,37 +12,39 @@ const { isModel } = require('../utils/models');
 const { ensure } = require('nodester/validators/arguments');
 
 
+/**
+ * @class
+ * @classdesc NodesterFilter is a set of rules on how to process client's input.
+ *
+ * @param {Model} model
+ * @param {Object} [options]
+ * @param {Array}  options.attributes
+ * @param {Array}  options.clauses
+ * @param {Object} options.includes
+ *
+ * @param {Object} options.bounds
+ * @param {Object} options.bounds.attributes
+ * @param {Object} options.bounds.clauses
+ *
+ * @param {Object} options.statics
+ * @param {Object} options.statics.attributes
+ * @param {Object} options.statics.clauses
+ *
+ * @access public
+ */
 module.exports = class NodesterFilter {
 
-	/*
-	 *
-	 * @param {Model} model
-	 * @param {Object} options
-	 * @param {Array}  options.fields
-	 * @param {Array}  options.clauses
-	 * @param {Object} options.includes
-	 *
-	 * @param {Object} options.bounds
-	 * @param {Object} options.bounds.fields
-	 * @param {Object} options.bounds.clauses
-	 *
-	 * @param {Object} options.statics
-	 * @param {Object} options.statics.attributes
-	 * @param {Object} options.statics.clauses
-	 *
-	 *
-	 */
 	constructor(model=null, options={}) {
 		ensure(options, 'object,required', 'options');
 		
 		this._model = model;
 
-		this._fields = [];
+		this._attributes = [];
 		this._clauses = [];
 		this._includes = {};
 
 		this._bounds = {
-			fields: {},
+			attributes: {},
 			clauses: {}
 		}
 		
@@ -53,7 +55,7 @@ module.exports = class NodesterFilter {
 
 		// If model is present:
 		if (isModel(this.model)) {
-			this._fields = Object.keys(this.model.tableAttributes);
+			this._attributes = Object.keys(this.model.tableAttributes);
 			this._clauses = CLAUSES.asArray;
 
 			// ...and no 'bounds' and 'statics' are provided,
@@ -67,7 +69,7 @@ module.exports = class NodesterFilter {
 		}
 		
 		const {
-			fields,
+			attributes,
 			clauses,
 			includes,
 			bounds,
@@ -75,9 +77,9 @@ module.exports = class NodesterFilter {
 		} = options;
 
 
-		// If fields are array:
-		if (Array.isArray(fields)) {
-			this._fields = fields;
+		// If attributes are array:
+		if (Array.isArray(attributes)) {
+			this._attributes = attributes;
 		}
 
 		if (Array.isArray(clauses)) {
@@ -124,8 +126,8 @@ module.exports = class NodesterFilter {
 	}
 
 	// Getters:
-	get fields() {
-		return this._fields;
+	get attributes() {
+		return this._attributes;
 	}
 
 	get clauses() {

package/lib/structures/Params.js

@@ -1,5 +1,5 @@
-/*!
- * /nodester
+/**
+ * nodester
  * MIT Licensed
  */
  
@@ -21,7 +21,7 @@ module.exports = Params;
  *
  * @return {Object} result
  *
- * @api public
+ * @access public
  */
 function Params(
 	sourceObj={},

package/lib/tools/nql.tool.js

@@ -1,5 +1,5 @@
-/*!
- * /nodester
+/**
+ * nodester
  * MIT Licensed
  */
 
@@ -14,11 +14,19 @@ module.exports = {
 	AST_ModelsTreeNode: _AST_ModelsTreeNode
 }
 
+/**
+ * @alias AST_ModelsTree
+ * @access public
+ */
 function _AST_ModelsTree(modelsTree) {
 	ensure(modelsTree, 'object,required', 'modelsTree');
 	return _AST_ModelsTreeNode(modelsTree.root);
 }
 
+/**
+ * @alias AST_ModelsTreeNode
+ * @access public
+ */
 function _AST_ModelsTreeNode(node, spacing=0) {
 	ensure(node, 'object,required', 'node');
 	ensure(spacing, 'number,required', 'spacing');

package/lib/tools/sql.tool.js

@@ -1,5 +1,5 @@
-/*!
- * /nodester
+/**
+ * nodester
  * MIT Licensed
  */
 
@@ -20,6 +20,10 @@ module.exports = {
 	rawInsert: _rawInsert
 }
 
+/**
+ * @alias parseSQLFileContents
+ * @access private
+ */
 async function _parseSQLFileContents(filePath) {
 	try {
 		const fileContent = await readFile(filePath, 'utf8');
@@ -35,11 +39,20 @@ async function _parseSQLFileContents(filePath) {
 	}
 }
 
+/**
+ * @alias rawSelect
+ * @access private
+ */
 function _rawSelect(db, tableName) {
 	const query = `select * from ${ tableName }`;
 	return db.query(query, { type: QueryTypes.SELECT });
 }
 
+
+/**
+ * @alias rawUpdate
+ * @access private
+ */
 function _rawUpdate(db, tableName, where, data) {
 	const dataKeys = Object.keys(data);
 
@@ -63,6 +76,10 @@ function _rawUpdate(db, tableName, where, data) {
 	});
 }
 
+/**
+ * @alias rawInsert
+ * @access private
+ */
 function _rawInsert(db, tableName, data) {
 	const dataKeys = Object.keys(data);
 	const dataValues = Object.values(data);

package/lib/utils/json.util.js

@@ -1,49 +1,50 @@
-/*!
- * /nodester
+/**
+ * nodester
  * MIT Licensed
  */
+
 'use strict';
 
 
 exports = module.exports = {
-  stringify: _stringify
+	stringify: _stringify
 }
 
 /**
  * Stringify JSON, like JSON.stringify, but v8 optimized, with the
  * ability to escape characters that can trigger HTML sniffing.
  *
- * @param {*} value
- * @param {function} replacer
+ * @param {any} value
+ * @param {Function} replacer
  * @param {number} spaces
  * @param {boolean} escape
  * @returns {string}
  *
  * @alias stringify
- * @private
+ * @access private
  */
 function _stringify (value, replacer, spaces, escape) {
-  // v8 checks arguments.length for optimizing simple call
-  // https://bugs.chromium.org/p/v8/issues/detail?id=4730
-  var json = replacer || spaces
-    ? JSON.stringify(value, replacer, spaces)
-    : JSON.stringify(value);
+	// v8 checks arguments.length for optimizing simple call
+	// https://bugs.chromium.org/p/v8/issues/detail?id=4730
+	var json = replacer || spaces
+		? JSON.stringify(value, replacer, spaces)
+		: JSON.stringify(value);
 
-  if (escape && typeof json === 'string') {
-    json = json.replace(/[<>&]/g, function (c) {
-      switch (c.charCodeAt(0)) {
-        case 0x3c:
-          return '\\u003c'
-        case 0x3e:
-          return '\\u003e'
-        case 0x26:
-          return '\\u0026'
-        /* istanbul ignore next: unreachable default */
-        default:
-          return c
-      }
-    })
-  }
+	if (escape && typeof json === 'string') {
+		json = json.replace(/[<>&]/g, function (c) {
+			switch (c.charCodeAt(0)) {
+				case 0x3c:
+					return '\\u003c'
+				case 0x3e:
+					return '\\u003e'
+				case 0x26:
+					return '\\u0026'
+				/** istanbul ignore next: unreachable default */
+				default:
+					return c
+			}
+		})
+	}
 
-  return json
+	return json;
 }

package/lib/utils/models.js

@@ -1,7 +1,8 @@
-/*!
- * /nodester
+/**
+ * nodester
  * MIT Licensed
  */
+
 'use strict';
 
 

package/lib/utils/objects.util.js

@@ -1,5 +1,5 @@
-/*!
- * /nodester
+/**
+ * nodester
  * MIT Licensed
  */
 
@@ -17,14 +17,13 @@ module.exports = {
 /**
  * Copy key-value of target object
  *
- * @param {object} target - Object to copy attributes from
- * @param {array} attributes - Array of keys
+ * @param {Object} target - Object to copy attributes from
+ * @param {Array} attributes - Array of keys
  *
- * @return {object} New object with attributes of target
+ * @return {Object} New object with attributes of target
  *
  * @alias copyWithCertainAttributes
- *
- * @api public
+ * @access public
  */
 function _copyWithCertainAttributes(target={}, attributes=[]) {
 	ensure(target, 'object,required', 'target');
@@ -40,15 +39,15 @@ function _copyWithCertainAttributes(target={}, attributes=[]) {
 /**
  * Merge the property descriptors of `src` into `target`
  *
- * @param {object} target - Object to add descriptors to
- * @param {object} src - Object to clone descriptors from
+ * @param {Object} target - Object to add descriptors to
+ * @param {Object} src - Object to clone descriptors from
  * @param {boolean} [redefine=true] - Redefine `target` properties with `src` properties
  *
- * @return {object} Reference to target
+ * @return {Object} Reference to target
  *
  * @alias merge
  *
- * @api public
+ * @access public
  */
 function _merge (target={}, src={}, redefine=true) {
 	ensure(target, 'object,required', 'target');

package/lib/utils/path.util.js

@@ -1,3 +1,9 @@
+/**
+ * nodester
+ * MIT Licensed
+ */
+
+'use strict';
 
 exports = module.exports = {
 	isAbsolute: _isAbsolute
@@ -6,12 +12,12 @@ exports = module.exports = {
 /**
  * Check if `path` looks absolute.
  *
- * @param {String} path
+ * @param {string} path
  *
- * @return {Boolean}
+ * @return {boolean}
  *
- * @api public
  * @alias isAbsolute
+ * @access public
  */
 function _isAbsolute(path) {
 	// Unix:

package/lib/utils/sanitizations.util.js

@@ -1,7 +1,8 @@
-/*!
- * /nodester
+/**
+ * nodester
  * MIT Licensed
  */
+
 'use strict';
 
 

package/lib/utils/types.util.js

@@ -1,3 +1,10 @@
+/**
+ * nodester
+ * MIT Licensed
+ */
+
+'use strict';
+
 const objectRegExp = /^\[object (\S+)\]$/;
 
 
@@ -12,7 +19,7 @@ module.exports = {
 /**
  *
  * @alias typeOf
- * @public
+ * @access public
  */
 function _typeOf(obj) {
 	const type = typeof obj;
@@ -32,7 +39,7 @@ function _typeOf(obj) {
 /**
  *
  * @alias isAsync
- * @public
+ * @access public
  */
 function _isAsync(fn) {
 	if (!fn) {
@@ -47,7 +54,7 @@ function _isAsync(fn) {
 /**
  *
  * @alias isRegExp
- * @public
+ * @access public
  */
 function _isRegExp(obj) {
 	if (!obj) {
@@ -62,7 +69,7 @@ function _isRegExp(obj) {
 /**
  *
  * @alias isConstructor
- * @public
+ * @access public
  */
 function _isConstructor(fn) {
 	try {

package/lib/validators/arguments.js

@@ -1,5 +1,5 @@
-/*!
- * /nodester
+/**
+ * nodester
  * MIT Licensed
  */
 
@@ -10,17 +10,26 @@ module.exports = {
 	ensure: _ensure
 }
 
-/*
- * Validates given argument against rules.
+/**
+ * Validates passed argument against passed rules.
  *
- * @param {Any} argument
- * @param {String} rules
- * @param {String} argumentName
+ * @example
+ *   ensure(value, 'string|array|object,required', 'value');
+ *
+ * @param {any} argument
+ * @param {string} rules
+ * @param {string} [argumentName]
  *
- * @api public
  * @alias ensure
+ * @access public
  */
 function _ensure(argument, rules, argumentName) {
+	if (typeof rules !== 'string') {
+		const err = new TypeError(`'rules' is a required argument.`);
+		Error.captureStackTrace(err, _ensure);
+		throw err;
+	}
+
 	const name = argumentName ? `'${ argumentName }'` : 'Argument';
 	
 	let rulesArray = rules.split(',');
@@ -57,8 +66,18 @@ function _ensure(argument, rules, argumentName) {
 
 	let mismatchedTypesCount = 0;
 	for (const type of types) {
-		if (typeof argument !== type) {
+		if (type === 'array') {
+			if (Array.isArray(argument) === false) {
+				mismatchedTypesCount++;
+				continue;
+			}
+			else {
+				return true;
+			}
+		}
+		else if (typeof argument !== type) {
 			mismatchedTypesCount++;
+			continue;
 		}
 	}
 

package/lib/validators/dates.js

@@ -1,5 +1,5 @@
-/*!
- * /nodester
+/**
+ * nodester
  * MIT Licensed
  */
 
@@ -10,12 +10,11 @@ module.exports = {
 	isValidDate: _isValidDate
 }
 
-
 /**
- * @param {Any} dateToTest
+ * @param {any} dateToTest
  *
  * @alias isValidDate
- * @api public
+ * @access public
  */
 function _isValidDate(dateToTest) {
 	// If number:

package/lib/validators/numbers.js

@@ -1,5 +1,5 @@
-/*!
- * /nodester
+/**
+ * nodester
  * MIT Licensed
  */
 
@@ -11,10 +11,10 @@ module.exports = {
 }
 
 /**
- * @param {Any} numToTest
+ * @param {any} numToTest
  *
  * @alias isValidNumber
- * @api public
+ * @access public
  */
 function _isValidNumber(numToTest){
 	return !isNaN(numToTest);

package/package.json

@@ -1,7 +1,15 @@
 {
   "name": "nodester",
-  "version": "0.2.5",
+  "version": "0.2.8",
   "description": "A versatile REST framework for Node.js",
+  "directories": {
+    "docs": "docs",
+    "lib": "lib",
+    "tests": "tests"
+  },
+  "source": [
+    "lib"
+  ],
   "exports": {
     ".": "./lib/application/index.js",
 
@@ -34,6 +42,7 @@
     "./loggers/console": "./lib/loggers/console.js",
     "./loggers/dev": "./lib/loggers/dev.js",
 
+    "./middlewares/404": "./lib/middlewares/404/index.js",
     "./middlewares/cookies": "./lib/middlewares/cookies/index.js",
     "./middlewares/formidable": "./lib/middlewares/formidable/index.js",
     "./middlewares/SearchParams": "./lib/middlewares/SearchParams/index.js",
@@ -55,46 +64,12 @@
     "./utils/sql": "./lib/utils/sql.util.js",
     "./utils/strings": "./lib/utils/strings.util.js",
     "./utils/sanitizations": "./lib/utils/sanitizations.util.js",
+    "./utils/types": "./lib/utils/types.util.js",
 
     "./validators/arguments": "./lib/validators/arguments.js"
   },
-  "directories": {
-    "docs": "docs",
-    "lib": "lib",
-    "tests": "tests"
-  },
-  "source": [
-    "lib"
-  ],
-  "scripts": {
-    "test": "jest",
-    "examples:rest": "node ./examples/rest/index.js"
-  },
-  "author": "Mark Khramko <markkhramko@gmail.com>",
-  "license": "MIT",
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/MarkKhramko/nodester.git"
-  },
-  "private": false,
-  "bugs": {
-    "url": "https://github.com/MarkKhramko/nodester/issues"
-  },
-  "homepage": "https://github.com/MarkKhramko/nodester#readme",
-  "keywords": [
-    "nodester",
-    "framework",
-    "web",
-    "http",
-    "rest",
-    "restful",
-    "router",
-    "app",
-    "api"
-  ],
   "dependencies": {
     "@js-temporal/polyfill": "^0.4.3",
-    "accepts": "^1.3.8",
     "body-parser": "^1.20.2",
     "common-js-file-extensions": "^1.0.4",
     "cookie": "^0.5.0",
@@ -117,10 +92,39 @@
     "type-is": "^1.6.18",
     "vary": "^1.1.2"
   },
+  "devDependencies": {
+    "eslint": "^8.55.0",
+    "eslint-plugin-jsdoc": "^46.9.0",
+    "jest": "^29.4.2"
+  },
   "engines": {
     "node": ">= 12.17.0"
   },
-  "devDependencies": {
-    "jest": "^29.4.2"
-  }
+  "scripts": {
+    "lint": "eslint .",
+    "test": "jest",
+    "publish": "npm run lint && npm publish"
+  },
+  "author": "Mark Khramko <markkhramko@gmail.com>",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/MarkKhramko/nodester.git"
+  },
+  "private": false,
+  "bugs": {
+    "url": "https://github.com/MarkKhramko/nodester/issues"
+  },
+  "homepage": "https://github.com/MarkKhramko/nodester#readme",
+  "keywords": [
+    "nodester",
+    "framework",
+    "web",
+    "http",
+    "rest",
+    "restful",
+    "router",
+    "app",
+    "api"
+  ]
 }