@aranova/tracking-react 0.17.3 → 0.18.0

package/dist/index.js

@@ -25,6 +25,7 @@ __export(src_exports, {
   ConsentBanner: () => ConsentBanner,
   DEFAULT_DECLINE_TTL_DAYS: () => DEFAULT_DECLINE_TTL_DAYS,
   DEFAULT_PHONE_COUNTRY: () => DEFAULT_PHONE_COUNTRY,
+  EVENT_SEMANTICS: () => EVENT_SEMANTICS,
   GoogleAdsTracking: () => GoogleAdsTracking,
   NAMED_RANGES: () => NAMED_RANGES,
   PhoneField: () => PhoneField,
@@ -45,6 +46,8 @@ __export(src_exports, {
   fromMinor: () => fromMinor,
   getConsentChoice: () => getConsentChoice,
   getConsentState: () => getConsentState,
+  getEventSemantics: () => getEventSemantics,
+  getTrackingConfigRuntime: () => getTrackingConfigRuntime,
   onConsentChange: () => onConsentChange,
   optIn: () => optIn,
   optOut: () => optOut,
@@ -680,6 +683,7 @@ function parseConversionConfig(raw) {
     business_id: typeof obj.business_id === "string" ? obj.business_id : void 0,
     customer_id: typeof obj.customer_id === "string" ? obj.customer_id : null,
     environment: typeof obj.environment === "string" ? obj.environment : void 0,
+    google_tracking_state: obj.google_tracking_state === "active" ? "active" : "disabled",
     gtag_ids: isStringMap(obj.gtag_ids) ? obj.gtag_ids : {},
     meta_pixel_ids: isStringMap(obj.meta_pixel_ids) ? obj.meta_pixel_ids : {},
     services,
@@ -815,6 +819,283 @@ function formatDateInTz(iso, timeZone, opts, locale) {
   }).format(date);
 }
 
+// ../tracking-core/src/resources/tracking-config-runtime.ts
+var CACHE_PREFIX2 = "_aranova_cfg_runtime_";
+var AUTHORITY_TTL_MS = 6e4;
+var runtimes = /* @__PURE__ */ new Map();
+var configuredIds = /* @__PURE__ */ new Set();
+var scriptLoad = null;
+var jsInitialized = false;
+function cacheKey2(url) {
+  return `${CACHE_PREFIX2}${url}`;
+}
+function readCache2(url) {
+  if (typeof window === "undefined") return null;
+  try {
+    const raw = window.sessionStorage.getItem(cacheKey2(url));
+    if (!raw) return null;
+    const parsed = JSON.parse(raw);
+    const config = parseConversionConfig(parsed.config);
+    if (!config) return null;
+    return {
+      etag: typeof parsed.etag === "string" ? parsed.etag : null,
+      config
+    };
+  } catch {
+    return null;
+  }
+}
+function writeCache2(url, entry) {
+  if (typeof window === "undefined") return;
+  try {
+    window.sessionStorage.setItem(cacheKey2(url), JSON.stringify(entry));
+  } catch {
+  }
+}
+function isTombstone(config) {
+  return config.google_tracking_state === "disabled" || Object.keys(config.gtag_ids).length === 0;
+}
+function validateConfig(config, ref) {
+  return config.business_id === ref.businessId && config.environment === ref.environment && (config.google_tracking_state === "active" || config.google_tracking_state === "disabled");
+}
+function pageViewSnapshot() {
+  if (typeof window === "undefined" || typeof document === "undefined") return null;
+  return {
+    href: window.location.href,
+    title: document.title || null,
+    referrer: document.referrer || null
+  };
+}
+function ensureScript(gtagId) {
+  if (typeof window === "undefined" || typeof document === "undefined") return Promise.resolve();
+  applyDefaultConsentState();
+  loadGtagScript(gtagId);
+  if (scriptLoad) return scriptLoad;
+  scriptLoad = new Promise((resolve) => {
+    const script = document.querySelector(
+      'script[data-aranova-tracking="aranova-gtag-loader"]'
+    );
+    if (!script) {
+      resolve();
+      return;
+    }
+    if (script.dataset.loaded === "true") {
+      resolve();
+      return;
+    }
+    window.setTimeout(resolve, 0);
+    script.addEventListener(
+      "load",
+      () => {
+        script.dataset.loaded = "true";
+        resolve();
+      },
+      { once: true }
+    );
+    script.addEventListener("error", () => resolve(), { once: true });
+  });
+  return scriptLoad;
+}
+var TrackingConfigRuntime = class {
+  constructor(ref, fetchImpl = globalThis.fetch) {
+    this.ref = ref;
+    this.fetchImpl = fetchImpl;
+    this.current = null;
+    this.etag = null;
+    this.stateValue = "unconfirmed";
+    this.confirmedAt = 0;
+    this.inFlight = null;
+    this.conversionQueue = [];
+    this.automaticQueue = [];
+    this.pageQueue = [];
+    this.listeners = /* @__PURE__ */ new Set();
+    const cached = readCache2(ref.cdnUrl);
+    this.current = cached?.config ?? null;
+    this.etag = cached?.etag ?? null;
+    void this.revalidate();
+    if (typeof window !== "undefined") {
+      window.addEventListener("visibilitychange", () => {
+        if (document.visibilityState === "visible") void this.revalidate();
+      });
+      window.addEventListener("focus", () => void this.revalidate());
+    }
+  }
+  state() {
+    return this.stateValue;
+  }
+  config() {
+    return this.stateValue === "active" || this.stateValue === "tombstone" ? this.current : null;
+  }
+  __unsafeExpireAuthorityForTests() {
+    this.confirmedAt = 0;
+  }
+  subscribe(listener) {
+    this.listeners.add(listener);
+    return () => this.listeners.delete(listener);
+  }
+  async ensureAuthority() {
+    if (this.stateValue !== "unconfirmed" && Date.now() - this.confirmedAt < AUTHORITY_TTL_MS) {
+      return true;
+    }
+    await this.revalidate();
+    return this.stateValue !== "unconfirmed" && Date.now() - this.confirmedAt < AUTHORITY_TTL_MS;
+  }
+  async revalidate() {
+    if (typeof window === "undefined" || !this.fetchImpl) return;
+    if (this.inFlight) return this.inFlight;
+    this.inFlight = this.revalidateNow().finally(() => {
+      this.inFlight = null;
+    });
+    return this.inFlight;
+  }
+  queuePageView(snapshot = pageViewSnapshot()) {
+    if (!snapshot) return;
+    this.pageQueue.push(snapshot);
+    void this.flush();
+  }
+  fireConversion(key, options) {
+    this.conversionQueue.push({ key, ...options });
+    void this.flush();
+  }
+  queueAutomaticEvent(eventType, metadata, transactionPath) {
+    this.automaticQueue.push({ eventType, metadata, transactionPath });
+    void this.flush();
+  }
+  listGoals() {
+    return this.current?.goals ?? [];
+  }
+  async revalidateNow() {
+    try {
+      const headers = {};
+      if (this.etag) headers["If-None-Match"] = this.etag;
+      const response = await this.fetchImpl(this.ref.cdnUrl, {
+        method: "GET",
+        headers,
+        cache: "no-cache"
+      });
+      if (response.status === 304 && this.current && validateConfig(this.current, this.ref)) {
+        this.confirm(this.current, this.etag);
+        await this.flush();
+        return;
+      }
+      if (!response.ok) {
+        this.expireAuthority();
+        return;
+      }
+      const next = parseConversionConfig(await response.json());
+      if (!next || !validateConfig(next, this.ref)) {
+        this.expireAuthority();
+        return;
+      }
+      if (this.current && next.config_version < this.current.config_version) {
+        this.expireAuthority();
+        return;
+      }
+      this.confirm(next, response.headers.get("ETag"));
+      await this.flush();
+    } catch {
+      this.expireAuthority();
+    }
+  }
+  expireAuthority() {
+    if (this.stateValue !== "unconfirmed") this.stateValue = "unconfirmed";
+  }
+  confirm(config, etag) {
+    this.current = config;
+    this.etag = etag;
+    this.confirmedAt = Date.now();
+    this.stateValue = isTombstone(config) ? "tombstone" : "active";
+    writeCache2(this.ref.cdnUrl, { etag, config });
+    if (this.stateValue === "tombstone") {
+      this.conversionQueue.length = 0;
+      this.automaticQueue.length = 0;
+      this.pageQueue.length = 0;
+    }
+    for (const listener of this.listeners) listener();
+  }
+  async flush() {
+    if (!await this.ensureAuthority()) return;
+    if (this.stateValue !== "active" || !this.current) return;
+    const ids = Object.values(this.current.gtag_ids).filter(
+      (id) => typeof id === "string" && isValidGtagId(id)
+    );
+    if (ids.length === 0) return;
+    await ensureScript(ids[0]);
+    const gtag = window.gtag;
+    if (typeof gtag !== "function") return;
+    if (!jsInitialized) {
+      gtag("js", /* @__PURE__ */ new Date());
+      jsInitialized = true;
+    }
+    for (const id of ids) {
+      if (configuredIds.has(id)) continue;
+      gtag("config", id, { send_page_view: false });
+      configuredIds.add(id);
+    }
+    while (this.pageQueue.length) {
+      const page = this.pageQueue.shift();
+      gtag("event", "page_view", {
+        page_location: page.href,
+        page_title: page.title ?? void 0,
+        page_referrer: page.referrer ?? void 0
+      });
+    }
+    while (this.automaticQueue.length) {
+      const event = this.automaticQueue.shift();
+      for (const goal of this.current.goals) {
+        if (goal.kind !== "event" || !goal.firing) continue;
+        if (!automaticThresholdMet(goal, event.eventType, event.metadata)) continue;
+        this.conversionQueue.push({
+          key: goal.key,
+          transactionId: `auto:${goal.key}:${event.transactionPath}`
+        });
+      }
+    }
+    while (this.conversionQueue.length) {
+      const item = this.conversionQueue.shift();
+      const goal = this.current.goals.find((g) => g.key === item.key);
+      const firing = goal?.firing;
+      if (!firing || getConsentState() === "denied") continue;
+      const currency = item.currency ?? firing.currency ?? null;
+      const value = item.value ?? (firing.value_cents != null && currency ? fromMinor(firing.value_cents, currency) : null);
+      fireGtagConversion({
+        sendTo: firing.send_to,
+        value,
+        currency,
+        transactionId: item.transactionId ?? null
+      });
+    }
+  }
+};
+function automaticThresholdMet(goal, eventType, metadata) {
+  const t = goal.trigger;
+  if (!t || t.event_type !== eventType) return false;
+  switch (eventType) {
+    case "scroll_depth":
+      return typeof metadata.depth_percent === "number" && t.threshold_percent != null && metadata.depth_percent >= t.threshold_percent;
+    case "time_on_site":
+      return typeof metadata.duration_ms === "number" && t.threshold_seconds != null && metadata.duration_ms >= t.threshold_seconds * 1e3;
+    case "multi_page_session":
+      return typeof metadata.page_count === "number" && t.page_threshold != null && metadata.page_count >= t.page_threshold;
+    case "specific_page_visit":
+      return typeof metadata.page_name === "string" && metadata.page_name === t.page_name;
+    case "page_view":
+    case "form_start":
+    case "phone_click":
+      return true;
+    default:
+      return false;
+  }
+}
+function getTrackingConfigRuntime(ref, fetchImpl) {
+  const key = `${ref.cdnUrl}|${ref.businessId}|${ref.environment}`;
+  const existing = runtimes.get(key);
+  if (existing) return existing;
+  const runtime = new TrackingConfigRuntime(ref, fetchImpl ?? globalThis.fetch);
+  runtimes.set(key, runtime);
+  return runtime;
+}
+
 // ../tracking-core/src/resources/conversion-autofire.ts
 function thresholdMet(goal, eventType, metadata) {
   const t = goal.trigger;
@@ -847,6 +1128,12 @@ function createConversionAutoFire(store) {
     for (const goal of store.listGoals()) {
       if (goal.kind !== "event" || !goal.firing) continue;
       if (!thresholdMet(goal, eventType, metadata)) continue;
+      if ("queueAutomaticEvent" in store) {
+        store.fireConversion(goal.key, {
+          transactionId: `auto:${goal.key}:${currentPath()}`
+        });
+        continue;
+      }
       const firing = goal.firing;
       const cents = firing.value_cents ?? null;
       const currency = firing.currency ?? null;
@@ -862,6 +1149,10 @@ function createConversionAutoFire(store) {
   }
   return {
     onAutomaticEvent(eventType, metadata) {
+      if ("queueAutomaticEvent" in store) {
+        store.queueAutomaticEvent(eventType, metadata, currentPath());
+        return;
+      }
       if (store.isReady()) {
         fireMatching(eventType, metadata);
         return;
@@ -1579,69 +1870,154 @@ var timeOnSiteConfigSchema = import_zod11.z.object({
   thresholdSeconds: import_zod11.z.number().int().positive()
 }).strict();
 
+// ../tracking-core/src/events/semantics.ts
+var EVENT_SEMANTICS = {
+  page_view: {
+    label: "Page view",
+    category: "page",
+    outcomeRole: "navigation",
+    clientVisibility: "simple"
+  },
+  time_on_site: {
+    label: "Time on site",
+    category: "engagement",
+    outcomeRole: "engagement",
+    clientVisibility: "detailed"
+  },
+  specific_page_visit: {
+    label: "Key page visit",
+    category: "engagement",
+    outcomeRole: "engagement",
+    clientVisibility: "detailed"
+  },
+  scroll_depth: {
+    label: "Scroll depth",
+    category: "engagement",
+    outcomeRole: "engagement",
+    clientVisibility: "detailed"
+  },
+  multi_page_session: {
+    label: "Multi-page session",
+    category: "engagement",
+    outcomeRole: "engagement",
+    clientVisibility: "detailed"
+  },
+  form_start: {
+    label: "Form started",
+    category: "engagement",
+    outcomeRole: "engagement",
+    clientVisibility: "simple"
+  },
+  sdk_heartbeat: {
+    label: "SDK heartbeat",
+    category: "system",
+    outcomeRole: "diagnostic",
+    clientVisibility: "hidden"
+  },
+  page_exit: {
+    label: "Page exit",
+    category: "engagement",
+    outcomeRole: "diagnostic",
+    clientVisibility: "detailed"
+  },
+  form_submit: {
+    label: "Form submitted",
+    category: "lead",
+    outcomeRole: "lead",
+    clientVisibility: "simple"
+  },
+  phone_click: {
+    label: "Phone click",
+    category: "lead",
+    outcomeRole: "lead",
+    clientVisibility: "simple"
+  },
+  cta_click: {
+    label: "CTA click",
+    category: "engagement",
+    outcomeRole: "engagement",
+    clientVisibility: "simple"
+  }
+};
+function getEventSemantics(eventName) {
+  return eventName in EVENT_SEMANTICS ? EVENT_SEMANTICS[eventName] : null;
+}
+
 // ../tracking-core/src/events/registry.ts
 var EVENT_REGISTRY = {
   // --- automatic triggers ---
   page_view: {
     kind: "automatic",
+    semantics: EVENT_SEMANTICS.page_view,
     metadataSchema: pageViewMetadataSchema,
     configSchema: pageViewConfigSchema
   },
   time_on_site: {
     kind: "automatic",
+    semantics: EVENT_SEMANTICS.time_on_site,
     metadataSchema: timeOnSiteMetadataSchema,
     configSchema: timeOnSiteConfigSchema
   },
   specific_page_visit: {
     kind: "automatic",
+    semantics: EVENT_SEMANTICS.specific_page_visit,
     metadataSchema: specificPageVisitMetadataSchema,
     configSchema: specificPageVisitConfigSchema
   },
   scroll_depth: {
     kind: "automatic",
+    semantics: EVENT_SEMANTICS.scroll_depth,
     metadataSchema: scrollDepthMetadataSchema,
     configSchema: scrollDepthConfigSchema
   },
   multi_page_session: {
     kind: "automatic",
+    semantics: EVENT_SEMANTICS.multi_page_session,
     metadataSchema: multiPageSessionMetadataSchema,
     configSchema: multiPageSessionConfigSchema
   },
   form_start: {
     kind: "automatic",
+    semantics: EVENT_SEMANTICS.form_start,
     metadataSchema: formStartMetadataSchema,
     configSchema: formStartConfigSchema
   },
   // --- SDK-internal automatic (not consumer-configurable) ---
   sdk_heartbeat: {
     kind: "automatic",
+    semantics: EVENT_SEMANTICS.sdk_heartbeat,
     metadataSchema: sdkHeartbeatMetadataSchema,
     configSchema: sdkHeartbeatConfigSchema
   },
   page_exit: {
     kind: "automatic",
+    semantics: EVENT_SEMANTICS.page_exit,
     metadataSchema: pageExitMetadataSchema,
     configSchema: pageExitConfigSchema
   },
   // --- manual triggers ---
   form_submit: {
     kind: "manual",
+    semantics: EVENT_SEMANTICS.form_submit,
     metadataSchema: formSubmitMetadataSchema,
     configSchema: formSubmitConfigSchema
   },
   phone_click: {
     kind: "manual",
+    semantics: EVENT_SEMANTICS.phone_click,
     metadataSchema: phoneClickMetadataSchema,
     configSchema: phoneClickConfigSchema
   },
   cta_click: {
     kind: "manual",
+    semantics: EVENT_SEMANTICS.cta_click,
     metadataSchema: ctaClickMetadataSchema,
     configSchema: ctaClickConfigSchema
   }
 };
 var ALL_AUTOMATIC_EVENT_NAMES = Object.entries(EVENT_REGISTRY).filter(([, def]) => def.kind === "automatic").map(([name]) => name);
 var ALL_MANUAL_EVENT_NAMES = Object.entries(EVENT_REGISTRY).filter(([, def]) => def.kind === "manual").map(([name]) => name);
+var ALL_LEAD_EVENT_NAMES = Object.entries(EVENT_REGISTRY).filter(([, def]) => def.semantics.outcomeRole === "lead").map(([name]) => name);
 function getEventDefinition(name) {
   return EVENT_REGISTRY[name];
 }
@@ -2374,6 +2750,14 @@ function fireRecordedConversions(firing, input, recorded, sale, currency) {
   const txnBase = input.external_id ?? sale.id;
   for (const item of recorded) {
     if (!item.service) continue;
+    if ("fireConversion" in firing) {
+      firing.fireConversion(item.service, {
+        value: item.amount_cents != null ? fromMinor(item.amount_cents, currency) : void 0,
+        currency,
+        transactionId: `${txnBase}:${item.service}`
+      });
+      continue;
+    }
     const config = firing.getFiring(item.service);
     if (!config) continue;
     const cents = item.amount_cents ?? config.value_cents ?? null;
@@ -2416,6 +2800,14 @@ function createSalesClient(config) {
     // recordSale is the intent-revealing alias — same behavior, clearer call site.
     recordSale: record,
     trackConversion(key, options) {
+      if (config.firing && "fireConversion" in config.firing) {
+        config.firing.fireConversion(key, {
+          value: options?.value ?? void 0,
+          currency: options?.currency ?? config.defaultCurrency ?? void 0,
+          transactionId: options?.transactionId ?? null
+        });
+        return;
+      }
       const firing = config.firing?.getFiring(key);
       if (!firing) return;
       const currency = firing.currency ?? options?.currency ?? config.defaultCurrency ?? null;
@@ -2920,21 +3312,28 @@ var import_react3 = require("react");
 function AdPlatformTracking({
   gtagId,
   gtagIds,
+  trackingConfig,
+  standalonePageView = false,
   metaPixelId,
   metaPixelIds
 }) {
+  const trackingConfigKey = trackingConfig ? `${trackingConfig.cdnUrl}:${trackingConfig.businessId}:${trackingConfig.environment}` : "";
   const gtagIdsKey = (0, import_react3.useMemo)(() => gtagIds ? JSON.stringify(gtagIds) : "", [gtagIds]);
   const metaPixelIdsKey = (0, import_react3.useMemo)(
     () => metaPixelIds ? JSON.stringify(metaPixelIds) : "",
     [metaPixelIds]
   );
   (0, import_react3.useEffect)(() => {
-    if (gtagIds && Object.keys(gtagIds).length > 0) {
+    if (trackingConfig) {
+      const runtime = getTrackingConfigRuntime(trackingConfig);
+      if (standalonePageView) runtime.queuePageView();
+      else void runtime.revalidate();
+    } else if (gtagIds && Object.keys(gtagIds).length > 0) {
       bootstrapMultipleGtags(gtagIds);
     } else if (gtagId) {
       bootstrapGoogleAdsTracking(gtagId);
     }
-  }, [gtagId, gtagIdsKey]);
+  }, [gtagId, gtagIdsKey, trackingConfigKey, standalonePageView]);
   (0, import_react3.useEffect)(() => {
     if (metaPixelIds && Object.keys(metaPixelIds).length > 0) {
       bootstrapMultiplePixels(metaPixelIds);
@@ -2964,7 +3363,7 @@ function GoogleAdsTracking(props) {
 var import_react6 = require("react");
 
 // package.json
-var version = "0.17.3";
+var version = "0.18.0";
 
 // ../tracking-core/src/phone-react.tsx
 var import_react5 = require("react");
@@ -3063,7 +3462,16 @@ var NOOP_CLIENT = {
   getVisitorId: () => ""
 };
 function createTracking(options) {
-  const { apiKey, endpoint, triggers, environment, debug, phone, conversionConfig } = options;
+  const {
+    apiKey,
+    endpoint,
+    triggers,
+    environment,
+    debug,
+    phone,
+    conversionConfig,
+    trackingConfig
+  } = options;
   if (!apiKey || !endpoint) {
     if (apiKey || endpoint) {
       console.warn(
@@ -3109,7 +3517,9 @@ function createTracking(options) {
     );
     const gtagIdsKey = (0, import_react6.useMemo)(() => gtagIds ? JSON.stringify(gtagIds) : "", [gtagIds]);
     (0, import_react6.useEffect)(() => {
-      if (gtagIds && Object.keys(gtagIds).length > 0) {
+      if (trackingConfig) {
+        void getTrackingConfigRuntime(trackingConfig).revalidate();
+      } else if (gtagIds && Object.keys(gtagIds).length > 0) {
         bootstrapMultipleGtags(gtagIds);
       } else if (gtagId) {
         bootstrapGoogleAdsTracking(gtagId);
@@ -3139,13 +3549,20 @@ function createTracking(options) {
       });
       return attachClientCapturesOnce(rawClient, () => {
         const detachers = [];
-        const conversionStore = conversionConfig ? resolveConversionConfig({
+        const conversionStore = trackingConfig ? getTrackingConfigRuntime(trackingConfig) : conversionConfig ? resolveConversionConfig({
           cdnUrl: conversionConfig.cdnUrl,
           baked: conversionConfig.baked
         }) : null;
         const detectorClient = conversionStore ? withConversionAutoFire(rawClient, createConversionAutoFire(conversionStore)) : rawClient;
-        detachers.push(attachAutoPageView(detectorClient));
-        detachers.push(attachBfcacheRestore(detectorClient));
+        const pageClient = trackingConfig && conversionStore && "queuePageView" in conversionStore ? {
+          ...detectorClient,
+          trackEvent: (input) => {
+            detectorClient.trackEvent(input);
+            if (input.eventType === "page_view") conversionStore.queuePageView();
+          }
+        } : detectorClient;
+        detachers.push(attachAutoPageView(pageClient));
+        detachers.push(attachBfcacheRestore(pageClient));
         detachers.push(attachPageExit(detectorClient));
         const timeOnSite = triggers.automatic.time_on_site;
         if (timeOnSite) {
@@ -3202,6 +3619,7 @@ function createTracking(options) {
   ConsentBanner,
   DEFAULT_DECLINE_TTL_DAYS,
   DEFAULT_PHONE_COUNTRY,
+  EVENT_SEMANTICS,
   GoogleAdsTracking,
   NAMED_RANGES,
   PhoneField,
@@ -3222,6 +3640,8 @@ function createTracking(options) {
   fromMinor,
   getConsentChoice,
   getConsentState,
+  getEventSemantics,
+  getTrackingConfigRuntime,
   onConsentChange,
   optIn,
   optOut,