stormcloud-video-player 0.8.68 → 0.8.69

package/lib/player/FloorLadder.d.cts

@@ -0,0 +1,74 @@
+import { AdFloorLadderConfig, AdPosition } from '../types.cjs';
+
+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 FloorUrlResult {
+    url: string;
+    applied: boolean;
+    reason: string | undefined;
+}
+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 function resolveOpportunityFloor(config: Readonly<AdFloorLadderConfig>, context: FloorSelectionContext, selector?: FloorSelector): OpportunityFloor;
+declare function applyFloorToVastUrl(url: string, floor: OpportunityFloor): FloorUrlResult;
+declare class FloorLadderController {
+    private config;
+    private selector;
+    private readonly bounds;
+    constructor(initial?: Partial<AdFloorLadderConfig>, bounds?: Partial<FloorLadderBounds>, selector?: FloorSelector);
+    get(): AdFloorLadderConfig;
+    getBounds(): FloorLadderBounds;
+    update(update: Partial<AdFloorLadderConfig>): FloorLadderValidationReport;
+    validate(): FloorLadderValidationReport;
+    setSelector(selector: FloorSelector): void;
+    snapshotFor(context: Omit<FloorSelectionContext, "bounds">): OpportunityFloor;
+}
+
+export { DEFAULT_FLOOR_LADDER_BOUNDS, DEFAULT_WEB_FLOOR_LADDER_CONFIG, type FloorLadderBounds, FloorLadderController, type FloorLadderValidationReport, type FloorSelectionContext, type FloorSelector, type FloorSelectorResult, type FloorSource, type FloorUrlResult, type FloorValidation, type FloorValidationReason, type OpportunityFloor, applyFloorToVastUrl, fixedFloorSelector, generateFloorLevels, resolveFloorLadderBounds, resolveOpportunityFloor, validateFloorCents, validateFloorLadderConfig };