nodester 0.2.5 → 0.2.8

package/lib/http/request/index.js

@@ -1,5 +1,5 @@
-/*!
- * /nodester
+/**
+ * nodester
  * MIT Licensed
  */
  
@@ -7,7 +7,6 @@
 
 const { IncomingMessage } = require('http');
 
-const accepts = require('accepts');
 const isIP = require('net').isIP;
 const typeis = require('type-is');
 const fresh = require('fresh');
@@ -28,8 +27,7 @@ module.exports = req;
  * The `Referrer` header field is special-cased,
  * both `Referrer` and `Referer` are interchangeable.
  *
- * Examples:
- *
+ * @example
  *     req.get('Content-Type');
  *     // => "text/plain"
  *
@@ -39,13 +37,12 @@ module.exports = req;
  *     req.get('Something');
  *     // => undefined
  *
- * Aliased as `req.header()`.
- *
- * @param {String} name
+ * @param {string} name
  *
- * @return {String}
- *
- * @api public
+ * @return {string}
+ * 
+ * @alias req.header
+ * @access public
  */
 req.get =
 req.header = function header(name) {
@@ -69,178 +66,6 @@ req.header = function header(name) {
 };
 
 
-/**
- * To do: update docs.
- *
- * Check if the given `type(s)` is acceptable, returning
- * the best match when true, otherwise `undefined`, in which
- * case you should respond with 406 "Not Acceptable".
- *
- * The `type` value may be a single MIME type string
- * such as "application/json", an extension name
- * such as "json", a comma-delimited list such as "json, html, text/plain",
- * an argument list such as `"json", "html", "text/plain"`,
- * or an array `["json", "html", "text/plain"]`. When a list
- * or array is given, the _best_ match, if any is returned.
- *
- * Examples:
- *
- *     // Accept: text/html
- *     req.accepts('html');
- *     // => "html"
- *
- *     // Accept: text/*, application/json
- *     req.accepts('html');
- *     // => "html"
- *     req.accepts('text/html');
- *     // => "text/html"
- *     req.accepts('json, text');
- *     // => "json"
- *     req.accepts('application/json');
- *     // => "application/json"
- *
- *     // Accept: text/*, application/json
- *     req.accepts('image/png');
- *     req.accepts('png');
- *     // => undefined
- *
- *     // Accept: text/*;q=.5, application/json
- *     req.accepts(['html', 'json']);
- *     req.accepts('html', 'json');
- *     req.accepts('html, json');
- *     // => "json"
- *
- * @param {String|Array} type(s)
- * @return {String|Array|Boolean}
- *
- * @api public
- */
-req.accepts = function() {
-	const accept = accepts(this);
-	return accept.types.apply(accept, arguments);
-};
-
-
-/**
- * Check if the given `encoding`s are accepted.
- *
- * @param {String} ...encoding
- * @return {String|Array}
- *
- * @api public
- */
-req.acceptsEncodings = function() {
-	const accept = accepts(this);
-	return accept.encodings.apply(accept, arguments);
-};
-
-
-/**
- * Check if the given `charset`s are acceptable,
- * otherwise you should respond with 406 "Not Acceptable".
- *
- * @param {String} ...charset
- * @return {String|Array}
- *
- * @api public
- */
-req.acceptsCharsets = function() {
-	const accept = accepts(this);
-	return accept.charsets.apply(accept, arguments);
-};
-
-
-/**
- * Check if the given `lang`s are acceptable,
- * otherwise you should respond with 406 "Not Acceptable".
- *
- * @param {String} ...lang
- * @return {String|Array}
- *
- * @api public
- */
-req.acceptsLanguages = function() {
-	const accept = accepts(this);
-	return accept.languages.apply(accept, arguments);
-};
-
-
-/**
- * Parse Range header field, capping to the given `size`.
- *
- * Unspecified ranges such as "0-" require knowledge of your resource length. In
- * the case of a byte range this is of course the total number of bytes. If the
- * Range header field is not given `undefined` is returned, `-1` when unsatisfiable,
- * and `-2` when syntactically invalid.
- *
- * When ranges are returned, the array has a "type" property which is the type of
- * range that is required (most commonly, "bytes"). Each array element is an object
- * with a "start" and "end" property for the portion of the range.
- *
- * The "combine" option can be set to `true` and overlapping & adjacent ranges
- * will be combined into a single range.
- *
- * NOTE: remember that ranges are inclusive, so for example "Range: users=0-3"
- * should respond with 4 users when available, not 3.
- *
- * @param {number} size
- * @param {object} [options]
- * @param {boolean} [options.combine=false]
- *
- * @return {number|array}
- *
- * @api public
- */
-req.range = function range(size, options) {
-	const range = this.get('Range');
-	if (!range)
-		return;
-
-	return parseRange(size, range, options);
-};
-
-
-/**
- * Check if the incoming request contains the "Content-Type"
- * header field, and it contains the given mime `type`.
- *
- * Examples:
- *
- *      // With Content-Type: text/html; charset=utf-8
- *      req.is('html');
- *      req.is('text/html');
- *      req.is('text/*');
- *      // => true
- *
- *      // When Content-Type is application/json
- *      req.is('json');
- *      req.is('application/json');
- *      req.is('application/*');
- *      // => true
- *
- *      req.is('html');
- *      // => false
- *
- * @param {String|Array} types...
- * @return {String|false|null}
- *
- * @api public
- */
-req.is = function is(types) {
-	let arr = types;
-
-	// support flattened arguments
-	if (!Array.isArray(types)) {
-		arr = new Array(arguments.length);
-		for (let i = 0; i < arr.length; i++) {
-			arr[i] = arguments[i];
-		}
-	}
-
-	return typeis(this, arr);
-};
-
-
 /**
  * Return the protocol string "http" or "https"
  * when requested with TLS. When the "trust proxy"
@@ -251,11 +76,10 @@ req.is = function is(types) {
  * If you're running behind a reverse proxy that
  * supplies https for you this may be enabled.
  *
- * @return {String}
+ * @return {string}
  *
- * @api public
+ * @access public
  */
-
 defineGetter(req, 'protocol', function protocol() {
 	const proto = this.connection.encrypted
 		? 'https'
@@ -278,66 +102,12 @@ defineGetter(req, 'protocol', function protocol() {
 });
 
 
-/**
- * Short-hand for:
- *
- *    req.protocol === 'https'
- *
- * @return {Boolean}
- *
- * @api public
- */
-defineGetter(req, 'secure', function secure() {
-	return this.protocol === 'https';
-});
-
-
-/**
- * Return the remote address from the trusted proxy.
- *
- * The is the remote address on the socket unless
- * "trust proxy" is set.
- *
- * @return {String}
- *
- * @api public
- */
-defineGetter(req, 'ip', function ip() {
-	const trust = this.app.get('trust proxy fn');
-	return proxyaddr(this, trust);
-});
-
-
-/**
- * When "trust proxy" is set, trusted proxy addresses + client.
- *
- * For example if the value were "client, proxy1, proxy2"
- * you would receive the array `["client", "proxy1", "proxy2"]`
- * where "proxy2" is the furthest down-stream and "proxy1" and
- * "proxy2" were trusted.
- *
- * @return {Array} addresses
- *
- * @api public
- */
-defineGetter(req, 'ips', function ips() {
-	const trust = this.app.get('trust proxy fn');
-	const addrs = proxyaddr.all(this, trust);
-
-	// reverse the order (to farthest -> closest)
-	// and remove socket address
-	addresses.reverse().pop()
-
-	return addresses;
-});
-
-
 /**
  * Short-hand for `url.parse(req.url).pathname`.
  *
- * @return {String}
+ * @return {string}
  *
- * @api public
+ * @access public
  */
 defineGetter(req, 'path', function path() {
 	return parse(this).pathname;
@@ -349,9 +119,9 @@ defineGetter(req, 'path', function path() {
  * Will return  "X-Forwarded-Host" if set,
  * or "Host" as a fallback.
  *
- * @return {String}
+ * @return {string}
  *
- * @api public
+ * @access public
  */
 defineGetter(req, 'hostname', function hostname() {
 	const host = this.get('X-Forwarded-Host') ?? this.get('Host');
@@ -364,9 +134,9 @@ defineGetter(req, 'hostname', function hostname() {
  * Last-Modified and/or the ETag
  * still match.
  *
- * @return {Boolean}
+ * @return {boolean}
  *
- * @api public
+ * @access public
  */
 defineGetter(req, 'fresh', function() {
 	const method = this.method;
@@ -394,9 +164,9 @@ defineGetter(req, 'fresh', function() {
  * "Last-Modified" and / or the "ETag" for the
  * resource has changed.
  *
- * @return {Boolean}
+ * @return {boolean}
  *
- * @api public
+ * @access public
  */
 defineGetter(req, 'stale', function stale() {
 	return !this.fresh;
@@ -406,9 +176,9 @@ defineGetter(req, 'stale', function stale() {
 /**
  * Check if the request was an _XMLHttpRequest_.
  *
- * @return {Boolean}
+ * @return {boolean}
  *
- * @api public
+ * @access public
  */
 defineGetter(req, 'xhr', function xhr() {
 	const val = this.get('X-Requested-With') || '';

package/lib/http/request/utils.js

@@ -1,5 +1,5 @@
-/*!
- * /nodester
+/**
+ * nodester
  * MIT Licensed
  */
  
@@ -13,10 +13,10 @@ module.exports = {
  * Helper function for creating a getter on an object.
  *
  * @param {Object} obj
- * @param {String} name
+ * @param {string} name
  * @param {Function} getter
  *
- * @api private
+ * @access private
  */
 function _defineGetter(obj, name, getter) {
 	Object.defineProperty(obj, name, {

package/lib/http/response/headers.js

@@ -1,5 +1,5 @@
-/*!
- * /nodester
+/**
+ * nodester
  * MIT Licensed
  */
 
@@ -23,21 +23,19 @@ module.exports = {
  * Set header `field` to `value`, or pass
  * an object of header fields.
  *
- * Examples:
- *
+ * @example
  *    res.set('Foo', ['bar', 'baz']);
  *    res.set('Accept', 'application/json');
  *    res.set({ Accept: 'text/plain', 'X-API-Key': 'tobi' });
  *
- * Aliased as `res.header()`.
  *
- * @param {String|Object} keyOrObject
- * @param {String|Array} value
+ * @param {string|Object} keyOrObject
+ * @param {string|Array} value
  *
  * @return {ServerResponse} for chaining
  *
  * @alias setHeader
- * @api public
+ * @access public
  */
 function _setHeader(keyOrObject, value) {
 	// As a pair:
@@ -81,18 +79,17 @@ function _setHeader(keyOrObject, value) {
 /**
  * Append additional header `field` with value `val`.
  *
- * Example:
- *
+ * @example
  *    res.append.header('Link', ['<http://localhost/>', '<http://localhost:3000/>']);
  *    res.append.header('Set-Cookie', 'foo=bar; Path=/; HttpOnly');
  *    res.append.header('Warning', '199 Miscellaneous warning');
  *
- * @param {String} field
- * @param {String|Array} value
+ * @param {string} field
+ * @param {string|Array} value
  * @return {ServerResponse} for chaining
  *
  * @alias appendHeader
- * @api public
+ * @access public
  */
 function _appendHeader(field, value) {
 	const prev = this.get(field);
@@ -112,12 +109,12 @@ function _appendHeader(field, value) {
 /**
  * Get value for header `key`.
  *
- * @param {String} key
+ * @param {string} key
  *
- * @return {String}
+ * @return {string}
  *
  * @alias getHeader
- * @api public
+ * @access public
  */
 function _getHeader(key) {
 	return this.getHeader(key);
@@ -126,12 +123,12 @@ function _getHeader(key) {
 /**
  * Remove value for header `key`.
  *
- * @param {String} key
+ * @param {string} key
  *
- * @return {String}
+ * @return {string}
  *
  * @alias removeHeader
- * @api public
+ * @access public
  */
 function _removeHeader(key) {
 	return this.removeHeader(key);

package/lib/http/response/index.js

@@ -1,5 +1,5 @@
-/*!
- * /nodester
+/**
+ * nodester
  * MIT Licensed
  */
 
@@ -49,12 +49,12 @@ module.exports = response;
 /**
  * Set status `code`.
  *
- * @param {Number} code
+ * @param {Int|string} code
  *
  * @return {ServerResponse}
  *
  * @alias status
- * @api public
+ * @access public
  */
 function _status(code) {
 	this.statusCode = code;
@@ -69,14 +69,13 @@ function _status(code) {
  * response to the standard description from node's http.STATUS_CODES
  * or the statusCode number if no description.
  *
- * Examples:
- *
- *     res.sendStatus(200);
+ * @example
+ *   res.sendStatus(200);
  *
  * @param {number} statusCode
  *
  * @alias _sendStatus
- * @api public
+ * @access public
  */
 function _sendStatus(statusCode) {
 	const body = statuses.message[statusCode] || String(statusCode);
@@ -90,16 +89,15 @@ function _sendStatus(statusCode) {
 /**
  * Sends a response.
  *
- * Examples:
+ * @example
+ *   res.send(Buffer.from('wahoo'));
+ *   res.send({ some: 'json' });
+ *   res.send('<p>some html</p>');
  *
- *     res.send(Buffer.from('wahoo'));
- *     res.send({ some: 'json' });
- *     res.send('<p>some html</p>');
- *
- * @param {string|number|boolean|object|Buffer} body
+ * @param {string|number|boolean|Object|Buffer} body
  *
  * @alias send
- * @api public
+ * @access public
  */
 function _send(body) {
 	const req = this.req;
@@ -190,10 +188,10 @@ function _send(body) {
 /**
  * Send JSON response.
  *
- * @param {string|number|boolean|object} obj
+ * @param {string|number|boolean|Object} obj
  *
  * @alias json
- * @api public
+ * @access public
  */
 function _json(obj) {
 
@@ -210,20 +208,19 @@ function _json(obj) {
  * Set _Content-Type_ response header with `type` through `mime.getType()`
  * when it does not contain "/", or set the Content-Type to `type` otherwise.
  *
- * Examples:
- *
- *     res.type('.html');
- *     res.type('html');
- *     res.type('json');
- *     res.type('application/json');
- *     res.type('png');
+ * @example
+ *   res.setContentType('.html');
+ *   res.setContentType('html');
+ *   res.setContentType('json');
+ *   res.setContentType('application/json');
+ *   res.setContentType('png');
  *
- * @param {String} type
+ * @param {string} type 
  *
  * @return {ServerResponse} for chaining
  *
  * @alias setContentType
- * @api public
+ * @access public
  */
 function _setContentType(type) {
 	const contentType = type.indexOf('/') === -1 ?
@@ -238,10 +235,10 @@ function _setContentType(type) {
 /**
  * Returns _Content-Type_ header.
  *
- * @return {String} type
+ * @return {string} type
  *
  * @alias getContentType
- * @api public
+ * @access public
  */
 function _getContentType() {
 	return this.getHeader('Content-Type');

package/lib/http/response/utils.js

@@ -1,5 +1,5 @@
-/*!
- * /nodester
+/**
+ * nodester
  * MIT Licensed
  */
 
@@ -8,6 +8,7 @@
 // Utils:
 const contentType = require('content-type');
 
+
 module.exports = {
 	setCharset: _setCharset
 }
@@ -15,12 +16,12 @@ module.exports = {
 /**
  * Set the charset in a given Content-Type string.
  *
- * @param {String} type
- * @param {String} charset
+ * @param {string} type
+ * @param {string} charset
  *
- * @return {String}
+ * @return {string}
  *
- * @api private
+ * @access private
  */
 function _setCharset(type, charset) {
 	if (!type || !charset) {

package/lib/loggers/console.js

@@ -1,5 +1,5 @@
-/*!
- * /nodester
+/**
+ * nodester
  * MIT Licensed
  */
 
@@ -16,9 +16,8 @@ exports = module.exports = {
  * @param {Error} err
  *
  * @alias error
- * @public
+ * @access public
  */
-
 function _error(err) {
   console.error(err.stack || err.toString());
 }

package/lib/loggers/dev.js

@@ -1,5 +1,5 @@
-/*!
- * /nodester
+/**
+ * nodester
  * MIT Licensed
  */
 
@@ -16,9 +16,8 @@ exports = module.exports = {
  * @param {Array} args
  *
  * @alias error
- * @public
+ * @access public
  */
-
 function _error(...args) {
 	const activeEnv = process.env.NODE_ENV
 

package/lib/middlewares/404/index.js

@@ -0,0 +1,38 @@
+/**
+ * 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/SearchParams/index.js

@@ -1,5 +1,5 @@
-/*!
- * /nodester
+/**
+ * nodester
  * MIT Licensed
  */
  
@@ -21,5 +21,5 @@ function handle(req, res, next) {
 
 	req.searchParams = params;
 
-	next();
+	return next();
 }