nodester 0.1.4 → 0.2.0

package/lib/http/codes/index.js

@@ -1,157 +1,82 @@
-const symbolsByTag = {
-	// Informational:
-	CONTINUE: Symbol('100: Continue'),
-	SWITCHING_PROTOCOLS: Symbol('101: Switching Protocols'),
-	PROCESSING: Symbol('102: Processing'),
-	EARLY_HINTS: Symbol('103: Early Hints'),
+/*!
+ * /nodester
+ * MIT Licensed
+ */
+'use strict';
 
-	// Success:
-	OK: Symbol('200: OK'),
-	CREATED: Symbol('201: Created'),
-	ACCEPTED: Symbol('202: Accepted'),
-	NON_AUTHORITATIVE_INFORMATION: Symbol('203: Non-Authoritative Information'),
-	NO_CONTENT: Symbol('204: No Content'),
-	RESET_CONTENT: Symbol('205: Reset Content'),
-	PARTIAL_CONTENT: Symbol('206: Partial Content'),
-	MULTI_STATUS: Symbol('207: Multi-Status'),
-	ALREADY_REPORTED: Symbol('208: Already Reported'),
-	IM_USED: Symbol('226: IM Used'),
+const Enum = require('nodester/enum');
 
-	// Redirections:
-	MULTIPLE_CHOICES: Symbol('300: Multiple Choices'),
-	MOVED_PERMANENTLY: Symbol('301: Moved Permanently'),
-	FOUND: Symbol('302: Found'),
-	SEE_OTHER: Symbol('303: See Other'),
-	NOT_MODIFIED: Symbol('304: Not Modified'),
-	USE_PROXY: Symbol('305: Use Proxy'),
-	TEMPORARY_REDIRECT: Symbol('307: Temporary Redirect'),
-	PERMANENT_REDIRECT: Symbol('308: Permanent Redirect'),
-
-	// Client Errors:
-	BAD_REQUEST: Symbol('400: Bad Request'),
-	UNAUTHORIZED: Symbol('401: Unauthorized'),
-	PAYMENT_REQUIRED: Symbol('402: Payment Required'),
-	FORBIDDEN: Symbol('403: Forbidden'),
-	NOT_FOUND: Symbol('404: Not Found'),
-	METHOD_NOT_ALLOWED: Symbol('405: Method Not Allowed'),
-	NOT_ACCEPTABLE: Symbol('406: Not Acceptable'),
-	PROXY_AUTHENTICATION_REQUIRED: Symbol('407: Proxy Authentication Required'),
-	REQUEST_TIMEOUT: Symbol('408: Request Timeout'),
-	CONFLICT: Symbol('409: Conflict'),
-	GONE: Symbol('410: Gone'),
-	LENGTH_REQUIRED: Symbol('411: Length Required'),
-	PRECONDITION_FAILED: Symbol('412: Precondition Failed'),
-	PAYLOAD_TOO_LARGE: Symbol('413: Payload Too Large'),
-	URI_TOO_LONG: Symbol('414: URI Too Long'),
-	UNSUPPORTED_MEDIA_TYPE: Symbol('415: Unsupported Media Type'),
-	RANGE_NOT_SATISFIABLE: Symbol('416: Range Not Satisfiable'),
-	EXPECTATION_FAILED: Symbol('417: Expectation Failed'),
-	IM_A_TEAPOT: Symbol("418: I'm a teapot"),
-	MISDIRECTED_REQUEST: Symbol('421: Misdirected Request'),
-	UNPROCESSABLE_ENTITY: Symbol('422: Unprocessable Entity'),
-	LOCKED: Symbol('423: Locked'),
-	FAILED_DEPENDENCY: Symbol('424: Failed Dependency'),
-	TOO_EARLY: Symbol('425: Too Early'),
-	UPGRADE_REQUIRED: Symbol('426: Upgrade Required'),
-	PRECONDITION_REQUIRED: Symbol('428: Precondition Required'),
-	TOO_MANY_REQUESTS: Symbol('429: Too Many Requests'),
-	REQUEST_HEADER_FIELDS_TOO_LARGE: Symbol('431: Request Header Fields Too Large'),
-	UNAVAILABLE_FOR_LEGAL_REASONS: Symbol('451: Unavailable For Legal Reasons'),
 
-	// Server Errors:
-	INTERNAL_SERVER_ERROR: Symbol('500: Internal Server Error'),
-	NOT_IMPLEMENTED: Symbol('501: Not Implemented'),
-	BAD_GATEWAY: Symbol('502: Bad Gateway'),
-	SERVICE_UNAVAILABLE: Symbol('503: Service Unavailable'),
-	GATEWAY_TIMEOUT: Symbol('504: Gateway Timeout'),
-	HTTP_VERSION_NOT_SUPPORTED: Symbol('505: HTTP Version Not Supported'),
-	VARIANT_ALSO_NEGOTIATES: Symbol('506: Variant Also Negotiates'),
-	INSUFFICIENT_STORAGE: Symbol('507: Insufficient Storage'),
-	LOOP_DETECTED: Symbol('508: Loop Detected'),
-	NOT_EXTENDED: Symbol('510: Not Extended'),
-	NETWORK_AUTHENTICATION_REQUIRED: Symbol('511: Network Authentication Required')
-}
-
-const descriptionsByCode = {
+module.exports = new Enum({
 	// Informational:
-	100: 'Continue',
-	101: 'Switching Protocols',
-	102: 'Processing',
-	103: 'Early Hints',
+	CONTINUE: 100,
+	SWITCHING_PROTOCOLS: 101,
+	PROCESSING: 102,
+	EARLY_HINTS: 103,
 
 	// Success:
-	200: 'OK',
-	201: 'Created',
-	202: 'Accepted',
-	203: 'Non-Authoritative Information',
-	204: 'No Content',
-	205: 'Reset Content',
-	206: 'Partial Content',
-	207: 'Multi-Status',
-	208: 'Already Reported',
-	226: 'IM Used',
+	OK: 200,
+	CREATED: 201,
+	ACCEPTED: 202,
+	NON_AUTHORITATIVE_INFORMATION: 203,
+	NO_CONTENT: 204,
+	RESET_CONTENT: 205,
+	PARTIAL_CONTENT: 206,
+	MULTI_STATUS: 207,
+	ALREADY_REPORTED: 208,
+	IM_USED: 226,
 
 	// Redirections:
-	300: 'Multiple Choices',
-	301: 'Moved Permanently',
-	302: 'Found',
-	303: 'See Other',
-	304: 'Not Modified',
-	305: 'Use Proxy',
-	307: 'Temporary Redirect',
-	308: 'Permanent Redirect',
+	MULTIPLE_CHOICES: 300,
+	MOVED_PERMANENTLY: 301,
+	FOUND: 302,
+	SEE_OTHER: 303,
+	NOT_MODIFIED: 304,
+	USE_PROXY: 305,
+	TEMPORARY_REDIRECT: 307,
+	PERMANENT_REDIRECT: 308,
 
 	// Client Errors:
-	400: 'Bad Request',
-	401: 'Unauthorized',
-	402: 'Payment Required',
-	403: 'Forbidden',
-	404: 'Not Found',
-	405: 'Method Not Allowed',
-	406: 'Not Acceptable',
-	407: 'Proxy Authentication Required',
-	408: 'Request Timeout',
-	409: 'Conflict',
-	410: 'Gone',
-	411: 'Length Required',
-	412: 'Precondition Failed',
-	413: 'Payload Too Large',
-	414: 'URI Too Long',
-	415: 'Unsupported Media Type',
-	416: 'Range Not Satisfiable',
-	417: 'Expectation Failed',
-	418: 'I\'m a teapot',
-	421: 'Misdirected Request',
-	422: 'Unprocessable Entity',
-	423: 'Locked',
-	424: 'Failed Dependency',
-	425: 'Too Early',
-	426: 'Upgrade Required',
-	428: 'Precondition Required',
-	429: 'Too Many Requests',
-	431: 'Request Header Fields Too Large',
-	451: 'Unavailable For Legal Reasons',
+	BAD_REQUEST: 400,
+	UNAUTHORIZED: 401,
+	PAYMENT_REQUIRED: 402,
+	FORBIDDEN: 403,
+	NOT_FOUND: 404,
+	METHOD_NOT_ALLOWED: 405,
+	NOT_ACCEPTABLE: 406,
+	PROXY_AUTHENTICATION_REQUIRED: 407,
+	REQUEST_TIMEOUT: 408,
+	CONFLICT: 409,
+	GONE: 410,
+	LENGTH_REQUIRED: 411,
+	PRECONDITION_FAILED: 412,
+	PAYLOAD_TOO_LARGE: 413,
+	URI_TOO_LONG: 414,
+	UNSUPPORTED_MEDIA_TYPE: 415,
+	RANGE_NOT_SATISFIABLE: 416,
+	EXPECTATION_FAILED: 417,
+	IM_A_TEAPOT: 418,
+	MISDIRECTED_REQUEST: 421,
+	UNPROCESSABLE_ENTITY: 422,
+	LOCKED: 423,
+	FAILED_DEPENDENCY: 424,
+	TOO_EARLY: 425,
+	UPGRADE_REQUIRED: 426,
+	PRECONDITION_REQUIRED: 428,
+	TOO_MANY_REQUESTS: 429,
+	REQUEST_HEADER_FIELDS_TOO_LARGE: 431,
+	UNAVAILABLE_FOR_LEGAL_REASONS: 451,
 
 	// Server Errors:
-	500: 'Internal Server Error',
-	501: 'Not Implemented',
-	502: 'Bad Gateway',
-	503: 'Service Unavailable',
-	504: 'Gateway Timeout',
-	505: 'HTTP Version Not Supported',
-	506: 'Variant Also Negotiates',
-	507: 'Insufficient Storage',
-	508: 'Loop Detected',
-	510: 'Not Extended',
-	511: 'Network Authentication Required'
-};
-
-module.exports = {
-	descriptions: {
-		byCode: descriptionsByCode
-	},
-
-	symbols: {
-		byTag: symbolsByTag
-	}
-}
+	INTERNAL_SERVER_ERROR: 500,
+	NOT_IMPLEMENTED: 501,
+	BAD_GATEWAY: 502,
+	SERVICE_UNAVAILABLE: 503,
+	GATEWAY_TIMEOUT: 504,
+	HTTP_VERSION_NOT_SUPPORTED: 505,
+	VARIANT_ALSO_NEGOTIATES: 506,
+	INSUFFICIENT_STORAGE: 507,
+	LOOP_DETECTED: 508,
+	NOT_EXTENDED: 510,
+	NETWORK_AUTHENTICATION_REQUIRED: 511,
+});

package/lib/http/codes/symbols.js

@@ -0,0 +1,82 @@
+/*!
+ * /nodester
+ * MIT Licensed
+ */
+'use strict';
+
+const Enum = require('nodester/enum');
+
+
+module.exports = new Enum({
+	// Informational:
+	CONTINUE: Symbol('100: Continue'),
+	SWITCHING_PROTOCOLS: Symbol('101: Switching Protocols'),
+	PROCESSING: Symbol('102: Processing'),
+	EARLY_HINTS: Symbol('103: Early Hints'),
+
+	// Success:
+	OK: Symbol('200: OK'),
+	CREATED: Symbol('201: Created'),
+	ACCEPTED: Symbol('202: Accepted'),
+	NON_AUTHORITATIVE_INFORMATION: Symbol('203: Non-Authoritative Information'),
+	NO_CONTENT: Symbol('204: No Content'),
+	RESET_CONTENT: Symbol('205: Reset Content'),
+	PARTIAL_CONTENT: Symbol('206: Partial Content'),
+	MULTI_STATUS: Symbol('207: Multi-Status'),
+	ALREADY_REPORTED: Symbol('208: Already Reported'),
+	IM_USED: Symbol('226: IM Used'),
+
+	// Redirections:
+	MULTIPLE_CHOICES: Symbol('300: Multiple Choices'),
+	MOVED_PERMANENTLY: Symbol('301: Moved Permanently'),
+	FOUND: Symbol('302: Found'),
+	SEE_OTHER: Symbol('303: See Other'),
+	NOT_MODIFIED: Symbol('304: Not Modified'),
+	USE_PROXY: Symbol('305: Use Proxy'),
+	TEMPORARY_REDIRECT: Symbol('307: Temporary Redirect'),
+	PERMANENT_REDIRECT: Symbol('308: Permanent Redirect'),
+
+	// Client Errors:
+	BAD_REQUEST: Symbol('400: Bad Request'),
+	UNAUTHORIZED: Symbol('401: Unauthorized'),
+	PAYMENT_REQUIRED: Symbol('402: Payment Required'),
+	FORBIDDEN: Symbol('403: Forbidden'),
+	NOT_FOUND: Symbol('404: Not Found'),
+	METHOD_NOT_ALLOWED: Symbol('405: Method Not Allowed'),
+	NOT_ACCEPTABLE: Symbol('406: Not Acceptable'),
+	PROXY_AUTHENTICATION_REQUIRED: Symbol('407: Proxy Authentication Required'),
+	REQUEST_TIMEOUT: Symbol('408: Request Timeout'),
+	CONFLICT: Symbol('409: Conflict'),
+	GONE: Symbol('410: Gone'),
+	LENGTH_REQUIRED: Symbol('411: Length Required'),
+	PRECONDITION_FAILED: Symbol('412: Precondition Failed'),
+	PAYLOAD_TOO_LARGE: Symbol('413: Payload Too Large'),
+	URI_TOO_LONG: Symbol('414: URI Too Long'),
+	UNSUPPORTED_MEDIA_TYPE: Symbol('415: Unsupported Media Type'),
+	RANGE_NOT_SATISFIABLE: Symbol('416: Range Not Satisfiable'),
+	EXPECTATION_FAILED: Symbol('417: Expectation Failed'),
+	IM_A_TEAPOT: Symbol("418: I'm a teapot"),
+	MISDIRECTED_REQUEST: Symbol('421: Misdirected Request'),
+	UNPROCESSABLE_ENTITY: Symbol('422: Unprocessable Entity'),
+	LOCKED: Symbol('423: Locked'),
+	FAILED_DEPENDENCY: Symbol('424: Failed Dependency'),
+	TOO_EARLY: Symbol('425: Too Early'),
+	UPGRADE_REQUIRED: Symbol('426: Upgrade Required'),
+	PRECONDITION_REQUIRED: Symbol('428: Precondition Required'),
+	TOO_MANY_REQUESTS: Symbol('429: Too Many Requests'),
+	REQUEST_HEADER_FIELDS_TOO_LARGE: Symbol('431: Request Header Fields Too Large'),
+	UNAVAILABLE_FOR_LEGAL_REASONS: Symbol('451: Unavailable For Legal Reasons'),
+
+	// Server Errors:
+	INTERNAL_SERVER_ERROR: Symbol('500: Internal Server Error'),
+	NOT_IMPLEMENTED: Symbol('501: Not Implemented'),
+	BAD_GATEWAY: Symbol('502: Bad Gateway'),
+	SERVICE_UNAVAILABLE: Symbol('503: Service Unavailable'),
+	GATEWAY_TIMEOUT: Symbol('504: Gateway Timeout'),
+	HTTP_VERSION_NOT_SUPPORTED: Symbol('505: HTTP Version Not Supported'),
+	VARIANT_ALSO_NEGOTIATES: Symbol('506: Variant Also Negotiates'),
+	INSUFFICIENT_STORAGE: Symbol('507: Insufficient Storage'),
+	LOOP_DETECTED: Symbol('508: Loop Detected'),
+	NOT_EXTENDED: Symbol('510: Not Extended'),
+	NETWORK_AUTHENTICATION_REQUIRED: Symbol('511: Network Authentication Required')
+});

package/lib/http/{request.js → request/index.js}

@@ -2,17 +2,21 @@
  * /nodester
  * MIT Licensed
  */
+ 
 'use strict';
 
+const { IncomingMessage } = require('http');
+
 const accepts = require('accepts');
 const isIP = require('net').isIP;
 const typeis = require('type-is');
-const { IncomingMessage } = require('http');
 const fresh = require('fresh');
 const parseRange = require('range-parser');
 const parse = require('parseurl');
 const proxyaddr = require('proxy-addr');
 
+const { defineGetter } = require('./utils');
+
 
 const req = IncomingMessage.prototype;
 
@@ -38,8 +42,10 @@ module.exports = req;
  * Aliased as `req.header()`.
  *
  * @param {String} name
+ *
  * @return {String}
- * @public
+ *
+ * @api public
  */
 req.get =
 req.header = function header(name) {
@@ -106,7 +112,8 @@ req.header = function header(name) {
  *
  * @param {String|Array} type(s)
  * @return {String|Array|Boolean}
- * @public
+ *
+ * @api public
  */
 req.accepts = function() {
 	const accept = accepts(this);
@@ -119,7 +126,8 @@ req.accepts = function() {
  *
  * @param {String} ...encoding
  * @return {String|Array}
- * @public
+ *
+ * @api public
  */
 req.acceptsEncodings = function() {
 	const accept = accepts(this);
@@ -133,7 +141,8 @@ req.acceptsEncodings = function() {
  *
  * @param {String} ...charset
  * @return {String|Array}
- * @public
+ *
+ * @api public
  */
 req.acceptsCharsets = function() {
 	const accept = accepts(this);
@@ -147,7 +156,8 @@ req.acceptsCharsets = function() {
  *
  * @param {String} ...lang
  * @return {String|Array}
- * @public
+ *
+ * @api public
  */
 req.acceptsLanguages = function() {
 	const accept = accepts(this);
@@ -176,8 +186,10 @@ req.acceptsLanguages = function() {
  * @param {number} size
  * @param {object} [options]
  * @param {boolean} [options.combine=false]
+ *
  * @return {number|array}
- * @public
+ *
+ * @api public
  */
 req.range = function range(size, options) {
 	const range = this.get('Range');
@@ -211,7 +223,8 @@ req.range = function range(size, options) {
  *
  * @param {String|Array} types...
  * @return {String|false|null}
- * @public
+ *
+ * @api public
  */
 req.is = function is(types) {
 	let arr = types;
@@ -239,7 +252,8 @@ req.is = function is(types) {
  * supplies https for you this may be enabled.
  *
  * @return {String}
- * @public
+ *
+ * @api public
  */
 
 defineGetter(req, 'protocol', function protocol() {
@@ -254,12 +268,13 @@ defineGetter(req, 'protocol', function protocol() {
 
 	// Note: X-Forwarded-Proto is normally only ever a
 	//       single value, but this is to be safe.
-	const header = this.get('X-Forwarded-Proto') || proto
-	const index = header.indexOf(',')
+	const header = this.get('X-Forwarded-Proto') || proto;
+	const index = header.indexOf(',');
 
-	return index !== -1
-		? header.substring(0, index).trim()
-		: header.trim()
+	return index !== -1 ?
+					header.substring(0, index).trim()
+					:
+					header.trim();
 });
 
 
@@ -269,7 +284,8 @@ defineGetter(req, 'protocol', function protocol() {
  *    req.protocol === 'https'
  *
  * @return {Boolean}
- * @public
+ *
+ * @api public
  */
 defineGetter(req, 'secure', function secure() {
 	return this.protocol === 'https';
@@ -283,7 +299,8 @@ defineGetter(req, 'secure', function secure() {
  * "trust proxy" is set.
  *
  * @return {String}
- * @public
+ *
+ * @api public
  */
 defineGetter(req, 'ip', function ip() {
 	const trust = this.app.get('trust proxy fn');
@@ -299,8 +316,9 @@ defineGetter(req, 'ip', function ip() {
  * where "proxy2" is the furthest down-stream and "proxy1" and
  * "proxy2" were trusted.
  *
- * @return {Array}
- * @public
+ * @return {Array} addresses
+ *
+ * @api public
  */
 defineGetter(req, 'ips', function ips() {
 	const trust = this.app.get('trust proxy fn');
@@ -308,37 +326,9 @@ defineGetter(req, 'ips', function ips() {
 
 	// reverse the order (to farthest -> closest)
 	// and remove socket address
-	addrs.reverse().pop()
+	addresses.reverse().pop()
 
-	return addrs
-});
-
-
-/**
- * Return subdomains as an array.
- *
- * Subdomains are the dot-separated parts of the host before the main domain of
- * the app. By default, the domain of the app is assumed to be the last two
- * parts of the host. This can be changed by setting "subdomain offset".
- *
- * For example, if the domain is "tobi.ferrets.example.com":
- * If "subdomain offset" is not set, req.subdomains is `["ferrets", "tobi"]`.
- * If "subdomain offset" is 3, req.subdomains is `["tobi"]`.
- *
- * @return {Array}
- * @public
- */
-defineGetter(req, 'subdomains', function subdomains() {
-	const hostname = this.hostname;
-
-	if (!hostname) return [];
-
-	const offset = this.app.get('subdomain offset');
-	const subdomains = !isIP(hostname)
-		? hostname.split('.').reverse()
-		: [hostname];
-
-	return subdomains.slice(offset);
+	return addresses;
 });
 
 
@@ -346,7 +336,8 @@ defineGetter(req, 'subdomains', function subdomains() {
  * Short-hand for `url.parse(req.url).pathname`.
  *
  * @return {String}
- * @public
+ *
+ * @api public
  */
 defineGetter(req, 'path', function path() {
 	return parse(this).pathname;
@@ -359,7 +350,8 @@ defineGetter(req, 'path', function path() {
  * or "Host" as a fallback.
  *
  * @return {String}
- * @public
+ *
+ * @api public
  */
 defineGetter(req, 'hostname', function hostname() {
 	const host = this.get('X-Forwarded-Host') ?? this.get('Host');
@@ -373,23 +365,24 @@ defineGetter(req, 'hostname', function hostname() {
  * still match.
  *
  * @return {Boolean}
- * @public
+ *
+ * @api public
  */
 defineGetter(req, 'fresh', function() {
 	const method = this.method;
-	const res = this.res
-	const status = res.statusCode
+	const res = this.res;
+	const status = res.statusCode;
 
 	// GET or HEAD for weak freshness validation only
-	if ('GET' !== method && 'HEAD' !== method)
+	if (method !== 'GET' && method !== 'HEAD')
 		return false;
 
 	// 2xx or 304 as per rfc2616 14.26
 	if ((status >= 200 && status < 300) || 304 === status) {
 		return fresh(this.headers, {
-			'etag': res.get('ETag'),
+			'etag': res.get('etag'),
 			'last-modified': res.get('Last-Modified')
-		})
+		});
 	}
 
 	return false;
@@ -402,7 +395,8 @@ defineGetter(req, 'fresh', function() {
  * resource has changed.
  *
  * @return {Boolean}
- * @public
+ *
+ * @api public
  */
 defineGetter(req, 'stale', function stale() {
 	return !this.fresh;
@@ -413,26 +407,10 @@ defineGetter(req, 'stale', function stale() {
  * Check if the request was an _XMLHttpRequest_.
  *
  * @return {Boolean}
- * @public
+ *
+ * @api public
  */
 defineGetter(req, 'xhr', function xhr() {
 	const val = this.get('X-Requested-With') || '';
 	return val.toLowerCase() === 'xmlhttprequest';
 });
-
-
-/**
- * Helper function for creating a getter on an object.
- *
- * @param {Object} obj
- * @param {String} name
- * @param {Function} getter
- * @private
- */
-function defineGetter(obj, name, getter) {
-	Object.defineProperty(obj, name, {
-		configurable: true,
-		enumerable: true,
-		get: getter
-	});
-}

package/lib/http/request/utils.js

@@ -0,0 +1,27 @@
+/*!
+ * /nodester
+ * MIT Licensed
+ */
+ 
+'use strict';
+
+module.exports = {
+	defineGetter: _defineGetter
+}
+
+/**
+ * Helper function for creating a getter on an object.
+ *
+ * @param {Object} obj
+ * @param {String} name
+ * @param {Function} getter
+ *
+ * @api private
+ */
+function _defineGetter(obj, name, getter) {
+	Object.defineProperty(obj, name, {
+		configurable: true,
+		enumerable: true,
+		get: getter
+	});
+}