stormcloud-video-player 0.8.68 → 0.8.70

package/lib/index.d.cts

@@ -1,7 +1,8 @@
 export { StormcloudVideoPlayerComponent, StormcloudVideoPlayerProps, StormcloudVideoPlayerComponent as default } from './ui/StormcloudVideoPlayer.cjs';
 export { default as StormcloudPlayer, createStormcloudPlayer } from './StormcloudPlayer.cjs';
 export { StormcloudVideoPlayer } from './player/StormcloudVideoPlayer.cjs';
-export { AdBreak, AdController, AdControllerOptions, AdDetectInfo, AdImpressionInfo, AdLoadedInfo, AdSchedule, ClientInfo, HeartbeatData, ImaController, ImaControllerOptions, LateJoinPolicy, PlayerAnalyticsContext, StormcloudVideoPlayerConfig, TrackingData } from './types.cjs';
+export { AdBreak, AdController, AdControllerOptions, AdDetectInfo, AdFloorLadderConfig, AdImpressionInfo, AdLoadedInfo, AdPosition, AdSchedule, ClientInfo, FloorLadderMode, HeartbeatData, ImaController, ImaControllerOptions, LateJoinPolicy, PlayerAnalyticsContext, StormcloudVideoPlayerConfig, TrackingData } from './types.cjs';
+export { DEFAULT_FLOOR_LADDER_BOUNDS, DEFAULT_WEB_FLOOR_LADDER_CONFIG, FloorLadderBounds, FloorLadderValidationReport, FloorSelectionContext, FloorSelector, FloorSelectorResult, FloorSource, FloorValidation, OpportunityFloor, fixedFloorSelector, generateFloorLevels, resolveFloorLadderBounds, validateFloorCents, validateFloorLadderConfig } from './player/FloorLadder.cjs';
 export { BaseStormcloudPlayerProps, OnProgressProps } from './props.cjs';
 export { canPlay } from './patterns.cjs';
 export { IS_BROWSER, IS_GLOBAL, IS_IOS, IS_SAFARI, SUPPORTS_DASH, SUPPORTS_HLS, isMediaStream, lazy, merge, omit, parseQuery, randomString, supportsWebKitPresentationMode } from './utils.cjs';

package/lib/index.d.ts

@@ -50,10 +50,37 @@ interface StormcloudVideoPlayerConfig {
     podMaxAds?: number;
     podMaxDurationMs?: number;
     podExactDuration?: boolean;
+    adFloorLadderEnabled?: boolean;
+    adFloorLadder?: Partial<AdFloorLadderConfig>;
+    adFloorMinCents?: number;
+    adFloorMaxCents?: number;
+    adFloorStepCents?: number;
+    enableEdgePodRequest?: boolean;
+    edgePodUrl?: string;
+}
+type AdPosition = "preroll" | "midroll" | "postroll";
+type FloorLadderMode = "fixed";
+interface AdFloorLadderConfig {
+    enabled: boolean;
+    targetingKey: string;
+    minFloorCents: number;
+    maxFloorCents: number;
+    stepCents: number;
+    selectedFloorCents: number;
+    fallbackFloorCents: number;
+    readyFloorCents: number[];
+    mode: FloorLadderMode;
+    allowedPositions: AdPosition[];
+    targetAdUnitPath: string;
+    configurationVersion: string;
+}
+type AdRequestSource = "gam" | "edge";
+interface AdRequestOptions {
+    source?: AdRequestSource;
 }
 interface AdController {
     initialize: () => void;
-    requestAds: (vastTagUrl: string) => Promise<void>;
+    requestAds: (vastTagUrl: string, options?: AdRequestOptions) => Promise<void>;
     play: () => Promise<void>;
     pause: () => void;
     resume: () => void;
@@ -74,6 +101,7 @@ interface AdController {
     getLoadedAdId?: () => string | undefined;
     getPodAdCount?: () => number;
     getPodTotalDurationMs?: () => number;
+    limitPodToBudget?: (maxDurationMs: number, maxAds: number) => number;
     setFunnelContext?: (context: {
         breakId?: number;
         requestId?: number;
@@ -160,6 +188,58 @@ interface AdImpressionInfo {
     timestamp: string;
 }
 
+declare const DEFAULT_WEB_FLOOR_LADDER_CONFIG: Readonly<AdFloorLadderConfig>;
+type FloorValidationReason = "not_integer" | "out_of_range" | "not_step_multiple" | "not_ready";
+type FloorValidation = {
+    ok: true;
+} | {
+    ok: false;
+    reason: FloorValidationReason;
+};
+type FloorSource = "selected" | "fallback" | "none";
+/** Levels that have targeting values in GAM; the ladder config can narrow these but never widen them. */
+interface FloorLadderBounds {
+    minCents: number;
+    maxCents: number;
+    stepCents: number;
+}
+declare const DEFAULT_FLOOR_LADDER_BOUNDS: Readonly<FloorLadderBounds>;
+interface FloorSelectionContext {
+    position: AdPosition;
+    isCtv: boolean;
+    bounds: Readonly<FloorLadderBounds>;
+}
+interface FloorSelectorResult {
+    floorCents?: number;
+    source: FloorSource;
+    reason?: string;
+}
+interface FloorSelector {
+    readonly name: string;
+    select(config: Readonly<AdFloorLadderConfig>, context: FloorSelectionContext): FloorSelectorResult;
+}
+interface OpportunityFloor {
+    readonly status: "armed" | "skipped";
+    readonly floorCents: number | undefined;
+    readonly source: FloorSource;
+    readonly reason: string | undefined;
+    readonly selector: string;
+    readonly position: AdPosition;
+    readonly configurationVersion: string;
+    readonly targetingKey: string;
+    readonly targetAdUnitPath: string;
+}
+interface FloorLadderValidationReport {
+    ok: boolean;
+    levels: number[];
+    errors: string[];
+}
+declare function generateFloorLevels(minCents: number, maxCents: number, stepCents: number): number[];
+declare function resolveFloorLadderBounds(overrides?: Partial<FloorLadderBounds>): FloorLadderBounds;
+declare function validateFloorCents(value: unknown, config: Readonly<AdFloorLadderConfig>, bounds?: Readonly<FloorLadderBounds>): FloorValidation;
+declare function validateFloorLadderConfig(config: Readonly<AdFloorLadderConfig>, bounds?: Readonly<FloorLadderBounds>): FloorLadderValidationReport;
+declare const fixedFloorSelector: FloorSelector;
+
 declare class StormcloudVideoPlayer {
     private readonly video;
     private readonly config;
@@ -176,9 +256,20 @@ declare class StormcloudVideoPlayer {
     private readonly placeholder;
     private readonly hlsEngine;
     private readonly adBreak;
+    private readonly floorLadder;
+    private floorLadderEnabled;
+    private readonly edgePodBaseUrl;
     constructor(config: StormcloudVideoPlayerConfig);
     private get debug();
     private createAdPlayer;
+    private isCtvEnvironment;
+    setAdFloorLadder(update: Partial<AdFloorLadderConfig>): FloorLadderValidationReport;
+    setAdFloorLadderEnabled(enabled: boolean): void;
+    isAdFloorLadderEnabled(): boolean;
+    private warnOnInvalidFloorLadder;
+    getAdFloorLadder(): AdFloorLadderConfig;
+    getAdFloorBounds(): FloorLadderBounds;
+    setAdFloorSelector(selector: FloorSelector): void;
     private generatePodVastUrl;
     load(): Promise<void>;
     private onManifestParsed;
@@ -4041,4 +4132,4 @@ interface PalNonceManager {
 }
 declare function createPalNonceManager(): PalNonceManager;
 
-export { type AdBreak, type AdController, type AdControllerOptions, type AdDetectInfo, type AdImpressionInfo, type AdLoadedInfo, type AdSchedule, type BaseStormcloudPlayerProps, type BrowserInfo, type ClientInfo, DEFAULT_TRACKING_INGEST_CONFIG, type HeartbeatData, IS_BROWSER, IS_GLOBAL, IS_IOS, IS_SAFARI, type ImaController, type ImaControllerOptions, type LateJoinPolicy, type OnProgressProps, type PalNonceManager, type PalNonceOptions, type PlayerAnalyticsContext, SUPPORTS_DASH, SUPPORTS_HLS, StormcloudPlayer, StormcloudVideoPlayer, StormcloudVideoPlayerComponent, type StormcloudVideoPlayerConfig, type StormcloudVideoPlayerProps, type TrackingData, type TrackingIngestChannel, type TrackingIngestConfig, applyTrackingIngestConfig, buildAnalyticsContext, canPlay, configureTrackingIngest, createHlsAdPlayer, createPalNonceManager, createStormcloudPlayer, StormcloudVideoPlayerComponent as default, detectBrowser, getBrowserConfigOverrides, getBrowserID, getClientInfo, ingestPlayerTracking, initializePolyfills, isMediaStream, isTrackingIngestEnabled, lazy, logBrowserInfo, merge, omit, parseQuery, players, randomString, requiresMediaPipelineResetAfterAds, sendAdDetectTracking, sendAdImpressionTracking, sendAdLoadedTracking, sendHeartbeat, sendInitialTracking, supportsFeature, supportsModernJS, supportsWebKitPresentationMode, trackingIngestConfig };
+export { type AdBreak, type AdController, type AdControllerOptions, type AdDetectInfo, type AdFloorLadderConfig, type AdImpressionInfo, type AdLoadedInfo, type AdPosition, type AdSchedule, type BaseStormcloudPlayerProps, type BrowserInfo, type ClientInfo, DEFAULT_FLOOR_LADDER_BOUNDS, DEFAULT_TRACKING_INGEST_CONFIG, DEFAULT_WEB_FLOOR_LADDER_CONFIG, type FloorLadderBounds, type FloorLadderMode, type FloorLadderValidationReport, type FloorSelectionContext, type FloorSelector, type FloorSelectorResult, type FloorSource, type FloorValidation, type HeartbeatData, IS_BROWSER, IS_GLOBAL, IS_IOS, IS_SAFARI, type ImaController, type ImaControllerOptions, type LateJoinPolicy, type OnProgressProps, type OpportunityFloor, type PalNonceManager, type PalNonceOptions, type PlayerAnalyticsContext, SUPPORTS_DASH, SUPPORTS_HLS, StormcloudPlayer, StormcloudVideoPlayer, StormcloudVideoPlayerComponent, type StormcloudVideoPlayerConfig, type StormcloudVideoPlayerProps, type TrackingData, type TrackingIngestChannel, type TrackingIngestConfig, applyTrackingIngestConfig, buildAnalyticsContext, canPlay, configureTrackingIngest, createHlsAdPlayer, createPalNonceManager, createStormcloudPlayer, StormcloudVideoPlayerComponent as default, detectBrowser, fixedFloorSelector, generateFloorLevels, getBrowserConfigOverrides, getBrowserID, getClientInfo, ingestPlayerTracking, initializePolyfills, isMediaStream, isTrackingIngestEnabled, lazy, logBrowserInfo, merge, omit, parseQuery, players, randomString, requiresMediaPipelineResetAfterAds, resolveFloorLadderBounds, sendAdDetectTracking, sendAdImpressionTracking, sendAdLoadedTracking, sendHeartbeat, sendInitialTracking, supportsFeature, supportsModernJS, supportsWebKitPresentationMode, trackingIngestConfig, validateFloorCents, validateFloorLadderConfig };