mirror of
https://github.com/heygen-com/hyperframes.git
synced 2026-11-18 16:08:56 +00:00
* docs: download links name where the visit began Docs download links carry the visit's source (ref, utm_*, ad-click kind), like the homepage's links. Mintlify's Card download button now carries them and the PostHog id it was dropping. * docs: keep the attribution comment to public names * docs: take over only the Card's click, so Mintlify's own link handlers still run Stopping every download click hid the navbar CTA's docs.navitem.cta_click. Only Mintlify's Card (data-client-link) ignores a changed href; every other link is followed by the browser from the tagged href, as before. A source restored from storage carries only its own names.
154 lines
7.3 KiB
JavaScript
154 lines
7.3 KiB
JavaScript
// Studio download links name this visitor's PostHog id (`ph_id`), so hyperframes.studio counts the download under the
|
|
// same person as these docs' pageviews. Both sites send to one PostHog project, but each domain has its own cookie,
|
|
// so the download site cannot read this one. Mintlify runs every .js file in docs/ on every page
|
|
// (mintlify.com/docs/customize/custom-scripts). The id is added at click time only, so a copied link never carries it,
|
|
// and only when PostHog is running here and the visitor has not opted out of it.
|
|
// They also name where this visit began, as the homepage's download links do: the first docs page's utm tags, the
|
|
// kind of ad click id it came with (never the id) and `ref`, the site that sent it. The download site reads them as
|
|
// the visit's landing source: the click's own Referer is these docs, or nothing at all, since Mintlify's navbar
|
|
// button is rel="noreferrer".
|
|
(function () {
|
|
var TOKEN = "phc_zjjbX0PnWxERXrMHhkEJWj9A9BhGVLRReICgsfTMmpx";
|
|
var STATE = "ph_" + TOKEN + "_posthog";
|
|
// posthog-js keeps a visitor's opt-out under this key: "0" opted out, "1" opted in. It lives in localStorage by
|
|
// default, in a cookie when a site configures that, so both are read.
|
|
var OPT_OUT = "__ph_opt_in_out_" + TOKEN;
|
|
// The one download address the docs link to (docs.json navbar and footer, quickstart.mdx).
|
|
var DOWNLOAD = { protocol: "https:", hostname: "hyperframes.studio", pathname: "/studio/download" };
|
|
var UUID = /^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/i;
|
|
// The campaign tags and ad click ids the download site reads, in its order.
|
|
var CAMPAIGN = ["utm_source", "utm_medium", "utm_campaign", "utm_term", "utm_content"];
|
|
var AD_CLICKS = ["gclid", "gbraid", "wbraid", "dclid", "fbclid", "msclkid", "ttclid", "twclid", "li_fat_id", "rdt_cid", "sccid", "epik"];
|
|
// Our own sites and HeyGen's sign-in: a visit that moved between them says nothing about where it began.
|
|
var NOT_A_SOURCE = /(^|\.)hyperframes\.(heygen\.com|studio|dev)$|^(app|accounts|api2)\.heygen\.com$/;
|
|
// The first docs page of this visit's source, kept for the tab: a later page's Referer is these docs.
|
|
var LANDING = "hf_docs_landing";
|
|
|
|
function cookie(name) {
|
|
var prefix = name + "=";
|
|
var raw = document.cookie.split("; ").find(function (c) {
|
|
return c.indexOf(prefix) === 0;
|
|
});
|
|
return raw ? decodeURIComponent(raw.slice(prefix.length)) : null;
|
|
}
|
|
|
|
function stored(name) {
|
|
try {
|
|
return window.localStorage.getItem(name);
|
|
} catch {
|
|
return null;
|
|
}
|
|
}
|
|
|
|
// Mintlify loads posthog-js for this token from its own proxy (ph.mintlify.com/array/<token>/...). Without that
|
|
// script on the page PostHog is not running here, so nothing is forwarded.
|
|
function posthogLoaded() {
|
|
return Array.prototype.some.call(document.scripts, function (s) {
|
|
return s.src.indexOf("/array/" + TOKEN + "/") !== -1;
|
|
});
|
|
}
|
|
|
|
function optedOut() {
|
|
var choice = stored(OPT_OUT) || cookie(OPT_OUT);
|
|
if (choice !== null && String(choice).replace(/"/g, "") !== "1") return true;
|
|
// A browser-wide "do not track" or Global Privacy Control signal counts as no consent.
|
|
return navigator.globalPrivacyControl === true || navigator.doNotTrack === "1";
|
|
}
|
|
|
|
function posthogId() {
|
|
var raw = cookie(STATE) || stored(STATE);
|
|
if (!raw) return null;
|
|
try {
|
|
var id = JSON.parse(raw).distinct_id;
|
|
return typeof id === "string" && UUID.test(id) ? id : null;
|
|
} catch {
|
|
return null;
|
|
}
|
|
}
|
|
|
|
// This visit's source as download-link params: the page's own campaign tags, the kind of ad click id and the site
|
|
// that sent it, host alone (a path or query can name a person). Empty when the visit names none.
|
|
function visitSource() {
|
|
var page = new URLSearchParams(window.location.search);
|
|
var out = new URLSearchParams();
|
|
CAMPAIGN.forEach(function (name) {
|
|
var value = page.get(name);
|
|
if (value) out.set(name, value);
|
|
});
|
|
var adClick = AD_CLICKS.find(function (name) {
|
|
return (page.get(name) || "").trim();
|
|
});
|
|
if (adClick) out.set("ad_click", adClick);
|
|
try {
|
|
var ref = new URL(document.referrer);
|
|
var host = ref.hostname.replace(/\.$/, "");
|
|
if ((ref.protocol === "https:" || ref.protocol === "http:") && host && !NOT_A_SOURCE.test(host)) out.set("ref", host);
|
|
} catch {
|
|
// No Referer: a typed address, a bookmark or a link from an app.
|
|
}
|
|
return out.toString();
|
|
}
|
|
|
|
// Kept from the first page this script ran on in the tab; sessionStorage blocked (some privacy modes) falls back
|
|
// to this page's own source.
|
|
var landing = visitSource();
|
|
try {
|
|
var kept = window.sessionStorage.getItem(LANDING);
|
|
if (kept === null) window.sessionStorage.setItem(LANDING, landing);
|
|
else landing = kept;
|
|
} catch {
|
|
// keep this page's
|
|
}
|
|
|
|
function tag(event) {
|
|
var link = event.target instanceof Element && event.target.closest("a[href]");
|
|
if (!link) return;
|
|
var url;
|
|
try {
|
|
url = new URL(link.href);
|
|
} catch {
|
|
return;
|
|
}
|
|
if (
|
|
url.protocol !== DOWNLOAD.protocol ||
|
|
url.hostname !== DOWNLOAD.hostname ||
|
|
url.port !== "" ||
|
|
url.pathname !== DOWNLOAD.pathname
|
|
) {
|
|
return;
|
|
}
|
|
var original = link.getAttribute("href");
|
|
// A tag the link already names keeps its own value. Only the source's own names come back from storage, so a value
|
|
// kept there can never add any other parameter (ph_id belongs to the consent check below).
|
|
new URLSearchParams(landing).forEach(function (value, name) {
|
|
var known = CAMPAIGN.indexOf(name) !== -1 || name === "ref" || (name === "ad_click" && AD_CLICKS.indexOf(value) !== -1);
|
|
if (known && !url.searchParams.has(name)) url.searchParams.set(name, value);
|
|
});
|
|
var id = posthogLoaded() && !optedOut() && posthogId();
|
|
if (id) url.searchParams.set("ph_id", id);
|
|
if (url.toString() === new URL(link.href).toString()) return;
|
|
// Mintlify's <Card> (its anchor carries data-client-link) opens its own href prop from React, never the link's current
|
|
// href, so its click is followed here: a new tab for a middle click, Cmd/Ctrl-click or a target="_blank" link, else
|
|
// this tab. Every other link keeps the browser's own follow of the href set below, so Mintlify's click handlers
|
|
// (the navbar CTA's docs.navitem.cta_click) still run. Shift (new window) and Alt (save link) stay the browser's.
|
|
var card = link.hasAttribute("data-client-link");
|
|
var newTab = event.button === 1 || event.metaKey || event.ctrlKey || link.target === "_blank";
|
|
if (card && (event.button === 0 || event.button === 1) && !event.shiftKey && !event.altKey) {
|
|
event.preventDefault();
|
|
event.stopPropagation();
|
|
if (newTab) window.open(url.toString(), "_blank", /noreferrer/.test(link.rel) ? "noopener,noreferrer" : "noopener");
|
|
else window.location.assign(url.toString());
|
|
return;
|
|
}
|
|
link.href = url.toString();
|
|
// Put the link back once the browser has followed it, so copying it later still leaves the id out.
|
|
setTimeout(function () {
|
|
link.setAttribute("href", original);
|
|
}, 0);
|
|
}
|
|
|
|
// Capture phase, before the browser follows the link; auxclick covers a middle-click into a new tab.
|
|
document.addEventListener("click", tag, true);
|
|
document.addEventListener("auxclick", tag, true);
|
|
})();
|