Merge searchParams with input URL (#840)

Co-authored-by: Sindre Sorhus <sindresorhus@gmail.com>

Author: AkaHarshit

readme.md

@@ -187,11 +187,11 @@ Shortcut for sending JSON. Use this instead of the `body` option. Accepts any pl
 Type: `string | object<string, string | number | boolean | undefined> | Array<Array<string | number | boolean>> | URLSearchParams`\
 Default: `''`
 
-Search parameters to include in the request URL. Setting this will override all existing search parameters in the input URL.
+Search parameters to include in the request URL. Setting this will merge with any existing search parameters in the input URL.
 
 Accepts any value supported by [`URLSearchParams()`](https://developer.mozilla.org/en-US/docs/Web/API/URLSearchParams/URLSearchParams).
 
-When passing an object, `undefined` values are automatically filtered out, while `null` values are preserved and converted to the string `'null'`.
+When passing an object, setting a value to `undefined` deletes the parameter, while `null` values are preserved and converted to the string `'null'`.
 
 ##### baseUrl
 

source/core/Ky.ts

@@ -15,7 +15,12 @@ import type {
 import {type ResponsePromise} from '../types/ResponsePromise.js';
 import type {StandardSchemaV1} from '../types/standard-schema.js';
 import {streamRequest, streamResponse} from '../utils/body.js';
-import {cloneShallow, mergeHeaders, mergeHooks} from '../utils/merge.js';
+import {
+	cloneShallow,
+	mergeHeaders,
+	mergeHooks,
+	deletedParametersSymbol,
+} from '../utils/merge.js';
 import {normalizeRequestMethod, normalizeRetryOptions} from '../utils/normalize.js';
 import timeout from '../utils/timeout.js';
 import delay from '../utils/delay.js';
@@ -375,13 +380,40 @@ export class Ky {
 		this.request = new globalThis.Request(this.#input, this.#options);
 
 		if (hasSearchParameters(this.#options.searchParams)) {
-			// eslint-disable-next-line unicorn/prevent-abbreviations
-			const textSearchParams = typeof this.#options.searchParams === 'string'
-				? this.#options.searchParams.replace(/^\?/, '')
-				: new URLSearchParams(Ky.#normalizeSearchParams(this.#options.searchParams) as unknown as SearchParamsInit).toString();
-			// eslint-disable-next-line unicorn/prevent-abbreviations
-			const searchParams = '?' + textSearchParams;
-			const url = this.request.url.replace(/(?:\?.*?)?(?=#|$)/, searchParams);
+			const url = new URL(this.request.url);
+
+			if (typeof this.#options.searchParams === 'string') {
+				const stringSearchParameters = this.#options.searchParams.replace(/^\?/, '');
+				if (stringSearchParameters !== '') {
+					url.search = url.search ? `${url.search}&${stringSearchParameters}` : `?${stringSearchParameters}`;
+				}
+			} else {
+				const optionsSearchParameters = new URLSearchParams(Ky.#normalizeSearchParams(this.#options.searchParams) as unknown as SearchParamsInit);
+
+				for (const [key, value] of optionsSearchParameters.entries()) {
+					url.searchParams.append(key, value);
+				}
+			}
+
+			if (
+				this.#options.searchParams
+				&& typeof this.#options.searchParams === 'object'
+				&& !Array.isArray(this.#options.searchParams)
+				&& !(this.#options.searchParams instanceof URLSearchParams)
+			) {
+				for (const [key, value] of Object.entries(this.#options.searchParams)) {
+					if (value === undefined) {
+						url.searchParams.delete(key);
+					}
+				}
+			}
+
+			const deleted = (this.#options.searchParams as any)?.[deletedParametersSymbol] as Set<string> | undefined;
+			if (deleted) {
+				for (const key of deleted) {
+					url.searchParams.delete(key);
+				}
+			}
 
 			// Recreate request with the updated URL. We already have all options in this.#options, including duplex.
 			this.request = new globalThis.Request(url, this.#options as RequestInit);

source/types/options.ts

@@ -102,11 +102,11 @@ export type KyOptions = {
 	stringifyJson?: (data: unknown) => string;
 
 	/**
-	Search parameters to include in the request URL. Setting this will override all existing search parameters in the input URL.
+	Search parameters to include in the request URL. Setting this will merge with any existing search parameters in the input URL.
 
 	Accepts any value supported by [`URLSearchParams()`](https://developer.mozilla.org/en-US/docs/Web/API/URLSearchParams/URLSearchParams).
 
-	When passing an object, `undefined` values are automatically filtered out, while `null` values are preserved and converted to the string `'null'`.
+	When passing an object, setting a value to `undefined` deletes the parameter, while `null` values are preserved and converted to the string `'null'`.
 	*/
 	searchParams?: SearchParamsOption;
 

source/utils/merge.ts

@@ -136,8 +136,11 @@ export const mergeHooks = (original: Hooks = {}, incoming: Hooks = {}): Required
 	}
 );
 
+export const deletedParametersSymbol = Symbol('deletedParameters');
+
 const appendSearchParameters = (target: any, source: any): URLSearchParams => {
-	const result = new URLSearchParams();
+	const result = new URLSearchParams() as URLSearchParams & {[deletedParametersSymbol]?: Set<string>};
+	const deleted = new Set<string>();
 
 	for (const input of [target, source]) {
 		if (input === undefined) {
@@ -147,6 +150,15 @@ const appendSearchParameters = (target: any, source: any): URLSearchParams => {
 		if (input instanceof URLSearchParams) {
 			for (const [key, value] of input.entries()) {
 				result.append(key, value);
+				deleted.delete(key);
+			}
+
+			const inputDeleted = (input as any)[deletedParametersSymbol] as Set<string> | undefined;
+			if (inputDeleted) {
+				for (const key of inputDeleted) {
+					result.delete(key);
+					deleted.add(key);
+				}
 			}
 		} else if (Array.isArray(input)) {
 			for (const pair of input) {
@@ -155,22 +167,32 @@ const appendSearchParameters = (target: any, source: any): URLSearchParams => {
 				}
 
 				result.append(String(pair[0]), String(pair[1]));
+				deleted.delete(String(pair[0]));
 			}
 		} else if (isObject(input)) {
 			for (const [key, value] of Object.entries(input)) {
-				if (value !== undefined) {
+				if (value === undefined) {
+					result.delete(key);
+					deleted.add(key);
+				} else {
 					result.append(key, String(value));
+					deleted.delete(key);
 				}
 			}
 		} else {
 			// String
 			const parameters = new URLSearchParams(input);
 			for (const [key, value] of parameters.entries()) {
 				result.append(key, value);
+				deleted.delete(key);
 			}
 		}
 	}
 
+	if (deleted.size > 0) {
+		result[deletedParametersSymbol] = deleted;
+	}
+
 	return result;
 };
 

source/utils/options.ts

@@ -1,5 +1,6 @@
 import {kyOptionKeys, requestOptionsRegistry, vendorSpecificOptions} from '../core/constants.js';
 import type {SearchParamsOption} from '../types/options.js';
+import {deletedParametersSymbol} from './merge.js';
 
 export const findUnknownOptions = (
 	request: Request,
@@ -38,7 +39,7 @@ export const hasSearchParameters = (search: SearchParamsOption): boolean => {
 	}
 
 	if (search instanceof URLSearchParams) {
-		return search.size > 0;
+		return search.size > 0 || Boolean((search as any)[deletedParametersSymbol]?.size);
 	}
 
 	// Record

test/fetch.ts

@@ -63,14 +63,14 @@ test('fetch option takes a custom fetch function', async t => {
 			fetch: customFetch,
 			searchParams: 'new',
 		}).text(),
-		`${fixture}?new`,
+		`${fixture}?old&new`,
 	);
 	t.is(
 		await ky(`${fixture}?old#hash`, {
 			fetch: customFetch,
 			searchParams: 'new',
 		}).text(),
-		`${fixture}?new#hash`,
+		`${fixture}?old&new#hash`,
 	);
 	t.is(await ky('unicorn', {fetch: customFetch, prefix: `${fixture}/api/`}).text(), `${fixture}/api/unicorn`);
 });