urlpurify 1.0.0 → 1.1.0

package/README.md

@@ -35,8 +35,9 @@ import { cleanUrl, defaultUnwrappers, unwrapWebArchive } from 'urlpurify'
 const cleaned = cleanUrl(url, {
   // Unwrappers to apply, first match wins per pass (omit to use defaults).
   unwrappers: [...defaultUnwrappers, unwrapWebArchive],
-  // Query parameter names to remove, matched case-insensitively (omit to use defaults).
-  trackingParams: ['utm_source', 'utm_medium', 'fbclid'],
+  // Param names (matched case-insensitively) or anchored regexes tested against the
+  // lowercased name (omit to use defaults).
+  trackingParams: ['fbclid', /^utm_[a-z0-9_-]+$/],
   // Maximum number of unwrap passes for nested wrappers. Defaults to 3.
   maxUnwrapDepth: 3,
 })
@@ -69,7 +70,7 @@ For wrappers that encode the target (base64 path segments, custom escaping), wri
 
 ### Defaults
 
-`defaultTrackingParams` and `defaultUnwrappers` are exported from the package root. `defaultUnwrappers` enables a conservative subset of the catalog (search-engine redirects and social-platform shims); everything else is exported individually for explicit opt-in.
+`defaultTrackingParams` is the combined default list for `cleanUrl` and `stripTrackingParams`: literal names plus family regexes like `/^utm_[a-z0-9_-]+$/` that cover vendor namespaces where new variants keep appearing. Its parts are exported separately as `trackingParamsLiterals` (strings only, for consumers that need a plain string list) and `trackingParamsPatterns`. `defaultUnwrappers` is exported alongside. `defaultUnwrappers` enables a conservative subset of the catalog (search-engine redirects and social-platform shims); everything else is exported individually for explicit opt-in.
 
 ## Unwrappers
 

package/dist/clean.d.ts

@@ -1,8 +1,8 @@
-import { CleanUrlOptions, UrlUnwrapper } from "./types.js";
+import { CleanUrlOptions, TrackingParam, UrlUnwrapper } from "./types.js";
 
 //#region src/clean.d.ts
 declare const unwrapUrl: (url: string, unwrappers?: Array<UrlUnwrapper>) => string | undefined;
-declare const stripTrackingParams: (url: string, trackingParams?: Array<string>) => string;
+declare const stripTrackingParams: (url: string, trackingParams?: Array<TrackingParam>) => string;
 declare const cleanUrl: (url: string, options?: CleanUrlOptions) => string;
 //#endregion
 export { cleanUrl, stripTrackingParams, unwrapUrl };

package/dist/clean.js

@@ -1,12 +1,18 @@
-import { defaultTrackingParams } from "./params.js";
-import { defaultUnwrappers } from "./defaults.js";
+import { defaultTrackingParams, defaultUnwrappers } from "./defaults.js";
 //#region src/clean.ts
-const trackingParamsCache = /* @__PURE__ */ new WeakMap();
-const getTrackingParamsSet = (params) => {
-	let cached = trackingParamsCache.get(params);
+const trackingMatcherCache = /* @__PURE__ */ new WeakMap();
+const getTrackingMatcher = (params) => {
+	let cached = trackingMatcherCache.get(params);
 	if (!cached) {
-		cached = new Set(params.map((param) => param.toLowerCase()));
-		trackingParamsCache.set(params, cached);
+		const literals = /* @__PURE__ */ new Set();
+		const patterns = [];
+		for (const param of params) if (param instanceof RegExp) patterns.push(param);
+		else literals.add(param.toLowerCase());
+		cached = {
+			literals,
+			patterns
+		};
+		trackingMatcherCache.set(params, cached);
 	}
 	return cached;
 };
@@ -17,9 +23,12 @@ const parseUrl = (url) => {
 };
 const deleteTrackingParams = (url, trackingParams) => {
 	if (!url.search) return false;
-	const trackingSet = getTrackingParamsSet(trackingParams);
+	const matcher = getTrackingMatcher(trackingParams);
 	const keysToDelete = [];
-	for (const key of url.searchParams.keys()) if (trackingSet.has(key.toLowerCase())) keysToDelete.push(key);
+	for (const key of url.searchParams.keys()) {
+		const name = key.toLowerCase();
+		if (matcher.literals.has(name) || matcher.patterns.some((pattern) => pattern.test(name))) keysToDelete.push(key);
+	}
 	for (const key of keysToDelete) url.searchParams.delete(key);
 	return keysToDelete.length > 0;
 };

package/dist/defaults.d.ts

@@ -1,7 +1,9 @@
-import { UrlUnwrapper } from "./types.js";
-import { defaultTrackingParams } from "./params.js";
+import { TrackingParam, UrlUnwrapper } from "./types.js";
+import { trackingParamsLiterals } from "./tracking/literals.js";
+import { trackingParamsPatterns } from "./tracking/patterns.js";
 
 //#region src/defaults.d.ts
+declare const defaultTrackingParams: Array<TrackingParam>;
 declare const defaultUnwrappers: Array<UrlUnwrapper>;
 //#endregion
-export { defaultUnwrappers };
+export { defaultTrackingParams, defaultUnwrappers };

package/dist/defaults.js

@@ -10,8 +10,10 @@ import { unwrapRedditOut } from "./unwraps/redditOut.js";
 import { unwrapVkAway } from "./unwraps/vkAway.js";
 import { unwrapYahooSearch } from "./unwraps/yahooSearch.js";
 import { unwrapYouTube } from "./unwraps/youtube.js";
-import "./params.js";
+import { trackingParamsLiterals } from "./tracking/literals.js";
+import { trackingParamsPatterns } from "./tracking/patterns.js";
 //#region src/defaults.ts
+const defaultTrackingParams = [...trackingParamsLiterals, ...trackingParamsPatterns];
 const defaultUnwrappers = [
 	unwrapBing,
 	unwrapGoogle,
@@ -27,4 +29,4 @@ const defaultUnwrappers = [
 	unwrapRedditOut
 ];
 //#endregion
-export { defaultUnwrappers };
+export { defaultTrackingParams, defaultUnwrappers };

package/dist/index.d.ts

@@ -1,7 +1,8 @@
-import { CleanUrlOptions, UrlUnwrapper } from "./types.js";
+import { CleanUrlOptions, TrackingParam, UrlUnwrapper } from "./types.js";
 import { cleanUrl, stripTrackingParams, unwrapUrl } from "./clean.js";
-import { defaultTrackingParams } from "./params.js";
-import { defaultUnwrappers } from "./defaults.js";
+import { trackingParamsLiterals } from "./tracking/literals.js";
+import { trackingParamsPatterns } from "./tracking/patterns.js";
+import { defaultTrackingParams, defaultUnwrappers } from "./defaults.js";
 import { unwrapAceml } from "./unwraps/aceml.js";
 import { unwrapAdjust } from "./unwraps/adjust.js";
 import { unwrapAmazonAffiliate } from "./unwraps/amazonAffiliate.js";
@@ -77,4 +78,4 @@ import { unwrapYandexTurbo } from "./unwraps/yandexTurbo.js";
 import { unwrapYouTube } from "./unwraps/youtube.js";
 import { unwrapZhihu } from "./unwraps/zhihu.js";
 import { ParamExtractorConfig, createParamExtractor } from "./utils.js";
-export { type CleanUrlOptions, type ParamExtractorConfig, type UrlUnwrapper, cleanUrl, createParamExtractor, defaultTrackingParams, defaultUnwrappers, stripTrackingParams, unwrapAceml, unwrapAdjust, unwrapAmazonAffiliate, unwrapAmpCache, unwrapAwin, unwrapBing, unwrapCjNetwork, unwrapDigidip, unwrapDisqus, unwrapDouban, unwrapDuckduckgo, unwrapEbayRover, unwrapEffiliation, unwrapEmbedly, unwrapFacebookShim, unwrapFeedsportal, unwrapFirebaseDynamicLinks, unwrapFlipboard, unwrapGateSc, unwrapGeoriot, unwrapGitee, unwrapGoogle, unwrapGoogleAmpViewer, unwrapGoogleNews, unwrapGoogleNewsModern, unwrapGoogleScholar, unwrapGoogleTranslate, unwrapHashnode, unwrapIcptrack, unwrapIdealoPartner, unwrapInstagramShim, unwrapJianshuGo, unwrapJuejin, unwrapLeverAnalytics, unwrapLinksynergy, unwrapMailchimp, unwrapMailpanion, unwrapMailpgn, unwrapMailtrack, unwrapMedium, unwrapMimecast, unwrapMozillaOutgoing, unwrapNarrativ, unwrapNicoMs, unwrapOutlookSafelinks, unwrapPartnerAds, unwrapPocket, unwrapPostmark, unwrapProofpointV1, unwrapProofpointV2, unwrapProofpointV3, unwrapPxf, unwrapRecruitics, unwrapRedditOut, unwrapRedirectingat, unwrapSegmentfault, unwrapShareasale, unwrapSjv, unwrapSkimlinks, unwrapSlack, unwrapSmartredirect, unwrapSspai, unwrapSteamLinkfilter, unwrapTelegramIv, unwrapTradedoubler, unwrapTumblr, unwrapUrl, unwrapValuecommerce, unwrapViglink, unwrapVkAway, unwrapWebArchive, unwrapYahooSearch, unwrapYandexTurbo, unwrapYouTube, unwrapZhihu };
+export { type CleanUrlOptions, type ParamExtractorConfig, type TrackingParam, type UrlUnwrapper, cleanUrl, createParamExtractor, defaultTrackingParams, defaultUnwrappers, stripTrackingParams, trackingParamsLiterals, trackingParamsPatterns, unwrapAceml, unwrapAdjust, unwrapAmazonAffiliate, unwrapAmpCache, unwrapAwin, unwrapBing, unwrapCjNetwork, unwrapDigidip, unwrapDisqus, unwrapDouban, unwrapDuckduckgo, unwrapEbayRover, unwrapEffiliation, unwrapEmbedly, unwrapFacebookShim, unwrapFeedsportal, unwrapFirebaseDynamicLinks, unwrapFlipboard, unwrapGateSc, unwrapGeoriot, unwrapGitee, unwrapGoogle, unwrapGoogleAmpViewer, unwrapGoogleNews, unwrapGoogleNewsModern, unwrapGoogleScholar, unwrapGoogleTranslate, unwrapHashnode, unwrapIcptrack, unwrapIdealoPartner, unwrapInstagramShim, unwrapJianshuGo, unwrapJuejin, unwrapLeverAnalytics, unwrapLinksynergy, unwrapMailchimp, unwrapMailpanion, unwrapMailpgn, unwrapMailtrack, unwrapMedium, unwrapMimecast, unwrapMozillaOutgoing, unwrapNarrativ, unwrapNicoMs, unwrapOutlookSafelinks, unwrapPartnerAds, unwrapPocket, unwrapPostmark, unwrapProofpointV1, unwrapProofpointV2, unwrapProofpointV3, unwrapPxf, unwrapRecruitics, unwrapRedditOut, unwrapRedirectingat, unwrapSegmentfault, unwrapShareasale, unwrapSjv, unwrapSkimlinks, unwrapSlack, unwrapSmartredirect, unwrapSspai, unwrapSteamLinkfilter, unwrapTelegramIv, unwrapTradedoubler, unwrapTumblr, unwrapUrl, unwrapValuecommerce, unwrapViglink, unwrapVkAway, unwrapWebArchive, unwrapYahooSearch, unwrapYandexTurbo, unwrapYouTube, unwrapZhihu };

package/dist/index.js

@@ -11,8 +11,9 @@ import { unwrapRedditOut } from "./unwraps/redditOut.js";
 import { unwrapVkAway } from "./unwraps/vkAway.js";
 import { unwrapYahooSearch } from "./unwraps/yahooSearch.js";
 import { unwrapYouTube } from "./unwraps/youtube.js";
-import { defaultTrackingParams } from "./params.js";
-import { defaultUnwrappers } from "./defaults.js";
+import { trackingParamsLiterals } from "./tracking/literals.js";
+import { trackingParamsPatterns } from "./tracking/patterns.js";
+import { defaultTrackingParams, defaultUnwrappers } from "./defaults.js";
 import { cleanUrl, stripTrackingParams, unwrapUrl } from "./clean.js";
 import { unwrapAceml } from "./unwraps/aceml.js";
 import { unwrapAdjust } from "./unwraps/adjust.js";
@@ -76,4 +77,4 @@ import { unwrapViglink } from "./unwraps/viglink.js";
 import { unwrapWebArchive } from "./unwraps/webArchive.js";
 import { unwrapYandexTurbo } from "./unwraps/yandexTurbo.js";
 import { unwrapZhihu } from "./unwraps/zhihu.js";
-export { cleanUrl, createParamExtractor, defaultTrackingParams, defaultUnwrappers, stripTrackingParams, unwrapAceml, unwrapAdjust, unwrapAmazonAffiliate, unwrapAmpCache, unwrapAwin, unwrapBing, unwrapCjNetwork, unwrapDigidip, unwrapDisqus, unwrapDouban, unwrapDuckduckgo, unwrapEbayRover, unwrapEffiliation, unwrapEmbedly, unwrapFacebookShim, unwrapFeedsportal, unwrapFirebaseDynamicLinks, unwrapFlipboard, unwrapGateSc, unwrapGeoriot, unwrapGitee, unwrapGoogle, unwrapGoogleAmpViewer, unwrapGoogleNews, unwrapGoogleNewsModern, unwrapGoogleScholar, unwrapGoogleTranslate, unwrapHashnode, unwrapIcptrack, unwrapIdealoPartner, unwrapInstagramShim, unwrapJianshuGo, unwrapJuejin, unwrapLeverAnalytics, unwrapLinksynergy, unwrapMailchimp, unwrapMailpanion, unwrapMailpgn, unwrapMailtrack, unwrapMedium, unwrapMimecast, unwrapMozillaOutgoing, unwrapNarrativ, unwrapNicoMs, unwrapOutlookSafelinks, unwrapPartnerAds, unwrapPocket, unwrapPostmark, unwrapProofpointV1, unwrapProofpointV2, unwrapProofpointV3, unwrapPxf, unwrapRecruitics, unwrapRedditOut, unwrapRedirectingat, unwrapSegmentfault, unwrapShareasale, unwrapSjv, unwrapSkimlinks, unwrapSlack, unwrapSmartredirect, unwrapSspai, unwrapSteamLinkfilter, unwrapTelegramIv, unwrapTradedoubler, unwrapTumblr, unwrapUrl, unwrapValuecommerce, unwrapViglink, unwrapVkAway, unwrapWebArchive, unwrapYahooSearch, unwrapYandexTurbo, unwrapYouTube, unwrapZhihu };
+export { cleanUrl, createParamExtractor, defaultTrackingParams, defaultUnwrappers, stripTrackingParams, trackingParamsLiterals, trackingParamsPatterns, unwrapAceml, unwrapAdjust, unwrapAmazonAffiliate, unwrapAmpCache, unwrapAwin, unwrapBing, unwrapCjNetwork, unwrapDigidip, unwrapDisqus, unwrapDouban, unwrapDuckduckgo, unwrapEbayRover, unwrapEffiliation, unwrapEmbedly, unwrapFacebookShim, unwrapFeedsportal, unwrapFirebaseDynamicLinks, unwrapFlipboard, unwrapGateSc, unwrapGeoriot, unwrapGitee, unwrapGoogle, unwrapGoogleAmpViewer, unwrapGoogleNews, unwrapGoogleNewsModern, unwrapGoogleScholar, unwrapGoogleTranslate, unwrapHashnode, unwrapIcptrack, unwrapIdealoPartner, unwrapInstagramShim, unwrapJianshuGo, unwrapJuejin, unwrapLeverAnalytics, unwrapLinksynergy, unwrapMailchimp, unwrapMailpanion, unwrapMailpgn, unwrapMailtrack, unwrapMedium, unwrapMimecast, unwrapMozillaOutgoing, unwrapNarrativ, unwrapNicoMs, unwrapOutlookSafelinks, unwrapPartnerAds, unwrapPocket, unwrapPostmark, unwrapProofpointV1, unwrapProofpointV2, unwrapProofpointV3, unwrapPxf, unwrapRecruitics, unwrapRedditOut, unwrapRedirectingat, unwrapSegmentfault, unwrapShareasale, unwrapSjv, unwrapSkimlinks, unwrapSlack, unwrapSmartredirect, unwrapSspai, unwrapSteamLinkfilter, unwrapTelegramIv, unwrapTradedoubler, unwrapTumblr, unwrapUrl, unwrapValuecommerce, unwrapViglink, unwrapVkAway, unwrapWebArchive, unwrapYahooSearch, unwrapYandexTurbo, unwrapYouTube, unwrapZhihu };

package/dist/tracking/literals.d.ts

@@ -0,0 +1,4 @@
+//#region src/tracking/literals.d.ts
+declare const trackingParamsLiterals: string[];
+//#endregion
+export { trackingParamsLiterals };

package/dist/{params.js → tracking/literals.js}

@@ -1,5 +1,5 @@
-//#region src/params.ts
-const defaultTrackingParams = [
+//#region src/tracking/literals.ts
+const trackingParamsLiterals = [
 	"utm_source",
 	"utm_medium",
 	"utm_campaign",
@@ -154,4 +154,4 @@ const defaultTrackingParams = [
 	"xtor"
 ];
 //#endregion
-export { defaultTrackingParams };
+export { trackingParamsLiterals };

package/dist/tracking/patterns.d.ts

@@ -0,0 +1,4 @@
+//#region src/tracking/patterns.d.ts
+declare const trackingParamsPatterns: Array<RegExp>;
+//#endregion
+export { trackingParamsPatterns };

package/dist/tracking/patterns.js

@@ -0,0 +1,19 @@
+//#region src/tracking/patterns.ts
+const trackingParamsPatterns = [
+	/^utm_[a-z0-9_-]+$/,
+	/^stm_[a-z0-9_-]+$/,
+	/^hsa_[a-z0-9_]+$/,
+	/^mtm_[a-z0-9_]+$/,
+	/^pk_[a-z0-9_]+$/,
+	/^piwik_[a-z0-9_]+$/,
+	/^itm_[a-z0-9_]+$/,
+	/^int_[a-z0-9_]+$/,
+	/^at_[a-z0-9_]+$/,
+	/^g2i_[a-z0-9_]+$/,
+	/^bsft_[a-z0-9_]+$/,
+	/^sfmc_[a-z0-9_]+$/,
+	/^oft_[a-z0-9_]+$/,
+	/^cm_mmca?\d*$/
+];
+//#endregion
+export { trackingParamsPatterns };

package/dist/types.d.ts

@@ -1,9 +1,10 @@
 //#region src/types.d.ts
 type UrlUnwrapper = (url: URL) => string | undefined;
+type TrackingParam = string | RegExp;
 type CleanUrlOptions = {
   unwrappers?: Array<UrlUnwrapper>;
-  trackingParams?: Array<string>;
+  trackingParams?: Array<TrackingParam>;
   maxUnwrapDepth?: number;
 };
 //#endregion
-export { CleanUrlOptions, UrlUnwrapper };
+export { CleanUrlOptions, TrackingParam, UrlUnwrapper };

package/package.json

@@ -41,5 +41,5 @@
     "kvalita": "^1.14.0",
     "tsdown": "^0.22.2"
   },
-  "version": "1.0.0"
+  "version": "1.1.0"
 }

package/dist/params.d.ts

@@ -1,4 +0,0 @@
-//#region src/params.d.ts
-declare const defaultTrackingParams: string[];
-//#endregion
-export { defaultTrackingParams };