normalize-url 2.0.1 → 3.2.0

package/index.js

@@ -1,38 +1,16 @@
 'use strict';
-const url = require('url');
-const punycode = require('punycode');
-const queryString = require('query-string');
-const prependHttp = require('prepend-http');
-const sortKeys = require('sort-keys');
-
-const DEFAULT_PORTS = {
-	'http:': 80,
-	'https:': 443,
-	'ftp:': 21
-};
-
-// Protocols that always contain a `//`` bit
-const slashedProtocol = {
-	http: true,
-	https: true,
-	ftp: true,
-	gopher: true,
-	file: true,
-	'http:': true,
-	'https:': true,
-	'ftp:': true,
-	'gopher:': true,
-	'file:': true
-};
+// TODO: Use the `URL` global when targeting Node.js 10
+const URLParser = typeof URL === 'undefined' ? require('url').URL : URL;
 
 function testParameter(name, filters) {
 	return filters.some(filter => filter instanceof RegExp ? filter.test(name) : filter === name);
 }
 
-module.exports = (str, opts) => {
+module.exports = (urlString, opts) => {
 	opts = Object.assign({
 		normalizeProtocol: true,
 		normalizeHttps: false,
+		normalizeHttp: false,
 		stripFragment: true,
 		stripWWW: true,
 		removeQueryParameters: [/^utm_\w+/i],
@@ -41,43 +19,45 @@ module.exports = (str, opts) => {
 		sortQueryParameters: true
 	}, opts);
 
-	if (typeof str !== 'string') {
-		throw new TypeError('Expected a string');
-	}
+	urlString = urlString.trim();
 
-	const hasRelativeProtocol = str.startsWith('//');
+	const hasRelativeProtocol = urlString.startsWith('//');
+	const isRelativeUrl = !hasRelativeProtocol && /^\.*\//.test(urlString);
 
 	// Prepend protocol
-	str = prependHttp(str.trim()).replace(/^\/\//, 'http://');
+	if (!isRelativeUrl) {
+		urlString = urlString.replace(/^(?!(?:\w+:)?\/\/)|^\/\//, 'http://');
+	}
 
-	const urlObj = url.parse(str);
+	const urlObj = new URLParser(urlString);
 
-	if (opts.normalizeHttps && urlObj.protocol === 'https:') {
-		urlObj.protocol = 'http:';
+	if (opts.normalizeHttps && opts.normalizeHttp) {
+		throw new Error('The `normalizeHttp` and `normalizeHttps` options cannot be used together');
 	}
 
-	if (!urlObj.hostname && !urlObj.pathname) {
-		throw new Error('Invalid URL');
+	if (opts.normalizeHttp && urlObj.protocol === 'http:') {
+		urlObj.protocol = 'https:';
 	}
 
-	// Prevent these from being used by `url.format`
-	delete urlObj.host;
-	delete urlObj.query;
+	if (opts.normalizeHttps && urlObj.protocol === 'https:') {
+		urlObj.protocol = 'http:';
+	}
 
 	// Remove fragment
 	if (opts.stripFragment) {
-		delete urlObj.hash;
+		urlObj.hash = '';
 	}
 
-	// Remove default port
-	const port = DEFAULT_PORTS[urlObj.protocol];
-	if (Number(urlObj.port) === port) {
-		delete urlObj.port;
-	}
-
-	// Remove duplicate slashes
+	// Remove duplicate slashes if not preceded by a protocol
 	if (urlObj.pathname) {
-		urlObj.pathname = urlObj.pathname.replace(/\/{2,}/g, '/');
+		// TODO: Use the following instead when targeting Node.js 10
+		// `urlObj.pathname = urlObj.pathname.replace(/(?<!https?:)\/{2,}/g, '/');`
+		urlObj.pathname = urlObj.pathname.replace(/((?![https?:]).)\/{2,}/g, (_, p1) => {
+			if (/^(?!\/)/g.test(p1)) {
+				return `${p1}/`;
+			}
+			return '/';
+		});
 	}
 
 	// Decode URI octets
@@ -100,17 +80,7 @@ module.exports = (str, opts) => {
 		}
 	}
 
-	// Resolve relative paths, but only for slashed protocols
-	if (slashedProtocol[urlObj.protocol]) {
-		const domain = urlObj.protocol + '//' + urlObj.hostname;
-		const relative = url.resolve(domain, urlObj.pathname);
-		urlObj.pathname = relative.replace(domain, '');
-	}
-
 	if (urlObj.hostname) {
-		// IDN to Unicode
-		urlObj.hostname = punycode.toUnicode(urlObj.hostname).toLowerCase();
-
 		// Remove trailing dot
 		urlObj.hostname = urlObj.hostname.replace(/\.$/, '');
 
@@ -120,44 +90,32 @@ module.exports = (str, opts) => {
 		}
 	}
 
-	// Remove URL with empty query string
-	if (urlObj.search === '?') {
-		delete urlObj.search;
-	}
-
-	const queryParameters = queryString.parse(urlObj.search);
-
 	// Remove query unwanted parameters
 	if (Array.isArray(opts.removeQueryParameters)) {
-		for (const key in queryParameters) {
+		for (const key of [...urlObj.searchParams.keys()]) {
 			if (testParameter(key, opts.removeQueryParameters)) {
-				delete queryParameters[key];
+				urlObj.searchParams.delete(key);
 			}
 		}
 	}
 
 	// Sort query parameters
 	if (opts.sortQueryParameters) {
-		urlObj.search = queryString.stringify(sortKeys(queryParameters));
-	}
-
-	// Decode query parameters
-	if (urlObj.search !== null) {
-		urlObj.search = decodeURIComponent(urlObj.search);
+		urlObj.searchParams.sort();
 	}
 
 	// Take advantage of many of the Node `url` normalizations
-	str = url.format(urlObj);
+	urlString = urlObj.toString();
 
 	// Remove ending `/`
 	if (opts.removeTrailingSlash || urlObj.pathname === '/') {
-		str = str.replace(/\/$/, '');
+		urlString = urlString.replace(/\/$/, '');
 	}
 
 	// Restore relative protocol, if applicable
 	if (hasRelativeProtocol && !opts.normalizeProtocol) {
-		str = str.replace(/^http:\/\//, '//');
+		urlString = urlString.replace(/^http:\/\//, '//');
 	}
 
-	return str;
+	return urlString;
 };

package/package.json

@@ -1,46 +1,40 @@
 {
-  "name": "normalize-url",
-  "version": "2.0.1",
-  "description": "Normalize a URL",
-  "license": "MIT",
-  "repository": "sindresorhus/normalize-url",
-  "author": {
-    "name": "Sindre Sorhus",
-    "email": "sindresorhus@gmail.com",
-    "url": "sindresorhus.com"
-  },
-  "engines": {
-    "node": ">=4"
-  },
-  "scripts": {
-    "test": "xo && ava"
-  },
-  "files": [
-    "index.js"
-  ],
-  "keywords": [
-    "normalize",
-    "url",
-    "uri",
-    "address",
-    "string",
-    "normalization",
-    "normalisation",
-    "query",
-    "querystring",
-    "unicode",
-    "simplify",
-    "strip",
-    "trim",
-    "canonical"
-  ],
-  "dependencies": {
-    "prepend-http": "^2.0.0",
-    "query-string": "^5.0.1",
-    "sort-keys": "^2.0.0"
-  },
-  "devDependencies": {
-    "ava": "*",
-    "xo": "*"
-  }
+	"name": "normalize-url",
+	"version": "3.2.0",
+	"description": "Normalize a URL",
+	"license": "MIT",
+	"repository": "sindresorhus/normalize-url",
+	"author": {
+		"name": "Sindre Sorhus",
+		"email": "sindresorhus@gmail.com",
+		"url": "sindresorhus.com"
+	},
+	"engines": {
+		"node": ">=6"
+	},
+	"scripts": {
+		"test": "xo && ava"
+	},
+	"files": [
+		"index.js"
+	],
+	"keywords": [
+		"normalize",
+		"url",
+		"uri",
+		"address",
+		"string",
+		"normalization",
+		"normalisation",
+		"query",
+		"querystring",
+		"simplify",
+		"strip",
+		"trim",
+		"canonical"
+	],
+	"devDependencies": {
+		"ava": "*",
+		"xo": "*"
+	}
 }

package/readme.md

@@ -69,6 +69,23 @@ normalizeUrl('https://sindresorhus.com:80/', {normalizeHttps: true});
 //=> 'http://sindresorhus.com'
 ```
 
+##### normalizeHttp
+
+Type: `boolean`<br>
+Default: `false`
+
+Normalize `http:` URLs to `https:`.
+
+```js
+normalizeUrl('https://sindresorhus.com:80/');
+//=> 'https://sindresorhus.com'
+
+normalizeUrl('http://sindresorhus.com:80/', {normalizeHttp: true});
+//=> 'https://sindresorhus.com'
+```
+
+This option is mutually exclusive with the `normalizeHttps` option.
+
 ##### stripFragment
 
 Type: `boolean`<br>