@streamlayer/feature-advertisement 1.1.0 → 1.1.1-rc.1343

package/lib/classic/cjs/advertisement.js

@@ -0,0 +1,333 @@
+'use strict';
+
+var _rollupPluginBabelHelpers = require('./_virtual/_rollupPluginBabelHelpers.js');
+require('core-js/modules/es.array.iterator.js');
+require('core-js/modules/esnext.iterator.constructor.js');
+require('core-js/modules/esnext.iterator.for-each.js');
+require('core-js/modules/esnext.set.difference.v2.js');
+require('core-js/modules/esnext.set.intersection.v2.js');
+require('core-js/modules/esnext.set.is-disjoint-from.v2.js');
+require('core-js/modules/esnext.set.is-subset-of.v2.js');
+require('core-js/modules/esnext.set.is-superset-of.v2.js');
+require('core-js/modules/esnext.set.symmetric-difference.v2.js');
+require('core-js/modules/esnext.set.union.v2.js');
+require('core-js/modules/web.dom-collections.for-each.js');
+require('core-js/modules/web.dom-collections.iterator.js');
+var classic = require('@streamlayer/sdk-web-interfaces/classic');
+var classic$1 = require('@streamlayer/sdk-web-logger/classic');
+var externalAd = require('./units/external-ad.js');
+var externalPauseAd = require('./units/external-pause-ad.js');
+var pauseAd = require('./units/pause-ad.js');
+var ssaiCreative = require('./units/ssai-creative.js');
+var ssaiProviders = require('./units/ssai-providers.js');
+var ssaiDetector = require('./units/ssai-detector.js');
+var ssaiAdBreak = require('./units/ssai-ad-break.js');
+var ssaiPreload = require('./units/ssai-preload.js');
+
+class Advertisement extends classic.AbstractFeatureUnit {
+  constructor(instance) {
+    super();
+    _rollupPluginBabelHelpers.defineProperty(this, "getExternalAd", void 0);
+    _rollupPluginBabelHelpers.defineProperty(this, "getExternalPauseAd", void 0);
+    _rollupPluginBabelHelpers.defineProperty(this, "getPauseAdList", void 0);
+    _rollupPluginBabelHelpers.defineProperty(this, "ssaiAdBreak", ssaiAdBreak.createSsaiAdBreakStore());
+    _rollupPluginBabelHelpers.defineProperty(this, "startSsaiMonitoring", void 0);
+    _rollupPluginBabelHelpers.defineProperty(this, "stopSsaiMonitoring", void 0);
+    /**
+     * Fire the impression tracking pixel for a creative. Called by the UI the
+     * moment the bar actually renders the creative, so "impression" means the
+     * viewer saw it (not merely that metadata resolved).
+     */
+    _rollupPluginBabelHelpers.defineProperty(this, "fireSsaiImpression", void 0);
+    /**
+     * Fire a named tracking beacon for a creative (`clickThrough`, or any event
+     * the creative carries). Lifecycle beacons — `start`, the quartiles and
+     * `complete` — are fired automatically by the detector as playback crosses
+     * them; this is for the ones only the UI knows about.
+     */
+    _rollupPluginBabelHelpers.defineProperty(this, "fireSsaiTracking", void 0);
+    /**
+     * Fire the companion's `clickTracking` beacons. Exposed for hosts that render
+     * the companion banner themselves — the TV overlay has no companion surface,
+     * so nothing in this SDK calls it.
+     */
+    _rollupPluginBabelHelpers.defineProperty(this, "fireSsaiCompanionClick", void 0);
+    /**
+     * User-dismissed the current break: hide the bar now and keep it hidden for
+     * the rest of this break (a later break/creative shows again).
+     */
+    _rollupPluginBabelHelpers.defineProperty(this, "dismissSsaiBreak", void 0);
+    /**
+     * Read-only timing introspection of the running SSAI monitor (null while no
+     * monitor runs). Feeds the demo app's SSAI debug window; safe to poll.
+     */
+    _rollupPluginBabelHelpers.defineProperty(this, "getSsaiDebugSnapshot", void 0);
+    _rollupPluginBabelHelpers.defineProperty(this, "externalAdStores", new Map());
+    _rollupPluginBabelHelpers.defineProperty(this, "externalPauseAdStores", new Map());
+    _rollupPluginBabelHelpers.defineProperty(this, "externalPauseAdEnabled", new Map());
+    _rollupPluginBabelHelpers.defineProperty(this, "pauseAdStore", null);
+    _rollupPluginBabelHelpers.defineProperty(this, "pauseAdEnabled", null);
+    _rollupPluginBabelHelpers.defineProperty(this, "ssaiDetector", null);
+    _rollupPluginBabelHelpers.defineProperty(this, "ssaiCache", null);
+    _rollupPluginBabelHelpers.defineProperty(this, "log", void 0);
+    _rollupPluginBabelHelpers.defineProperty(this, "connect", () => {
+      this.log.debug('connect');
+    });
+    _rollupPluginBabelHelpers.defineProperty(this, "disconnect", () => {
+      this.log.debug('disconnect');
+      this.stopSsaiMonitoring();
+      this.externalAdStores.forEach(store => {
+        store.off();
+      });
+      this.externalAdStores.clear();
+      this.externalPauseAdStores.forEach(store => {
+        store.off();
+      });
+      this.externalPauseAdEnabled.forEach(enabled => {
+        enabled.off();
+      });
+      this.externalPauseAdEnabled.clear();
+      this.externalPauseAdStores.clear();
+      if (this.pauseAdStore) {
+        var _this$pauseAdEnabled;
+        this.pauseAdStore.$list.off();
+        this.pauseAdStore.$index.off();
+        (_this$pauseAdEnabled = this.pauseAdEnabled) === null || _this$pauseAdEnabled === void 0 || _this$pauseAdEnabled.off();
+        this.pauseAdStore = null;
+        this.pauseAdEnabled = null;
+      }
+    });
+    this.log = classic$1.createLogger('advertisement');
+    const externalAdGenerator = externalAd.externalAd(instance);
+    const externalPauseAdGenerator = externalPauseAd.externalPauseAd(instance);
+    const pauseAdGenerator = pauseAd.pauseAdListStore(instance);
+    this.fireSsaiImpression = () => undefined;
+    this.fireSsaiTracking = () => undefined;
+    this.fireSsaiCompanionClick = () => undefined;
+    this.dismissSsaiBreak = () => undefined;
+    // Stable across start/stop cycles — always answers from the CURRENT detector.
+    this.getSsaiDebugSnapshot = () => {
+      var _this$ssaiDetector$ge, _this$ssaiDetector;
+      return (_this$ssaiDetector$ge = (_this$ssaiDetector = this.ssaiDetector) === null || _this$ssaiDetector === void 0 ? void 0 : _this$ssaiDetector.getDebugSnapshot()) !== null && _this$ssaiDetector$ge !== void 0 ? _this$ssaiDetector$ge : null;
+    };
+    this.getPauseAdList = options => {
+      if (this.pauseAdStore) {
+        const $enabled = this.pauseAdEnabled;
+        const wasDisabled = $enabled.get() === false;
+        $enabled.set(options.$enabled);
+        if (wasDisabled && options.$enabled) {
+          window.requestAnimationFrame(() => {
+            if (this.pauseAdStore) this.pauseAdStore.$list.revalidate();
+          });
+        }
+        return this.pauseAdStore;
+      }
+      const $enabled = classic.createSingleStore(options.$enabled);
+      this.pauseAdEnabled = $enabled;
+      this.pauseAdStore = pauseAdGenerator($enabled, options);
+      return this.pauseAdStore;
+    };
+    this.getExternalAd = (adUrl = '') => {
+      if (this.externalAdStores.has(adUrl)) {
+        const $store = this.externalAdStores.get(adUrl);
+        return [$store, adUrl];
+      }
+      const store = externalAdGenerator(adUrl);
+      this.externalAdStores.set(adUrl, store);
+      return [store, adUrl];
+    };
+    this.getExternalPauseAd = (adUrl, options) => {
+      var _options$template;
+      // Store identity is (template, url): the template selects a DIFFERENT creative
+      // from the SAME tag, so the two must not share a store. Required because the
+      // cache-hit branch below applies only `$enabled` and drops the rest of `options`.
+      const storeKey = `${(_options$template = options.template) !== null && _options$template !== void 0 ? _options$template : 'default'}::${adUrl}`;
+      if (this.externalPauseAdStores.has(storeKey)) {
+        const $enabled = this.externalPauseAdEnabled.get(storeKey);
+        const $store = this.externalPauseAdStores.get(storeKey);
+        const shouldRevalidate = $enabled.get() === false && options.$enabled === true;
+        $enabled.set(options.$enabled);
+        if (shouldRevalidate) {
+          window.requestAnimationFrame(() => {
+            $store.revalidate();
+          });
+        }
+        // The 2nd element MUST stay the BARE url — `ExposedPauseAd` compares it to
+        // `vastUrlRef.current` (index.tsx:121) to scope store errors to the selected tag.
+        return [$store, adUrl];
+      }
+      const $enabled = classic.createSingleStore(options.$enabled);
+      const store = externalPauseAdGenerator(adUrl, $enabled, options);
+      this.externalPauseAdEnabled.set(storeKey, $enabled);
+      this.externalPauseAdStores.set(storeKey, store);
+      return [store, adUrl];
+    };
+    this.startSsaiMonitoring = options => {
+      this.stopSsaiMonitoring();
+      const provider = ssaiProviders.resolveProvider(options.provider);
+      const cache = new ssaiCreative.SsaiCreativeCache(provider);
+      this.ssaiCache = cache;
+      this.fireSsaiImpression = creativeId => {
+        cache.fireImpressionById(creativeId);
+      };
+      this.fireSsaiTracking = (creativeId, event) => {
+        cache.fireTrackingById(creativeId, event);
+      };
+      this.fireSsaiCompanionClick = creativeId => {
+        cache.fireCompanionClickById(creativeId);
+      };
+      // Creative ids whose artwork preload has completed. Tracked apart from the
+      // cache: `peek` alone would let the bar show with a logo still in flight.
+      const preloadedIds = new Set();
+      /**
+       * Resolve + warm a creative the moment its id shows up in the manifest —
+       * typically seconds before its break starts, since the playhead trails the
+       * live edge. By break start the sync fast-path in `loadCreative` then flips
+       * the store straight to 'ready'. Failure here is only a debug note: the
+       * break may still be minutes away, and `loadCreative` retries (and warns)
+       * when the ad actually starts.
+       */
+      const prefetchCreative = creativeId => {
+        cache.resolve(creativeId).then(creative => ssaiPreload.preloadCreativeAssets(creative)).then(() => {
+          preloadedIds.add(creativeId);
+        }).catch(error => {
+          this.log.debug(error, 'ssai creative prefetch failed');
+        });
+      };
+      const publishReady = (range, creative) => {
+        this.ssaiAdBreak.set({
+          creativeId: range.creativeId,
+          creative,
+          status: 'ready',
+          startMs: range.startMs,
+          durationSec: range.durationSec
+        });
+        // "loaded" = metadata resolved. Impression (eventBus + pixel) fires
+        // from the UI when the bar is actually rendered, not here.
+        classic.eventBus.emit('ssaiAdBreak', {
+          action: 'vastLoaded',
+          payload: {
+            creativeId: creative.creativeId,
+            advertiser: creative.advertiser,
+            clickThroughUrl: creative.clickThroughUrl
+          }
+        });
+      };
+      const loadCreative = range => {
+        // Fast path: prefetched at discovery, artwork warm — go straight to
+        // 'ready'. Skipping the 'detecting' hop matters for pods in particular:
+        // it momentarily empties the store, which the UI renders as the bar
+        // starting to close between two back-to-back ads.
+        const prefetched = cache.peek(range.creativeId);
+        if (prefetched && preloadedIds.has(range.creativeId)) {
+          publishReady(range, prefetched);
+          return;
+        }
+        this.ssaiAdBreak.set({
+          creativeId: range.creativeId,
+          status: 'detecting',
+          startMs: range.startMs,
+          durationSec: range.durationSec
+        });
+        cache.resolve(range.creativeId)
+        // Warm the artwork BEFORE flipping to 'ready', so the bar fades in with
+        // its logo already decoded instead of popping it in mid-animation. Capped
+        // internally, so a slow image host delays nothing.
+        .then(creative => ssaiPreload.preloadCreativeAssets(creative).then(() => {
+          preloadedIds.add(range.creativeId);
+          return creative;
+        })).then(creative => {
+          const current = this.ssaiAdBreak.get();
+          // Re-checked after the preload as well as the fetch: the break can end
+          // while either is in flight.
+          if (!current || current.creativeId !== range.creativeId) {
+            return;
+          }
+          publishReady(range, creative);
+        }).catch(error => {
+          this.log.warn(error, 'ssai creative resolution failed');
+        });
+      };
+      this.ssaiDetector = ssaiDetector.createSsaiDetector({
+        player: options.player,
+        videoRef: options.videoRef,
+        manifestUrl: options.manifestUrl,
+        onAdDiscovered: creativeId => {
+          this.log.debug({
+            creativeId
+          }, 'ssai ad discovered, prefetching creative');
+          prefetchCreative(creativeId);
+        },
+        onBreakStart: range => {
+          this.log.debug({
+            creativeId: range.creativeId
+          }, 'ssai break start');
+          classic.eventBus.emit('ssaiAdBreak', {
+            action: 'breakStart',
+            payload: {
+              creativeId: range.creativeId
+            }
+          });
+          loadCreative(range);
+        },
+        onCreativeChange: range => {
+          this.log.debug({
+            creativeId: range.creativeId
+          }, 'ssai creative change');
+          loadCreative(range);
+        },
+        onAdEnding: range => {
+          const current = this.ssaiAdBreak.get();
+          // Only a bar currently showing this creative has anything to wind
+          // down — a dismissed or still-resolving break stays as it is.
+          if (!current || current.creativeId !== range.creativeId || current.status !== 'ready') {
+            return;
+          }
+          this.ssaiAdBreak.set(_rollupPluginBabelHelpers.objectSpread2(_rollupPluginBabelHelpers.objectSpread2({}, current), {}, {
+            status: 'ending'
+          }));
+        },
+        onProgress: (range, event) => {
+          this.log.debug({
+            creativeId: range.creativeId,
+            event
+          }, 'ssai progress');
+          cache.fireTrackingById(range.creativeId, event);
+        },
+        onBreakEnd: () => {
+          this.log.debug('ssai break end');
+          const current = this.ssaiAdBreak.get();
+          classic.eventBus.emit('ssaiAdBreak', {
+            action: 'breakEnd',
+            payload: {
+              creativeId: current === null || current === void 0 ? void 0 : current.creativeId
+            }
+          });
+          this.ssaiAdBreak.set(null);
+        }
+      });
+      this.dismissSsaiBreak = () => {
+        var _this$ssaiDetector2;
+        (_this$ssaiDetector2 = this.ssaiDetector) === null || _this$ssaiDetector2 === void 0 || _this$ssaiDetector2.dismissActiveBreak();
+        this.ssaiAdBreak.set(null);
+      };
+    };
+    this.stopSsaiMonitoring = () => {
+      if (this.ssaiDetector) {
+        this.ssaiDetector.destroy();
+        this.ssaiDetector = null;
+      }
+      if (this.ssaiCache) {
+        this.ssaiCache.destroy();
+        this.ssaiCache = null;
+      }
+      this.fireSsaiImpression = () => undefined;
+      this.fireSsaiTracking = () => undefined;
+      this.fireSsaiCompanionClick = () => undefined;
+      this.dismissSsaiBreak = () => undefined;
+      this.ssaiAdBreak.set(null);
+    };
+  }
+}
+
+exports.Advertisement = Advertisement;

package/lib/classic/cjs/index.js

@@ -0,0 +1,47 @@
+'use strict';
+
+var advertisement$1 = require('./advertisement.js');
+var externalPauseAd = require('./units/external-pause-ad.js');
+var pauseAdCard = require('./units/pause-ad-card.js');
+var gam = require('./units/gam.js');
+var vastTracker = require('./units/vast-tracker.js');
+require('core-js/modules/es.array.iterator.js');
+require('core-js/modules/es.promise.js');
+require('core-js/modules/esnext.iterator.constructor.js');
+require('core-js/modules/esnext.iterator.for-each.js');
+require('core-js/modules/web.dom-collections.for-each.js');
+require('core-js/modules/web.dom-collections.iterator.js');
+var ssaiProviders = require('./units/ssai-providers.js');
+var ssaiPreload = require('./units/ssai-preload.js');
+
+const advertisement = (instance, _opts, done) => {
+  instance.sdk.advertisement = new advertisement$1.Advertisement(instance);
+  instance.sdk.onMount({
+    name: 'advertisement'
+  }, () => {
+    instance.sdk.advertisement.connect();
+    return () => {
+      instance.sdk.advertisement.disconnect();
+    };
+  });
+  done();
+};
+
+exports.isFullbleedVideoTemplate = externalPauseAd.isFullbleedVideoTemplate;
+exports.INSIGHT_BODY_MAX_LENGTH = pauseAdCard.INSIGHT_BODY_MAX_LENGTH;
+exports.gam = gam.gam;
+exports.createCompanionTracker = vastTracker.createCompanionTracker;
+exports.createVastTracker = vastTracker.createVastTracker;
+exports.resolveVastTrackerTarget = vastTracker.resolveVastTrackerTarget;
+exports.BUILTIN_PROVIDERS = ssaiProviders.BUILTIN_PROVIDERS;
+exports.DEFAULT_CREATIVE_API_BASE = ssaiProviders.DEFAULT_CREATIVE_API_BASE;
+exports.createQuortexProvider = ssaiProviders.createQuortexProvider;
+exports.createStreamLayerProvider = ssaiProviders.createStreamLayerProvider;
+exports.createVastProvider = ssaiProviders.createVastProvider;
+exports.fireBeacon = ssaiProviders.fireBeacon;
+exports.fireTrackingEvents = ssaiProviders.fireTrackingEvents;
+exports.resolveProvider = ssaiProviders.resolveProvider;
+exports.DEFAULT_PRELOAD_TIMEOUT_MS = ssaiPreload.DEFAULT_PRELOAD_TIMEOUT_MS;
+exports.preloadCreativeAssets = ssaiPreload.preloadCreativeAssets;
+exports.preloadImages = ssaiPreload.preloadImages;
+exports.advertisement = advertisement;

package/lib/classic/cjs/package.json

@@ -0,0 +1 @@
+{"type":"commonjs"}