@bidkernel/analytics 0.20.0 → 0.22.0

package/dist/index.js

@@ -30,7 +30,9 @@ __export(src_exports, {
   getbidkernel: () => getbidkernel,
   hookImaPrototype: () => hookImaPrototype,
   initImaInterception: () => initImaInterception,
+  isSessionActive: () => isSessionActive,
   isTrustedEndpoint: () => isTrustedEndpoint,
+  onSessionResume: () => onSessionResume,
   registerPrebidAnalytics: () => registerPrebidAnalytics
 });
 module.exports = __toCommonJS(src_exports);
@@ -354,6 +356,17 @@ var BidderOutcome = {
   BIDDER_OUTCOME_NO_RESPONSE: 5,
   UNRECOGNIZED: -1
 };
+var FloorSource = {
+  /** FLOOR_SOURCE_UNSPECIFIED - module off, no decision */
+  FLOOR_SOURCE_UNSPECIFIED: 0,
+  /** FLOOR_SOURCE_STATIC - the publisher's rule, scaled by the treatment */
+  FLOOR_SOURCE_STATIC: 1,
+  /** FLOOR_SOURCE_POOL - the bid pool's standing bid plus margin */
+  FLOOR_SOURCE_POOL: 2,
+  /** FLOOR_SOURCE_NONE - module on, but neither term applied */
+  FLOOR_SOURCE_NONE: 3,
+  UNRECOGNIZED: -1
+};
 function createBaseTraceEventBatch() {
   return {
     propertyId: new Uint8Array(0),
@@ -756,7 +769,15 @@ var TraceEvent_MetadataEntry = {
   }
 };
 function createBaseBidderOutcomeEntry() {
-  return { adUnitCode: "", outcome: 0, bid: void 0, refreshIndex: 0 };
+  return {
+    adUnitCode: "",
+    outcome: 0,
+    bid: void 0,
+    refreshIndex: 0,
+    floorCents: void 0,
+    floorSource: 0,
+    floorTreatmentBp: void 0
+  };
 }
 var BidderOutcomeEntry = {
   encode(message, writer = new import_wire.BinaryWriter()) {
@@ -772,6 +793,15 @@ var BidderOutcomeEntry = {
     if (message.refreshIndex !== void 0 && message.refreshIndex !== 0) {
       writer.uint32(56).int32(message.refreshIndex);
     }
+    if (message.floorCents !== void 0) {
+      writer.uint32(64).int32(message.floorCents);
+    }
+    if (message.floorSource !== void 0 && message.floorSource !== 0) {
+      writer.uint32(72).int32(message.floorSource);
+    }
+    if (message.floorTreatmentBp !== void 0) {
+      writer.uint32(80).int32(message.floorTreatmentBp);
+    }
     return writer;
   },
   decode(input, length) {
@@ -809,6 +839,27 @@ var BidderOutcomeEntry = {
           message.refreshIndex = reader.int32();
           continue;
         }
+        case 8: {
+          if (tag !== 64) {
+            break;
+          }
+          message.floorCents = reader.int32();
+          continue;
+        }
+        case 9: {
+          if (tag !== 72) {
+            break;
+          }
+          message.floorSource = reader.int32();
+          continue;
+        }
+        case 10: {
+          if (tag !== 80) {
+            break;
+          }
+          message.floorTreatmentBp = reader.int32();
+          continue;
+        }
       }
       if ((tag & 7) === 4 || tag === 0) {
         break;
@@ -1008,6 +1059,12 @@ var CACHED_BID_TTL_MS = 30 * 60 * 1e3;
 var MAX_CACHED_BID_KEYS = 200;
 var MAX_IMPRESSION_KEYS = 1e3;
 var MAX_TRACKED_AUCTIONS = 50;
+var MAX_FLOOR_DECISIONS = 200;
+var FLOOR_SOURCE_PROTO = {
+  static: FloorSource.FLOOR_SOURCE_STATIC,
+  pool: FloorSource.FLOOR_SOURCE_POOL,
+  none: FloorSource.FLOOR_SOURCE_NONE
+};
 var CLICK_DEDUP_MS = 1e3;
 var SESSION_KEY = "_bidkernel_session";
 var SESSION_TS_KEY = "_bidkernel_session_ts";
@@ -1083,49 +1140,83 @@ function sameEndpointOrigin(a, b) {
 }
 var SESSION_PERSIST_INTERVAL_MS = 60 * 1e3;
 var persistedSessionTs = 0;
-function persistSessionTs(now) {
+var ACTIVITY_EVENTS = ["pointerdown", "pointermove", "keydown", "scroll", "wheel", "touchstart"];
+var activityListenersBound = false;
+var sessionResumeListeners = /* @__PURE__ */ new Set();
+function persistSessionTs(ts) {
   try {
     if (typeof localStorage !== "undefined") {
-      localStorage.setItem(SESSION_TS_KEY, now.toString());
-      persistedSessionTs = now;
+      localStorage.setItem(SESSION_TS_KEY, ts.toString());
+      persistedSessionTs = ts;
     }
   } catch {
   }
 }
-function extendSession() {
+function isSessionActive(now = Date.now()) {
+  return inMemorySessionTs > 0 && now - inMemorySessionTs <= THIRTY_MINUTES_MS;
+}
+function onSessionResume(listener) {
+  bindActivityListeners();
+  sessionResumeListeners.add(listener);
+  return () => {
+    sessionResumeListeners.delete(listener);
+  };
+}
+function recordActivity() {
   const now = Date.now();
+  const lapsed = !!inMemorySessionId && !isSessionActive(now);
   inMemorySessionTs = now;
-  if (!storageAllowed) return;
+  if (lapsed) {
+    inMemorySessionId = null;
+    for (const listener of sessionResumeListeners) listener();
+    return;
+  }
+  if (!storageAllowed || !inMemorySessionId || persistedSessionTs === 0) return;
   if (now - persistedSessionTs < SESSION_PERSIST_INTERVAL_MS) return;
   persistSessionTs(now);
 }
+function sessionNeedsSync() {
+  return !inMemorySessionId || storageAllowed && persistedSessionTs === 0;
+}
+function bindActivityListeners() {
+  if (activityListenersBound || typeof window === "undefined") return;
+  activityListenersBound = true;
+  const onActivity = () => recordActivity();
+  for (const name of ACTIVITY_EVENTS) {
+    window.addEventListener(name, onActivity, { passive: true, capture: true });
+  }
+  if (typeof document !== "undefined") {
+    document.addEventListener("visibilitychange", () => {
+      if (document.visibilityState === "visible") recordActivity();
+    });
+  }
+}
 function getOrCreateSessionId() {
   const now = Date.now();
-  const memoryFresh = !!inMemorySessionId && !!inMemorySessionTs && now - inMemorySessionTs <= THIRTY_MINUTES_MS;
+  const memoryFresh = !!inMemorySessionId && isSessionActive(now);
   try {
     if (storageAllowed && typeof localStorage !== "undefined") {
       const storedId = localStorage.getItem(SESSION_KEY);
       const tsStr = localStorage.getItem(SESSION_TS_KEY);
       const storedTs = tsStr ? parseInt(tsStr, 10) || 0 : 0;
       if (storedId && storedTs && now - storedTs <= THIRTY_MINUTES_MS) {
-        persistSessionTs(now);
-        inMemorySessionId = storedId;
-        inMemorySessionTs = now;
+        if (inMemorySessionId !== storedId || inMemorySessionTs < storedTs) {
+          inMemorySessionId = storedId;
+          inMemorySessionTs = Math.max(inMemorySessionTs, storedTs);
+        }
+        if (persistedSessionTs === 0) persistedSessionTs = storedTs;
         return storedId;
       }
       const newId = memoryFresh ? inMemorySessionId : generateUUID();
+      if (!memoryFresh) inMemorySessionTs = now;
       localStorage.setItem(SESSION_KEY, newId);
-      persistSessionTs(now);
+      persistSessionTs(inMemorySessionTs);
       inMemorySessionId = newId;
-      inMemorySessionTs = now;
       return newId;
     }
   } catch {
   }
-  if (inMemorySessionId && inMemorySessionTs && now - inMemorySessionTs <= THIRTY_MINUTES_MS) {
-    inMemorySessionTs = now;
-    return inMemorySessionId;
-  }
+  if (memoryFresh) return inMemorySessionId;
   inMemorySessionId = generateUUID();
   inMemorySessionTs = now;
   return inMemorySessionId;
@@ -1284,7 +1375,13 @@ var BidkernelPrebidAnalytics = class _BidkernelPrebidAnalytics {
   videoDetachCleanups = /* @__PURE__ */ new Set();
   // Compacted bidder participation map per auction: auctionId -> Map<`${bidder}:${adUnitCode}`, BidderOutcomeEntry>
   auctionBidderOutcomes = /* @__PURE__ */ new Map();
+  // Live Floors decisions: `${auctionId}:${adUnitCode}` -> decision (see recordFloorDecision)
+  floorDecisions = /* @__PURE__ */ new Map();
   logger;
+  // True when this instance owns its session id (none was supplied), so the
+  // id follows the page-wide session as it lapses and restarts. An id the
+  // integration supplied is stamped as given.
+  managesSessionId;
   constructor(config) {
     if (config.storageAllowed !== void 0) {
       _BidkernelPrebidAnalytics.setStorageAllowed(config.storageAllowed);
@@ -1295,7 +1392,7 @@ var BidkernelPrebidAnalytics = class _BidkernelPrebidAnalytics {
       endpoint,
       propertyId: config.propertyId || "",
       pageviewId: config.pageviewId || generateUUID(),
-      sessionId: config.sessionId || getOrCreateSessionId(),
+      sessionId: config.sessionId || "",
       userId: config.userId || "",
       deviceType: config.deviceType || "desktop",
       country: config.country || "",
@@ -1314,6 +1411,9 @@ var BidkernelPrebidAnalytics = class _BidkernelPrebidAnalytics {
       prefix: "[bidkernel][prebid-analytics]",
       logLevel: this.config.logLevel
     });
+    recordActivity();
+    this.managesSessionId = !config.sessionId;
+    if (this.managesSessionId) this.config.sessionId = getOrCreateSessionId();
     if (requestedEndpoint && !endpoint) {
       this.log(
         "ERROR",
@@ -1362,6 +1462,7 @@ var BidkernelPrebidAnalytics = class _BidkernelPrebidAnalytics {
       if (typeof document !== "undefined") {
         document.addEventListener("visibilitychange", this.boundVisibilityChange);
       }
+      bindActivityListeners();
       this.flushTimer = setInterval(() => this.flush(), FLUSH_INTERVAL_MS);
       this.resendPersistedBatches();
     }
@@ -1471,6 +1572,7 @@ var BidkernelPrebidAnalytics = class _BidkernelPrebidAnalytics {
     this.slotEmittedImpressionKeys.clear();
     this.slotLastAuctionIds.clear();
     this.auctionBidderOutcomes.clear();
+    this.floorDecisions.clear();
     if (this.flushTimer) {
       clearInterval(this.flushTimer);
       this.flushTimer = null;
@@ -2230,15 +2332,44 @@ var BidkernelPrebidAnalytics = class _BidkernelPrebidAnalytics {
     if (eventType === void 0) return;
     this.enqueue(eventType, eventName, data, level);
   }
+  /**
+   * Record the wrapper's Live Floors decision for an auction and ad unit,
+   * before the auction runs. The decision is stamped on the auction's
+   * outcome entries for the ad unit at auction end and on the win and
+   * impression rows that follow, so every outcome can be split by floor,
+   * source and treatment without a join. Integrations without the module
+   * never call this and their rows carry no floor fields.
+   */
+  recordFloorDecision(auctionId, adUnitCode, decision) {
+    if (!auctionId || !adUnitCode) return;
+    const key = `${auctionId}:${adUnitCode}`;
+    this.floorDecisions.delete(key);
+    this.floorDecisions.set(key, {
+      floorCents: decision.floorCents !== void 0 && Number.isFinite(decision.floorCents) ? Math.round(decision.floorCents) : void 0,
+      source: decision.source,
+      treatment: Number.isFinite(decision.treatment) ? decision.treatment : 1
+    });
+    while (this.floorDecisions.size > MAX_FLOOR_DECISIONS) {
+      const oldest = this.floorDecisions.keys().next();
+      if (oldest.done) break;
+      this.floorDecisions.delete(oldest.value);
+    }
+  }
+  floorDecisionFor(auctionId, adUnitCode) {
+    return auctionId && adUnitCode ? this.floorDecisions.get(`${auctionId}:${adUnitCode}`) : void 0;
+  }
   setUserId(userId) {
     this.config.userId = userId;
   }
   setSessionId(sessionId) {
     this.config.sessionId = sessionId;
+    this.managesSessionId = !sessionId;
+    if (this.managesSessionId) this.config.sessionId = getOrCreateSessionId();
   }
   navigate(pageviewId, pageUrl) {
     this.disable();
     this.slotRefreshIndices.clear();
+    this.floorDecisions.clear();
     this.pendingThresholdListeners.clear();
     this.config.pageviewId = pageviewId || generateUUID();
     if (pageUrl) {
@@ -2252,7 +2383,7 @@ var BidkernelPrebidAnalytics = class _BidkernelPrebidAnalytics {
       this.pageUrl = "";
     }
     this.logger.resetTiming();
-    extendSession();
+    recordActivity();
     this.enable();
   }
   handleAuctionInit(data) {
@@ -2591,7 +2722,9 @@ var BidkernelPrebidAnalytics = class _BidkernelPrebidAnalytics {
   enqueue(type, eventName, data, level) {
     if (!this.isEnabled) return;
     if (!this.shouldSample(type, level)) return;
-    extendSession();
+    if (this.managesSessionId && sessionNeedsSync()) {
+      this.config.sessionId = getOrCreateSessionId();
+    }
     const protoEvent = {
       eventId: idToBytes(generateUUID()),
       timestampMs: Date.now(),
@@ -2626,13 +2759,32 @@ var BidkernelPrebidAnalytics = class _BidkernelPrebidAnalytics {
     }
     if (data.bidderOutcomes && Array.isArray(data.bidderOutcomes)) {
       protoEvent.bidderOutcomes = data.bidderOutcomes.map(
-        (entry) => ({
-          ...entry,
-          refreshIndex: entry.refreshIndex ?? this.auctionCycleIndex(entry.adUnitCode || "")
-        })
+        (entry) => {
+          const floor = this.floorDecisionFor(String(data.auctionId || ""), entry.adUnitCode || "");
+          return {
+            ...entry,
+            refreshIndex: entry.refreshIndex ?? this.auctionCycleIndex(entry.adUnitCode || ""),
+            ...floor ? {
+              floorCents: floor.floorCents,
+              floorSource: FLOOR_SOURCE_PROTO[floor.source],
+              floorTreatmentBp: Math.round(floor.treatment * 1e4)
+            } : {}
+          };
+        }
       );
     }
     const metadata = { ...data.metadata };
+    if (type === TraceEventType.BID_WIN || type === TraceEventType.IMPRESSION) {
+      const floor = this.floorDecisionFor(
+        String(data.auctionId || ""),
+        protoEvent.adUnitCode || ""
+      );
+      if (floor) {
+        if (floor.floorCents !== void 0) metadata.floor_cents = String(floor.floorCents);
+        metadata.floor_source = floor.source;
+        metadata.floor_treatment = floor.treatment.toFixed(2);
+      }
+    }
     if (data.error !== void 0 && data.error !== null) {
       metadata.error = typeof data.error === "object" && data.error.message ? String(data.error.message) : String(data.error);
     }
@@ -3841,6 +3993,8 @@ function getbidkernel(alias = "bidkernel") {
   getbidkernel,
   hookImaPrototype,
   initImaInterception,
+  isSessionActive,
   isTrustedEndpoint,
+  onSessionResume,
   registerPrebidAnalytics
 });