stormcloud-video-player 0.8.55 → 0.8.56

package/lib/index.cjs

@@ -780,15 +780,147 @@ function supportsFeature(feature) {
             return false;
     }
 }
+// src/utils/vastTrackingMacros.ts
+var VAST_MACRO_PATTERN = /\[([A-Z][A-Z0-9_]*)\]/g;
+var CACHEBUSTING_ALIASES = /\[CACHEBUSTER\]|\[cachebuster\]|\[timestamp\]|\[random\]|\[INSERT_RANDOM_NUMBER\]|%%CACHEBUSTER%%|%%CACHEBUST%%|\$\{CACHEBUSTER\}|\$\{CACHEBUSTING\}|\{cachebuster\}|\{random\}/g;
+var KNOWN_VAST_MACROS = /* @__PURE__ */ new Set([
+    "ADCATEGORIES",
+    "ADCOUNT",
+    "ADPLAYHEAD",
+    "ADSERVINGID",
+    "ADTYPE",
+    "APIFRAMEWORKS",
+    "APPBUNDLE",
+    "ASSETURI",
+    "BLOCKEDADCATEGORIES",
+    "BREAKMAXADLENGTH",
+    "BREAKMAXADS",
+    "BREAKMAXDURATION",
+    "BREAKMINADLENGTH",
+    "BREAKPOSITION",
+    "CACHEBUSTING",
+    "CLICKPOS",
+    "CLICKTYPE",
+    "CLIENTUA",
+    "CONTENTID",
+    "CONTENTPLAYHEAD",
+    "CONTENTURI",
+    "DEVICEIP",
+    "DEVICEUA",
+    "DOMAIN",
+    "ERRORCODE",
+    "EXTENSIONS",
+    "GDPRCONSENT",
+    "IFA",
+    "IFATYPE",
+    "INVENTORYSTATE",
+    "LATLONG",
+    "LIMITADTRACKING",
+    "MEDIAMIME",
+    "MEDIAPLAYHEAD",
+    "OMIDPARTNER",
+    "PAGEURL",
+    "PLACEMENTTYPE",
+    "PLAYERCAPABILITIES",
+    "PLAYERSIZE",
+    "PLAYERSTATE",
+    "PODSEQUENCE",
+    "REGULATIONS",
+    "SERVERSIDE",
+    "SERVERUA",
+    "TIMESTAMP",
+    "TRANSACTIONID",
+    "UNIVERSALADID",
+    "VASTVERSIONS",
+    "VERIFICATIONVENDORS"
+]);
+function generateCachebuster() {
+    return String(Math.floor(Math.random() * 9e7) + 1e7);
+}
+function formatPlayhead(seconds) {
+    if (seconds == null || !Number.isFinite(seconds) || seconds < 0) {
+        return void 0;
+    }
+    var total = Math.floor(seconds);
+    var hh = String(Math.floor(total / 3600)).padStart(2, "0");
+    var mm = String(Math.floor(total % 3600 / 60)).padStart(2, "0");
+    var ss = String(total % 60).padStart(2, "0");
+    var ms = String(Math.floor((seconds - total) * 1e3)).padStart(3, "0");
+    return "".concat(hh, ":").concat(mm, ":").concat(ss, ".").concat(ms);
+}
+function resolveMacroValues(ctx) {
+    var values = /* @__PURE__ */ new Map();
+    var set = function set(key, value) {
+        if (value != null && value !== "") values.set(key, value);
+    };
+    var adPlayhead = formatPlayhead(ctx.adPlayheadSeconds);
+    set("ADPLAYHEAD", adPlayhead);
+    set("MEDIAPLAYHEAD", adPlayhead);
+    set("CONTENTPLAYHEAD", formatPlayhead(ctx.contentPlayheadSeconds));
+    set("ASSETURI", ctx.assetUri);
+    set("MEDIAMIME", ctx.mediaMime);
+    set("TIMESTAMP", (/* @__PURE__ */ new Date()).toISOString());
+    set("SERVERSIDE", "0");
+    if (ctx.errorCode != null && ctx.errorCode !== "") {
+        set("ERRORCODE", String(ctx.errorCode));
+    }
+    if (ctx.playerWidth != null && ctx.playerHeight != null) {
+        set("PLAYERSIZE", "".concat(Math.round(ctx.playerWidth), ",").concat(Math.round(ctx.playerHeight)));
+    }
+    set("IFA", ctx.deviceId);
+    set("IFATYPE", ctx.deviceIdType);
+    if (ctx.limitAdTracking != null) {
+        set("LIMITADTRACKING", ctx.limitAdTracking ? "1" : "0");
+    }
+    set("PAGEURL", ctx.pageUrl);
+    if (ctx.pageUrl) {
+        try {
+            set("DOMAIN", new URL(ctx.pageUrl).hostname);
+        } catch (unused) {}
+    }
+    set("CLIENTUA", ctx.clientUa);
+    set("DEVICEUA", ctx.clientUa);
+    if (ctx.podSequence != null) {
+        set("PODSEQUENCE", String(ctx.podSequence));
+    }
+    return values;
+}
+function substituteVastTrackingMacros(url) {
+    var ctx = arguments.length > 1 && arguments[1] !== void 0 ? arguments[1] : {};
+    if (!url) return url;
+    var values = resolveMacroValues(ctx);
+    return url.replace(CACHEBUSTING_ALIASES, function() {
+        return generateCachebuster();
+    }).replace(VAST_MACRO_PATTERN, function(match, name) {
+        if (name === "CACHEBUSTING") return generateCachebuster();
+        var value = values.get(name);
+        if (value != null) return encodeURIComponent(value);
+        return KNOWN_VAST_MACROS.has(name) ? "" : match;
+    });
+}
 // src/sdk/hlsAdPlayer.ts
 var MAX_VAST_WRAPPER_DEPTH = 5;
+var BEACON_TIMEOUT_MS = 3e4;
+var inFlightBeacons = /* @__PURE__ */ new Set();
+var VAST_ERROR_MEDIA_DISPLAY = 405;
+function toVastMediaErrorCode(error) {
+    switch(error === null || error === void 0 ? void 0 : error.code){
+        case 1:
+            return 400;
+        case 2:
+            return 401;
+        case 4:
+            return 403;
+        default:
+            return VAST_ERROR_MEDIA_DISPLAY;
+    }
+}
 function createHlsAdPlayer(contentVideo, options) {
     var _contentVideo_AD_VIDEO_PROP, _contentVideo_AD_CONTAINER_PROP;
     var adPlaying = false;
     var originalMutedState = false;
     var originalVolume = Math.max(0, Math.min(1, contentVideo.volume || 1));
     var listeners = /* @__PURE__ */ new Map();
-    var licenseKey = options === null || options === void 0 ? void 0 : options.licenseKey;
     var mainHlsInstance = options === null || options === void 0 ? void 0 : options.mainHlsInstance;
     var AD_CONTAINER_PROP = "__stormcloudAdContainer";
     var AD_VIDEO_PROP = "__stormcloudAdVideo";
@@ -799,10 +931,9 @@ function createHlsAdPlayer(contentVideo, options) {
     var adContainerEl = (_contentVideo_AD_CONTAINER_PROP = contentVideo[AD_CONTAINER_PROP]) !== null && _contentVideo_AD_CONTAINER_PROP !== void 0 ? _contentVideo_AD_CONTAINER_PROP : void 0;
     var adEventHandlers = [];
     var currentAd;
-    var currentAdMediaUrl;
+    var currentAdMediaFile;
     var podAds = [];
     var podIndex = 0;
-    var sessionId;
     var preloadedAds = /* @__PURE__ */ new Map();
     var preloadingAds = /* @__PURE__ */ new Map();
     var destroyed = false;
@@ -852,21 +983,47 @@ function createHlsAdPlayer(contentVideo, options) {
             }
         }
     }
-    function generateSessionId() {
-        return "session-".concat(Date.now(), "-").concat(Math.random().toString(36).substr(2, 9));
+    function buildTrackingMacroContext(errorCode) {
+        var context = {
+            adPlayheadSeconds: adVideoElement === null || adVideoElement === void 0 ? void 0 : adVideoElement.currentTime,
+            contentPlayheadSeconds: contentVideo.currentTime,
+            assetUri: currentAdMediaFile === null || currentAdMediaFile === void 0 ? void 0 : currentAdMediaFile.url,
+            mediaMime: currentAdMediaFile === null || currentAdMediaFile === void 0 ? void 0 : currentAdMediaFile.type,
+            playerWidth: (adVideoElement === null || adVideoElement === void 0 ? void 0 : adVideoElement.clientWidth) || (adContainerEl === null || adContainerEl === void 0 ? void 0 : adContainerEl.clientWidth),
+            playerHeight: (adVideoElement === null || adVideoElement === void 0 ? void 0 : adVideoElement.clientHeight) || (adContainerEl === null || adContainerEl === void 0 ? void 0 : adContainerEl.clientHeight)
+        };
+        if (errorCode != null) {
+            context.errorCode = errorCode;
+        }
+        if (typeof navigator !== "undefined" && navigator.userAgent) {
+            context.clientUa = navigator.userAgent;
+        }
+        if (typeof location !== "undefined" && location.href) {
+            context.pageUrl = location.href;
+        }
+        if (podAds.length > 0) {
+            context.podSequence = podIndex + 1;
+        }
+        return context;
     }
-    function fireTrackingPixels(urls) {
+    function fireTrackingPixels(urls, options2) {
         if (!urls || urls.length === 0) return;
+        var macroContext = buildTrackingMacroContext(options2 === null || options2 === void 0 ? void 0 : options2.errorCode);
         urls.forEach(function(url) {
             try {
-                var trackingUrl = url;
-                if (sessionId) {
-                    trackingUrl = "".concat(trackingUrl).concat(trackingUrl.includes("?") ? "&" : "?", "session_id=").concat(sessionId);
-                }
-                if (licenseKey) {
-                    trackingUrl = "".concat(trackingUrl).concat(trackingUrl.includes("?") ? "&" : "?", "license_key=").concat(licenseKey);
-                }
+                var trackingUrl = substituteVastTrackingMacros(url, macroContext);
                 var img = new Image(1, 1);
+                inFlightBeacons.add(img);
+                var timeoutId;
+                var release = function release() {
+                    if (timeoutId !== void 0) clearTimeout(timeoutId);
+                    img.onload = null;
+                    img.onerror = null;
+                    inFlightBeacons.delete(img);
+                };
+                img.onload = release;
+                img.onerror = release;
+                timeoutId = setTimeout(release, BEACON_TIMEOUT_MS);
                 img.src = trackingUrl;
                 console.log("[HlsAdPlayer] Fired tracking pixel: ".concat(trackingUrl));
             } catch (error) {
@@ -1505,7 +1662,9 @@ function createHlsAdPlayer(contentVideo, options) {
             if (!adPlaying) return;
             console.error("[HlsAdPlayer] Ad video error:", e);
             if (currentAd) {
-                fireTrackingPixels(currentAd.trackingUrls.error);
+                fireTrackingPixels(currentAd.trackingUrls.error, {
+                    errorCode: toVastMediaErrorCode(adVideoElement === null || adVideoElement === void 0 ? void 0 : adVideoElement.error)
+                });
             }
             if (podIndex < podAds.length - 1 && advanceToNextPodAd()) {
                 return;
@@ -1617,9 +1776,9 @@ function createHlsAdPlayer(contentVideo, options) {
             delete contentVideo.dataset.stormcloudAdPlaying;
         }
     }
-    function resetQuartileTracking() {
+    function resetQuartileTracking(preserveImpression) {
         trackingFired = {
-            impression: false,
+            impression: preserveImpression ? trackingFired.impression : false,
             start: false,
             firstQuartile: false,
             midpoint: false,
@@ -1627,27 +1786,6 @@ function createHlsAdPlayer(contentVideo, options) {
             complete: false
         };
     }
-    function markCreativeRendered(reason) {
-        if (!currentAd || trackingFired.impression) return;
-        trackingFired.impression = true;
-        fireTrackingPixels(currentAd.trackingUrls.impression);
-        console.log("[HlsAdPlayer] Impression (pod ".concat(podIndex + 1, "/").concat(podAds.length || 1, ", reason: ").concat(reason, "): ").concat(currentAd.title));
-        emit("ad_impression", {
-            adId: currentAd.id,
-            title: currentAd.title,
-            durationSeconds: currentAd.duration,
-            mediaUrl: currentAdMediaUrl,
-            podIndex: podIndex,
-            podSize: podAds.length || 1,
-            reason: reason
-        });
-    }
-    function canDetectBlackFrames() {
-        if (!adVideoElement) return false;
-        if (requiresMediaPipelineResetAfterAds()) return false;
-        if (isRvfcSupported(adVideoElement)) return true;
-        return getDecodedVideoFrameCount(adVideoElement) !== void 0;
-    }
     function isRvfcSupported(video) {
         return typeof video.requestVideoFrameCallback === "function";
     }
@@ -1710,7 +1848,7 @@ function createHlsAdPlayer(contentVideo, options) {
         if (!mediaFile) {
             throw new Error("No media file available for ad");
         }
-        currentAdMediaUrl = mediaFile.url;
+        currentAdMediaFile = mediaFile;
         var isHlsAd = isHlsMediaFile(mediaFile);
         console.log("[HlsAdPlayer] Loading ".concat(isHlsAd ? "HLS" : "progressive", " ad (pod ").concat(podIndex + 1, "/").concat(podAds.length || 1, ") from: ").concat(mediaFile.url));
         if (isHlsAd && import_hls.default.isSupported()) {
@@ -1754,9 +1892,11 @@ function createHlsAdPlayer(contentVideo, options) {
         }
         podIndex++;
         currentAd = podAds[podIndex];
-        currentAdMediaUrl = void 0;
-        resetQuartileTracking();
+        currentAdMediaFile = void 0;
+        resetQuartileTracking(false);
         if (currentAd) {
+            fireTrackingPixels(currentAd.trackingUrls.impression);
+            trackingFired.impression = true;
             console.log("[HlsAdPlayer] Advancing to next pod ad (".concat(podIndex + 1, "/").concat(podAds.length, "): ").concat(currentAd.title, ", duration: ").concat(currentAd.duration, "s"));
         }
         clearStallWatchdog();
@@ -1795,7 +1935,9 @@ function createHlsAdPlayer(contentVideo, options) {
         console.warn("[HlsAdPlayer] Ad playback stalled (no progress) - recovering to avoid a blank frame");
         clearStallWatchdog();
         if (currentAd) {
-            fireTrackingPixels(currentAd.trackingUrls.error);
+            fireTrackingPixels(currentAd.trackingUrls.error, {
+                errorCode: VAST_ERROR_MEDIA_DISPLAY
+            });
         }
         if (podIndex < podAds.length - 1 && advanceToNextPodAd()) {
             return;
@@ -1851,7 +1993,6 @@ function createHlsAdPlayer(contentVideo, options) {
             if (!adPlaying) return;
             sawDecodedVideoFrame = true;
             markRvfcReliable();
-            markCreativeRendered("first_presented_frame");
         };
         try {
             videoFrameCallbackHandle = rvfc.call(adVideoElement, onPresentedFrame);
@@ -1864,7 +2005,9 @@ function createHlsAdPlayer(contentVideo, options) {
         console.warn("[HlsAdPlayer] Ad audio is advancing but no video frames decoded (black screen) - skipping this creative");
         clearStallWatchdog();
         if (currentAd) {
-            fireTrackingPixels(currentAd.trackingUrls.error);
+            fireTrackingPixels(currentAd.trackingUrls.error, {
+                errorCode: VAST_ERROR_MEDIA_DISPLAY
+            });
         }
         if (podIndex < podAds.length - 1 && advanceToNextPodAd()) {
             return;
@@ -1886,7 +2029,6 @@ function createHlsAdPlayer(contentVideo, options) {
                 if (decodedFrames !== void 0 && decodedFrames > 0) {
                     sawDecodedVideoFrame = true;
                     markFrameCounterReliable();
-                    markCreativeRendered("decoded_frames");
                 } else if (adVideoElement.currentTime >= BLACKFRAME_MIN_PLAYBACK_S) {
                     var timeAdvancing = adVideoElement.currentTime > lastAdProgressPosition + 0.05;
                     if (isRvfcSupported(adVideoElement) && timeAdvancing && isRvfcReliable()) {
@@ -1899,9 +2041,6 @@ function createHlsAdPlayer(contentVideo, options) {
                     }
                 }
             }
-            if (!trackingFired.impression && !adVideoElement.paused && adVideoElement.currentTime >= BLACKFRAME_MIN_PLAYBACK_S && (sawDecodedVideoFrame || !canDetectBlackFrames())) {
-                markCreativeRendered(sawDecodedVideoFrame ? "decoded_frames" : "sustained_playback");
-            }
             if (adVideoElement.currentTime > lastAdProgressPosition + 0.05) {
                 noteAdProgress();
                 return;
@@ -2002,7 +2141,6 @@ function createHlsAdPlayer(contentVideo, options) {
                                 ,
                                 6
                             ]);
-                            sessionId = generateSessionId();
                             ads = [];
                             if (!preloadedAds.has(vastTagUrl)) return [
                                 3,
@@ -2040,9 +2178,12 @@ function createHlsAdPlayer(contentVideo, options) {
                             podAds = ads;
                             podIndex = 0;
                             currentAd = ads[0];
-                            currentAdMediaUrl = void 0;
-                            resetQuartileTracking();
+                            currentAdMediaFile = void 0;
                             console.log("[HlsAdPlayer] Pod parsed: ".concat(ads.length, ' ad(s), first="').concat(currentAd === null || currentAd === void 0 ? void 0 : currentAd.title, '", duration=').concat(currentAd === null || currentAd === void 0 ? void 0 : currentAd.duration, "s"));
+                            if (currentAd) {
+                                fireTrackingPixels(currentAd.trackingUrls.impression);
+                                trackingFired.impression = true;
+                            }
                             return [
                                 2,
                                 Promise.resolve()
@@ -2082,7 +2223,7 @@ function createHlsAdPlayer(contentVideo, options) {
                             contentVideo[AD_VIDEO_PROP] = adVideoElement;
                         }
                         setupAdEventListeners();
-                        resetQuartileTracking();
+                        resetQuartileTracking(true);
                         contentVolume = contentVideo.volume;
                         originalVolume = Math.max(0, Math.min(1, contentVolume || originalVolume));
                         if (!(options === null || options === void 0 ? void 0 : options.continueLiveStreamDuringAds)) {
@@ -2172,7 +2313,7 @@ function createHlsAdPlayer(contentVideo, options) {
                         }
                     }
                     currentAd = void 0;
-                    currentAdMediaUrl = void 0;
+                    currentAdMediaFile = void 0;
                     podAds = [];
                     podIndex = 0;
                     return [
@@ -2213,6 +2354,7 @@ function createHlsAdPlayer(contentVideo, options) {
             teardownAdEventListeners();
             releaseAdDecoder();
             currentAd = void 0;
+            currentAdMediaFile = void 0;
             podAds = [];
             podIndex = 0;
             listeners.clear();
@@ -3527,19 +3669,8 @@ function buildPlayerMetricEvent() {
     }).apply(this, arguments);
 }
 function publishTracking(licenseKey, channel, body) {
-    var debug = arguments.length > 3 && arguments[3] !== void 0 ? arguments[3] : false;
     ensureMQTTClient();
-    var topic = buildPlayerTopic(licenseKey, channel);
-    var published = publishMQTT(topic, body);
-    if (debug) {
-        console.log("[StormcloudVideoPlayer] publishTracking:", JSON.stringify({
-            licenseKey: licenseKey,
-            channel: channel,
-            topic: topic,
-            body: body,
-            published: published
-        }, null, 2));
-    }
+    publishMQTT(buildPlayerTopic(licenseKey, channel), body);
 }
 function sendInitialTracking(_0) {
     return _async_to_generator(function(licenseKey) {
@@ -3573,7 +3704,7 @@ function sendInitialTracking(_0) {
                         events: [
                             metricEvent
                         ]
-                    }, !!context.debugAdTiming);
+                    });
                     return [
                         3,
                         4
@@ -3683,7 +3814,7 @@ function sendAdLoadedTracking(_0, _1) {
 }
 function sendAdImpressionTracking(_0, _1) {
     return _async_to_generator(function(licenseKey, adImpressionInfo) {
-        var context, _adImpressionInfo_adUrl, metricEvent, error;
+        var context, metricEvent, error;
         var _arguments = arguments;
         return _ts_generator(this, function(_state) {
             switch(_state.label){
@@ -3708,18 +3839,17 @@ function sendAdImpressionTracking(_0, _1) {
                     ];
                 case 2:
                     metricEvent = _state.sent();
-                    publishTracking(licenseKey, "heartbeat", metricEvent, !!context.debugAdTiming);
+                    publishTracking(licenseKey, "heartbeat", metricEvent);
                     publishTracking(licenseKey, "impressions", {
                         events: [
                             {
-                                event_id: createUuid(),
                                 player_id: metricEvent.player_id,
                                 ad_played_count: 1,
-                                ad_url: (_adImpressionInfo_adUrl = adImpressionInfo.adUrl) !== null && _adImpressionInfo_adUrl !== void 0 ? _adImpressionInfo_adUrl : adImpressionInfo.adId,
+                                ad_url: adImpressionInfo.adUrl,
                                 capture_at: adImpressionInfo.timestamp
                             }
                         ]
-                    }, !!context.debugAdTiming);
+                    });
                     return [
                         3,
                         4
@@ -3764,7 +3894,7 @@ function sendHeartbeat(_0) {
                     ];
                 case 2:
                     heartbeatData = _state.sent();
-                    publishTracking(licenseKey, "heartbeat", heartbeatData, !!context.debugAdTiming);
+                    publishTracking(licenseKey, "heartbeat", heartbeatData);
                     return [
                         3,
                         4
@@ -7558,22 +7688,27 @@ var AdBreakOrchestrator = /*#__PURE__*/ function() {
                         console.log("[POD] Playing pod ad ".concat((payload === null || payload === void 0 ? void 0 : payload.index) != null ? payload.index + 1 : "?", "/").concat((_ref = payload === null || payload === void 0 ? void 0 : payload.total) !== null && _ref !== void 0 ? _ref : "?"));
                     }
                 });
-                adPlayer.on("ad_impression", function(payload) {
-                    var impressionInfo = {
+                adPlayer.on("all_ads_completed", function() {
+                    sendAdImpressionTracking(_this.host.config.licenseKey, {
                         source: "hls",
                         adIndex: _this.timing.currentAdIndex,
                         timestamp: (/* @__PURE__ */ new Date()).toISOString()
-                    };
-                    if (payload === null || payload === void 0 ? void 0 : payload.adId) impressionInfo.adId = payload.adId;
-                    if (payload === null || payload === void 0 ? void 0 : payload.mediaUrl) impressionInfo.adUrl = payload.mediaUrl;
-                    if ((payload === null || payload === void 0 ? void 0 : payload.durationSeconds) != null) {
-                        impressionInfo.durationSeconds = payload.durationSeconds;
+                    }, _this.analyticsContext).catch(function() {});
+                    _this.timing.recordPlayedAdDuration(_this.host.getAdPlayer());
+                    var remaining = _this.timing.getRemainingAdMs();
+                    _this.timing.consecutiveFailures = 0;
+                    if (_this.debug) {
+                        console.log("[StormcloudVideoPlayer] all_ads_completed event received - remaining=".concat(remaining, "ms, queued ads=").concat(_this.adRequestQueue.length), _this.adRequestQueue.length > 0 ? {
+                            queuedUrls: _to_consumable_array(_this.adRequestQueue)
+                        } : {});
                     }
-                    sendAdImpressionTracking(_this.host.config.licenseKey, impressionInfo, _this.analyticsContext).catch(function(error) {
-                        if (_this.debug) {
-                            console.warn("[AdBreakOrchestrator] Failed to send ad impression tracking:", error);
+                    if (_this.inAdBreak) {
+                        if (_this.timing.hasTimeToStartAnotherAd()) {
+                            _this.tryNextAvailableAdWithRateLimit();
+                        } else {
+                            _this.handleAdPodComplete();
                         }
-                    });
+                    }
                 });
                 adPlayer.on("ad_error", function(errorPayload) {
                     var errorMessage = "Ad playback failed";
@@ -7616,6 +7751,11 @@ var AdBreakOrchestrator = /*#__PURE__*/ function() {
                     }
                 });
                 adPlayer.on("content_resume", function() {
+                    sendAdImpressionTracking(_this.host.config.licenseKey, {
+                        source: "hls",
+                        adIndex: _this.timing.currentAdIndex,
+                        timestamp: (/* @__PURE__ */ new Date()).toISOString()
+                    }, _this.analyticsContext).catch(function() {});
                     if (!_this.host.video.muted) {
                         _this.host.video.muted = true;
                         if (_this.debug) {