@jmp-technologies/analytics 0.1.16 → 0.1.18

package/README.md

@@ -73,6 +73,8 @@ import {
 
 Or call **`trackEmailClick(path)`** / **`trackCallClick(path)`** from `useJmpAnalytics()`.
 
+For **SMS / WhatsApp / maps / scheduling** link taps, call **`trackContactClick(path, { channel, linkHost })`** — or set **`autoTrackContactLinks: true`** in your config (or **`NEXT_PUBLIC_JMP_AUTO_CONTACT_LINKS=true`**) to register one delegated `click` listener that classifies outbound links for you. Auto-tracking is **off by default**; per-link opt-out via `data-jmp-no-track` on the `<a>` (or any ancestor).
+
 **Hooks:** `useJmpAnalytics()` from `@jmp-technologies/analytics/next` or `@jmp-technologies/analytics/react` for forms and custom events.
 
 ---
@@ -243,7 +245,7 @@ When present, `category` is an optional section label you can use to group FAQs
 
 **Tracking events**
 
-- `trackPageView`, `trackFormSubmit`, `trackCallClick`, `trackEmailClick` (since **0.1.10**), `trackLead`
+- `trackPageView`, `trackFormSubmit`, `trackCallClick`, `trackEmailClick` (since **0.1.10**), `trackContactClick` (since **0.1.18** — SMS, WhatsApp, maps, scheduling), `trackLead`
 
 **Content**
 

package/dist/{chunk-AEQGPTDY.js → chunk-SOHYQ5GT.js}

@@ -3,7 +3,6 @@ var JMP_SESSION_ID_KEY = "jmp_analytics_sid";
 var JMP_LANDING_REFERER_KEY = "jmp_analytics_landing_referer";
 var JMP_LANDING_REFERER_COOKIE = "jmp_lr";
 var JMP_UTM_SESSION_KEY = "jmp_analytics_utm";
-var JMP_EARLY_BEACON_PATH_KEY = "jmp_analytics_early_beacon_path";
 var LANDING_REFERER_COOKIE_MAX_AGE_SEC = 30 * 60;
 var JMP_UTM_PARAM_KEYS = [
   "utm_source",
@@ -89,11 +88,9 @@ function captureLandingAttribution(siteHostname) {
     const preservedReferer = storedReferer || cookieReferer;
     const currentReferer = document.referrer?.trim() || null;
     if (currentReferer && isExternalReferrerUrl(currentReferer, siteHostname)) {
-      if (!storedReferer) {
-        sessionStorage.setItem(JMP_LANDING_REFERER_KEY, currentReferer);
-      }
+      sessionStorage.setItem(JMP_LANDING_REFERER_KEY, currentReferer);
       writeLandingRefererCookie(currentReferer, siteHostname);
-      landingReferer = preservedReferer || currentReferer;
+      landingReferer = currentReferer;
     } else if (preservedReferer) {
       landingReferer = preservedReferer;
       if (!storedReferer) {
@@ -138,84 +135,175 @@ function getOrCreateSessionIdFromStorage() {
     return void 0;
   }
 }
-function wasEarlyBeaconSentForPath(path) {
-  if (typeof window === "undefined") {
-    return false;
+function buildLandingCaptureInlineScript() {
+  const cookieMaxAge = String(LANDING_REFERER_COOKIE_MAX_AGE_SEC);
+  return `(function(){try{var h=location.hostname;var ref=document.referrer||'';function rh(u){try{return new URL(u).hostname.replace(/^www\\./i,'').toLowerCase()}catch(e){try{return new URL('https://'+u).hostname.replace(/^www\\./i,'').toLowerCase()}catch(e2){return null}}}function ext(r){var x=rh(r);if(!x)return false;var s=h.replace(/^www\\./i,'').toLowerCase();return x!==s&&x.slice(-('.'+s).length)!==('.'+s)}function apexDom(hn){var s=hn.replace(/^www\\./i,'').toLowerCase();if(!s||s==='localhost'||/\\.local$/i.test(s)||s.indexOf('.')<0)return null;return s}function readCk(hn){var apex=apexDom(hn);if(!apex)return '';var pre='${JMP_LANDING_REFERER_COOKIE}=';var parts=document.cookie.split(';');for(var i=0;i<parts.length;i++){var t=parts[i].trim();if(t.indexOf(pre)===0){try{return decodeURIComponent(t.slice(pre.length)).trim()}catch(e){return ''}}}return ''}function writeCk(r,hn){var apex=apexDom(hn);if(!apex)return;var sec=location.protocol==='https:'?'; Secure':'';document.cookie='${JMP_LANDING_REFERER_COOKIE}='+encodeURIComponent(r.slice(0,2048))+'; Domain=.'+apex+'; Path=/; Max-Age=${cookieMaxAge}; SameSite=Lax'+sec}var stored=sessionStorage.getItem('${JMP_LANDING_REFERER_KEY}')||'';var ck=readCk(h);var preserved=stored||ck;var lr='';if(ref&&ext(ref)){sessionStorage.setItem('${JMP_LANDING_REFERER_KEY}',ref);writeCk(ref,h);lr=ref}else{lr=preserved||'';if(lr&&!stored)sessionStorage.setItem('${JMP_LANDING_REFERER_KEY}',lr)}var sid=sessionStorage.getItem('${JMP_SESSION_ID_KEY}');if(!sid&&crypto&&crypto.randomUUID){sid=crypto.randomUUID();sessionStorage.setItem('${JMP_SESSION_ID_KEY}',sid)}try{var sp=new URLSearchParams(location.search);var utm={};var updated=false;['utm_source','utm_medium','utm_campaign','utm_content','utm_term'].forEach(function(n){var v=sp.get(n);if(v){utm[n]=v;updated=true}});if(updated)sessionStorage.setItem('${JMP_UTM_SESSION_KEY}',JSON.stringify(utm))}catch(e){}}catch(e){}})();`;
+}
+
+// src/contact-link-classifier.ts
+var BOOKING_LINK_HOSTS = [
+  "calendly.com",
+  "cal.com",
+  "acuityscheduling.com",
+  "calendar.google.com",
+  "calendar.app.google",
+  "bookings.microsoft.com",
+  "outlook.office.com",
+  "outlook.office365.com",
+  "book.ms",
+  "setmore.com",
+  "simplybook.me",
+  "oncehub.com",
+  "scheduleonce.com",
+  "youcanbook.me",
+  "savvycal.com",
+  "tidycal.com",
+  "zohobookings.com",
+  "square.site",
+  "squareup.com",
+  "meetings.hubspot.com",
+  "jobber.com",
+  "housecallpro.com",
+  "servicetitan.com",
+  "thryv.com",
+  "honeybook.com",
+  "dubsado.com",
+  "fresha.com",
+  "booksy.com",
+  "vagaro.com",
+  "mindbodyonline.com",
+  "mindbody.io",
+  "janeapp.com",
+  "cliniko.com",
+  "practicebetter.io"
+];
+var WHATSAPP_HOSTS = ["wa.me", "api.whatsapp.com", "whatsapp.com"];
+function hostnameMatches(host, pattern) {
+  const h = host.toLowerCase();
+  const p = pattern.toLowerCase();
+  return h === p || h.endsWith(`.${p}`);
+}
+function isMapsHost(host, pathname) {
+  if (hostnameMatches(host, "maps.apple.com")) {
+    return true;
   }
-  try {
-    return sessionStorage.getItem(JMP_EARLY_BEACON_PATH_KEY) === path;
-  } catch {
-    return false;
+  if (hostnameMatches(host, "maps.app.goo.gl")) {
+    return true;
+  }
+  if (hostnameMatches(host, "google.com") || hostnameMatches(host, "google.co")) {
+    return pathname === "/maps" || pathname.startsWith("/maps/") || pathname.startsWith("/local");
   }
+  return false;
 }
-function markEarlyBeaconSentForPath(path) {
-  if (typeof window === "undefined") {
-    return;
+function isWhatsAppHost(host, pathname) {
+  for (const pattern of WHATSAPP_HOSTS) {
+    if (!hostnameMatches(host, pattern)) {
+      continue;
+    }
+    if (pattern === "whatsapp.com") {
+      return pathname.startsWith("/send");
+    }
+    return true;
+  }
+  return false;
+}
+function isBookingHost(host) {
+  for (const pattern of BOOKING_LINK_HOSTS) {
+    if (hostnameMatches(host, pattern)) {
+      return true;
+    }
+  }
+  return false;
+}
+function classifyContactHref(href) {
+  const raw = href.trim();
+  if (!raw || raw.startsWith("#") || raw.startsWith("javascript:")) {
+    return null;
+  }
+  const lower = raw.toLowerCase();
+  if (lower.startsWith("tel:")) {
+    return { kind: "call" };
+  }
+  if (lower.startsWith("mailto:")) {
+    return { kind: "email" };
+  }
+  if (lower.startsWith("sms:") || lower.startsWith("smsto:")) {
+    return { kind: "contact_click", channel: "sms", linkHost: null };
   }
+  if (lower.startsWith("geo:")) {
+    return { kind: "contact_click", channel: "maps", linkHost: null };
+  }
+  if (raw.startsWith("/") || raw.startsWith("?")) {
+    return null;
+  }
+  let url;
   try {
-    sessionStorage.setItem(JMP_EARLY_BEACON_PATH_KEY, path);
+    url = new URL(raw);
   } catch {
+    return null;
+  }
+  if (url.protocol !== "http:" && url.protocol !== "https:") {
+    return null;
+  }
+  const host = url.hostname.toLowerCase();
+  const pathname = url.pathname.toLowerCase();
+  if (isWhatsAppHost(host, pathname)) {
+    return { kind: "contact_click", channel: "whatsapp", linkHost: host };
   }
+  if (isMapsHost(host, pathname)) {
+    return { kind: "contact_click", channel: "maps", linkHost: host };
+  }
+  if (isBookingHost(host)) {
+    return { kind: "contact_click", channel: "booking", linkHost: host };
+  }
+  return null;
 }
-function sendEarlyPageViewBeacon(args) {
-  if (typeof window === "undefined" || typeof fetch === "undefined") {
+
+// src/index.ts
+var JMP_ANALYTICS_SDK_VERSION = "0.1.18";
+var JMP_TRACKING_CONSENT_STORAGE_KEY = "jmp_analytics_consent_v1";
+var moduleTrackingConsentGranted = true;
+var trackingConsentListeners = /* @__PURE__ */ new Set();
+function readStoredTrackingConsent() {
+  if (typeof window === "undefined") {
     return false;
   }
-  const path = `${window.location.pathname}${window.location.search}` || "/";
-  if (wasEarlyBeaconSentForPath(path)) {
+  try {
+    return localStorage.getItem(JMP_TRACKING_CONSENT_STORAGE_KEY) === "granted";
+  } catch {
     return false;
   }
-  const { landingReferer, utm } = captureLandingAttribution(window.location.hostname);
-  const sessionId = getOrCreateSessionIdFromStorage();
-  const metadata = {
-    pageHostname: window.location.hostname,
-    earlyBeacon: true,
-    ...utm
-  };
-  if (landingReferer) {
-    metadata.referer = landingReferer;
-  }
-  const payload = {
-    type: "page_view",
-    path,
-    trackingKey: args.trackingKey,
-    ...sessionId ? { sessionId } : {},
-    metadata
-  };
-  const headers = {
-    "Content-Type": "application/json",
-    "X-JMP-Tracking-Key": args.trackingKey
+}
+function isJmpTrackingConsentGranted() {
+  return moduleTrackingConsentGranted;
+}
+function subscribeJmpTrackingConsent(listener) {
+  trackingConsentListeners.add(listener);
+  return () => {
+    trackingConsentListeners.delete(listener);
   };
-  if (landingReferer) {
-    headers["X-JMP-Visitor-Referer"] = landingReferer;
+}
+function setJmpTrackingConsent(granted) {
+  if (moduleTrackingConsentGranted === granted) {
+    return;
   }
-  markEarlyBeaconSentForPath(path);
-  void fetch(`${args.baseUrl.replace(/\/$/, "")}/api/events`, {
-    method: "POST",
-    headers,
-    body: JSON.stringify(payload),
-    keepalive: true,
-    mode: "cors",
-    credentials: "omit"
-  }).catch(() => {
+  moduleTrackingConsentGranted = granted;
+  if (typeof window !== "undefined") {
     try {
-      sessionStorage.removeItem(JMP_EARLY_BEACON_PATH_KEY);
+      localStorage.setItem(
+        JMP_TRACKING_CONSENT_STORAGE_KEY,
+        granted ? "granted" : "denied"
+      );
     } catch {
     }
-  });
-  return true;
-}
-function escapeInlineScript(value) {
-  return value.replace(/\\/g, "\\\\").replace(/'/g, "\\'");
-}
-function buildLandingCaptureInlineScript(args) {
-  const baseUrl = escapeInlineScript(args.baseUrl.replace(/\/$/, ""));
-  const trackingKey = escapeInlineScript(args.trackingKey);
-  const cookieMaxAge = String(LANDING_REFERER_COOKIE_MAX_AGE_SEC);
-  return `(function(){try{var k='${trackingKey}',b='${baseUrl}';if(!k||!b)return;var p=location.pathname+location.search||'/';var sentKey='${JMP_EARLY_BEACON_PATH_KEY}';if(sessionStorage.getItem(sentKey)===p)return;var h=location.hostname;var ref=document.referrer||'';function rh(u){try{return new URL(u).hostname.replace(/^www\\./i,'').toLowerCase()}catch(e){try{return new URL('https://'+u).hostname.replace(/^www\\./i,'').toLowerCase()}catch(e2){return null}}}function ext(r){var x=rh(r);if(!x)return false;var s=h.replace(/^www\\./i,'').toLowerCase();return x!==s&&x.slice(-('.'+s).length)!==('.'+s)}function apexDom(hn){var s=hn.replace(/^www\\./i,'').toLowerCase();if(!s||s==='localhost'||/\\.local$/i.test(s)||s.indexOf('.')<0)return null;return s}function readCk(hn){var apex=apexDom(hn);if(!apex)return '';var pre='${JMP_LANDING_REFERER_COOKIE}=';var parts=document.cookie.split(';');for(var i=0;i<parts.length;i++){var t=parts[i].trim();if(t.indexOf(pre)===0){try{return decodeURIComponent(t.slice(pre.length)).trim()}catch(e){return ''}}}return ''}function writeCk(r,hn){var apex=apexDom(hn);if(!apex)return;var sec=location.protocol==='https:'?'; Secure':'';document.cookie='${JMP_LANDING_REFERER_COOKIE}='+encodeURIComponent(r.slice(0,2048))+'; Domain=.'+apex+'; Path=/; Max-Age=${cookieMaxAge}; SameSite=Lax'+sec}var stored=sessionStorage.getItem('${JMP_LANDING_REFERER_KEY}')||'';var ck=readCk(h);var preserved=stored||ck;var lr='';if(ref&&ext(ref)){if(!stored)sessionStorage.setItem('${JMP_LANDING_REFERER_KEY}',ref);writeCk(ref,h);lr=preserved||ref}else{lr=preserved||'';if(lr&&!stored)sessionStorage.setItem('${JMP_LANDING_REFERER_KEY}',lr)}var sid=sessionStorage.getItem('${JMP_SESSION_ID_KEY}');if(!sid&&crypto&&crypto.randomUUID){sid=crypto.randomUUID();sessionStorage.setItem('${JMP_SESSION_ID_KEY}',sid)}var md={pageHostname:h,earlyBeacon:true};try{var sp=new URLSearchParams(location.search);['utm_source','utm_medium','utm_campaign','utm_content','utm_term'].forEach(function(n){var v=sp.get(n);if(v)md[n]=v})}catch(e){}if(lr)md.referer=lr;var body=JSON.stringify({type:'page_view',path:p,trackingKey:k,sessionId:sid||undefined,metadata:md});var hd={'Content-Type':'application/json','X-JMP-Tracking-Key':k};if(lr)hd['X-JMP-Visitor-Referer']=lr;sessionStorage.setItem(sentKey,p);fetch(b+'/api/events',{method:'POST',headers:hd,body:body,keepalive:true,mode:'cors',credentials:'omit'}).catch(function(){sessionStorage.removeItem(sentKey)})}catch(e){}})();`;
+    if (granted) {
+      captureLandingAttribution(window.location.hostname);
+    }
+  }
+  for (const listener of trackingConsentListeners) {
+    listener();
+  }
 }
-
-// src/index.ts
 function captureAndGetLandingReferer() {
   if (typeof window === "undefined") {
     return null;
@@ -290,9 +378,16 @@ function createJmpAnalytics(config) {
     );
   }
   const fetchFn = resolvedFetch;
+  moduleTrackingConsentGranted = config.requireConsent ? readStoredTrackingConsent() : true;
+  function canSend() {
+    return moduleTrackingConsentGranted;
+  }
   let lastDedupePath = "";
   let lastDedupeAt = 0;
   async function send(body) {
+    if (!canSend()) {
+      return;
+    }
     const url = `${baseUrl}/api/events`;
     const headers = {
       "Content-Type": "application/json",
@@ -348,6 +443,9 @@ function createJmpAnalytics(config) {
     }
   }
   async function sendLead(body) {
+    if (!canSend()) {
+      return;
+    }
     const url = `${baseUrl}/api/leads`;
     const headers = {
       "Content-Type": "application/json",
@@ -410,6 +508,9 @@ function createJmpAnalytics(config) {
     return false;
   }
   function trackPageView(options) {
+    if (!canSend()) {
+      return Promise.resolve();
+    }
     const pathFromOptions = options?.path?.trim();
     let pathname = "/";
     let search = "";
@@ -425,9 +526,6 @@ function createJmpAnalytics(config) {
       search = window.location.search.replace(/^\?/, "");
     }
     const path = search ? `${pathname}?${search}` : pathname;
-    if (wasEarlyBeaconSentForPath(path)) {
-      return Promise.resolve();
-    }
     if (shouldDedupePageView(pathname)) {
       return Promise.resolve();
     }
@@ -478,6 +576,20 @@ function createJmpAnalytics(config) {
       metadata: metadata ?? {}
     });
   }
+  function trackContactClick(path, options) {
+    const metadata = {
+      ...options.metadata && typeof options.metadata === "object" ? options.metadata : {},
+      channel: options.channel
+    };
+    if (options.linkHost) {
+      metadata.linkHost = options.linkHost;
+    }
+    return send({
+      type: "contact_click",
+      path: path || "/",
+      metadata
+    });
+  }
   function trackLead(options) {
     const path = options?.path ?? (typeof window !== "undefined" ? window.location.pathname : "/");
     const body = { path: path || "/" };
@@ -510,7 +622,20 @@ function createJmpAnalytics(config) {
     if (type === "call_click") {
       return trackCallClick(payload.path, payload.metadata);
     }
-    return trackEmailClick(payload.path, payload.metadata);
+    if (type === "email_click") {
+      return trackEmailClick(payload.path, payload.metadata);
+    }
+    const meta = payload.metadata ?? {};
+    const channel = typeof meta.channel === "string" ? meta.channel : "";
+    const linkHost = typeof meta.linkHost === "string" ? meta.linkHost : null;
+    if (channel !== "sms" && channel !== "whatsapp" && channel !== "maps" && channel !== "booking") {
+      return Promise.resolve();
+    }
+    return trackContactClick(payload.path, {
+      channel,
+      linkHost,
+      metadata: meta
+    });
   }
   function subscribeToSpaNavigation() {
     if (typeof window === "undefined") {
@@ -544,12 +669,75 @@ function createJmpAnalytics(config) {
       history.replaceState = replace;
     };
   }
-  if (typeof window !== "undefined") {
+  let lastContactClickKey = "";
+  let lastContactClickAt = 0;
+  function subscribeContactLinkAutoTrack() {
+    if (typeof window === "undefined" || typeof document === "undefined") {
+      return () => {
+      };
+    }
+    const handler = (event) => {
+      if (!canSend()) {
+        return;
+      }
+      const target = event.target;
+      if (!(target instanceof Element)) {
+        return;
+      }
+      const anchor = target.closest("a[href]");
+      if (!(anchor instanceof HTMLAnchorElement)) {
+        return;
+      }
+      if (anchor.closest("[data-jmp-no-track]")) {
+        return;
+      }
+      const href = anchor.getAttribute("href") ?? "";
+      const classified = classifyContactHref(href);
+      if (!classified) {
+        return;
+      }
+      const path = window.location.pathname;
+      if (classified.kind === "call") {
+        if (dedupeContactClick(`call_click:${path}`)) {
+          return;
+        }
+        void trackCallClick(path);
+        return;
+      }
+      if (classified.kind === "email") {
+        if (dedupeContactClick(`email_click:${path}`)) {
+          return;
+        }
+        void trackEmailClick(path);
+        return;
+      }
+      if (dedupeContactClick(`contact_click:${classified.channel}:${path}`)) {
+        return;
+      }
+      void trackContactClick(path, {
+        channel: classified.channel,
+        linkHost: classified.linkHost
+      });
+    };
+    document.addEventListener("click", handler, { capture: true });
+    return () => {
+      document.removeEventListener("click", handler, { capture: true });
+    };
+  }
+  function dedupeContactClick(key) {
+    const now = Date.now();
+    if (key === lastContactClickKey && now - lastContactClickAt < 1e3) {
+      return true;
+    }
+    lastContactClickKey = key;
+    lastContactClickAt = now;
+    return false;
+  }
+  if (typeof window !== "undefined" && canSend()) {
     captureLandingAttribution(window.location.hostname);
-    sendEarlyPageViewBeacon({
-      baseUrl,
-      trackingKey: config.trackingKey
-    });
+  }
+  if (typeof window !== "undefined" && config.autoTrackContactLinks && canSend()) {
+    subscribeContactLinkAutoTrack();
   }
   return {
     track,
@@ -557,8 +745,12 @@ function createJmpAnalytics(config) {
     trackFormSubmit,
     trackCallClick,
     trackEmailClick,
+    trackContactClick,
     trackLead,
-    subscribeToSpaNavigation
+    subscribeToSpaNavigation,
+    subscribeContactLinkAutoTrack,
+    setTrackingConsent: setJmpTrackingConsent,
+    isTrackingConsentGranted: isJmpTrackingConsentGranted
   };
 }
 async function trackJmpServerPageView(config, options = {}) {
@@ -681,7 +873,10 @@ async function registerJmpContentWrappers(config) {
       "Content-Type": "application/json",
       "X-JMP-Tracking-Key": config.trackingKey
     },
-    body: JSON.stringify({ wrappers })
+    body: JSON.stringify({
+      wrappers,
+      sdkVersion: JMP_ANALYTICS_SDK_VERSION
+    })
   });
   const text = await res.text();
   if (!res.ok) {
@@ -779,11 +974,15 @@ function getJmpBrowserAnalyticsConfigFromEnv(overrides) {
   const baseUrl = readProcessEnv("NEXT_PUBLIC_JMP_ANALYTICS_URL");
   const trackingKey = readProcessEnv("NEXT_PUBLIC_JMP_TRACKING_KEY");
   if (!baseUrl || !trackingKey) return null;
+  const requireConsentFromEnv = readProcessEnv("NEXT_PUBLIC_JMP_ANALYTICS_REQUIRE_CONSENT") === "true";
+  const autoTrackContactLinksFromEnv = readProcessEnv("NEXT_PUBLIC_JMP_AUTO_CONTACT_LINKS") === "true";
   return {
     baseUrl,
     trackingKey,
     pageViewDedupeMs: DEFAULT_JMP_BROWSER_PAGE_VIEW_DEDUPE_MS,
-    ...overrides
+    ...overrides,
+    requireConsent: overrides?.requireConsent ?? requireConsentFromEnv,
+    autoTrackContactLinks: overrides?.autoTrackContactLinks ?? autoTrackContactLinksFromEnv
   };
 }
 function getJmpServerContentConfigFromEnv(overrides) {
@@ -816,8 +1015,14 @@ function createJmpContentClientFromServerEnv(overrides) {
 }
 
 export {
-  sendEarlyPageViewBeacon,
   buildLandingCaptureInlineScript,
+  BOOKING_LINK_HOSTS,
+  classifyContactHref,
+  JMP_ANALYTICS_SDK_VERSION,
+  JMP_TRACKING_CONSENT_STORAGE_KEY,
+  isJmpTrackingConsentGranted,
+  subscribeJmpTrackingConsent,
+  setJmpTrackingConsent,
   createJmpAnalytics,
   trackJmpServerPageView,
   getJmpBlogPosts,
@@ -837,4 +1042,4 @@ export {
   getOrCreateJmpAnalyticsFromBrowserEnv,
   createJmpContentClientFromServerEnv
 };
-//# sourceMappingURL=chunk-AEQGPTDY.js.map
+//# sourceMappingURL=chunk-SOHYQ5GT.js.map