From 7dc389fcc15aec8b1d9db8afc5aff85e48fb2827 Mon Sep 17 00:00:00 2001
From: Adriaan <1079135+adriaandotcom@users.noreply.github.com>
Date: Fri, 30 May 2025 17:29:24 +0200
Subject: [PATCH] Add callback support to sa_pageview

---
 dist/latest/auto-events.js          |  2 +-
 dist/latest/latest.dev.js           | 38 ++++++++++++++++--------
 src/default.js                      | 46 ++++++++++++++++++-----------
 test/unit/pageview-callback.test.js | 34 +++++++++++++++++++++
 4 files changed, 89 insertions(+), 31 deletions(-)
 create mode 100644 test/unit/pageview-callback.test.js

diff --git a/dist/latest/auto-events.js b/dist/latest/auto-events.js
index 7575a1e..c8ac687 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-05-29; 7048; v12) */
+/* Simple Analytics - Privacy-first analytics (docs.simpleanalytics.com/script; 2025-05-30; 7048; 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()}));
 //# sourceMappingURL=auto-events.js.map
\ No newline at end of file
diff --git a/dist/latest/latest.dev.js b/dist/latest/latest.dev.js
index 06bf05c..2c2adb2 100644
--- a/dist/latest/latest.dev.js
+++ b/dist/latest/latest.dev.js
@@ -1,4 +1,4 @@
-/* Simple Analytics - Privacy-first analytics (docs.simpleanalytics.com/script; 2025-05-29; 36a5; v12) */
+/* Simple Analytics - Privacy-first analytics (docs.simpleanalytics.com/script; 2025-05-30; 8325; v12) */
 /* eslint-env browser */
 
 (function (
@@ -656,21 +656,25 @@
       isPushState,
       deleteSourceInfo,
       sameSite,
-      metadata
+      metadata,
+      callback
     ) {
       if (isPushState) sendOnLeave("" + payload.page_id, trueVar);
       if (collectDataOnLeave) payload.page_id = uuid();
 
       var currentPage = definedHostname + getPath();
 
-      sendData({
-        id: payload.page_id,
-        type: pageviewText,
-        referrer: !deleteSourceInfo || sameSite ? referrer : null,
-        query: getQueryParams(deleteSourceInfo),
+      sendData(
+        {
+          id: payload.page_id,
+          type: pageviewText,
+          referrer: !deleteSourceInfo || sameSite ? referrer : null,
+          query: getQueryParams(deleteSourceInfo),
 
-        metadata: stringify(metadata),
-      });
+          metadata: stringify(metadata),
+        },
+        callback
+      );
 
       previousReferrer = referrer;
       referrer = currentPage;
@@ -680,7 +684,14 @@
 
     var sameSite, userNavigated;
 
-    var pageview = function (isPushState, pathOverwrite, metadata) {
+    var pageview = function (
+      isPushState,
+      pathOverwrite,
+      metadata,
+      callbackRaw
+    ) {
+      if (!callbackRaw && isFunction(metadata)) callbackRaw = metadata;
+      var callback = isFunction(callbackRaw) ? callbackRaw : function () {};
       // Obfuscate personal data in URL by dropping the search and hash
       var path = getPath(pathOverwrite);
 
@@ -759,7 +770,8 @@
           isPushState,
           isPushState || userNavigated || !collectMetricByString("r"), // r = referrers
           sameSite,
-          metadata
+          metadata,
+          callback
         );
       };
 
@@ -850,8 +862,8 @@
 
     if (autoCollect) pageview();
 
-    window.sa_pageview = function (path, metadata) {
-      pageview(0, path, metadata);
+    window.sa_pageview = function (path, metadata, callback) {
+      pageview(0, path, metadata, callback);
     };
 
 
diff --git a/src/default.js b/src/default.js
index 816815a..f17076a 100644
--- a/src/default.js
+++ b/src/default.js
@@ -745,23 +745,27 @@
       isPushState,
       deleteSourceInfo,
       sameSite,
-      metadata
+      metadata,
+      callback
     ) {
       if (isPushState) sendOnLeave("" + payload.page_id, trueVar);
       if (collectDataOnLeave) payload.page_id = uuid();
 
       var currentPage = definedHostname + getPath();
 
-      sendData({
-        id: payload.page_id,
-        type: pageviewText,
-        referrer: !deleteSourceInfo || sameSite ? referrer : null,
-        query: getQueryParams(deleteSourceInfo),
-
-        /** if metadata **/
-        metadata: stringify(metadata),
-        /** endif **/
-      });
+      sendData(
+        {
+          id: payload.page_id,
+          type: pageviewText,
+          referrer: !deleteSourceInfo || sameSite ? referrer : null,
+          query: getQueryParams(deleteSourceInfo),
+
+          /** if metadata **/
+          metadata: stringify(metadata),
+          /** endif **/
+        },
+        callback
+      );
 
       previousReferrer = referrer;
       referrer = currentPage;
@@ -771,7 +775,14 @@
 
     var sameSite, userNavigated;
 
-    var pageview = function (isPushState, pathOverwrite, metadata) {
+    var pageview = function (
+      isPushState,
+      pathOverwrite,
+      metadata,
+      callbackRaw
+    ) {
+      if (!callbackRaw && isFunction(metadata)) callbackRaw = metadata;
+      var callback = isFunction(callbackRaw) ? callbackRaw : function () {};
       // Obfuscate personal data in URL by dropping the search and hash
       var path = getPath(pathOverwrite);
 
@@ -864,7 +875,8 @@
           isPushState,
           isPushState || userNavigated || !collectMetricByString("r"), // r = referrers
           sameSite,
-          metadata
+          metadata,
+          callback
         );
       };
 
@@ -961,12 +973,12 @@
     if (autoCollect) pageview();
 
     /** if metadata **/
-    window.sa_pageview = function (path, metadata) {
-      pageview(0, path, metadata);
+    window.sa_pageview = function (path, metadata, callback) {
+      pageview(0, path, metadata, callback);
     };
     /** else **/
-    window.sa_pageview = function (path) {
-      pageview(0, path);
+    window.sa_pageview = function (path, callback) {
+      pageview(0, path, undefinedVar, callback);
     };
     /** endif **/
 
diff --git a/test/unit/pageview-callback.test.js b/test/unit/pageview-callback.test.js
new file mode 100644
index 0000000..6929b31
--- /dev/null
+++ b/test/unit/pageview-callback.test.js
@@ -0,0 +1,34 @@
+const { expect } = require("chai");
+const { createDOM } = require("./helpers/dom");
+
+describe("pageview callback", function () {
+  it("executes callback after sending a pageview", function (done) {
+    const dom = createDOM({ settings: { autoCollect: false } });
+
+    const sent = dom.sent;
+    dom.window.Image = function () {
+      return {
+        onload: null,
+        onerror: null,
+        set src(value) {
+          sent.push({ type: "image", url: value });
+          if (this.onload) this.onload();
+        },
+      };
+    };
+
+    let called = false;
+    dom.window.sa_pageview("/callback", function () {
+      called = true;
+    });
+
+    setTimeout(() => {
+      const req = dom.sent.find(
+        (r) => r.type === "image" && /path=%2Fcallback/.test(r.url)
+      );
+      expect(req, "pageview request").to.exist;
+      expect(called, "callback called").to.be.true;
+      done();
+    }, 10);
+  });
+});