stormcloud-video-player 0.8.4 → 0.8.5

package/lib/index.d.cts

@@ -38,6 +38,10 @@ interface StormcloudVideoPlayerConfig {
     vmapUrl?: string;
     vastMode?: 'adstorm' | 'default';
     minSegmentsBeforePlay?: number;
+    deviceId?: string;
+    deviceIdType?: string;
+    limitAdTracking?: boolean;
+    adTest?: boolean;
 }
 interface AdController {
     initialize: () => void;
@@ -215,6 +219,11 @@ declare class StormcloudVideoPlayer {
     private adDetectSentForCurrentBreak;
     private palNonce;
     private palPlaybackStarted;
+    private readonly streamCorrelator;
+    private consentSignals;
+    private podCounter;
+    private podAssignedByPrefetch;
+    private adRequestPositionInBreak;
     constructor(config: StormcloudVideoPlayerConfig);
     private createAdPlayer;
     load(): Promise<void>;
@@ -278,6 +287,7 @@ declare class StormcloudVideoPlayer {
     getCurrentAdIndex(): number;
     getTotalAdsInBreak(): number;
     getAdRemainingMs(): number;
+    private beginNewAdPod;
     private generateVastUrlsWithCorrelators;
     isAdPlaying(): boolean;
     isShowingAds(): boolean;

package/lib/index.d.ts

@@ -38,6 +38,10 @@ interface StormcloudVideoPlayerConfig {
     vmapUrl?: string;
     vastMode?: 'adstorm' | 'default';
     minSegmentsBeforePlay?: number;
+    deviceId?: string;
+    deviceIdType?: string;
+    limitAdTracking?: boolean;
+    adTest?: boolean;
 }
 interface AdController {
     initialize: () => void;
@@ -215,6 +219,11 @@ declare class StormcloudVideoPlayer {
     private adDetectSentForCurrentBreak;
     private palNonce;
     private palPlaybackStarted;
+    private readonly streamCorrelator;
+    private consentSignals;
+    private podCounter;
+    private podAssignedByPrefetch;
+    private adRequestPositionInBreak;
     constructor(config: StormcloudVideoPlayerConfig);
     private createAdPlayer;
     load(): Promise<void>;
@@ -278,6 +287,7 @@ declare class StormcloudVideoPlayer {
     getCurrentAdIndex(): number;
     getTotalAdsInBreak(): number;
     getAdRemainingMs(): number;
+    private beginNewAdPod;
     private generateVastUrlsWithCorrelators;
     isAdPlaying(): boolean;
     isShowingAds(): boolean;

package/lib/index.js

@@ -2236,6 +2236,166 @@ function initializePolyfills() {
     polyfillTextEncoder();
     polyfillPromiseFinally();
 }
+// src/utils/vastMacros.ts
+function generateCorrelator() {
+    if (typeof crypto !== "undefined" && crypto.getRandomValues) {
+        try {
+            var _buf_, _buf_1;
+            var buf = new Uint32Array(2);
+            crypto.getRandomValues(buf);
+            var value = ((_buf_ = buf[0]) !== null && _buf_ !== void 0 ? _buf_ : 0) * 2097152 + (((_buf_1 = buf[1]) !== null && _buf_1 !== void 0 ? _buf_1 : 0) & 2097151);
+            if (value > 0) {
+                return String(value);
+            }
+        } catch (unused) {}
+    }
+    return String(Math.floor(Math.random() * Number.MAX_SAFE_INTEGER) + 1);
+}
+var UNEXPANDED_MACRO_PATTERN = /^(\[[^\]]*\]|\{[^}]*\}|%%[^%]*%%)$/;
+function applyVastMacros(baseUrl, ctx) {
+    var url;
+    try {
+        url = new URL(baseUrl);
+    } catch (unused) {
+        return replaceCorrelatorFallback(baseUrl, ctx.correlator);
+    }
+    var params = url.searchParams;
+    params.set("correlator", ctx.correlator);
+    params.set("scor", ctx.streamCorrelator);
+    if (ctx.pod != null) {
+        params.set("pod", String(ctx.pod));
+    }
+    if (ctx.adPosition != null) {
+        params.set("ppos", String(ctx.adPosition));
+    }
+    if (ctx.pageUrl) {
+        params.set("url", ctx.pageUrl);
+        params.set("description_url", ctx.pageUrl);
+    }
+    if (ctx.adWillPlayMuted != null) {
+        params.set("vpmute", ctx.adWillPlayMuted ? "1" : "0");
+    }
+    if (ctx.adWillAutoPlay != null) {
+        params.set("vpa", ctx.adWillAutoPlay ? "auto" : "click");
+    }
+    if (ctx.deviceId && ctx.deviceIdType) {
+        params.set("rdid", ctx.deviceId);
+        params.set("idtype", ctx.deviceIdType);
+        params.set("is_lat", ctx.limitAdTracking ? "1" : "0");
+    } else {
+        params.delete("rdid");
+        params.delete("idtype");
+        params.delete("is_lat");
+    }
+    var consent = ctx.consent;
+    if ((consent === null || consent === void 0 ? void 0 : consent.gdpr) != null) {
+        params.set("gdpr", consent.gdpr);
+    }
+    if ((consent === null || consent === void 0 ? void 0 : consent.gdprConsent) != null) {
+        params.set("gdpr_consent", consent.gdprConsent);
+    }
+    if ((consent === null || consent === void 0 ? void 0 : consent.usPrivacy) != null) {
+        params.set("us_privacy", consent.usPrivacy);
+    }
+    if (ctx.adTest) {
+        params.set("adtest", "on");
+    }
+    var staleKeys = [];
+    params.forEach(function(value, key) {
+        if (UNEXPANDED_MACRO_PATTERN.test(value)) {
+            staleKeys.push(key);
+        }
+    });
+    var _iteratorNormalCompletion = true, _didIteratorError = false, _iteratorError = undefined;
+    try {
+        for(var _iterator = staleKeys[Symbol.iterator](), _step; !(_iteratorNormalCompletion = (_step = _iterator.next()).done); _iteratorNormalCompletion = true){
+            var key = _step.value;
+            params.delete(key);
+        }
+    } catch (err) {
+        _didIteratorError = true;
+        _iteratorError = err;
+    } finally{
+        try {
+            if (!_iteratorNormalCompletion && _iterator.return != null) {
+                _iterator.return();
+            }
+        } finally{
+            if (_didIteratorError) {
+                throw _iteratorError;
+            }
+        }
+    }
+    return url.toString();
+}
+function replaceCorrelatorFallback(baseUrl, correlator) {
+    var correlatorRegex = /([?&])correlator=([^&]*)/;
+    if (correlatorRegex.test(baseUrl)) {
+        return baseUrl.replace(correlatorRegex, "$1correlator=".concat(correlator));
+    }
+    var sep = baseUrl.includes("?") ? "&" : "?";
+    return "".concat(baseUrl).concat(sep, "correlator=").concat(correlator);
+}
+function fetchConsentSignals() {
+    var timeoutMs = arguments.length > 0 && arguments[0] !== void 0 ? arguments[0] : 1500;
+    var signals = {};
+    if (typeof window === "undefined") {
+        return Promise.resolve(signals);
+    }
+    var tasks = [];
+    var tcfApi = window.__tcfapi;
+    if (typeof tcfApi === "function") {
+        tasks.push(new Promise(function(resolve) {
+            var settled = false;
+            try {
+                tcfApi("addEventListener", 2, function(tcData, success) {
+                    if (settled) return;
+                    if (success && tcData && (tcData.eventStatus === "tcloaded" || tcData.eventStatus === "useractioncomplete")) {
+                        settled = true;
+                        signals.gdpr = tcData.gdprApplies ? "1" : "0";
+                        if (typeof tcData.tcString === "string" && tcData.tcString) {
+                            signals.gdprConsent = tcData.tcString;
+                        }
+                        try {
+                            tcfApi("removeEventListener", 2, function() {}, tcData.listenerId);
+                        } catch (unused) {}
+                        resolve();
+                    }
+                });
+            } catch (unused) {
+                resolve();
+            }
+            setTimeout(function() {
+                if (!settled) {
+                    settled = true;
+                    resolve();
+                }
+            }, timeoutMs);
+        }));
+    }
+    var uspApi = window.__uspapi;
+    if (typeof uspApi === "function") {
+        tasks.push(new Promise(function(resolve) {
+            try {
+                uspApi("getUSPData", 1, function(data, success) {
+                    if (success && typeof (data === null || data === void 0 ? void 0 : data.uspString) === "string" && data.uspString) {
+                        signals.usPrivacy = data.uspString;
+                    }
+                    resolve();
+                });
+            } catch (unused) {
+                resolve();
+            }
+            setTimeout(resolve, timeoutMs);
+        }));
+    }
+    if (tasks.length === 0) {
+        return Promise.resolve(signals);
+    }
+    return Promise.all(tasks).then(function() {
+        return signals;
+    });
+}
 // src/utils/browserCompat.ts
 function getChromeVersion(ua) {
     var match = ua.match(/Chrome\/(\d+)/);
@@ -2485,6 +2645,11 @@ var StormcloudVideoPlayer = /*#__PURE__*/ function() {
         this.preloadPoolLoopRunning = false;
         this.adDetectSentForCurrentBreak = false;
         this.palPlaybackStarted = false;
+        this.streamCorrelator = generateCorrelator();
+        this.consentSignals = {};
+        this.podCounter = 0;
+        this.podAssignedByPrefetch = false;
+        this.adRequestPositionInBreak = 0;
         this.continuousFetchLoopRunning = false;
         initializePolyfills();
         var browserOverrides = getBrowserConfigOverrides();
@@ -2557,6 +2722,9 @@ var StormcloudVideoPlayer = /*#__PURE__*/ function() {
                                     adWillPlayMuted: !!this.config.muted,
                                     continuousPlayback: (_this_config_lowLatencyMode = this.config.lowLatencyMode) !== null && _this_config_lowLatencyMode !== void 0 ? _this_config_lowLatencyMode : false
                                 }).catch(function() {});
+                                fetchConsentSignals().then(function(signals) {
+                                    _this.consentSignals = signals;
+                                }).catch(function() {});
                                 this.initializeTracking();
                                 if (!this.shouldUseNativeHls()) return [
                                     3,
@@ -4853,25 +5021,35 @@ var StormcloudVideoPlayer = /*#__PURE__*/ function() {
                 return this.getRemainingAdMs();
             }
         },
+        {
+            key: "beginNewAdPod",
+            value: function beginNewAdPod() {
+                this.podCounter++;
+                this.adRequestPositionInBreak = 0;
+            }
+        },
         {
             key: "generateVastUrlsWithCorrelators",
             value: function generateVastUrlsWithCorrelators(baseUrl, count) {
                 var urls = [];
-                var baseTimestamp = Date.now();
                 for(var i = 0; i < count; i++){
-                    var timestamp = baseTimestamp + i;
-                    var random = Math.floor(Math.random() * 1e12);
-                    var uniqueCorrelator = "".concat(timestamp, "_").concat(random, "_").concat(i);
-                    var urlWithCorrelator = void 0;
-                    var correlatorRegex = /([?&])correlator=([^&]*)/;
-                    if (correlatorRegex.test(baseUrl)) {
-                        urlWithCorrelator = baseUrl.replace(correlatorRegex, "$1correlator=".concat(uniqueCorrelator));
-                    } else if (baseUrl.includes("?")) {
-                        urlWithCorrelator = "".concat(baseUrl, "&correlator=").concat(uniqueCorrelator);
-                    } else {
-                        urlWithCorrelator = "".concat(baseUrl, "?correlator=").concat(uniqueCorrelator);
-                    }
-                    urls.push(this.palNonce.injectNonce(urlWithCorrelator));
+                    this.adRequestPositionInBreak++;
+                    var adWillPlayMuted = this.inAdBreak ? this.adPlayer.getOriginalMutedState() : this.video.muted;
+                    var urlWithMacros = applyVastMacros(baseUrl, {
+                        correlator: generateCorrelator(),
+                        streamCorrelator: this.streamCorrelator,
+                        pod: this.podCounter > 0 ? this.podCounter : void 0,
+                        adPosition: this.adRequestPositionInBreak,
+                        pageUrl: typeof window !== "undefined" ? window.location.href : void 0,
+                        adWillPlayMuted: adWillPlayMuted,
+                        adWillAutoPlay: !!this.config.autoplay,
+                        deviceId: this.config.deviceId,
+                        deviceIdType: this.config.deviceIdType,
+                        limitAdTracking: this.config.limitAdTracking,
+                        adTest: this.config.adTest,
+                        consent: this.consentSignals
+                    });
+                    urls.push(this.palNonce.injectNonce(urlWithMacros));
                 }
                 return urls;
             }
@@ -4941,6 +5119,8 @@ var StormcloudVideoPlayer = /*#__PURE__*/ function() {
                     }
                     return;
                 }
+                this.beginNewAdPod();
+                this.podAssignedByPrefetch = true;
                 var urlsToPregenerate = 5;
                 var generatedUrls = this.generateVastUrlsWithCorrelators(baseVastUrl, urlsToPregenerate);
                 this.pendingAdBreak = _object_spread_props(_object_spread({
@@ -4978,6 +5158,7 @@ var StormcloudVideoPlayer = /*#__PURE__*/ function() {
                 }
                 this.pendingAdBreak = null;
                 this.pendingScte35CueKey = void 0;
+                this.podAssignedByPrefetch = false;
             }
         },
         {
@@ -5414,6 +5595,11 @@ var StormcloudVideoPlayer = /*#__PURE__*/ function() {
                                 this.continuousFetchingActive = true;
                                 this.isShowingPlaceholder = false;
                                 this.totalAdRequestsInBreak = 0;
+                                if (this.podAssignedByPrefetch) {
+                                    this.podAssignedByPrefetch = false;
+                                } else {
+                                    this.beginNewAdPod();
+                                }
                                 currentMuted = this.video.muted;
                                 currentVolume = this.video.volume;
                                 this.adPlayer.updateOriginalMutedState(currentMuted, currentVolume);