@bidkernel/analytics 0.16.0 → 0.17.0

package/dist/index.d.ts

@@ -23,21 +23,9 @@ interface BidTrace {
     creativeId?: string | undefined;
 }
 declare const BidTrace: MessageFns<BidTrace>;
-type Builtin = Date | Function | Uint8Array | string | number | boolean | undefined;
-type DeepPartial<T> = T extends Builtin ? T : T extends globalThis.Array<infer U> ? globalThis.Array<DeepPartial<U>> : T extends ReadonlyArray<infer U> ? ReadonlyArray<DeepPartial<U>> : T extends {} ? {
-    [K in keyof T]?: DeepPartial<T[K]>;
-} : Partial<T>;
-type KeysOfUnion<T> = T extends T ? keyof T : never;
-type Exact<P, I extends P> = P extends Builtin ? P : P & {
-    [K in keyof P]: Exact<P[K], I[K]>;
-} & {
-    [K in Exclude<keyof I, KeysOfUnion<P>>]: never;
-};
 interface MessageFns<T> {
     encode(message: T, writer?: BinaryWriter): BinaryWriter;
     decode(input: BinaryReader | Uint8Array, length?: number): T;
-    create<I extends Exact<DeepPartial<T>, I>>(base?: I): T;
-    fromPartial<I extends Exact<DeepPartial<T>, I>>(object: I): T;
 }
 
 interface AnalyticsConfig {
@@ -83,24 +71,6 @@ interface SlotObserveOptions {
     refreshIndex?: number;
     emitRefreshEvent?: boolean;
 }
-interface VideoPlayerOptions {
-    /** The ad unit code / slot identifier for analytics reporting */
-    adUnitCode?: string;
-    slotId?: string;
-    auctionId?: string;
-    transactionId?: string;
-    bid?: any;
-    metadata?: Record<string, string>;
-    refreshIndex?: number;
-    /** Whether to automatically track IAB video viewability (2s continuous >=50% in-view) and Time-in-View. Defaults to true. */
-    trackViewability?: boolean;
-    /** Custom callback when impression is triggered */
-    onImpression?: (slotId: string, details: any) => void;
-    /** Custom callback when playback milestone reached (25%, 50%, 75%, 100%) */
-    onMilestone?: (milestone: "firstQuartile" | "midpoint" | "thirdQuartile" | "complete", slotId: string) => void;
-    /** Custom callback when render / playback error occurs */
-    onError?: (error: any) => void;
-}
 interface CachedWinningBid {
     bidTrace: BidTrace;
     auctionId: string;
@@ -115,6 +85,7 @@ interface SlotViewabilityState {
     timeInViewMs: number;
     refreshIndex: number;
 }
+declare const CACHED_BID_TTL_MS: number;
 /**
  * The ingest endpoint decides where auction telemetry -- CPMs, deal IDs,
  * advertiser domains, user and session IDs -- is shipped, and it arrives from
@@ -154,17 +125,9 @@ declare class PrebidEventDeduper {
     private seenKeys;
     isDuplicate(eventName: string, data: any): boolean;
 }
-/**
- * Hooks Google IMA SDK methods to automatically intercept AdsManager creation
- * across active BidkernelPrebidAnalytics instances without requiring manual
- * publisher calls to attachImaAdsManager.
- */
-declare function hookImaPrototype(ima: any): void;
-declare function initImaInterception(): void;
 declare class BidkernelPrebidAnalytics {
     private static activeInstances;
     static getActiveInstances(): Set<BidkernelPrebidAnalytics>;
-    static initImaInterception(): void;
     /**
      * Allows or forbids localStorage writes for every instance on the page.
      * Collection and delivery are unaffected: only the persisted session id,
@@ -269,11 +232,6 @@ declare class BidkernelPrebidAnalytics {
      * consecutively, so eviction takes a whole bid's aliases together.
      */
     private pruneCachedWinningBids;
-    /**
-     * Searches cached winning bids for an entry matching the given filters (creativeId,
-     * adId, or mediaType), falling back to the most recent winning video bid.
-     */
-    private findCachedWinningBid;
     /** Records a dedup key, evicting oldest-first at the cap. */
     private addImpressionKey;
     /**
@@ -287,18 +245,6 @@ declare class BidkernelPrebidAnalytics {
     recordImpression(slotId: string, options?: SlotObserveOptions & {
         bid?: any;
     }): boolean;
-    /**
-     * Bridges Google IMA SDK AdsManager events to Bidkernel analytics.
-     * Defers IMPRESSION emission until AdEvent.STARTED (or IMPRESSION),
-     * tracks milestones (FIRST_QUARTILE, MIDPOINT, THIRD_QUARTILE, COMPLETE),
-     * and handles AD_ERROR.
-     */
-    attachImaAdsManager(adsManager: any, options?: VideoPlayerOptions): () => void;
-    /**
-     * Attaches render hooks and viewability tracking to a video player.
-     * Supports HTML5 <video> elements, container elements, or Google IMA AdsManager.
-     */
-    attachVideoPlayer(target: any, options?: VideoPlayerOptions): () => void;
     onTimeInViewThreshold(slotId: string, thresholdMs: number, callback: (slotId: string, durationMs: number) => void): () => void;
     getViewabilityState(slotId: string): SlotViewabilityState | undefined;
     /** The validated ingest endpoint in use, or "" when none passed validation. */
@@ -336,6 +282,69 @@ declare class BidkernelPrebidAnalytics {
 }
 declare function registerPrebidAnalytics(pbjsGlobalName?: string, defaults?: Partial<AnalyticsConfig>): void;
 
+/**
+ * Video and Google IMA support for the analytics adapter: render-triggered
+ * impressions from a video player or an IMA AdsManager, and the automatic
+ * IMA interception that hooks every AdsManager the page creates.
+ *
+ * Importing this module installs attachVideoPlayer and attachImaAdsManager
+ * on BidkernelPrebidAnalytics and starts the interception, so the package's
+ * public entry (index.ts) and the standalone bundle carry the full API. The
+ * display-only SDK imports the core module alone and ships none of this.
+ */
+interface VideoPlayerOptions {
+    /** The ad unit code / slot identifier for analytics reporting */
+    adUnitCode?: string;
+    slotId?: string;
+    auctionId?: string;
+    transactionId?: string;
+    bid?: any;
+    metadata?: Record<string, string>;
+    refreshIndex?: number;
+    /** Whether to automatically track IAB video viewability (2s continuous >=50% in-view) and Time-in-View. Defaults to true. */
+    trackViewability?: boolean;
+    /** Custom callback when impression is triggered */
+    onImpression?: (slotId: string, details: any) => void;
+    /** Custom callback when playback milestone reached (25%, 50%, 75%, 100%) */
+    onMilestone?: (milestone: "firstQuartile" | "midpoint" | "thirdQuartile" | "complete", slotId: string) => void;
+    /** Custom callback when render / playback error occurs */
+    onError?: (error: any) => void;
+}
+/**
+ * Hooks Google IMA SDK methods to automatically intercept AdsManager creation
+ * across active BidkernelPrebidAnalytics instances without requiring manual
+ * publisher calls to attachImaAdsManager.
+ */
+declare function hookImaPrototype(ima: any): void;
+declare function initImaInterception(): void;
+/**
+ * Bridges Google IMA SDK AdsManager events to Bidkernel analytics.
+ * Defers IMPRESSION emission until AdEvent.STARTED (or IMPRESSION),
+ * tracks milestones (FIRST_QUARTILE, MIDPOINT, THIRD_QUARTILE, COMPLETE),
+ * and handles AD_ERROR.
+ */
+declare function attachImaAdsManager(analytics: BidkernelPrebidAnalytics, adsManager: any, options?: VideoPlayerOptions): () => void;
+/**
+ * Attaches render hooks and viewability tracking to a video player.
+ * Supports HTML5 <video> elements, container elements, or Google IMA AdsManager.
+ */
+declare function attachVideoPlayer(analytics: BidkernelPrebidAnalytics, target: any, options?: VideoPlayerOptions): () => void;
+declare module "./prebid-analytics" {
+    interface BidkernelPrebidAnalytics {
+        /**
+         * Bridges Google IMA SDK AdsManager events to Bidkernel analytics: the
+         * IMPRESSION is deferred until AdEvent.STARTED (or IMPRESSION), quartile
+         * milestones are reported, and AD_ERROR becomes an adRenderFailed.
+         */
+        attachImaAdsManager(adsManager: any, options?: VideoPlayerOptions): () => void;
+        /**
+         * Attaches render hooks and viewability tracking to a video player: an
+         * HTML5 <video> element, a container element, or an IMA AdsManager.
+         */
+        attachVideoPlayer(target: any, options?: VideoPlayerOptions): () => void;
+    }
+}
+
 type SlotSize = [number, number];
 type SlotSizes = SlotSize[];
 interface SizeMapping {
@@ -402,4 +411,4 @@ interface AdsGlobal {
  */
 declare function getbidkernel(alias?: string): AdsGlobal;
 
-export { type AdsGlobal, type AnalyticsConfig, BidkernelPrebidAnalytics, type CachedWinningBid, PrebidEventDeduper, type SizeMapping, type SlotConfig, type SlotObserveOptions, type SlotSize, type SlotSizes, type SlotViewabilityState, type VideoPlayerOptions, getOrCreateSessionId, getPrebidEventKey, getbidkernel, hookImaPrototype, initImaInterception, isTrustedEndpoint, registerPrebidAnalytics };
+export { type AdsGlobal, type AnalyticsConfig, BidkernelPrebidAnalytics, CACHED_BID_TTL_MS, type CachedWinningBid, PrebidEventDeduper, type SizeMapping, type SlotConfig, type SlotObserveOptions, type SlotSize, type SlotSizes, type SlotViewabilityState, type VideoPlayerOptions, attachImaAdsManager, attachVideoPlayer, getOrCreateSessionId, getPrebidEventKey, getbidkernel, hookImaPrototype, initImaInterception, isTrustedEndpoint, registerPrebidAnalytics };