normalize-url 7.1.0 → 8.0.0

package/index.d.ts

@@ -1,10 +1,8 @@
-export interface Options {
+export type Options = {
 	/**
-	@default 'http:'
-
-	Values: `'https:' | 'http:'`
+	@default 'http'
 	*/
-	readonly defaultProtocol?: string; // TODO: Make this `'https:' | 'http:'` in the next major version.
+	readonly defaultProtocol?: 'https' | 'http';
 
 	/**
 	Prepends `defaultProtocol` to the URL if it's protocol-relative.
@@ -13,44 +11,44 @@ export interface Options {
 
 	@example
 	```
-	normalizeUrl('//sindresorhus.com:80/');
+	normalizeUrl('//sindresorhus.com');
 	//=> 'http://sindresorhus.com'
 
-	normalizeUrl('//sindresorhus.com:80/', {normalizeProtocol: false});
+	normalizeUrl('//sindresorhus.com', {normalizeProtocol: false});
 	//=> '//sindresorhus.com'
 	```
 	*/
 	readonly normalizeProtocol?: boolean;
 
 	/**
-	Normalizes `https:` URLs to `http:`.
+	Normalizes HTTPS URLs to HTTP.
 
 	@default false
 
 	@example
 	```
-	normalizeUrl('https://sindresorhus.com:80/');
+	normalizeUrl('https://sindresorhus.com');
 	//=> 'https://sindresorhus.com'
 
-	normalizeUrl('https://sindresorhus.com:80/', {forceHttp: true});
+	normalizeUrl('https://sindresorhus.com', {forceHttp: true});
 	//=> 'http://sindresorhus.com'
 	```
 	*/
 	readonly forceHttp?: boolean;
 
 	/**
-	Normalizes `http:` URLs to `https:`.
+	Normalizes HTTP URLs to HTTPS.
 
-	This option can't be used with the `forceHttp` option at the same time.
+	This option cannot be used with the `forceHttp` option at the same time.
 
 	@default false
 
 	@example
 	```
-	normalizeUrl('https://sindresorhus.com:80/');
-	//=> 'https://sindresorhus.com'
+	normalizeUrl('http://sindresorhus.com');
+	//=> 'http://sindresorhus.com'
 
-	normalizeUrl('http://sindresorhus.com:80/', {forceHttps: true});
+	normalizeUrl('http://sindresorhus.com', {forceHttps: true});
 	//=> 'https://sindresorhus.com'
 	```
 	*/
@@ -249,6 +247,23 @@ export interface Options {
 	*/
 	readonly removeDirectoryIndex?: boolean | ReadonlyArray<RegExp | string>;
 
+	/**
+	Removes an explicit port number from the URL.
+
+	Port 443 is always removed from HTTPS URLs and 80 is always removed from HTTP URLs regardless of this option.
+
+	@default false
+
+	@example
+	```
+	normalizeUrl('sindresorhus.com:123', {
+		removeExplicitPort: true
+	});
+	//=> 'http://sindresorhus.com'
+	```
+	*/
+	readonly removeExplicitPort?: boolean;
+
 	/**
 	Sorts the query parameters alphabetically by key.
 
@@ -263,11 +278,13 @@ export interface Options {
 	```
 	*/
 	readonly sortQueryParameters?: boolean;
-}
+};
 
 /**
 [Normalize](https://en.wikipedia.org/wiki/URL_normalization) a URL.
 
+URLs with custom protocols are not normalized and just passed through by default. Supported protocols are: `https`, `http`, `file`, and `data`.
+
 @param url - URL to normalize, including [data URL](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URIs).
 
 @example

package/index.js

@@ -4,6 +4,21 @@ const DATA_URL_DEFAULT_CHARSET = 'us-ascii';
 
 const testParameter = (name, filters) => filters.some(filter => filter instanceof RegExp ? filter.test(name) : filter === name);
 
+const supportedProtocols = new Set([
+	'https:',
+	'http:',
+	'file:',
+]);
+
+const hasCustomProtocol = urlString => {
+	try {
+		const {protocol} = new URL(urlString);
+		return protocol.endsWith(':') && !supportedProtocols.has(protocol);
+	} catch {
+		return false;
+	}
+};
+
 const normalizeDataURL = (urlString, {stripHash}) => {
 	const match = /^data:(?<type>[^,]*?),(?<data>[^#]*?)(?:#(?<hash>.*))?$/.exec(urlString);
 
@@ -22,7 +37,7 @@ const normalizeDataURL = (urlString, {stripHash}) => {
 	}
 
 	// Lowercase MIME type
-	const mimeType = (mediaType.shift() || '').toLowerCase();
+	const mimeType = mediaType.shift()?.toLowerCase() ?? '';
 	const attributes = mediaType
 		.map(attribute => {
 			let [key, value = ''] = attribute.split('=').map(string => string.trim());
@@ -57,7 +72,7 @@ const normalizeDataURL = (urlString, {stripHash}) => {
 
 export default function normalizeUrl(urlString, options) {
 	options = {
-		defaultProtocol: 'http:',
+		defaultProtocol: 'http',
 		normalizeProtocol: true,
 		forceHttp: false,
 		forceHttps: false,
@@ -69,10 +84,16 @@ export default function normalizeUrl(urlString, options) {
 		removeTrailingSlash: true,
 		removeSingleSlash: true,
 		removeDirectoryIndex: false,
+		removeExplicitPort: false,
 		sortQueryParameters: true,
 		...options,
 	};
 
+	// Legacy: Append `:` to the protocol if missing.
+	if (typeof options.defaultProtocol === 'string' && !options.defaultProtocol.endsWith(':')) {
+		options.defaultProtocol = `${options.defaultProtocol}:`;
+	}
+
 	urlString = urlString.trim();
 
 	// Data URL
@@ -80,8 +101,8 @@ export default function normalizeUrl(urlString, options) {
 		return normalizeDataURL(urlString, options);
 	}
 
-	if (/^view-source:/i.test(urlString)) {
-		throw new Error('`view-source:` is not supported as it is a non-standard protocol');
+	if (hasCustomProtocol(urlString)) {
+		return urlString;
 	}
 
 	const hasRelativeProtocol = urlString.startsWith('//');
@@ -228,6 +249,11 @@ export default function normalizeUrl(urlString, options) {
 		urlObject.pathname = urlObject.pathname.replace(/\/$/, '');
 	}
 
+	// Remove an explicit port number, excluding a default port number, if applicable
+	if (options.removeExplicitPort && urlObject.port) {
+		urlObject.port = '';
+	}
+
 	const oldUrlString = urlString;
 
 	// Take advantage of many of the Node `url` normalizations

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "normalize-url",
-	"version": "7.1.0",
+	"version": "8.0.0",
 	"description": "Normalize a URL",
 	"license": "MIT",
 	"repository": "sindresorhus/normalize-url",
@@ -11,9 +11,12 @@
 		"url": "https://sindresorhus.com"
 	},
 	"type": "module",
-	"exports": "./index.js",
+	"exports": {
+		"types": "./index.d.ts",
+		"default": "./index.js"
+	},
 	"engines": {
-		"node": ">=12.20"
+		"node": ">=14.16"
 	},
 	"scripts": {
 		"test": "xo && c8 ava && tsd"
@@ -38,10 +41,10 @@
 		"canonical"
 	],
 	"devDependencies": {
-		"ava": "^4.0.1",
-		"c8": "^7.11.0",
-		"tsd": "^0.19.1",
-		"xo": "^0.47.0"
+		"ava": "^5.0.1",
+		"c8": "^7.12.0",
+		"tsd": "^0.24.1",
+		"xo": "^0.52.4"
 	},
 	"c8": {
 		"reporter": [

package/readme.md

@@ -30,6 +30,8 @@ normalizeUrl('//www.sindresorhus.com:80/../baz?b=bar&a=foo');
 
 ### normalizeUrl(url, options?)
 
+URLs with custom protocols are not normalized and just passed through by default. Supported protocols are: `https`, `http`, `file`, and `data`.
+
 #### url
 
 Type: `string`
@@ -43,8 +45,8 @@ Type: `object`
 ##### defaultProtocol
 
 Type: `string`\
-Default: `http:`\
-Values: `'https:' | 'http:'`
+Default: `'http'`\
+Values: `'https' | 'http'`
 
 ##### normalizeProtocol
 
@@ -54,10 +56,10 @@ Default: `true`
 Prepend `defaultProtocol` to the URL if it's protocol-relative.
 
 ```js
-normalizeUrl('//sindresorhus.com:80/');
+normalizeUrl('//sindresorhus.com');
 //=> 'http://sindresorhus.com'
 
-normalizeUrl('//sindresorhus.com:80/', {normalizeProtocol: false});
+normalizeUrl('//sindresorhus.com', {normalizeProtocol: false});
 //=> '//sindresorhus.com'
 ```
 
@@ -66,13 +68,13 @@ normalizeUrl('//sindresorhus.com:80/', {normalizeProtocol: false});
 Type: `boolean`\
 Default: `false`
 
-Normalize `https:` to `http:`.
+Normalize HTTPS to HTTP.
 
 ```js
-normalizeUrl('https://sindresorhus.com:80/');
+normalizeUrl('https://sindresorhus.com');
 //=> 'https://sindresorhus.com'
 
-normalizeUrl('https://sindresorhus.com:80/', {forceHttp: true});
+normalizeUrl('https://sindresorhus.com', {forceHttp: true});
 //=> 'http://sindresorhus.com'
 ```
 
@@ -81,17 +83,17 @@ normalizeUrl('https://sindresorhus.com:80/', {forceHttp: true});
 Type: `boolean`\
 Default: `false`
 
-Normalize `http:` to `https:`.
+Normalize HTTP to HTTPS.
 
 ```js
-normalizeUrl('https://sindresorhus.com:80/');
-//=> 'https://sindresorhus.com'
+normalizeUrl('http://sindresorhus.com');
+//=> 'http://sindresorhus.com'
 
-normalizeUrl('http://sindresorhus.com:80/', {forceHttps: true});
+normalizeUrl('http://sindresorhus.com', {forceHttps: true});
 //=> 'https://sindresorhus.com'
 ```
 
-This option can't be used with the `forceHttp` option at the same time.
+This option cannot be used with the `forceHttp` option at the same time.
 
 ##### stripAuthentication
 
@@ -275,6 +277,22 @@ normalizeUrl('www.sindresorhus.com/foo/default.php', {
 //=> 'http://sindresorhus.com/foo'
 ```
 
+##### removeExplicitPort
+
+Type: `boolean`\
+Default: `false`
+
+Removes an explicit port number from the URL.
+
+Port 443 is always removed from HTTPS URLs and 80 is always removed from HTTP URLs regardless of this option.
+
+```js
+normalizeUrl('sindresorhus.com:123', {
+	removeExplicitPort: true
+});
+//=> 'http://sindresorhus.com'
+```
+
 ##### sortQueryParameters
 
 Type: `boolean`\