From 40d0592b32498b0e7a49420b5c450d83e33fcf89 Mon Sep 17 00:00:00 2001
From: Adriaan <1079135+adriaandotcom@users.noreply.github.com>
Date: Tue, 24 Jun 2025 19:05:34 +0200
Subject: [PATCH] feat(auto-events): allow cmd-click to open in new tab

---
 dist/latest/auto-events.js             |  4 +--
 src/auto-events.js                     | 41 ++++++++++++++---------
 test/unit/auto-events-cmdclick.test.js | 45 ++++++++++++++++++++++++++
 3 files changed, 72 insertions(+), 18 deletions(-)
 create mode 100644 test/unit/auto-events-cmdclick.test.js

diff --git a/dist/latest/auto-events.js b/dist/latest/auto-events.js
index ad6fe1f..f143c39 100644
--- a/dist/latest/auto-events.js
+++ b/dist/latest/auto-events.js
@@ -1,4 +1,4 @@
-/* Simple Analytics - Privacy-first analytics (docs.simpleanalytics.com/script; 2025-06-13; 7048; v12) */
+/* Simple Analytics - Privacy-first analytics (docs.simpleanalytics.com/script; 2025-06-13; 644f; v12) */
 
-function r(t,e){var a,n;t.hasAttribute("data-simple-event")||(a=!1,h.downloads&&/^https?:\/\//i.test(t.href)&&new RegExp("\\.("+(h.downloadsExtensions||[]).join("|")+")$","i").test(t.pathname)?a="download":h.outbound&&/^https?:\/\//i.test(t.href)&&t.hostname!==m.location.hostname?a="outbound":h.emails&&/^mailto:/i.test(t.href)&&(a="email"),a&&(e?(n="saAutomatedLink(this, '"+a+"');",t.hasAttribute("target")&&"_self"!==t.getAttribute("target")||(n+=" return false;"),t.setAttribute("onclick",n)):t.addEventListener("click",function(){g(t,a)})))}function e(){try{for(var t=document.getElementsByTagName("a"),e=0;e<t.length;e++){var a=t[e],n=a.getAttribute("href");n&&(a.getAttribute("onclick")||/^mailto:/.test(n)?r(a,!1):r(a,!0))}}catch(o){b(o.message,"warn")}}var m,b,t,o,a,n,i,l,p,h,g;void 0!==(m=window)&&(b=function(t,e){var a="warn"===e?console.warn:console.info;return a&&a("Simple Analytics auto events:",t)},t=m.document,o=t.currentScript||t.querySelector('script[src*="auto-events.js"]'),n=(a=function(t,e,a){var n=o&&o.dataset[t];return"bool"!==e||"true"!==n&&"false"!==n?"bool"===e?a:"array"===e&&n?n.split(",").map(function(t){return t.trim()}).filter(Boolean):"array"!==e&&n||a:"true"===n})("collect","array",["outbound","emails","downloads"]),i=a("fullUrls","bool",!1),l={outbound:-1<n.indexOf("outbound"),emails:-1<n.indexOf("emails"),downloads:-1<n.indexOf("downloads"),downloadsExtensions:a("extensions","array",["pdf","csv","docx","xlsx","zip","doc","xls"]),title:a("useTitle","bool",!0),outboundFullUrl:i,downloadsFullUrl:i},p=a("saGlobal","string","sa_event"),void 0===(h=l)&&b("options object not found, please specify","warn"),g=function g(t,e){try{if(!t)return b("no element found");var a=!1,n=function(){a||t.hasAttribute("target")||(document.location=t.getAttribute("href")),a=!0};if(m[p]&&m[p+"_loaded"]){var o,r=t.hostname,i=t.pathname,l={title:t.getAttribute("title")||undefined},s=t.href||undefined,u=!1;if(h.title&&t.hasAttribute("title")&&(""!=(o=t.getAttribute("title").trim())&&(u=!0)),u)d=o;else switch(e){case"outbound":d=r+(h.outboundFullUrl?i:""),l.url=s;break;case"download":d=h.downloadsFullUrl?r+i:i.split("/").pop(),l.url=s;break;case"email":var d=(t.getAttribute("href").split(":")[1]||"").split("?")[0];l.email=d}var c=e+"_"+d.replace(/[^a-z0-9]+/gi,"_").replace(/(^_+|_+$)/g,"");return m[p](c,l,n),b("collected "+c),"email"===e?n():m.setTimeout(n,5e3)}return b(p+" is not defined","warn"),n()}catch(f){b(f.message,"warn")}},m.saAutomatedLink=g,"ready"===t.readyState||"complete"===t.readyState?e():document.addEventListener("readystatechange",function(t){"complete"===t.target.readyState&&e()}));
+function r(e,t){var a,n;e.hasAttribute("data-simple-event")||(a=!1,v.downloads&&/^https?:\/\//i.test(e.href)&&new RegExp("\\.("+(v.downloadsExtensions||[]).join("|")+")$","i").test(e.pathname)?a="download":v.outbound&&/^https?:\/\//i.test(e.href)&&e.hostname!==b.location.hostname?a="outbound":v.emails&&/^mailto:/i.test(e.href)&&(a="email"),a&&(t?(n="return saAutomatedLink(this, '"+a+"', event);",e.setAttribute("onclick",n)):e.addEventListener("click",function(t){g(e,a,t)})))}function e(){try{for(var t=document.getElementsByTagName("a"),e=0;e<t.length;e++){var a=t[e],n=a.getAttribute("href");n&&(a.getAttribute("onclick")||/^mailto:/.test(n)?r(a,!1):r(a,!0))}}catch(o){p(o.message,"warn")}}var b,p,t,o,a,n,i,l,h,v,g;void 0!==(b=window)&&(p=function(t,e){var a="warn"===e?console.warn:console.info;return a&&a("Simple Analytics auto events:",t)},t=b.document,o=t.currentScript||t.querySelector('script[src*="auto-events.js"]'),n=(a=function(t,e,a){var n=o&&o.dataset[t];return"bool"!==e||"true"!==n&&"false"!==n?"bool"===e?a:"array"===e&&n?n.split(",").map(function(t){return t.trim()}).filter(Boolean):"array"!==e&&n||a:"true"===n})("collect","array",["outbound","emails","downloads"]),i=a("fullUrls","bool",!1),l={outbound:-1<n.indexOf("outbound"),emails:-1<n.indexOf("emails"),downloads:-1<n.indexOf("downloads"),downloadsExtensions:a("extensions","array",["pdf","csv","docx","xlsx","zip","doc","xls"]),title:a("useTitle","bool",!0),outboundFullUrl:i,downloadsFullUrl:i},h=a("saGlobal","string","sa_event"),void 0===(v=l)&&p("options object not found, please specify","warn"),g=function g(t,e,a){try{if(!t)return p("no element found");var n=!1,o=t.hasAttribute("target")&&"_self"!==t.getAttribute("target")||a&&(a.metaKey||a.ctrlKey||a.shiftKey||a.altKey||1===a.button);a&&!o&&a.preventDefault&&a.preventDefault();var r=function(){n||o||t.hasAttribute("target")||(document.location=t.getAttribute("href")),n=!0};if(b[h]&&b[h+"_loaded"]){var i,l=t.hostname,s=t.pathname,u={title:t.getAttribute("title")||undefined},d=t.href||undefined,c=!1;if(v.title&&t.hasAttribute("title")&&(""!=(i=t.getAttribute("title").trim())&&(c=!0)),c)a=i;else switch(e){case"outbound":a=l+(v.outboundFullUrl?s:""),u.url=d;break;case"download":a=v.downloadsFullUrl?l+s:s.split("/").pop(),u.url=d;break;case"email":a=(t.getAttribute("href").split(":")[1]||"").split("?")[0],u.email=a}var f=e+"_"+a.replace(/[^a-z0-9]+/gi,"_").replace(/(^_+|_+$)/g,"");return b[h](f,u,r),p("collected "+f),"email"===e?r():b.setTimeout(r,5e3),o}return p(h+" is not defined","warn"),r(),o}catch(m){return p(m.message,"warn"),o}},b.saAutomatedLink=g,"ready"===t.readyState||"complete"===t.readyState?e():document.addEventListener("readystatechange",function(t){"complete"===t.target.readyState&&e()}));
 //# sourceMappingURL=auto-events.js.map
\ No newline at end of file
diff --git a/src/auto-events.js b/src/auto-events.js
index 3f08e13..d24271d 100644
--- a/src/auto-events.js
+++ b/src/auto-events.js
@@ -73,13 +73,25 @@
   if (typeof optionsLink === "undefined")
     log("options object not found, please specify", "warn");
 
-  var saAutomatedLink = function saAutomatedLink(element, type) {
+  var saAutomatedLink = function saAutomatedLink(element, type, event) {
     try {
       if (!element) return log("no element found");
       var sent = false;
 
+      var openNewTab =
+        (element.hasAttribute("target") &&
+          element.getAttribute("target") !== "_self") ||
+        (event &&
+          (event.metaKey ||
+            event.ctrlKey ||
+            event.shiftKey ||
+            event.altKey ||
+            event.button === 1));
+
+      if (event && !openNewTab && event.preventDefault) event.preventDefault();
+
       var callback = function () {
-        if (!sent && !element.hasAttribute("target"))
+        if (!sent && !openNewTab && !element.hasAttribute("target"))
           document.location = element.getAttribute("href");
         sent = true;
       };
@@ -134,15 +146,18 @@
 
         log("collected " + clean);
 
-        return type === "email"
-          ? callback()
-          : window.setTimeout(callback, 5000);
+        if (type === "email") callback();
+        else window.setTimeout(callback, 5000);
+
+        return openNewTab;
       } else {
         log(saGlobal + " is not defined", "warn");
-        return callback();
+        callback();
+        return openNewTab;
       }
     } catch (error) {
       log(error.message, "warn");
+      return openNewTab;
     }
   };
 
@@ -179,18 +194,12 @@
     if (!collect) return;
 
     if (onclick) {
-      var onClickAttribute = "saAutomatedLink(this, '" + collect + "');";
-
-      if (
-        !link.hasAttribute("target") ||
-        link.getAttribute("target") === "_self"
-      )
-        onClickAttribute += " return false;";
-
+      var onClickAttribute =
+        "return saAutomatedLink(this, '" + collect + "', event);";
       link.setAttribute("onclick", onClickAttribute);
     } else {
-      link.addEventListener("click", function () {
-        saAutomatedLink(link, collect);
+      link.addEventListener("click", function (e) {
+        saAutomatedLink(link, collect, e);
       });
     }
   }
diff --git a/test/unit/auto-events-cmdclick.test.js b/test/unit/auto-events-cmdclick.test.js
new file mode 100644
index 0000000..e7a0b74
--- /dev/null
+++ b/test/unit/auto-events-cmdclick.test.js
@@ -0,0 +1,45 @@
+const { expect } = require("chai");
+const { JSDOM } = require("jsdom");
+const { readFileSync } = require("fs");
+const vm = require("vm");
+
+describe("auto-events cmd-click", function () {
+  it("allows meta click without preventing default", function () {
+    const html =
+      '<!doctype html><html><body><a id="doc" href="https://docs.example.com/">Doc</a></body></html>';
+    const dom = new JSDOM(html, {
+      url: "https://simpleanalytics.com/",
+      runScripts: "outside-only",
+      pretendToBeVisual: true,
+    });
+    const context = dom.getInternalVMContext();
+    vm.runInContext(
+      "window.sa_event = function(){}; window.sa_event_loaded = true;",
+      context
+    );
+    const script = readFileSync("dist/latest/auto-events.js", "utf8");
+    vm.runInContext(script, context);
+    const link = dom.window.document.getElementById("doc");
+    const normalEvent = new dom.window.MouseEvent("click", {
+      bubbles: true,
+      cancelable: true,
+    });
+    const metaEvent = new dom.window.MouseEvent("click", {
+      bubbles: true,
+      cancelable: true,
+      metaKey: true,
+    });
+
+    const normalReturn = dom.window.saAutomatedLink(
+      link,
+      "outbound",
+      normalEvent
+    );
+    const metaReturn = dom.window.saAutomatedLink(link, "outbound", metaEvent);
+
+    expect(normalEvent.defaultPrevented).to.equal(true);
+    expect(metaEvent.defaultPrevented).to.equal(false);
+    expect(normalReturn).to.equal(false);
+    expect(metaReturn).to.equal(true);
+  });
+});