@bidkernel/analytics 0.17.0 → 0.19.0

package/dist/index.js

@@ -327,7 +327,6 @@ var TraceEventType = {
   TRACE_EVENT_TYPE_UNSPECIFIED: 0,
   AUCTION_START: 1,
   AUCTION_END: 2,
-  BID_RESPONSE: 3,
   BID_WIN: 4,
   /** IMPRESSION - ad rendered into DOM */
   IMPRESSION: 5,
@@ -358,14 +357,14 @@ var BidderOutcome = {
 };
 function createBaseTraceEventBatch() {
   return {
-    propertyId: "",
-    pageviewId: "",
-    sessionId: "",
+    propertyId: new Uint8Array(0),
+    pageviewId: new Uint8Array(0),
+    sessionId: new Uint8Array(0),
     pageUrl: "",
     country: "",
     region: "",
     deviceType: "",
-    userId: "",
+    userId: new Uint8Array(0),
     domain: "",
     events: [],
     browser: "",
@@ -377,14 +376,14 @@ function createBaseTraceEventBatch() {
 }
 var TraceEventBatch = {
   encode(message, writer = new import_wire.BinaryWriter()) {
-    if (message.propertyId !== void 0 && message.propertyId !== "") {
-      writer.uint32(10).string(message.propertyId);
+    if (message.propertyId !== void 0 && message.propertyId.length !== 0) {
+      writer.uint32(10).bytes(message.propertyId);
     }
-    if (message.pageviewId !== void 0 && message.pageviewId !== "") {
-      writer.uint32(18).string(message.pageviewId);
+    if (message.pageviewId !== void 0 && message.pageviewId.length !== 0) {
+      writer.uint32(18).bytes(message.pageviewId);
     }
-    if (message.sessionId !== void 0 && message.sessionId !== "") {
-      writer.uint32(26).string(message.sessionId);
+    if (message.sessionId !== void 0 && message.sessionId.length !== 0) {
+      writer.uint32(26).bytes(message.sessionId);
     }
     if (message.pageUrl !== void 0 && message.pageUrl !== "") {
       writer.uint32(34).string(message.pageUrl);
@@ -398,8 +397,8 @@ var TraceEventBatch = {
     if (message.deviceType !== void 0 && message.deviceType !== "") {
       writer.uint32(58).string(message.deviceType);
     }
-    if (message.userId !== void 0 && message.userId !== "") {
-      writer.uint32(66).string(message.userId);
+    if (message.userId !== void 0 && message.userId.length !== 0) {
+      writer.uint32(66).bytes(message.userId);
     }
     if (message.domain !== void 0 && message.domain !== "") {
       writer.uint32(74).string(message.domain);
@@ -437,21 +436,21 @@ var TraceEventBatch = {
           if (tag !== 10) {
             break;
           }
-          message.propertyId = reader.string();
+          message.propertyId = reader.bytes();
           continue;
         }
         case 2: {
           if (tag !== 18) {
             break;
           }
-          message.pageviewId = reader.string();
+          message.pageviewId = reader.bytes();
           continue;
         }
         case 3: {
           if (tag !== 26) {
             break;
           }
-          message.sessionId = reader.string();
+          message.sessionId = reader.bytes();
           continue;
         }
         case 4: {
@@ -486,7 +485,7 @@ var TraceEventBatch = {
           if (tag !== 66) {
             break;
           }
-          message.userId = reader.string();
+          message.userId = reader.bytes();
           continue;
         }
         case 9: {
@@ -555,12 +554,12 @@ function createBaseTraceEvent() {
     timestampMs: 0,
     type: 0,
     eventName: "",
-    auctionId: "",
-    transactionId: "",
+    auctionId: new Uint8Array(0),
+    transactionId: new Uint8Array(0),
     adUnitCode: "",
     bid: void 0,
     namespace: "",
-    eventId: "",
+    eventId: new Uint8Array(0),
     metadata: {},
     viewableDurationMs: void 0,
     bidderOutcomes: []
@@ -577,11 +576,11 @@ var TraceEvent = {
     if (message.eventName !== void 0 && message.eventName !== "") {
       writer.uint32(26).string(message.eventName);
     }
-    if (message.auctionId !== void 0 && message.auctionId !== "") {
-      writer.uint32(34).string(message.auctionId);
+    if (message.auctionId !== void 0 && message.auctionId.length !== 0) {
+      writer.uint32(34).bytes(message.auctionId);
     }
-    if (message.transactionId !== void 0 && message.transactionId !== "") {
-      writer.uint32(42).string(message.transactionId);
+    if (message.transactionId !== void 0 && message.transactionId.length !== 0) {
+      writer.uint32(42).bytes(message.transactionId);
     }
     if (message.adUnitCode !== void 0 && message.adUnitCode !== "") {
       writer.uint32(50).string(message.adUnitCode);
@@ -592,8 +591,8 @@ var TraceEvent = {
     if (message.namespace !== void 0 && message.namespace !== "") {
       writer.uint32(66).string(message.namespace);
     }
-    if (message.eventId !== void 0 && message.eventId !== "") {
-      writer.uint32(74).string(message.eventId);
+    if (message.eventId !== void 0 && message.eventId.length !== 0) {
+      writer.uint32(74).bytes(message.eventId);
     }
     globalThis.Object.entries(message.metadata || {}).forEach(([key, value]) => {
       TraceEvent_MetadataEntry.encode({ key, value }, writer.uint32(82).fork()).join();
@@ -640,14 +639,14 @@ var TraceEvent = {
           if (tag !== 34) {
             break;
           }
-          message.auctionId = reader.string();
+          message.auctionId = reader.bytes();
           continue;
         }
         case 5: {
           if (tag !== 42) {
             break;
           }
-          message.transactionId = reader.string();
+          message.transactionId = reader.bytes();
           continue;
         }
         case 6: {
@@ -675,7 +674,7 @@ var TraceEvent = {
           if (tag !== 74) {
             break;
           }
-          message.eventId = reader.string();
+          message.eventId = reader.bytes();
           continue;
         }
         case 10: {
@@ -758,24 +757,18 @@ var TraceEvent_MetadataEntry = {
   }
 };
 function createBaseBidderOutcomeEntry() {
-  return { bidder: "", adUnitCode: "", mediaType: "", outcome: 0, latencyMs: 0 };
+  return { adUnitCode: "", outcome: 0, bid: void 0 };
 }
 var BidderOutcomeEntry = {
   encode(message, writer = new import_wire.BinaryWriter()) {
-    if (message.bidder !== void 0 && message.bidder !== "") {
-      writer.uint32(10).string(message.bidder);
-    }
     if (message.adUnitCode !== void 0 && message.adUnitCode !== "") {
       writer.uint32(18).string(message.adUnitCode);
     }
-    if (message.mediaType !== void 0 && message.mediaType !== "") {
-      writer.uint32(26).string(message.mediaType);
-    }
     if (message.outcome !== void 0 && message.outcome !== 0) {
       writer.uint32(32).int32(message.outcome);
     }
-    if (message.latencyMs !== void 0 && message.latencyMs !== 0) {
-      writer.uint32(41).double(message.latencyMs);
+    if (message.bid !== void 0) {
+      BidTrace.encode(message.bid, writer.uint32(50).fork()).join();
     }
     return writer;
   },
@@ -786,13 +779,6 @@ var BidderOutcomeEntry = {
     while (reader.pos < end) {
       const tag = reader.uint32();
       switch (tag >>> 3) {
-        case 1: {
-          if (tag !== 10) {
-            break;
-          }
-          message.bidder = reader.string();
-          continue;
-        }
         case 2: {
           if (tag !== 18) {
             break;
@@ -800,13 +786,6 @@ var BidderOutcomeEntry = {
           message.adUnitCode = reader.string();
           continue;
         }
-        case 3: {
-          if (tag !== 26) {
-            break;
-          }
-          message.mediaType = reader.string();
-          continue;
-        }
         case 4: {
           if (tag !== 32) {
             break;
@@ -814,11 +793,11 @@ var BidderOutcomeEntry = {
           message.outcome = reader.int32();
           continue;
         }
-        case 5: {
-          if (tag !== 41) {
+        case 6: {
+          if (tag !== 50) {
             break;
           }
-          message.latencyMs = reader.double();
+          message.bid = BidTrace.decode(reader, reader.uint32());
           continue;
         }
       }
@@ -965,8 +944,28 @@ var BidTrace = {
   }
 };
 
+// src/ids.ts
+var CANONICAL_UUID = /^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/;
+var UUID_BYTES = 16;
+var utf8Encoder = typeof TextEncoder !== "undefined" ? new TextEncoder() : null;
+var utf8Decoder = typeof TextDecoder !== "undefined" ? new TextDecoder() : null;
+function idToBytes(id) {
+  if (!id) return new Uint8Array(0);
+  if (CANONICAL_UUID.test(id)) {
+    const hex = id.replace(/-/g, "");
+    const out2 = new Uint8Array(UUID_BYTES);
+    for (let i = 0; i < UUID_BYTES; i++) {
+      out2[i] = parseInt(hex.slice(i * 2, i * 2 + 2), 16);
+    }
+    return out2;
+  }
+  if (utf8Encoder) return utf8Encoder.encode(id);
+  const out = new Uint8Array(id.length);
+  for (let i = 0; i < id.length; i++) out[i] = id.charCodeAt(i) & 255;
+  return out;
+}
+
 // src/prebid-analytics.ts
-var BATCH_SIZE = 20;
 var FLUSH_INTERVAL_MS = 1e4;
 var MAX_ERRORS_PER_SESSION = 50;
 var MAX_QUEUE_SIZE = 200;
@@ -983,7 +982,6 @@ var PENDING_BATCH_CLEANUP_DELAY_MS = 1e4;
 var EVENT_NAME_TO_TYPE = {
   auctionStart: TraceEventType.AUCTION_START,
   auctionEnd: TraceEventType.AUCTION_END,
-  bidResponse: TraceEventType.BID_RESPONSE,
   bidWin: TraceEventType.BID_WIN,
   adRenderFailed: TraceEventType.AD_RENDER_FAILED,
   click: TraceEventType.CLICK,
@@ -2243,7 +2241,8 @@ var BidkernelPrebidAnalytics = class _BidkernelPrebidAnalytics {
     }
   }
   trackRawEvent(level, eventName, data) {
-    const eventType = EVENT_NAME_TO_TYPE[eventName] ?? (level === "ERROR" ? TraceEventType.ERROR : TraceEventType.TRACE_EVENT_TYPE_UNSPECIFIED);
+    const eventType = EVENT_NAME_TO_TYPE[eventName] ?? (level === "ERROR" ? TraceEventType.ERROR : void 0);
+    if (eventType === void 0) return;
     this.enqueue(eventType, eventName, data, level);
   }
   setUserId(userId) {
@@ -2314,11 +2313,9 @@ var BidkernelPrebidAnalytics = class _BidkernelPrebidAnalytics {
         const key = `${bidder}:${adUnitCode}`;
         if (!auctionMap.has(key)) {
           auctionMap.set(key, {
-            bidder,
             adUnitCode,
-            mediaType,
             outcome: BidderOutcome.BIDDER_OUTCOME_NO_RESPONSE,
-            latencyMs: 0
+            bid: { bidder, mediaType, latencyMs: 0 }
           });
         }
       });
@@ -2334,43 +2331,23 @@ var BidkernelPrebidAnalytics = class _BidkernelPrebidAnalytics {
     const latencyMs = Number.isFinite(data.timeToRespond) ? data.timeToRespond : 0;
     const resMediaTypes = Object.keys(data.mediaTypes || {});
     const mediaType = data.mediaType || (data.mediaTypes?.video ? "video" : resMediaTypes.length > 0 ? resMediaTypes[0] : "banner");
-    if (auctionId && bidder) {
-      const auctionMap = this.getOrCreateAuctionOutcomes(auctionId);
-      const key = `${bidder}:${adUnitCode}`;
-      const entry = auctionMap.get(key);
-      const outcome = cpm > 0 ? BidderOutcome.BIDDER_OUTCOME_BID : BidderOutcome.BIDDER_OUTCOME_NO_BID;
-      if (entry) {
-        entry.outcome = outcome;
-        entry.latencyMs = latencyMs;
-        if (mediaType) entry.mediaType = mediaType;
-      } else {
-        auctionMap.set(key, {
-          bidder,
-          adUnitCode,
-          mediaType,
-          outcome,
-          latencyMs
-        });
-      }
-    }
-    if (cpm > 0) {
-      this.enqueue(TraceEventType.BID_RESPONSE, "bidResponse", {
-        auctionId,
-        transactionId: data.transactionId || "",
-        adUnitCode,
-        bid: {
-          bidder,
-          cpm,
-          currency: data.originalCurrency ?? data.currency ?? "USD",
-          ...parseBidDimensions(data),
-          dealId: data.dealId || "",
-          mediaType,
-          latencyMs,
-          advertiserDomain: data.meta?.advertiserDomains?.[0] || "",
-          creativeId: data.creativeId || ""
-        }
-      });
-    }
+    if (!auctionId || !bidder) return;
+    const bid = cpm > 0 ? {
+      bidder,
+      cpm,
+      currency: data.originalCurrency ?? data.currency ?? "USD",
+      ...parseBidDimensions(data),
+      dealId: data.dealId || "",
+      mediaType,
+      latencyMs,
+      advertiserDomain: data.meta?.advertiserDomains?.[0] || "",
+      creativeId: data.creativeId || ""
+    } : { bidder, mediaType, latencyMs };
+    this.getOrCreateAuctionOutcomes(auctionId).set(`${bidder}:${adUnitCode}`, {
+      adUnitCode,
+      outcome: cpm > 0 ? BidderOutcome.BIDDER_OUTCOME_BID : BidderOutcome.BIDDER_OUTCOME_NO_BID,
+      bid
+    });
   }
   handleBidTimeout(data) {
     if (this.isDuplicate("bidTimeout", data)) return;
@@ -2387,14 +2364,12 @@ var BidkernelPrebidAnalytics = class _BidkernelPrebidAnalytics {
         const entry = auctionMap.get(key);
         if (entry) {
           entry.outcome = BidderOutcome.BIDDER_OUTCOME_TIMEOUT;
-          if (latencyMs > 0) entry.latencyMs = latencyMs;
+          if (latencyMs > 0 && entry.bid) entry.bid.latencyMs = latencyMs;
         } else {
           auctionMap.set(key, {
-            bidder,
             adUnitCode,
-            mediaType: "banner",
             outcome: BidderOutcome.BIDDER_OUTCOME_TIMEOUT,
-            latencyMs
+            bid: { bidder, mediaType: "banner", latencyMs }
           });
         }
       }
@@ -2463,11 +2438,9 @@ var BidkernelPrebidAnalytics = class _BidkernelPrebidAnalytics {
         }
       } else {
         auctionMap.set(key, {
-          bidder,
           adUnitCode,
-          mediaType: "banner",
           outcome: BidderOutcome.BIDDER_OUTCOME_NO_BID,
-          latencyMs: 0
+          bid: { bidder, mediaType: "banner", latencyMs: 0 }
         });
       }
     }
@@ -2630,12 +2603,14 @@ var BidkernelPrebidAnalytics = class _BidkernelPrebidAnalytics {
     if (!this.shouldSample(type, level)) return;
     extendSession();
     const protoEvent = {
-      eventId: generateUUID(),
+      eventId: idToBytes(generateUUID()),
       timestampMs: Date.now(),
       type,
-      eventName,
-      auctionId: data.auctionId || "",
-      transactionId: data.transactionId || "",
+      // Typed events have a fixed name that ingest derives from `type`; only
+      // ERROR events carry theirs, which names the failure.
+      eventName: type === TraceEventType.ERROR ? eventName : "",
+      auctionId: idToBytes(String(data.auctionId || "")),
+      transactionId: idToBytes(String(data.transactionId || "")),
       adUnitCode: data.adUnitCode || data.elementId || "",
       namespace: data.ns || data.namespace || ""
     };
@@ -2643,9 +2618,9 @@ var BidkernelPrebidAnalytics = class _BidkernelPrebidAnalytics {
       protoEvent.bid = {
         bidder: data.bid.bidder || "",
         cpm: Number.isFinite(data.bid.cpm) ? data.bid.cpm : 0,
-        // No defaults here: handlers with a priced bid (bidResponse, bidWon,
-        // impression) set currency/mediaType themselves. Defaulting for the
-        // rest would stamp fake "USD"/"banner" on noBid and bidRequest rows.
+        // No defaults here: handlers with a priced bid (bidWon, impression)
+        // set currency/mediaType themselves. Defaulting for the rest would
+        // stamp fake "USD"/"banner" on rows that carried no bid.
         currency: data.bid.currency || "",
         width: Number.isFinite(data.bid.width) ? data.bid.width : 0,
         height: Number.isFinite(data.bid.height) ? data.bid.height : 0,
@@ -2677,11 +2652,11 @@ var BidkernelPrebidAnalytics = class _BidkernelPrebidAnalytics {
       protoEvent.metadata = boundedMetadata;
     }
     this.queue.push(protoEvent);
-    if (this.queue.length > MAX_QUEUE_SIZE) {
-      this.queue.splice(0, this.queue.length - MAX_QUEUE_SIZE);
-    }
-    if (this.queue.length >= BATCH_SIZE) {
+    if (this.queue.length >= MAX_QUEUE_SIZE) {
       this.flush();
+      if (this.queue.length > MAX_QUEUE_SIZE) {
+        this.queue.splice(0, this.queue.length - MAX_QUEUE_SIZE);
+      }
     } else if (REVENUE_FLUSH_TYPES.has(type) && this.revenueFlushTimer === null) {
       this.revenueFlushTimer = setTimeout(() => {
         this.revenueFlushTimer = null;
@@ -2713,14 +2688,14 @@ var BidkernelPrebidAnalytics = class _BidkernelPrebidAnalytics {
     if (this.queue.length === 0 || !this.config.endpoint) return null;
     const domain = typeof window !== "undefined" ? window.location.hostname : "";
     const buildBatch = (evts) => ({
-      propertyId: this.config.propertyId,
-      pageviewId: this.config.pageviewId,
-      sessionId: this.config.sessionId,
+      propertyId: idToBytes(this.config.propertyId),
+      pageviewId: idToBytes(this.config.pageviewId),
+      sessionId: idToBytes(this.config.sessionId),
       pageUrl: this.pageUrl,
       country: this.config.country,
       region: this.config.region,
       deviceType: this.config.deviceType,
-      userId: this.config.userId,
+      userId: idToBytes(this.config.userId),
       domain,
       events: evts
     });
@@ -2740,7 +2715,7 @@ var BidkernelPrebidAnalytics = class _BidkernelPrebidAnalytics {
         const [dropped] = this.queue.splice(0, 1);
         this.log(
           "WARN",
-          `Dropping oversized event ${dropped?.eventName || dropped?.eventId} (${encoded.byteLength} bytes exceeds the ${MAX_PAYLOAD_BYTES}-byte cap on its own)`
+          `Dropping oversized event (type ${dropped?.type}, ${encoded.byteLength} bytes exceeds the ${MAX_PAYLOAD_BYTES}-byte cap on its own)`
         );
         continue;
       }
@@ -3066,6 +3041,62 @@ function registerPrebidAnalytics(pbjsGlobalName = "pbjs", defaults) {
 // src/video.ts
 var internals = (analytics) => analytics;
 var adsLoaderListenerMap = /* @__PURE__ */ new WeakMap();
+var adsLoadersWithErrorListener = /* @__PURE__ */ new WeakSet();
+function describeImaError(event) {
+  const err = typeof event?.getError === "function" ? event.getError() : event?.error || event;
+  const call = (name) => err && typeof err[name] === "function" ? err[name]() : void 0;
+  const message = call("getMessage") || err?.message || String(err || "IMA ad error");
+  const code = call("getErrorCode") ?? err?.code;
+  const vastCode = call("getVastErrorCode");
+  const type = call("getType") ?? err?.type;
+  const metadata = { message };
+  if (code) metadata.error_code = String(code);
+  if (vastCode) metadata.vast_error_code = String(vastCode);
+  if (type) metadata.error_type = String(type);
+  return { err, message, metadata };
+}
+function recordImaAdError(analytics, event, ctx) {
+  const self = internals(analytics);
+  const { err, message, metadata } = describeImaError(event);
+  self.log("WARN", "IMA AdErrorEvent received", event);
+  self.enqueue(TraceEventType.AD_RENDER_FAILED, "adRenderFailed", {
+    auctionId: ctx.auctionId,
+    transactionId: ctx.transactionId,
+    adUnitCode: ctx.adUnitCode,
+    bid: ctx.bid,
+    metadata: {
+      ...ctx.metadata,
+      reason: ctx.adStarted ? "ima_playback_error" : "ima_ad_error",
+      playback_phase: ctx.adStarted ? "post_start" : "pre_start",
+      ...metadata
+    },
+    error: typeof err === "object" ? err : new Error(message)
+  });
+  return err;
+}
+function ensureAdsLoaderErrorListener(loader, addEventListener) {
+  if (!loader || typeof loader !== "object" || adsLoadersWithErrorListener.has(loader)) return;
+  adsLoadersWithErrorListener.add(loader);
+  const type = typeof window !== "undefined" && window.google?.ima?.AdErrorEvent?.Type?.AD_ERROR || "adError";
+  try {
+    addEventListener.call(loader, type, (event) => {
+      for (const instance of BidkernelPrebidAnalytics.getActiveInstances()) {
+        try {
+          const cached = findCachedWinningBid(instance, { mediaType: "video" });
+          recordImaAdError(instance, event, {
+            adStarted: false,
+            adUnitCode: cached?.adUnitCode || "video",
+            auctionId: cached?.auctionId,
+            transactionId: cached?.transactionId,
+            bid: cached?.bidTrace
+          });
+        } catch {
+        }
+      }
+    });
+  } catch {
+  }
+}
 function hookAdsManagerLoadedEvent(loadedEventCtor) {
   if (!loadedEventCtor) return;
   try {
@@ -3133,6 +3164,7 @@ function hookAdsLoader(adsLoaderCtor) {
     if (typeof proto.addEventListener === "function" && !proto.addEventListener.__bidkernelHooked) {
       const origAddEventListener = proto.addEventListener;
       const hookedAddEventListener = function(type, listener, ...rest) {
+        ensureAdsLoaderErrorListener(this, origAddEventListener);
         if ((type === "adsManagerLoaded" || type === (this?.AdsManagerLoadedEvent?.Type?.ADS_MANAGER_LOADED || "adsManagerLoaded")) && typeof listener === "function") {
           let wrappedListener = adsLoaderListenerMap.get(listener);
           if (!wrappedListener) {
@@ -3488,25 +3520,15 @@ function attachImaAdsManager(analytics, adsManager, options) {
     });
   };
   const onAdError = (event) => {
-    self.log("WARN", "IMA AdErrorEvent received", event);
-    const err = typeof event?.getError === "function" ? event.getError() : event?.error || event;
-    const msg = (err && typeof err.getMessage === "function" ? err.getMessage() : err?.message) || String(err || "IMA ad error");
-    const code = (err && typeof err.getErrorCode === "function" ? err.getErrorCode() : err?.code) || "";
     const cached = getWinningBid();
     const resolvedAdUnitCode = options?.adUnitCode && options.adUnitCode !== "video" ? options.adUnitCode : cached?.adUnitCode || slotId;
-    self.enqueue(TraceEventType.AD_RENDER_FAILED, "adRenderFailed", {
+    const err = recordImaAdError(analytics, event, {
+      adStarted,
+      adUnitCode: resolvedAdUnitCode,
       auctionId: auctionId || cached?.auctionId,
       transactionId: transactionId || cached?.transactionId,
-      adUnitCode: resolvedAdUnitCode,
       bid: cached?.bidTrace || options?.bid,
-      metadata: {
-        ...options?.metadata,
-        reason: adStarted ? "ima_playback_error" : "ima_ad_error",
-        playback_phase: adStarted ? "post_start" : "pre_start",
-        message: msg,
-        ...code ? { ima_error_code: String(code) } : {}
-      },
-      error: typeof err === "object" ? err : new Error(msg)
+      metadata: options?.metadata
     });
     if (options?.onError) {
       try {
@@ -3686,7 +3708,7 @@ function attachVideoPlayer(analytics, target, options) {
         ...options?.metadata,
         reason: "html5_video_error",
         message: msg,
-        ...err?.code ? { video_error_code: String(err.code) } : {}
+        ...err?.code ? { error_code: String(err.code) } : {}
       },
       error: err ? new Error(msg) : void 0
     });