auto-events.js

(function saAutomatedEvents(window) {
  // Skip server side rendered pages
  if (typeof window === "undefined") return;

  var log = function (message, type) {
    var logger = type === "warn" ? console.warn : console.info;
    return logger && logger("Simple Analytics auto events:", message);
  };

  var doc = window.document;

  var scriptElement =
    doc.currentScript || doc.querySelector('script[src*="auto-events.js"]');

  var setting = function (attribute, type, defaultValue) {
    var value = scriptElement && scriptElement.dataset[attribute];

    // Booleans
    if (type === "bool" && (value === "true" || value === "false"))
      return value === "true";
    else if (type === "bool") return defaultValue;

    // Arrays
    if (type === "array" && value)
      return value
        .split(",")
        .map(function (item) {
          return item.trim();
        })
        .filter(Boolean);
    else if (type === "array") return defaultValue;

    return value || defaultValue;
  };

  var collectTypes = setting("collect", "array", [
    "outbound",
    "emails",
    "downloads",
  ]);
  var fullUrls = setting("fullUrls", "bool", false);

  var options = {
    // What to collect
    outbound: collectTypes.indexOf("outbound") > -1,
    emails: collectTypes.indexOf("emails") > -1,
    downloads: collectTypes.indexOf("downloads") > -1,
    // Downloads: enter file extensions you want to collect
    downloadsExtensions: setting("extensions", "array", [
      "pdf",
      "csv",
      "docx",
      "xlsx",
      "zip",
      "doc",
      "xls",
    ]),

    // All: use title attribute if set for event name (for all events)
    // THIS TAKES PRECEDENCE OVER OTHER SETTINGS BELOW
    title: setting("useTitle", "bool", true),
    // Outbound: use full URL of the links? false for just the hostname
    outboundFullUrl: fullUrls,
    // Downloads: if taking event name from URL, use full URL or just filename (default)
    downloadsFullUrl: fullUrls,
  };

  var saGlobal = setting("saGlobal", "string", "sa_event");

  // For compiling the script
  var optionsLink = options;

  if (typeof optionsLink === "undefined")
    log("options object not found, please specify", "warn");

  window.saAutomatedLink = function saAutomatedLink(element, type) {
    try {
      if (!element) return log("no element found");
      var sent = false;

      var callback = function () {
        if (!sent && !element.hasAttribute("target"))
          document.location = element.getAttribute("href");
        sent = true;
      };

      if (window[saGlobal] && window[saGlobal + "_loaded"]) {
        var hostname = element.hostname;
        var pathname = element.pathname;

        var event;
        var metadata = {
          title: element.getAttribute("title") || undefined,
        };
        var url = element.href || undefined;

        var useTitle = false;
        if (optionsLink.title && element.hasAttribute("title")) {
          var theTitle = element.getAttribute("title").trim();
          if (theTitle != "") useTitle = true;
        }

        if (useTitle) {
          event = theTitle;
        } else {
          switch (type) {
            case "outbound": {
              event = hostname + (optionsLink.outboundFullUrl ? pathname : "");
              metadata.url = url;
              break;
            }
            case "download": {
              event = optionsLink.downloadsFullUrl
                ? hostname + pathname
                : pathname.split("/").pop();
              metadata.url = url;
              break;
            }
            case "email": {
              var href = element.getAttribute("href");
              event = (href.split(":")[1] || "").split("?")[0];
              metadata.email = event;
              break;
            }
          }
        }

        var clean =
          type +
          "_" +
          event.replace(/[^a-z0-9]+/gi, "_").replace(/(^_+|_+$)/g, "");

        window[saGlobal](clean, metadata, callback);

        log("collected " + clean);

        return type === "email"
          ? callback()
          : window.setTimeout(callback, 5000);
      } else {
        log(saGlobal + " is not defined", "warn");
        return callback();
      }
    } catch (error) {
      log(error.message, "warn");
    }
  };

  function collectLink(link, onclick) {
    var collect = false;

    // Collect download clicks
    if (
      optionsLink.downloads &&
      /^https?:\/\//i.test(link.href) &&
      new RegExp(
        "\\.(" + (optionsLink.downloadsExtensions || []).join("|") + ")$",
        "i"
      ).test(link.pathname)
    ) {
      collect = "download";

      // Collect outbound links clicks
    } else if (
      optionsLink.outbound &&
      /^https?:\/\//i.test(link.href) &&
      link.hostname !== window.location.hostname
    ) {
      collect = "outbound";

      // Collect email clicks
    } else if (optionsLink.emails && /^mailto:/i.test(link.href)) {
      collect = "email";
    }

    if (!collect) return;

    if (onclick) {
      var onClickAttribute = "saAutomatedLink(this, '" + collect + "');";

      if (
        !link.hasAttribute("target") ||
        link.getAttribute("target") === "_self"
      )
        onClickAttribute += " return false;";

      link.setAttribute("onclick", onClickAttribute);
    } else {
      link.addEventListener("click", function (element) {
        saAutomatedLink(element.target, collect);
      });
    }
  }

  function onDOMContentLoaded() {
    try {
      var a = document.getElementsByTagName("a");

      // Loop over all links on the page
      for (var i = 0; i < a.length; i++) {
        var link = a[i];
        var href = link.getAttribute("href");

        // Skip links that don't have an href
        if (!href) continue;

        // We don't want to overwrite website behaviour so we check for the onclick attribute
        if (!link.getAttribute("onclick") && !/^mailto:/.test(href)) {
          collectLink(link, true);
        } else {
          collectLink(link, false);
        }
      }
    } catch (error) {
      log(error.message, "warn");
    }
  }

  if (doc.readyState === "ready" || doc.readyState === "complete") {
    onDOMContentLoaded();
  } else {
    document.addEventListener("readystatechange", function (event) {
      if (event.target.readyState === "complete") onDOMContentLoaded();
    });
  }
})(window);