@webority/analytics 0.11.0 → 0.11.1

package/src/state.js

@@ -1,42 +0,0 @@
-import { getConsent as getSiteConsent, isConsentInitialized } from "./consent.js";
-import { events } from "./vocabulary.js";
-
-export const state = {
-    config: null,
-    posthogInstance: null,
-    posthogInitPromise: null,
-    registeredEvents: new Set(Object.values(events)),
-    warnedUnregisteredEvents: new Set(),
-};
-
-// The warning exists to reach a developer once. After this many distinct bad names the message
-// has landed, and a product building names from data must not grow the set for the life of the tab.
-export const WARNED_EVENT_LIMIT = 50;
-
-// registeredEvents is deliberately not reset: an event name is part of the product's
-// vocabulary, not of one analytics session, so a product that registers at module scope and
-// starts analytics later in a bootstrap effect keeps its registrations. warnedUnregisteredEvents
-// follows it for the same reason: the warning is about the code, not about one session, so
-// re-initializing must not make the same mistake shout again.
-export function resetState(config) {
-    state.config = config;
-    state.posthogInstance = null;
-    state.posthogInitPromise = null;
-}
-
-export function isEligible() {
-    const config = state.config;
-    if (!config) {
-        return false;
-    }
-    return Boolean(config.enabled && config.clientKey && config.environment !== "Local");
-}
-
-// The visitor's analytics consent is the only thing that gates capture.
-export function hasConsent() {
-    return isConsentInitialized() && getSiteConsent().analytics;
-}
-
-export function isActive() {
-    return isEligible() && hasConsent();
-}

package/src/tags.js

@@ -1,191 +0,0 @@
-import { getConsent, isAdStorageEnabled, isConsentInitialized, isStrictOptIn, onConsentChange } from "./consent.js";
-
-const INTERACTION_EVENTS = ["scroll", "mousemove", "touchstart", "keydown", "pointerdown"];
-const GOOGLE_GTM_URL = "https://www.googletagmanager.com/gtm.js";
-const DEFER_AFTER_LOAD_MS = 1500;
-const CLARITY_FALLBACK_MS = 3000;
-const CLARITY_SCROLL_PX = 100;
-
-const tagState = {
-    loaded: false,
-    clarityId: null,
-    clarityLoaded: false,
-    cancelClaritySchedule: null,
-};
-
-/**
- * Loads the marketing tags. Tag Manager waits for the first interaction, or 1.5s after load,
- * so its download never competes with the page's largest paint; Consent Mode (set by
- * initConsent) gates what its tags may do. Clarity records sessions, so it loads only with
- * analytics consent, and tells Clarity the visitor's choice (consentv2) when it loads and on every
- * change after; a revoke stops its recording from the next page. Ahrefs is cookieless and
- * loads straight away. GA4 is deliberately absent: it runs inside the Tag Manager container,
- * and loading it here as well counts every page view twice.
- *
- * gtmUrl replaces Google's loader address with the site's own (a proxy path or domain serving
- * gtm.js); the container id is appended as the id query parameter. A visitor whose saved choice
- * already grants Tag Manager gets it at DOM-ready, without the interaction wait.
- *
- * Under initConsent's strictOptIn nothing loads before consent: Ahrefs waits for analytics, and
- * Tag Manager for analytics, or for marketing when adStorage lets marketing grant ad signals,
- * whether granted on this page or saved on an earlier one. Marketing alone without adStorage
- * unlocks nothing in the container, and loading it would still let GA4 send cookieless pings.
- */
-export function loadTags(options = {}) {
-    if (!isConsentInitialized()) {
-        throw new Error("@webority/analytics: call initConsent before loadTags.");
-    }
-    if (tagState.loaded) {
-        return;
-    }
-    tagState.loaded = true;
-
-    const { gtmId, gtmUrl = GOOGLE_GTM_URL, clarityId, ahrefsKey } = options;
-    if (typeof gtmUrl !== "string" || gtmUrl.trim() === "") {
-        throw new Error("@webority/analytics: gtmUrl must be a non-empty string.");
-    }
-    const strict = isStrictOptIn();
-
-    if (ahrefsKey) {
-        const loadAhrefs = () => appendScript("https://analytics.ahrefs.com/analytics.js", { "data-key": ahrefsKey });
-        if (strict) {
-            whenConsented((consent) => consent.analytics, loadAhrefs);
-        } else {
-            loadAhrefs();
-        }
-    }
-
-    if (gtmId) {
-        const ads = isAdStorageEnabled();
-        const tagManagerGranted = (consent) => consent.analytics || (consent.marketing && ads);
-        const injectTagManager = () => {
-            window.dataLayer = window.dataLayer || [];
-            window.dataLayer.push({ "gtm.start": Date.now(), event: "gtm.js" });
-            appendScript(`${gtmUrl}${gtmUrl.includes("?") ? "&" : "?"}id=${encodeURIComponent(gtmId)}`);
-        };
-        const saved = getConsent();
-        const schedule = saved.decided && tagManagerGranted(saved) ? runAtDomReady : runAfterFirstInteraction;
-        const loadTagManager = () => schedule(injectTagManager);
-        if (strict) {
-            whenConsented(tagManagerGranted, loadTagManager);
-        } else {
-            loadTagManager();
-        }
-    }
-
-    if (clarityId) {
-        tagState.clarityId = clarityId;
-        if (getConsent().analytics) {
-            scheduleClarity();
-        }
-        onConsentChange((consent) => {
-            if (consent.analytics && !tagState.clarityLoaded) {
-                loadClarity();
-            } else if (tagState.clarityLoaded) {
-                sendClarityConsent(consent);
-            }
-        });
-    }
-}
-
-function whenConsented(granted, callback) {
-    if (granted(getConsent())) {
-        callback();
-        return;
-    }
-    const unsubscribe = onConsentChange((consent) => {
-        if (granted(consent)) {
-            unsubscribe();
-            callback();
-        }
-    });
-}
-
-function runAtDomReady(callback) {
-    if (document.readyState === "loading") {
-        document.addEventListener("DOMContentLoaded", callback, { once: true });
-    } else {
-        callback();
-    }
-}
-
-function runAfterFirstInteraction(callback) {
-    let ran = false;
-    const run = () => {
-        if (ran) {
-            return;
-        }
-        ran = true;
-        callback();
-    };
-
-    for (const eventName of INTERACTION_EVENTS) {
-        window.addEventListener(eventName, run, { once: true, passive: true });
-    }
-    if (document.readyState === "complete") {
-        setTimeout(run, DEFER_AFTER_LOAD_MS);
-    } else {
-        window.addEventListener("load", () => setTimeout(run, DEFER_AFTER_LOAD_MS), { once: true });
-    }
-}
-
-function scheduleClarity() {
-    const onScroll = () => {
-        if (window.scrollY > CLARITY_SCROLL_PX) {
-            loadClarity();
-        }
-    };
-    window.addEventListener("scroll", onScroll, { passive: true });
-    const timer = setTimeout(loadClarity, CLARITY_FALLBACK_MS);
-    tagState.cancelClaritySchedule = () => {
-        window.removeEventListener("scroll", onScroll);
-        clearTimeout(timer);
-    };
-}
-
-function loadClarity() {
-    // Whichever path loads Clarity first (scroll, timer or a consent grant) retires the others.
-    tagState.cancelClaritySchedule?.();
-    tagState.cancelClaritySchedule = null;
-    if (tagState.clarityLoaded || !tagState.clarityId) {
-        return;
-    }
-    tagState.clarityLoaded = true;
-
-    // Clarity's own queue: calls made before its script arrives are replayed once it does.
-    window.clarity =
-        window.clarity ||
-        function clarityQueue() {
-            window.clarity.q = window.clarity.q || [];
-            // biome-ignore lint/complexity/noArguments: Clarity's stub queues the Arguments object, as its own snippet does.
-            window.clarity.q.push(arguments);
-        };
-    sendClarityConsent(getConsent());
-    appendScript(`https://www.clarity.ms/tag/${encodeURIComponent(tagState.clarityId)}`, { crossorigin: "anonymous" });
-}
-
-// Clarity's consent API v2 (required for EEA, UK and Switzerland visitors): the signal rides the
-// stub's queue, so it is replayed in order once the script arrives.
-function sendClarityConsent(consent) {
-    window.clarity("consentv2", {
-        ad_Storage: consent.marketing && isAdStorageEnabled() ? "granted" : "denied",
-        analytics_Storage: consent.analytics ? "granted" : "denied",
-    });
-}
-
-function appendScript(src, attributes = {}) {
-    const script = document.createElement("script");
-    script.async = true;
-    script.src = src;
-    for (const [name, value] of Object.entries(attributes)) {
-        script.setAttribute(name, value);
-    }
-    document.head.appendChild(script);
-}
-
-export function resetTagsForTests() {
-    tagState.loaded = false;
-    tagState.clarityId = null;
-    tagState.clarityLoaded = false;
-    tagState.cancelClaritySchedule = null;
-}

package/src/track-helpers.js

@@ -1,8 +0,0 @@
-import { trackEvent } from "./analytics.js";
-import { trackHelperNames } from "./vocabulary.js";
-
-export const track = Object.freeze(
-    Object.fromEntries(
-        Object.entries(trackHelperNames).map(([camelName, eventName]) => [camelName, (props = {}) => trackEvent(eventName, props)]),
-    ),
-);

package/src/vocabulary.js

@@ -1,47 +0,0 @@
-export const events = Object.freeze({
-    SIGNUP_STARTED: "signup_started",
-    SIGNUP_COMPLETED: "signup_completed",
-    LOGIN_SUCCEEDED: "login_succeeded",
-    ONBOARDING_STARTED: "onboarding_started",
-    ONBOARDING_STEP_COMPLETED: "onboarding_step_completed",
-    ONBOARDING_COMPLETED: "onboarding_completed",
-    SUBSCRIPTION_ACTIVATED: "subscription_activated",
-    SUBSCRIPTION_CANCELLED: "subscription_cancelled",
-    PAYMENT_SUCCEEDED: "payment_succeeded",
-    PAYMENT_FAILED: "payment_failed",
-    FEEDBACK_SUBMITTED: "feedback_submitted",
-    LEAD_SUBMITTED: "lead_submitted",
-    LEAD_QUALIFIED: "lead_qualified",
-    WHATSAPP_CLICK: "whatsapp_click",
-    CALCULATOR_USE: "calculator_use",
-    PHONE_CLICK: "phone_click",
-    DEMO_BOOKED: "demo_booked",
-    CONTACT_SUBMITTED: "contact_submitted",
-    TRIAL_START_CLICK: "trial_start_click",
-    SAMPLE_REPORT_DOWNLOAD: "sample_report_download",
-});
-
-export const trackHelperNames = Object.freeze({
-    signupStarted: events.SIGNUP_STARTED,
-    signupCompleted: events.SIGNUP_COMPLETED,
-    loginSucceeded: events.LOGIN_SUCCEEDED,
-    onboardingStarted: events.ONBOARDING_STARTED,
-    onboardingStepCompleted: events.ONBOARDING_STEP_COMPLETED,
-    onboardingCompleted: events.ONBOARDING_COMPLETED,
-    subscriptionActivated: events.SUBSCRIPTION_ACTIVATED,
-    subscriptionCancelled: events.SUBSCRIPTION_CANCELLED,
-    paymentSucceeded: events.PAYMENT_SUCCEEDED,
-    paymentFailed: events.PAYMENT_FAILED,
-    feedbackSubmitted: events.FEEDBACK_SUBMITTED,
-    leadSubmitted: events.LEAD_SUBMITTED,
-    leadQualified: events.LEAD_QUALIFIED,
-    whatsappClick: events.WHATSAPP_CLICK,
-    calculatorUse: events.CALCULATOR_USE,
-    phoneClick: events.PHONE_CLICK,
-    demoBooked: events.DEMO_BOOKED,
-    contactSubmitted: events.CONTACT_SUBMITTED,
-    trialStartClick: events.TRIAL_START_CLICK,
-    sampleReportDownload: events.SAMPLE_REPORT_DOWNLOAD,
-});
-
-export const EVENT_NAME_PATTERN = /^[a-z][a-z0-9]*(_[a-z0-9]+)*$/;