@aranova/tracking-next 0.13.0 → 0.14.0

package/dist/index.js

@@ -56,6 +56,7 @@ __export(src_exports, {
   parsePhone: () => parsePhone,
   phoneField: () => phoneField,
   resetConsent: () => resetConsent,
+  resolveConversionConfig: () => resolveConversionConfig,
   saleCreateSchema: () => saleCreateSchema,
   saleItemSchema: () => saleItemSchema,
   saleServiceSchema: () => saleServiceSchema,
@@ -76,6 +77,13 @@ module.exports = __toCommonJS(src_exports);
 // ../tracking-core/src/consent.ts
 var CONSENT_STATE_KEY = "consent_state";
 var CONSENT_TIMESTAMP_KEY = "consent_timestamp";
+var grantedListeners = /* @__PURE__ */ new Set();
+function onConsentGranted(listener) {
+  grantedListeners.add(listener);
+  return () => {
+    grantedListeners.delete(listener);
+  };
+}
 function buildConsentPayload(state) {
   return {
     ad_storage: state,
@@ -104,6 +112,14 @@ function setConsentState(state) {
     window.gtag("consent", "update", buildConsentPayload(state));
   if (typeof window.fbq === "function")
     window.fbq("consent", state === "granted" ? "grant" : "revoke");
+  if (state === "granted") {
+    for (const listener of grantedListeners) {
+      try {
+        listener();
+      } catch {
+      }
+    }
+  }
 }
 function resetConsent() {
   if (typeof window === "undefined") return;
@@ -260,6 +276,24 @@ try {
 } catch (e) {}
 `.trim();
 }
+var SEND_TO_RE = /^AW-[A-Za-z0-9]+\/[A-Za-z0-9_-]+$/;
+function isValidSendTo(sendTo) {
+  return SEND_TO_RE.test(sendTo);
+}
+function fireGtagConversion(input) {
+  if (typeof window === "undefined" || typeof window.gtag !== "function") return false;
+  if (!isValidSendTo(input.sendTo)) return false;
+  const params = { send_to: input.sendTo };
+  if (input.value != null) params.value = input.value;
+  if (input.currency) params.currency = input.currency;
+  if (input.transactionId) params.transaction_id = input.transactionId;
+  try {
+    window.gtag("event", "conversion", params);
+    return true;
+  } catch {
+    return false;
+  }
+}
 function createGtagInitScriptMulti(gtagIds) {
   const safeIds = gtagIds.filter(isValidGtagId);
   const configs = safeIds.map((id) => `gtag('config', '${id}');`).join("\n");
@@ -388,6 +422,289 @@ function createTrackingEventCreatePayload(trackingParams, input, context) {
   };
 }
 
+// ../tracking-core/src/resources/conversion-firing.ts
+var DEDUP_PREFIX = "_aranova_conv_";
+var MAX_PENDING = 100;
+var pendingQueue = [];
+function dedupKey(input) {
+  return `${DEDUP_PREFIX}${input.transactionId ?? ""}:${input.sendTo}`;
+}
+function alreadyFired(input) {
+  if (!input.transactionId || typeof window === "undefined") return false;
+  try {
+    return window.sessionStorage.getItem(dedupKey(input)) !== null;
+  } catch {
+    return false;
+  }
+}
+function markFired(input) {
+  if (!input.transactionId || typeof window === "undefined") return;
+  try {
+    window.sessionStorage.setItem(dedupKey(input), "1");
+  } catch {
+  }
+}
+function fireOnce(input) {
+  if (alreadyFired(input)) return;
+  if (fireGtagConversion(input)) markFired(input);
+}
+function fireConversionWithConsent(input) {
+  const state = getConsentState();
+  if (state === "denied") return;
+  if (state === "pending") {
+    if (pendingQueue.length >= MAX_PENDING) pendingQueue.shift();
+    pendingQueue.push(input);
+    return;
+  }
+  fireOnce(input);
+}
+function flushPendingConversions() {
+  if (getConsentState() !== "granted") return;
+  while (pendingQueue.length > 0) {
+    const input = pendingQueue.shift();
+    if (input) fireOnce(input);
+  }
+}
+if (typeof window !== "undefined") onConsentGranted(flushPendingConversions);
+
+// ../tracking-core/src/resources/conversion-config.ts
+function isStringMap(value) {
+  return typeof value === "object" && value !== null && Object.values(value).every((v) => typeof v === "string");
+}
+function parseFiring(value) {
+  if (!value || typeof value !== "object") return null;
+  const f = value;
+  if (typeof f.send_to !== "string") return null;
+  return {
+    send_to: f.send_to,
+    value_cents: typeof f.value_cents === "number" ? f.value_cents : null,
+    currency: typeof f.currency === "string" ? f.currency : null
+  };
+}
+function parseTrigger(value) {
+  if (!value || typeof value !== "object") return null;
+  const t = value;
+  if (typeof t.event_type !== "string") return null;
+  const spec = { event_type: t.event_type };
+  if (typeof t.threshold_percent === "number") spec.threshold_percent = t.threshold_percent;
+  if (typeof t.threshold_seconds === "number") spec.threshold_seconds = t.threshold_seconds;
+  if (typeof t.page_threshold === "number") spec.page_threshold = t.page_threshold;
+  if (typeof t.page_name === "string") spec.page_name = t.page_name;
+  return spec;
+}
+function parseConversionConfig(raw) {
+  if (!raw || typeof raw !== "object") return null;
+  const obj = raw;
+  const servicesRaw = Array.isArray(obj.services) ? obj.services : [];
+  const services = servicesRaw.flatMap((entry) => {
+    if (!entry || typeof entry !== "object") return [];
+    const s = entry;
+    if (typeof s.key !== "string") return [];
+    return [
+      {
+        key: s.key,
+        label: typeof s.label === "string" ? s.label : void 0,
+        firing: parseFiring(s.firing)
+      }
+    ];
+  });
+  const goalsRaw = Array.isArray(obj.goals) ? obj.goals : null;
+  const goals = goalsRaw ? goalsRaw.flatMap((entry) => {
+    if (!entry || typeof entry !== "object") return [];
+    const g = entry;
+    if (typeof g.key !== "string") return [];
+    return [
+      {
+        key: g.key,
+        label: typeof g.label === "string" ? g.label : void 0,
+        kind: g.kind === "event" ? "event" : "sale",
+        trigger: parseTrigger(g.trigger),
+        firing: parseFiring(g.firing)
+      }
+    ];
+  }) : services.map((s) => ({
+    key: s.key,
+    label: s.label,
+    kind: "sale",
+    trigger: null,
+    firing: s.firing
+  }));
+  return {
+    schema_version: typeof obj.schema_version === "number" ? obj.schema_version : 1,
+    config_version: typeof obj.config_version === "number" ? obj.config_version : 0,
+    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,
+    gtag_ids: isStringMap(obj.gtag_ids) ? obj.gtag_ids : {},
+    meta_pixel_ids: isStringMap(obj.meta_pixel_ids) ? obj.meta_pixel_ids : {},
+    services,
+    goals
+  };
+}
+var CACHE_PREFIX = "_aranova_cfg_";
+function cacheKey(url) {
+  return `${CACHE_PREFIX}${url}`;
+}
+function readCache(url) {
+  if (typeof window === "undefined") return null;
+  try {
+    const raw = window.sessionStorage.getItem(cacheKey(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 writeCache(url, entry) {
+  if (typeof window === "undefined") return;
+  try {
+    window.sessionStorage.setItem(cacheKey(url), JSON.stringify(entry));
+  } catch {
+  }
+}
+function resolveConversionConfig(options) {
+  const cached = readCache(options.cdnUrl);
+  let current = cached?.config ?? options.baked ?? null;
+  let etag = cached?.etag ?? null;
+  const goalsByKey = /* @__PURE__ */ new Map();
+  function rebuildIndex() {
+    goalsByKey.clear();
+    for (const goal of current?.goals ?? []) {
+      goalsByKey.set(goal.key, goal);
+    }
+  }
+  function adopt(next, nextEtag) {
+    if (!next) return;
+    if (current && next.config_version <= current.config_version) return;
+    current = next;
+    etag = nextEtag;
+    rebuildIndex();
+    writeCache(options.cdnUrl, { etag, config: next });
+  }
+  async function revalidate() {
+    if (typeof window === "undefined") return;
+    try {
+      const doFetch = options.fetchImpl ?? globalThis.fetch;
+      if (!doFetch) return;
+      const headers = {};
+      if (etag) headers["If-None-Match"] = etag;
+      const response = await doFetch(options.cdnUrl, {
+        method: "GET",
+        headers
+      });
+      if (response.status === 304 || !response.ok) return;
+      adopt(parseConversionConfig(await response.json()), response.headers.get("ETag"));
+    } catch {
+    }
+  }
+  rebuildIndex();
+  void revalidate();
+  return {
+    getFiring: (key) => goalsByKey.get(key)?.firing ?? null,
+    getGoal: (key) => goalsByKey.get(key) ?? null,
+    listGoals: () => [...goalsByKey.values()],
+    current: () => current,
+    revalidate
+  };
+}
+
+// ../tracking-core/src/resources/sales/money.ts
+var MINOR_UNIT_EXPONENT = {
+  USD: 2,
+  CAD: 2
+};
+function exponentFor(currency) {
+  return MINOR_UNIT_EXPONENT[currency] ?? 2;
+}
+function toMinor(amount, currency) {
+  return Math.round(amount * 10 ** exponentFor(currency));
+}
+function fromMinor(cents, currency) {
+  return cents / 10 ** exponentFor(currency);
+}
+function formatMoney(cents, currency, locale) {
+  return new Intl.NumberFormat(locale, { style: "currency", currency }).format(
+    fromMinor(cents, currency)
+  );
+}
+function formatDateInTz(iso, timeZone, opts, locale) {
+  const date = new Date(iso);
+  if (Number.isNaN(date.getTime())) return iso;
+  return new Intl.DateTimeFormat(locale, {
+    year: "numeric",
+    month: "short",
+    day: "2-digit",
+    hour: "2-digit",
+    minute: "2-digit",
+    ...opts,
+    timeZone
+  }).format(date);
+}
+
+// ../tracking-core/src/resources/conversion-autofire.ts
+function thresholdMet(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":
+      return true;
+    // no threshold — fire whenever the detector emits
+    default:
+      return false;
+  }
+}
+function currentPath() {
+  return typeof window === "undefined" ? "" : window.location.pathname;
+}
+function createConversionAutoFire(store) {
+  return {
+    onAutomaticEvent(eventType, metadata) {
+      for (const goal of store.listGoals()) {
+        if (goal.kind !== "event" || !goal.firing) continue;
+        if (!thresholdMet(goal, eventType, metadata)) continue;
+        const firing = goal.firing;
+        const cents = firing.value_cents ?? null;
+        const currency = firing.currency ?? null;
+        fireConversionWithConsent({
+          sendTo: firing.send_to,
+          value: cents != null && currency ? fromMinor(cents, currency) : null,
+          currency,
+          // Page-scoped txn id → fire once per (goal, path) per session; engagement conversions
+          // shouldn't re-fire as the visitor scrolls back and forth or re-enters a page.
+          transactionId: `auto:${goal.key}:${currentPath()}`
+        });
+      }
+    }
+  };
+}
+function withConversionAutoFire(client, autoFire) {
+  return {
+    ...client,
+    trackEvent: (input) => {
+      client.trackEvent(input);
+      try {
+        autoFire.onAutomaticEvent(input.eventType, input.metadata ?? {});
+      } catch {
+      }
+    }
+  };
+}
+
 // ../tracking-core/src/session.ts
 var VISITOR_STORAGE_KEY = "aranova_tracking_visitor";
 var SESSION_STORAGE_KEY = "aranova_tracking_session";
@@ -1124,7 +1441,7 @@ function attachScrollDepth(client, config) {
   }
   const thresholds = new Set(config.thresholds);
   let firedForPath = /* @__PURE__ */ new Set();
-  let currentPath = window.location.pathname;
+  let currentPath2 = window.location.pathname;
   let rafId = null;
   function getScrollPercent() {
     const doc = document.documentElement;
@@ -1143,7 +1460,7 @@ function attachScrollDepth(client, config) {
           eventType: "scroll_depth",
           metadata: {
             depth_percent: threshold,
-            page: { path: currentPath }
+            page: { path: currentPath2 }
           },
           pageUrl: window.location.href,
           occurredAt: null
@@ -1160,8 +1477,8 @@ function attachScrollDepth(client, config) {
   }
   function resetIfPathChanged() {
     const newPath = window.location.pathname;
-    if (newPath === currentPath) return;
-    currentPath = newPath;
+    if (newPath === currentPath2) return;
+    currentPath2 = newPath;
     firedForPath = /* @__PURE__ */ new Set();
     setTimeout(checkThresholds, 0);
   }
@@ -1197,7 +1514,7 @@ function attachFormStart(client, config) {
   }
   const selector = config.selector ?? "form";
   let firedForms = /* @__PURE__ */ new Set();
-  let currentPath = window.location.pathname;
+  let currentPath2 = window.location.pathname;
   function getFormKey(form) {
     if (form.id) return `id:${form.id}`;
     const explicitAction = form.getAttribute("action");
@@ -1228,8 +1545,8 @@ function attachFormStart(client, config) {
   }
   function resetIfPathChanged() {
     const newPath = window.location.pathname;
-    if (newPath === currentPath) return;
-    currentPath = newPath;
+    if (newPath === currentPath2) return;
+    currentPath2 = newPath;
     firedForms = /* @__PURE__ */ new Set();
   }
   const originalPushState = history.pushState.bind(history);
@@ -1308,21 +1625,64 @@ async function salesRequest(config, method, path, body) {
 }
 
 // ../tracking-core/src/resources/sales/client.ts
+function fireRecordedConversions(firing, input, recorded, sale, currency) {
+  if (!firing) return;
+  const txnBase = input.external_id ?? sale.id;
+  for (const item of recorded) {
+    if (!item.service) continue;
+    const config = firing.getFiring(item.service);
+    if (!config) continue;
+    const cents = item.amount_cents ?? config.value_cents ?? null;
+    fireConversionWithConsent({
+      sendTo: config.send_to,
+      value: cents != null ? fromMinor(cents, currency) : null,
+      currency: config.currency ?? currency,
+      transactionId: `${txnBase}:${item.service}`
+    });
+  }
+}
 function createSalesClient(config) {
-  return {
-    async record(input) {
-      const currency = input.currency ?? config.defaultCurrency;
-      if (!currency) {
-        throw new Error(
-          "record: `currency` is required (pass it on the sale or set config.defaultCurrency)"
-        );
+  async function record(input) {
+    const currency = input.currency ?? config.defaultCurrency;
+    if (!currency) {
+      throw new Error(
+        "record: `currency` is required (pass it on the sale or set config.defaultCurrency)"
+      );
+    }
+    const body = {
+      ...input,
+      currency,
+      occurred_at: input.occurred_at ?? (/* @__PURE__ */ new Date()).toISOString()
+    };
+    const sale = await salesRequest(config, "POST", "/sales", body);
+    const recorded = input.services?.length ? input.services.map((s) => ({
+      service: s.service,
+      amount_cents: s.amount_cents
+    })) : [
+      {
+        service: input.service,
+        amount_cents: input.amount_total_cents ?? null
       }
-      const body = {
-        ...input,
+    ];
+    fireRecordedConversions(config.firing, input, recorded, sale, currency);
+    return sale;
+  }
+  return {
+    record,
+    // recordSale is the intent-revealing alias — same behavior, clearer call site.
+    recordSale: record,
+    trackConversion(key, options) {
+      const firing = config.firing?.getFiring(key);
+      if (!firing) return;
+      const currency = firing.currency ?? options?.currency ?? config.defaultCurrency ?? null;
+      const cents = firing.value_cents ?? null;
+      const value = options?.value ?? (cents != null && currency ? fromMinor(cents, currency) : null);
+      fireConversionWithConsent({
+        sendTo: firing.send_to,
+        value,
         currency,
-        occurred_at: input.occurred_at ?? (/* @__PURE__ */ new Date()).toISOString()
-      };
-      return salesRequest(config, "POST", "/sales", body);
+        transactionId: options?.transactionId ?? null
+      });
     },
     async list(query) {
       const { cursor, limit, sort, order, want_total, ...filters } = query ?? {};
@@ -1416,39 +1776,6 @@ function createSalesClient(config) {
   };
 }
 
-// ../tracking-core/src/resources/sales/money.ts
-var MINOR_UNIT_EXPONENT = {
-  USD: 2,
-  CAD: 2
-};
-function exponentFor(currency) {
-  return MINOR_UNIT_EXPONENT[currency] ?? 2;
-}
-function toMinor(amount, currency) {
-  return Math.round(amount * 10 ** exponentFor(currency));
-}
-function fromMinor(cents, currency) {
-  return cents / 10 ** exponentFor(currency);
-}
-function formatMoney(cents, currency, locale) {
-  return new Intl.NumberFormat(locale, { style: "currency", currency }).format(
-    fromMinor(cents, currency)
-  );
-}
-function formatDateInTz(iso, timeZone, opts, locale) {
-  const date = new Date(iso);
-  if (Number.isNaN(date.getTime())) return iso;
-  return new Intl.DateTimeFormat(locale, {
-    year: "numeric",
-    month: "short",
-    day: "2-digit",
-    hour: "2-digit",
-    minute: "2-digit",
-    ...opts,
-    timeZone
-  }).format(date);
-}
-
 // ../tracking-core/src/resources/sales/schema.ts
 var import_zod11 = require("zod");
 var SUPPORTED_CURRENCIES = ["USD", "CAD"];
@@ -1913,7 +2240,7 @@ function GoogleAdsTracking(props) {
 var import_navigation = require("next/navigation");
 
 // package.json
-var version = "0.13.0";
+var version = "0.14.0";
 
 // src/factory.tsx
 var import_react4 = require("react");
@@ -2007,7 +2334,7 @@ var PhoneField = (0, import_react3.forwardRef)(function PhoneField2({ country, v
 // src/factory.tsx
 var import_jsx_runtime5 = require("react/jsx-runtime");
 function createTracking(options) {
-  const { apiKey, endpoint, triggers, environment, gtagIds, debug, phone } = options;
+  const { apiKey, endpoint, triggers, environment, gtagIds, debug, phone, conversionConfig } = options;
   if (!apiKey || !endpoint) {
     if (apiKey || endpoint) {
       console.warn(
@@ -2051,6 +2378,17 @@ function createTracking(options) {
       ),
       []
     );
+    const conversionStore = (0, import_react4.useMemo)(
+      () => conversionConfig ? resolveConversionConfig({
+        cdnUrl: conversionConfig.cdnUrl,
+        baked: conversionConfig.baked
+      }) : null,
+      []
+    );
+    const wrapClient = (0, import_react4.useMemo)(() => {
+      const autoFire = conversionStore ? createConversionAutoFire(conversionStore) : null;
+      return (c) => autoFire ? withConversionAutoFire(c, autoFire) : c;
+    }, [conversionStore]);
     (0, import_react4.useEffect)(() => {
       const rawClient = getOrCreateTrackingClient({
         apiKey,
@@ -2062,7 +2400,7 @@ function createTracking(options) {
         activeGtagIds: gtagIds,
         debug
       });
-      fireManualPageView(rawClient);
+      fireManualPageView(wrapClient(rawClient));
     }, [pathname, searchParams]);
     const firedPagesRef = (0, import_react4.useRef)(/* @__PURE__ */ new Set());
     (0, import_react4.useEffect)(() => {
@@ -2077,14 +2415,18 @@ function createTracking(options) {
         activeGtagIds: gtagIds,
         debug
       });
+      const detectorClient = wrapClient(rawClient);
       for (const { name, pathPattern } of specificPageVisitConfig.pages) {
         if (!pathPattern.test(pathname)) continue;
         const key = `${name}:${pathname}`;
         if (firedPagesRef.current.has(key)) continue;
         firedPagesRef.current.add(key);
-        rawClient.trackEvent({
+        detectorClient.trackEvent({
           eventType: "specific_page_visit",
-          metadata: { page_name: name, page: { path: pathname } },
+          metadata: {
+            page_name: name,
+            page: { path: pathname }
+          },
           pageUrl: null,
           occurredAt: null
         });
@@ -2101,7 +2443,7 @@ function createTracking(options) {
         activeGtagIds: gtagIds,
         debug
       });
-      return attachBfcacheRestore(rawClient);
+      return attachBfcacheRestore(wrapClient(rawClient));
     }, []);
     (0, import_react4.useEffect)(() => {
       if (!timeOnSiteConfig) return;
@@ -2115,7 +2457,7 @@ function createTracking(options) {
         activeGtagIds: gtagIds,
         debug
       });
-      return attachTimeOnSite(rawClient, timeOnSiteConfig);
+      return attachTimeOnSite(wrapClient(rawClient), timeOnSiteConfig);
     }, []);
     const multiPageSessionConfig = triggers.automatic.multi_page_session ?? null;
     const mpsLastPathRef = (0, import_react4.useRef)(null);
@@ -2153,7 +2495,7 @@ function createTracking(options) {
             activeGtagIds: gtagIds,
             debug
           });
-          rawClient.trackEvent({
+          wrapClient(rawClient).trackEvent({
             eventType: "multi_page_session",
             metadata: {
               page_count: paths.size,
@@ -2178,13 +2520,14 @@ function createTracking(options) {
         activeGtagIds: gtagIds,
         debug
       });
+      const detectorClient = wrapClient(rawClient);
       const scrollDepth = triggers.automatic.scroll_depth;
       if (scrollDepth) {
-        detachers.push(attachScrollDepth(rawClient, scrollDepth));
+        detachers.push(attachScrollDepth(detectorClient, scrollDepth));
       }
       const formStart = triggers.automatic.form_start;
       if (formStart) {
-        detachers.push(attachFormStart(rawClient, formStart));
+        detachers.push(attachFormStart(detectorClient, formStart));
       }
       return () => {
         for (let i = detachers.length - 1; i >= 0; i--) {
@@ -2233,6 +2576,7 @@ function createTracking(options) {
   parsePhone,
   phoneField,
   resetConsent,
+  resolveConversionConfig,
   saleCreateSchema,
   saleItemSchema,
   saleServiceSchema,