normalize-url 4.2.0 → 4.5.0

package/index.d.ts

@@ -1,183 +1,216 @@
-export interface Options {
-	/**
-	 * @default 'http:'
-	 */
-	readonly defaultProtocol?: string;
+declare namespace normalizeUrl {
+	interface Options {
+		/**
+		@default 'http:'
+		*/
+		readonly defaultProtocol?: string;
 
-	/**
-	 * Prepends `defaultProtocol` to the URL if it's protocol-relative.
-	 *
-	 * @default true
-	 *
-	 * @example
-	 *
-	 * normalizeUrl('//sindresorhus.com:80/');
-	 * //=> 'http://sindresorhus.com'
-	 *
-	 * normalizeUrl('//sindresorhus.com:80/', {normalizeProtocol: false});
-	 * //=> '//sindresorhus.com'
-	 */
-	readonly normalizeProtocol?: boolean;
+		/**
+		Prepends `defaultProtocol` to the URL if it's protocol-relative.
 
-	/**
-	 * Normalizes `https:` URLs to `http:`.
-	 *
-	 * @default false
-	 *
-	 * @example
-	 *
-	 * normalizeUrl('https://sindresorhus.com:80/');
-	 * //=> 'https://sindresorhus.com'
-	 *
-	 * normalizeUrl('https://sindresorhus.com:80/', {forceHttp: true});
-	 * //=> 'http://sindresorhus.com'
-	 */
-	readonly forceHttp?: boolean;
+		@default true
 
-	/**
-	 * Normalizes `http:` URLs to `https:`.
-	 *
-	 * This option can't 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:80/', {forceHttps: true});
-	 * //=> 'https://sindresorhus.com'
-	 */
-	readonly forceHttps?: boolean;
+		@example
+		```
+		normalizeUrl('//sindresorhus.com:80/');
+		//=> 'http://sindresorhus.com'
 
-	/**
-	 * Strip the [authentication](https://en.wikipedia.org/wiki/Basic_access_authentication) part of a URL.
-	 *
-	 * @default true
-	 *
-	 * @example
-	 *
-	 * normalizeUrl('user:password@sindresorhus.com');
-	 * //=> 'https://sindresorhus.com'
-	 *
-	 * normalizeUrl('user:password@sindresorhus.com', {stripAuthentication: false});
-	 * //=> 'https://user:password@sindresorhus.com'
-	 */
-	readonly stripAuthentication?: boolean;
+		normalizeUrl('//sindresorhus.com:80/', {normalizeProtocol: false});
+		//=> '//sindresorhus.com'
+		```
+		*/
+		readonly normalizeProtocol?: boolean;
 
-	/**
-	 * Removes hash from the URL.
-	 *
-	 * @default false
-	 *
-	 * @example
-	 *
-	 * normalizeUrl('sindresorhus.com/about.html#contact');
-	 * //=> 'http://sindresorhus.com/about.html#contact'
-	 *
-	 * normalizeUrl('sindresorhus.com/about.html#contact', {stripHash: true});
-	 * //=> 'http://sindresorhus.com/about.html'
-	 */
-	readonly stripHash?: boolean;
+		/**
+		Normalizes `https:` URLs to `http:`.
 
-	/**
-	 * Removes HTTP(S) protocol from an URL `http://sindresorhus.com` → `sindresorhus.com`.
-	 *
-	 * @default false
-	 *
-	 * @example
-	 *
-	 * normalizeUrl('https://sindresorhus.com');
-	 * //=> 'https://sindresorhus.com'
-	 *
-	 * normalizeUrl('sindresorhus.com', {stripProtocol: true});
-	 * //=> 'sindresorhus.com'
-	 */
-	readonly stripProtocol?: boolean;
+		@default false
 
-	/**
-	 * Removes `www.` from the URL.
-	 *
-	 * @default true
-	 *
-	 * @example
-	 *
-	 * normalizeUrl('http://www.sindresorhus.com');
-	 * //=> 'http://sindresorhus.com'
-	 *
-	 * normalizeUrl('http://www.sindresorhus.com', {stripWWW: false});
-	 * //=> 'http://www.sindresorhus.com'
-	 */
-	readonly stripWWW?: boolean;
+		@example
+		```
+		normalizeUrl('https://sindresorhus.com:80/');
+		//=> 'https://sindresorhus.com'
 
-	/**
-	 * Removes query parameters that matches any of the provided strings or regexes.
-	 *
-	 * @default [/^utm_\w+/i]
-	 *
-	 * @example
-	 *
-	 * normalizeUrl('www.sindresorhus.com?foo=bar&ref=test_ref', {
-	 * 	removeQueryParameters: ['ref']
-	 * });
-	 * //=> 'http://sindresorhus.com/?foo=bar'
-	 */
-	readonly removeQueryParameters?: (RegExp | string)[];
+		normalizeUrl('https://sindresorhus.com:80/', {forceHttp: true});
+		//=> 'http://sindresorhus.com'
+		```
+		*/
+		readonly forceHttp?: boolean;
 
-	/**
-	 * Removes trailing slash.
-	 *
-	 * **Note**: Trailing slash is always removed if the URL doesn't have a pathname.
-	 *
-	 * @default true
-	 *
-	 * @example
-	 *
-	 * normalizeUrl('http://sindresorhus.com/redirect/');
-	 * //=> 'http://sindresorhus.com/redirect'
-	 *
-	 * normalizeUrl('http://sindresorhus.com/redirect/', {removeTrailingSlash: false});
-	 * //=> 'http://sindresorhus.com/redirect/'
-	 *
-	 * normalizeUrl('http://sindresorhus.com/', {removeTrailingSlash: false});
-	 * //=> 'http://sindresorhus.com'
-	 */
-	readonly removeTrailingSlash?: boolean;
+		/**
+		Normalizes `http:` URLs to `https:`.
 
-	/**
-	 * Removes the default directory index file from path that matches any of the provided strings or regexes.
-	 * When `true`, the regex `/^index\.[a-z]+$/` is used.
-	 *
-	 * @default false
-	 *
-	 * @example
-	 *
-	 * normalizeUrl('www.sindresorhus.com/foo/default.php', {
-	 * 	removeDirectoryIndex: [/^default\.[a-z]+$/]
-	 * });
-	 * //=> 'http://sindresorhus.com/foo'
-	 */
-	readonly removeDirectoryIndex?: (RegExp | string)[];
+		This option can't be used with the `forceHttp` option at the same time.
 
-	/**
-	 * Sorts the query parameters alphabetically by key.
-	 *
-	 * @default true
-	 *
-	 * @example
-	 *
-	 * normalizeUrl('www.sindresorhus.com?b=two&a=one&c=three', {
-	 * 	sortQueryParameters: false
-	 * });
-	 * //=> 'http://sindresorhus.com/?b=two&a=one&c=three'
-	 */
-	readonly sortQueryParameters?: boolean;
+		@default false
+
+		@example
+		```
+		normalizeUrl('https://sindresorhus.com:80/');
+		//=> 'https://sindresorhus.com'
+
+		normalizeUrl('http://sindresorhus.com:80/', {forceHttps: true});
+		//=> 'https://sindresorhus.com'
+		```
+		*/
+		readonly forceHttps?: boolean;
+
+		/**
+		Strip the [authentication](https://en.wikipedia.org/wiki/Basic_access_authentication) part of a URL.
+
+		@default true
+
+		@example
+		```
+		normalizeUrl('user:password@sindresorhus.com');
+		//=> 'https://sindresorhus.com'
+
+		normalizeUrl('user:password@sindresorhus.com', {stripAuthentication: false});
+		//=> 'https://user:password@sindresorhus.com'
+		```
+		*/
+		readonly stripAuthentication?: boolean;
+
+		/**
+		Removes hash from the URL.
+
+		@default false
+
+		@example
+		```
+		normalizeUrl('sindresorhus.com/about.html#contact');
+		//=> 'http://sindresorhus.com/about.html#contact'
+
+		normalizeUrl('sindresorhus.com/about.html#contact', {stripHash: true});
+		//=> 'http://sindresorhus.com/about.html'
+		```
+		*/
+		readonly stripHash?: boolean;
+
+		/**
+		Removes HTTP(S) protocol from an URL `http://sindresorhus.com` → `sindresorhus.com`.
+
+		@default false
+
+		@example
+		```
+		normalizeUrl('https://sindresorhus.com');
+		//=> 'https://sindresorhus.com'
+
+		normalizeUrl('sindresorhus.com', {stripProtocol: true});
+		//=> 'sindresorhus.com'
+		```
+		*/
+		readonly stripProtocol?: boolean;
+
+		/**
+		Removes `www.` from the URL.
+
+		@default true
+
+		@example
+		```
+		normalizeUrl('http://www.sindresorhus.com');
+		//=> 'http://sindresorhus.com'
+
+		normalizeUrl('http://www.sindresorhus.com', {stripWWW: false});
+		//=> 'http://www.sindresorhus.com'
+		```
+		*/
+		readonly stripWWW?: boolean;
+
+		/**
+		Removes query parameters that matches any of the provided strings or regexes.
+
+		@default [/^utm_\w+/i]
+
+		@example
+		```
+		normalizeUrl('www.sindresorhus.com?foo=bar&ref=test_ref', {
+			removeQueryParameters: ['ref']
+		});
+		//=> 'http://sindresorhus.com/?foo=bar'
+		```
+		*/
+		readonly removeQueryParameters?: ReadonlyArray<RegExp | string>;
+
+		/**
+		Removes trailing slash.
+
+		__Note__: Trailing slash is always removed if the URL doesn't have a pathname.
+
+		@default true
+
+		@example
+		```
+		normalizeUrl('http://sindresorhus.com/redirect/');
+		//=> 'http://sindresorhus.com/redirect'
+
+		normalizeUrl('http://sindresorhus.com/redirect/', {removeTrailingSlash: false});
+		//=> 'http://sindresorhus.com/redirect/'
+
+		normalizeUrl('http://sindresorhus.com/', {removeTrailingSlash: false});
+		//=> 'http://sindresorhus.com'
+		```
+		*/
+		readonly removeTrailingSlash?: boolean;
+
+		/**
+		Removes the default directory index file from path that matches any of the provided strings or regexes.
+		When `true`, the regex `/^index\.[a-z]+$/` is used.
+
+		@default false
+
+		@example
+		```
+		normalizeUrl('www.sindresorhus.com/foo/default.php', {
+			removeDirectoryIndex: [/^default\.[a-z]+$/]
+		});
+		//=> 'http://sindresorhus.com/foo'
+		```
+		*/
+		readonly removeDirectoryIndex?: ReadonlyArray<RegExp | string>;
+
+		/**
+		Sorts the query parameters alphabetically by key.
+
+		@default true
+
+		@example
+		```
+		normalizeUrl('www.sindresorhus.com?b=two&a=one&c=three', {
+			sortQueryParameters: false
+		});
+		//=> 'http://sindresorhus.com/?b=two&a=one&c=three'
+		```
+		*/
+		readonly sortQueryParameters?: boolean;
+	}
 }
 
-/**
- * [Normalize](https://en.wikipedia.org/wiki/URL_normalization) a URL.
- *
- * @param url - URL to normalize.
- */
-export default function normalizeUrl(url: string, options?: Options): string;
+declare const normalizeUrl: {
+	/**
+	[Normalize](https://en.wikipedia.org/wiki/URL_normalization) a URL.
+
+	@param url - URL to normalize, including [data URL](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URIs).
+
+	@example
+	```
+	import normalizeUrl = require('normalize-url');
+
+	normalizeUrl('sindresorhus.com');
+	//=> 'http://sindresorhus.com'
+
+	normalizeUrl('HTTP://xn--xample-hva.com:80/?b=bar&a=foo');
+	//=> 'http://êxample.com/?a=foo&b=bar'
+	```
+	*/
+	(url: string, options?: normalizeUrl.Options): string;
+
+	// TODO: Remove this for the next major release, refactor the whole definition to:
+	// declare function normalizeUrl(url: string, options?: normalizeUrl.Options): string;
+	// export = normalizeUrl;
+	default: typeof normalizeUrl;
+};
+
+export = normalizeUrl;

package/index.js

@@ -2,10 +2,66 @@
 // TODO: Use the `URL` global when targeting Node.js 10
 const URLParser = typeof URL === 'undefined' ? require('url').URL : URL;
 
+// https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URIs
+const DATA_URL_DEFAULT_MIME_TYPE = 'text/plain';
+const DATA_URL_DEFAULT_CHARSET = 'us-ascii';
+
 const testParameter = (name, filters) => {
 	return filters.some(filter => filter instanceof RegExp ? filter.test(name) : filter === name);
 };
 
+const normalizeDataURL = (urlString, {stripHash}) => {
+	const parts = urlString.match(/^data:(.*?),(.*?)(?:#(.*))?$/);
+
+	if (!parts) {
+		throw new Error(`Invalid URL: ${urlString}`);
+	}
+
+	const mediaType = parts[1].split(';');
+	const body = parts[2];
+	const hash = stripHash ? '' : parts[3];
+
+	let base64 = false;
+
+	if (mediaType[mediaType.length - 1] === 'base64') {
+		mediaType.pop();
+		base64 = true;
+	}
+
+	// Lowercase MIME type
+	const mimeType = (mediaType.shift() || '').toLowerCase();
+	const attributes = mediaType
+		.map(attribute => {
+			let [key, value = ''] = attribute.split('=').map(string => string.trim());
+
+			// Lowercase `charset`
+			if (key === 'charset') {
+				value = value.toLowerCase();
+
+				if (value === DATA_URL_DEFAULT_CHARSET) {
+					return '';
+				}
+			}
+
+			return `${key}${value ? `=${value}` : ''}`;
+		})
+		.filter(Boolean);
+
+	const normalizedMediaType = [
+		...attributes
+	];
+
+	if (base64) {
+		normalizedMediaType.push('base64');
+	}
+
+	if (normalizedMediaType.length !== 0 || (mimeType && mimeType !== DATA_URL_DEFAULT_MIME_TYPE)) {
+		normalizedMediaType.unshift(mimeType);
+	}
+
+	return `data:${normalizedMediaType.join(';')},${base64 ? body.trim() : body}${hash ? `#${hash}` : ''}`;
+};
+
 const normalizeUrl = (urlString, options) => {
 	options = {
 		defaultProtocol: 'http:',
@@ -37,6 +93,11 @@ const normalizeUrl = (urlString, options) => {
 
 	urlString = urlString.trim();
 
+	// Data URL
+	if (/^data:/i.test(urlString)) {
+		return normalizeDataURL(urlString, options);
+	}
+
 	const hasRelativeProtocol = urlString.startsWith('//');
 	const isRelativeUrl = !hasRelativeProtocol && /^\.*\//.test(urlString);
 
@@ -156,4 +217,5 @@ const normalizeUrl = (urlString, options) => {
 };
 
 module.exports = normalizeUrl;
+// TODO: Remove this for the next major release
 module.exports.default = normalizeUrl;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "normalize-url",
-	"version": "4.2.0",
+	"version": "4.5.0",
 	"description": "Normalize a URL",
 	"license": "MIT",
 	"repository": "sindresorhus/normalize-url",
@@ -13,7 +13,7 @@
 		"node": ">=8"
 	},
 	"scripts": {
-		"test": "xo && nyc ava && tsd-check"
+		"test": "xo && nyc ava && tsd"
 	},
 	"files": [
 		"index.js",
@@ -35,10 +35,10 @@
 		"canonical"
 	],
 	"devDependencies": {
-		"ava": "^1.2.1",
-		"coveralls": "^3.0.0",
-		"nyc": "^13.1.0",
-		"tsd-check": "^0.3.0",
+		"ava": "^2.4.0",
+		"coveralls": "^3.0.6",
+		"nyc": "^14.1.1",
+		"tsd": "^0.8.0",
 		"xo": "^0.24.0"
 	}
 }

package/readme.md

@@ -27,17 +27,17 @@ normalizeUrl('HTTP://xn--xample-hva.com:80/?b=bar&a=foo');
 
 ## API
 
-### normalizeUrl(url, [options])
+### normalizeUrl(url, options?)
 
 #### url
 
 Type: `string`
 
-URL to normalize.
+URL to normalize, including [data URL](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URIs).
 
 #### options
 
-Type: `Object`
+Type: `object`
 
 ##### defaultProtocol
 
@@ -49,7 +49,7 @@ Default: `http:`
 Type: `boolean`<br>
 Default: `true`
 
-Prepends `defaultProtocol` to the URL if it's protocol-relative.
+Prepend `defaultProtocol` to the URL if it's protocol-relative.
 
 ```js
 normalizeUrl('//sindresorhus.com:80/');
@@ -64,7 +64,7 @@ normalizeUrl('//sindresorhus.com:80/', {normalizeProtocol: false});
 Type: `boolean`<br>
 Default: `false`
 
-Normalizes `https:` URLs to `http:`.
+Normalize `https:` to `http:`.
 
 ```js
 normalizeUrl('https://sindresorhus.com:80/');
@@ -79,7 +79,7 @@ normalizeUrl('https://sindresorhus.com:80/', {forceHttp: true});
 Type: `boolean`<br>
 Default: `false`
 
-Normalizes `http:` URLs to `https:`.
+Normalize `http:` to `https:`.
 
 ```js
 normalizeUrl('https://sindresorhus.com:80/');
@@ -96,7 +96,7 @@ This option can't be used with the `forceHttp` option at the same time.
 Type: `boolean`<br>
 Default: `true`
 
-Strip the [authentication](https://en.wikipedia.org/wiki/Basic_access_authentication) part of a URL.
+Strip the [authentication](https://en.wikipedia.org/wiki/Basic_access_authentication) part of the URL.
 
 ```js
 normalizeUrl('user:password@sindresorhus.com');
@@ -111,7 +111,7 @@ normalizeUrl('user:password@sindresorhus.com', {stripAuthentication: false});
 Type: `boolean`<br>
 Default: `false`
 
-Removes hash from the URL.
+Strip the hash part of the URL.
 
 ```js
 normalizeUrl('sindresorhus.com/about.html#contact');
@@ -126,7 +126,7 @@ normalizeUrl('sindresorhus.com/about.html#contact', {stripHash: true});
 Type: `boolean`<br>
 Default: `false`
 
-Removes HTTP(S) protocol from an URL `http://sindresorhus.com` → `sindresorhus.com`.
+Remove HTTP(S) protocol from the URL: `http://sindresorhus.com` → `sindresorhus.com`.
 
 ```js
 normalizeUrl('https://sindresorhus.com');
@@ -141,7 +141,7 @@ normalizeUrl('sindresorhus.com', {stripProtocol: true});
 Type: `boolean`<br>
 Default: `true`
 
-Removes `www.` from the URL.
+Remove `www.` from the URL.
 
 ```js
 normalizeUrl('http://www.sindresorhus.com');
@@ -153,10 +153,10 @@ normalizeUrl('http://www.sindresorhus.com', {stripWWW: false});
 
 ##### removeQueryParameters
 
-Type: `Array<RegExp|string>`<br>
+Type: `Array<RegExp | string>`<br>
 Default: `[/^utm_\w+/i]`
 
-Removes query parameters that matches any of the provided strings or regexes.
+Remove query parameters that matches any of the provided strings or regexes.
 
 ```js
 normalizeUrl('www.sindresorhus.com?foo=bar&ref=test_ref', {
@@ -170,7 +170,7 @@ normalizeUrl('www.sindresorhus.com?foo=bar&ref=test_ref', {
 Type: `boolean`<br>
 Default: `true`
 
-Removes trailing slash.
+Remove trailing slash.
 
 **Note:** Trailing slash is always removed if the URL doesn't have a pathname.
 
@@ -187,7 +187,7 @@ normalizeUrl('http://sindresorhus.com/', {removeTrailingSlash: false});
 
 ##### removeDirectoryIndex
 
-Type: `boolean` `Array<RegExp|string>`<br>
+Type: `boolean | Array<RegExp | string>`<br>
 Default: `false`
 
 Removes the default directory index file from path that matches any of the provided strings or regexes. When `true`, the regex `/^index\.[a-z]+$/` is used.
@@ -219,6 +219,14 @@ normalizeUrl('www.sindresorhus.com?b=two&a=one&c=three', {
 - [compare-urls](https://github.com/sindresorhus/compare-urls) - Compare URLs by first normalizing them
 
 
-## License
+---
 
-MIT © [Sindre Sorhus](https://sindresorhus.com)
+<div align="center">
+	<b>
+		<a href="https://tidelift.com/subscription/pkg/npm-normalize-url?utm_source=npm-normalize-url&utm_medium=referral&utm_campaign=readme">Get professional support for this package with a Tidelift subscription</a>
+	</b>
+	<br>
+	<sub>
+		Tidelift helps make open source sustainable for maintainers while giving companies<br>assurances about security, maintenance, and licensing for their dependencies.
+	</sub>
+</div>