@bidkernel/analytics 0.10.0 → 0.12.0

package/dist/index.mjs

@@ -1,3 +1,289 @@
+// ../logger/src/index.ts
+var LogLevel = {
+  DEBUG: "DEBUG",
+  INFO: "INFO",
+  WARN: "WARN",
+  ERROR: "ERROR"
+};
+var LOG_LEVEL_MAP = {
+  [LogLevel.DEBUG]: 10,
+  [LogLevel.INFO]: 20,
+  [LogLevel.WARN]: 30,
+  [LogLevel.ERROR]: 40
+};
+var COLORS = {
+  badge: "color: #2dd4bf; font-weight: bold",
+  // teal - [ads] badge
+  badgeWarn: "background: #f59e0b; color: #fff; padding: 2px 4px; border-radius: 3px; font-weight: bold",
+  // amber - [ads] badge (warning)
+  badgeError: "background: #ef4444; color: #fff; padding: 2px 4px; border-radius: 3px; font-weight: bold",
+  // red - [ads] badge (error)
+  dim: "color: #6b7280",
+  // gray - timestamp
+  event: "color: #38bdf8; font-weight: bold",
+  // blue - event name
+  eventWarn: "color: #f59e0b; font-weight: bold",
+  // amber - event name (warning)
+  eventError: "color: #ef4444; font-weight: bold",
+  // red - event name (error)
+  reset: "color: inherit"
+  // back to default
+};
+var logCounter = 0;
+var localGlobalListeners = /* @__PURE__ */ new Set();
+function getGlobalListeners() {
+  if (typeof window !== "undefined") {
+    const win = window;
+    if (!win.__bidkernelLogListeners) {
+      win.__bidkernelLogListeners = /* @__PURE__ */ new Set();
+    }
+    return win.__bidkernelLogListeners;
+  }
+  return localGlobalListeners;
+}
+function formatTime(ms) {
+  if (ms < 0 || !Number.isFinite(ms)) ms = 0;
+  if (ms < 1e3) return `${ms.toFixed(2)}ms`;
+  const s = ms / 1e3;
+  if (s < 60) return `${s.toFixed(2)}s`;
+  const m = Math.floor(s / 60);
+  if (m < 60) return `${m}m ${(s % 60).toFixed(2)}s`;
+  const h = Math.floor(m / 60);
+  return `${h}h ${m % 60}m ${(s % 60).toFixed(2)}s`;
+}
+function normalizeLogLevel(level) {
+  if (typeof level === "string") {
+    const upper = level.toUpperCase();
+    if (upper === "DEBUG" || upper === "INFO" || upper === "WARN" || upper === "ERROR") {
+      return upper;
+    }
+  }
+  return LogLevel.INFO;
+}
+var Logger = class _Logger {
+  _prefix;
+  _level;
+  _loadedAt;
+  _now;
+  _console;
+  _customFormatTime;
+  _listeners = /* @__PURE__ */ new Set();
+  constructor(options = {}) {
+    this._prefix = options.prefix ?? "[bidkernel]";
+    this._level = normalizeLogLevel(options.logLevel ?? LogLevel.INFO);
+    this._now = options.now;
+    this._console = options.console;
+    this._customFormatTime = options.formatTime;
+    if (options.onLog) {
+      this._listeners.add(options.onLog);
+    }
+    this._loadedAt = options.loadedAt ?? (this._now ? this._now() : typeof performance !== "undefined" && typeof performance.now === "function" ? performance.now() : Date.now());
+  }
+  get prefix() {
+    return this._prefix;
+  }
+  set prefix(val) {
+    this._prefix = val;
+  }
+  get logLevel() {
+    return this._level;
+  }
+  set logLevel(val) {
+    this._level = normalizeLogLevel(val);
+  }
+  getLevel() {
+    return this._level;
+  }
+  setLevel(level) {
+    this._level = normalizeLogLevel(level);
+  }
+  getPrefix() {
+    return this._prefix;
+  }
+  setPrefix(prefix) {
+    this._prefix = prefix;
+  }
+  resetTiming(loadedAt) {
+    this._loadedAt = loadedAt ?? (this._now ? this._now() : typeof performance !== "undefined" && typeof performance.now === "function" ? performance.now() : Date.now());
+  }
+  getLoadedAt() {
+    return this._loadedAt;
+  }
+  addListener(listener) {
+    this._listeners.add(listener);
+    return () => {
+      this._listeners.delete(listener);
+    };
+  }
+  removeListener(listener) {
+    this._listeners.delete(listener);
+  }
+  isEnabled(level) {
+    const target = normalizeLogLevel(level);
+    return (LOG_LEVEL_MAP[target] ?? 20) >= (LOG_LEVEL_MAP[this._level] ?? 20);
+  }
+  formatTime(ms) {
+    if (this._customFormatTime) {
+      return this._customFormatTime(ms);
+    }
+    return formatTime(ms);
+  }
+  _getConsole() {
+    if (this._console) return this._console;
+    if (typeof console !== "undefined") return console;
+    return void 0;
+  }
+  _getElapsed() {
+    const current = this._now ? this._now() : typeof performance !== "undefined" && typeof performance.now === "function" ? performance.now() : Date.now();
+    return Math.max(0, current - this._loadedAt);
+  }
+  _dispatchRecord(record) {
+    for (const l of this._listeners) {
+      try {
+        l(record);
+      } catch {
+      }
+    }
+    const globalListeners = getGlobalListeners();
+    for (const gl of globalListeners) {
+      if (!this._listeners.has(gl)) {
+        try {
+          gl(record);
+        } catch {
+        }
+      }
+    }
+    if (typeof window !== "undefined" && typeof window.dispatchEvent === "function") {
+      try {
+        window.dispatchEvent(new CustomEvent("__bidkernel_log__", { detail: record }));
+      } catch {
+      }
+    }
+  }
+  log(level, nameOrMsg, ...args) {
+    const normLevel = normalizeLogLevel(level);
+    if (!this.isEnabled(normLevel)) {
+      return;
+    }
+    const elapsed = this._getElapsed();
+    const formattedTimeStr = this.formatTime(elapsed);
+    const nowEpoch = Date.now();
+    const recordId = `bk_log_${nowEpoch}_${++logCounter}`;
+    const record = {
+      id: recordId,
+      timestamp: nowEpoch,
+      elapsedMs: elapsed,
+      level: normLevel,
+      prefix: this._prefix,
+      message: nameOrMsg,
+      args,
+      data: args.length === 1 ? args[0] : args.length > 1 ? args : void 0
+    };
+    this._dispatchRecord(record);
+    const c = this._getConsole();
+    if (!c) return;
+    let badgeStyle = COLORS.badge;
+    let eventStyle = COLORS.event;
+    if (normLevel === LogLevel.WARN) {
+      badgeStyle = COLORS.badgeWarn;
+      eventStyle = COLORS.eventWarn;
+    } else if (normLevel === LogLevel.ERROR) {
+      badgeStyle = COLORS.badgeError;
+      eventStyle = COLORS.eventError;
+    }
+    const fmt = `%c${this._prefix}%c ${formattedTimeStr} %c${nameOrMsg}%c`;
+    const styles = [badgeStyle, COLORS.dim, eventStyle, COLORS.reset];
+    const callArgs = [fmt, ...styles];
+    if (args.length > 0) {
+      callArgs.push(...args);
+    }
+    switch (normLevel) {
+      case LogLevel.DEBUG:
+        if (typeof c.log === "function") {
+          c.log(...callArgs);
+        } else if (typeof c.debug === "function") {
+          c.debug(...callArgs);
+        }
+        break;
+      case LogLevel.INFO:
+        if (typeof c.info === "function") {
+          c.info(...callArgs);
+        } else if (typeof c.log === "function") {
+          c.log(...callArgs);
+        }
+        break;
+      case LogLevel.WARN:
+        if (typeof c.warn === "function") {
+          c.warn(...callArgs);
+        } else if (typeof c.log === "function") {
+          c.log(...callArgs);
+        }
+        break;
+      case LogLevel.ERROR:
+        if (typeof c.error === "function") {
+          c.error(...callArgs);
+        } else if (typeof c.log === "function") {
+          c.log(...callArgs);
+        }
+        break;
+      default:
+        if (typeof c.log === "function") {
+          c.log(...callArgs);
+        }
+        break;
+    }
+  }
+  debug(nameOrMsg, ...args) {
+    this.log(LogLevel.DEBUG, nameOrMsg, ...args);
+  }
+  info(nameOrMsg, ...args) {
+    this.log(LogLevel.INFO, nameOrMsg, ...args);
+  }
+  warn(nameOrMsg, ...args) {
+    this.log(LogLevel.WARN, nameOrMsg, ...args);
+  }
+  error(nameOrMsg, ...args) {
+    this.log(LogLevel.ERROR, nameOrMsg, ...args);
+  }
+  logEvent(event) {
+    if (!event) return;
+    if (event.data !== void 0) {
+      this.log(event.level, event.eventName, event.data);
+    } else {
+      this.log(event.level, event.eventName);
+    }
+  }
+  child(subNamespace, options = {}) {
+    let childPrefix = this._prefix;
+    if (subNamespace) {
+      const formattedSub = subNamespace.startsWith("[") && subNamespace.endsWith("]") ? subNamespace : `[${subNamespace}]`;
+      childPrefix = `${this._prefix}${formattedSub}`;
+    }
+    return new _Logger({
+      prefix: childPrefix,
+      logLevel: options.logLevel ?? this._level,
+      loadedAt: options.loadedAt ?? this._loadedAt,
+      now: options.now ?? this._now,
+      console: options.console ?? this._console,
+      formatTime: options.formatTime ?? this._customFormatTime,
+      ...options
+    });
+  }
+  withPrefix(prefix) {
+    return new _Logger({
+      prefix,
+      logLevel: this._level,
+      loadedAt: this._loadedAt,
+      now: this._now,
+      console: this._console,
+      formatTime: this._customFormatTime
+    });
+  }
+};
+function createLogger(options) {
+  return new Logger(options);
+}
+
 // ../../protogen/trace_event.ts
 import { BinaryReader, BinaryWriter } from "@bufbuild/protobuf/wire";
 var TraceEventType = {
@@ -756,7 +1042,8 @@ var EVENT_NAME_TO_TYPE = {
   timeInView: TraceEventType.TIME_IN_VIEW,
   viewable: TraceEventType.VIEWABLE
 };
-var IMMEDIATE_FLUSH_TYPES = /* @__PURE__ */ new Set([
+var REVENUE_FLUSH_DELAY_MS = 3e3;
+var REVENUE_FLUSH_TYPES = /* @__PURE__ */ new Set([
   TraceEventType.IMPRESSION,
   TraceEventType.BID_WIN,
   TraceEventType.CLICK
@@ -1240,7 +1527,7 @@ var BidkernelPrebidAnalytics = class _BidkernelPrebidAnalytics {
   consecutiveSendFailures = 0;
   nextSendAllowedAt = 0;
   replayedEventCount = 0;
-  immediateFlushScheduled = false;
+  revenueFlushTimer = null;
   // localStorage keys of exit batches this instance persisted, so a page that
   // survives its own pagehide/hidden (bfcache restore, tab re-focus) can
   // remove them instead of leaving them for a duplicate resend.
@@ -1261,6 +1548,7 @@ var BidkernelPrebidAnalytics = class _BidkernelPrebidAnalytics {
   videoDetachCleanups = /* @__PURE__ */ new Set();
   // Compacted bidder participation map per auction: auctionId -> Map<`${bidder}:${adUnitCode}`, BidderOutcomeEntry>
   auctionBidderOutcomes = /* @__PURE__ */ new Map();
+  logger;
   constructor(config) {
     const requestedEndpoint = config.endpoint || "";
     const endpoint = !requestedEndpoint || isTrustedEndpoint(requestedEndpoint) ? requestedEndpoint : "";
@@ -1279,8 +1567,13 @@ var BidkernelPrebidAnalytics = class _BidkernelPrebidAnalytics {
       viewabilityEnabled: config.viewabilityEnabled ?? true,
       logLevel: config.logLevel || "INFO",
       pbjsGlobalName: config.pbjsGlobalName || "pbjs",
-      attachPbjsListeners: config.attachPbjsListeners ?? true
+      attachPbjsListeners: config.attachPbjsListeners ?? true,
+      revenueFlushDelayMs: Number.isFinite(config.revenueFlushDelayMs) && config.revenueFlushDelayMs >= 0 ? config.revenueFlushDelayMs : REVENUE_FLUSH_DELAY_MS
     };
+    this.logger = createLogger({
+      prefix: "[bidkernel][prebid-analytics]",
+      logLevel: this.config.logLevel
+    });
     if (requestedEndpoint && !endpoint) {
       this.log(
         "ERROR",
@@ -1297,6 +1590,7 @@ var BidkernelPrebidAnalytics = class _BidkernelPrebidAnalytics {
     if (this.isEnabled) return;
     this.isEnabled = true;
     _BidkernelPrebidAnalytics.activeInstances.add(this);
+    this.logger.setLevel(this.config.logLevel);
     if (!this.config.endpoint) {
       this.log("WARN", "Endpoint is empty. Analytics events will not be transmitted.");
     }
@@ -1433,6 +1727,10 @@ var BidkernelPrebidAnalytics = class _BidkernelPrebidAnalytics {
       clearInterval(this.flushTimer);
       this.flushTimer = null;
     }
+    if (this.revenueFlushTimer) {
+      clearTimeout(this.revenueFlushTimer);
+      this.revenueFlushTimer = null;
+    }
     if (this.persistedCleanupTimer) {
       clearTimeout(this.persistedCleanupTimer);
       this.persistedCleanupTimer = null;
@@ -2582,6 +2880,7 @@ var BidkernelPrebidAnalytics = class _BidkernelPrebidAnalytics {
     } else {
       this.pageUrl = "";
     }
+    this.logger.resetTiming();
     extendSession();
     this.enable();
   }
@@ -2996,12 +3295,11 @@ var BidkernelPrebidAnalytics = class _BidkernelPrebidAnalytics {
     }
     if (this.queue.length >= BATCH_SIZE) {
       this.flush();
-    } else if (IMMEDIATE_FLUSH_TYPES.has(type) && !this.immediateFlushScheduled) {
-      this.immediateFlushScheduled = true;
-      setTimeout(() => {
-        this.immediateFlushScheduled = false;
+    } else if (REVENUE_FLUSH_TYPES.has(type) && this.revenueFlushTimer === null) {
+      this.revenueFlushTimer = setTimeout(() => {
+        this.revenueFlushTimer = null;
         this.flush();
-      }, 0);
+      }, this.config.revenueFlushDelayMs);
     }
   }
   shouldSample(type, level) {
@@ -3261,25 +3559,13 @@ var BidkernelPrebidAnalytics = class _BidkernelPrebidAnalytics {
     }
   }
   log(level, msg, ...args) {
-    const levels = { DEBUG: 10, INFO: 20, WARN: 30, ERROR: 40 };
-    if (levels[level] < levels[this.config.logLevel]) return;
-    const prefix = `[bidkernel][prebid-analytics][${level}]`;
-    switch (level) {
-      case "DEBUG":
-        console.debug(prefix, msg, ...args);
-        break;
-      case "INFO":
-        console.info(prefix, msg, ...args);
-        break;
-      case "WARN":
-        console.warn(prefix, msg, ...args);
-        break;
-      case "ERROR":
-        console.error(prefix, msg, ...args);
-        break;
-    }
+    this.logger.log(level, msg, ...args);
   }
 };
+var defaultLogger = createLogger({
+  prefix: "[bidkernel]",
+  logLevel: "INFO"
+});
 function extractAnalyticsOptions(config, allowProviderless = true) {
   if (!config) return null;
   if (Array.isArray(config)) {
@@ -3336,8 +3622,8 @@ function registerPrebidAnalytics(pbjsGlobalName = "pbjs", defaults) {
       ...options
     };
     if (pinnedEndpoint && !sameEndpointOrigin(merged.endpoint || "", pinnedEndpoint)) {
-      console.warn(
-        `[bidkernel] Ignoring analytics endpoint change to ${merged.endpoint || "(empty)"}: this page is pinned to ${pinnedEndpoint}. Reload to change the ingest endpoint.`
+      defaultLogger.warn(
+        `Ignoring analytics endpoint change to ${merged.endpoint || "(empty)"}: this page is pinned to ${pinnedEndpoint}. Reload to change the ingest endpoint.`
       );
       merged.endpoint = pinnedEndpoint;
     }
@@ -3345,7 +3631,7 @@ function registerPrebidAnalytics(pbjsGlobalName = "pbjs", defaults) {
       try {
         previous.disable();
       } catch (e) {
-        console.warn("[bidkernel] Failed to disable previous analytics instance:", e);
+        defaultLogger.warn("Failed to disable previous analytics instance:", e);
       }
     }
     const analytics = new BidkernelPrebidAnalytics(merged);
@@ -3378,7 +3664,7 @@ function registerPrebidAnalytics(pbjsGlobalName = "pbjs", defaults) {
         enableInstance(stashed);
       }
     } catch (e) {
-      console.warn("[bidkernel] Failed to register standard Prebid analytics adapter:", e);
+      defaultLogger.warn("Failed to register standard Prebid analytics adapter:", e);
     }
   };
   if (pbjs.adapterManager && typeof pbjs.adapterManager.registerAnalyticsAdapter === "function") {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bidkernel/analytics",
-  "version": "0.10.0",
+  "version": "0.12.0",
   "description": "Bidkernel auction analytics: a standalone Prebid.js analytics adapter, plus TypeScript bindings for the Bidkernel ad SDK.",
   "keywords": [
     "advertising",
@@ -55,6 +55,7 @@
     "@bufbuild/protobuf": "^2.11.0"
   },
   "devDependencies": {
+    "@bidkernel/logger": "^0.1.0",
     "happy-dom": "^20.11.1",
     "tsup": "^8.5.0",
     "typescript": "^5.9.3",