Merge pull request #2 from yetric/support-plausible

Add support for source and ref as well as utm_source (Plausible)

package.json

@@ -1,7 +1,7 @@
 {
   "name": "use-utm",
-  "version": "1.0.2",
-  "description": "React hook for getting UTM parameters from the URL",
+  "version": "1.0.3",
+  "description": "Small library for getting/setting and removing UTM parameters from the URL",
   "main": "./dist/cjs/index.js",
   "module": "./dist/esm/index.js",
   "types": "./dist/esm/index.d.ts",

src/utm.spec.ts

@@ -9,6 +9,18 @@ describe("useUtm", () => {
         expect(campaign).toBeUndefined();
     });
 
+    it("should be able to parse ref as source", () => {
+        const urlWithRef = "https://www.example.com/?ref=google";
+        const { source } = utm(urlWithRef);
+        expect(source).toEqual("google");
+    });
+
+    it("should be able to parse source as source", () => {
+        const urlWithSource = "https://www.example.com/?source=google";
+        const { source } = utm(urlWithSource);
+        expect(source).toEqual("google");
+    });
+
     it("Should add utm params to a url", () => {
         const url = "https://www.example.com/";
         const utmParams = {

src/utm.ts

@@ -11,7 +11,7 @@ type MarketingParams = {
 export const utm = (url: string): MarketingParams => {
     const urlObject = new URL(url);
     const urlParams = new URLSearchParams(urlObject.search);
-    const utmSource = urlParams.get("utm_source");
+    const utmSource = urlParams.get("utm_source") || urlParams.get("source") || urlParams.get("ref");
     const utmMedium = urlParams.get("utm_medium");
     const utmCampaign = urlParams.get("utm_campaign");
     const utmTerm = urlParams.get("utm_term");