normalize-url 8.0.2 → 8.1.0

package/index.d.ts

@@ -278,6 +278,45 @@ export type Options = {
 	```
 	*/
 	readonly sortQueryParameters?: boolean;
+
+	/**
+	Removes the entire URL path, leaving only the domain.
+
+	@default false
+
+	@example
+	```
+	normalizeUrl('https://example.com/path/to/page', {
+		removePath: true
+	});
+	//=> 'https://example.com'
+	```
+	*/
+	readonly removePath?: boolean;
+
+	/**
+	Custom function to transform the URL path components.
+
+	The function receives an array of non-empty path components and should return a modified array.
+
+	@default false
+
+	@example
+	```
+	// Keep only the first path component
+	normalizeUrl('https://example.com/api/v1/users', {
+		transformPath: (pathComponents) => pathComponents.slice(0, 1)
+	});
+	//=> 'https://example.com/api'
+
+	// Remove specific components
+	normalizeUrl('https://example.com/admin/users', {
+		transformPath: (pathComponents) => pathComponents.filter(c => c !== 'admin')
+	});
+	//=> 'https://example.com/users'
+	```
+	*/
+	readonly transformPath?: (pathComponents: string[]) => string[];
 };
 
 /**

package/index.js

@@ -89,6 +89,8 @@ export default function normalizeUrl(urlString, options) {
 		removeDirectoryIndex: false,
 		removeExplicitPort: false,
 		sortQueryParameters: true,
+		removePath: false,
+		transformPath: false,
 		...options,
 	};
 
@@ -200,6 +202,18 @@ export default function normalizeUrl(urlString, options) {
 		}
 	}
 
+	// Remove path
+	if (options.removePath) {
+		urlObject.pathname = '/';
+	}
+
+	// Transform path components
+	if (options.transformPath && typeof options.transformPath === 'function') {
+		const pathComponents = urlObject.pathname.split('/').filter(Boolean);
+		const newComponents = options.transformPath(pathComponents);
+		urlObject.pathname = newComponents?.length > 0 ? `/${newComponents.join('/')}` : '/';
+	}
+
 	if (urlObject.hostname) {
 		// Remove trailing dot
 		urlObject.hostname = urlObject.hostname.replace(/\.$/, '');
@@ -240,12 +254,21 @@ export default function normalizeUrl(urlString, options) {
 
 	// Sort query parameters
 	if (options.sortQueryParameters) {
+		const originalSearch = urlObject.search;
 		urlObject.searchParams.sort();
 
 		// Calling `.sort()` encodes the search parameters, so we need to decode them again.
 		try {
 			urlObject.search = decodeURIComponent(urlObject.search);
 		} catch {}
+
+		// Fix parameters that originally had no equals sign but got one added by URLSearchParams
+		const partsWithoutEquals = originalSearch.slice(1).split('&').filter(p => p && !p.includes('='));
+		for (const part of partsWithoutEquals) {
+			const decoded = decodeURIComponent(part);
+			// Only replace at word boundaries to avoid partial matches
+			urlObject.search = urlObject.search.replace(`?${decoded}=`, `?${decoded}`).replace(`&${decoded}=`, `&${decoded}`);
+		}
 	}
 
 	if (options.removeTrailingSlash) {

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "normalize-url",
-	"version": "8.0.2",
+	"version": "8.1.0",
 	"description": "Normalize a URL",
 	"license": "MIT",
 	"repository": "sindresorhus/normalize-url",

package/readme.md

@@ -307,6 +307,41 @@ normalizeUrl('www.sindresorhus.com?b=two&a=one&c=three', {
 //=> 'http://sindresorhus.com/?b=two&a=one&c=three'
 ```
 
+##### removePath
+
+Type: `boolean`\
+Default: `false`
+
+Removes the entire URL path, leaving only the domain.
+
+```js
+normalizeUrl('https://example.com/path/to/page', {
+	removePath: true
+});
+//=> 'https://example.com'
+```
+
+##### transformPath
+
+Type: `Function`\
+Default: `false`
+
+Custom function to transform the URL path components. The function receives an array of non-empty path components and should return a modified array.
+
+```js
+// Keep only the first path component
+normalizeUrl('https://example.com/api/v1/users', {
+	transformPath: (pathComponents) => pathComponents.slice(0, 1)
+});
+//=> 'https://example.com/api'
+
+// Remove specific components
+normalizeUrl('https://example.com/admin/users', {
+	transformPath: (pathComponents) => pathComponents.filter(c => c !== 'admin')
+});
+//=> 'https://example.com/users'
+```
+
 ## Related
 
 - [compare-urls](https://github.com/sindresorhus/compare-urls) - Compare URLs by first normalizing them