boss-web-player-sdk 1.1.19 → 1.1.21

package/dist/index.d.ts

@@ -63,7 +63,7 @@ declare class AnalyticsModule {
     private milestonesHit;
     private lastHeartbeatPosition;
     private lastHeartbeatAt;
-    constructor(callback?: AnalyticsCallback, src?: string, seed?: AnalyticsSessionSnapshot);
+    constructor(callback?: AnalyticsCallback, src?: string, seed?: AnalyticsSessionSnapshot, videoId?: string);
     getSessionSnapshot(): AnalyticsSessionSnapshot;
     registerCallback(callback: AnalyticsCallback): void;
     setAdBreaks(adBreaks: Array<{
@@ -102,7 +102,7 @@ declare interface AnalyticsSessionSnapshot {
     milestonesHit: string[];
 }
 
-export declare function BossVideoPlayer({ playerKey, src, subtitles, licenseKey, themeColor, firebaseConfig, proxyDomains, apiBaseUrl, adTrackingUrl, overlayAdUrl, title, watermark, autoplay, muted, autoFullscreen, enableControls, enableSkipAd, skipAdAfterSeconds, chaptersDisplayMode, volumeControlType, subtitleStyle, drmConfig, onAnalyticsEvent, delegate, onKeyMomentsLoaded, initialTime, onTimeUpdate, }: BossVideoPlayerProps): JSX.Element;
+export declare function BossVideoPlayer({ playerKey, src, subtitles, licenseKey, themeColor, firebaseConfig, proxyDomains, apiBaseUrl, adTrackingUrl, overlayAdUrl, videoId: videoIdProp, title, watermark, autoplay, muted, autoFullscreen, enableControls, enableSkipAd, skipAdAfterSeconds, chaptersDisplayMode, volumeControlType, subtitleStyle, drmConfig, onAnalyticsEvent, delegate, onKeyMomentsLoaded, initialTime, onTimeUpdate, }: BossVideoPlayerProps): JSX.Element;
 
 export declare interface BossVideoPlayerProps {
     /** Player key from the GoBOSS dashboard — identifies your tenant. */
@@ -140,6 +140,7 @@ export declare interface BossVideoPlayerProps {
     adTrackingUrl?: string;
     /** AWS MediaTailor overlay ad tracking URL. */
     overlayAdUrl?: string;
+    videoId?: string;
     /** Video title shown in the player UI. */
     title?: string;
     /** Watermark text stamped on the video. */
@@ -286,7 +287,11 @@ declare class DRMModule {
     };
 }
 
-export declare function endSession(playerKey: string, sessionId: string, apiBase?: string): Promise<void>;
+/**
+ * Ends the session and finalizes billed minutes. `currentTime` and `duration`
+ * are required by the API — pass the final playback position and content length.
+ */
+export declare function endSession(playerKey: string, sessionId: string, currentTime?: number, duration?: number, apiBase?: string): Promise<void>;
 
 export declare type FeatureFlags = {
     m3u8_playback: boolean;
@@ -338,7 +343,7 @@ export declare interface FirebaseConfig {
     measurementId?: string;
 }
 
-export declare function initSdk(playerKey: string, apiBase?: string): Promise<SdkInitResponse>;
+export declare function initSdk(playerKey: string, apiBase?: string, options?: SdkInitOptions): Promise<SdkInitResponse>;
 
 export declare type KeyMoment = Chapter;
 
@@ -434,15 +439,17 @@ export declare interface PlayerDelegate {
 
 /**
  * In-session telemetry payload for POST /api/player/sdk/events.
- * `eventType`, `sessionId` and `currentTime` are always required; `videoId` and any
- * event-specific extras (e.g. `from`/`to`, `speed`, `bufferingCount`) are sent at the
- * top level — never wrapped in a client `properties` object (the server nests them).
+ * `eventType`, `sessionId` and `currentTime` are always required; `videoId`,
+ * `videoTitle` and any event-specific extras (e.g. `from`/`to`, `speed`,
+ * `bufferingCount`) are sent at the top level — never wrapped in a client
+ * `properties` object (the server nests them).
  */
 export declare interface PlayerEventPayload {
     eventType: string;
     sessionId: string;
     currentTime: number;
     videoId?: string;
+    videoTitle?: string;
     [key: string]: unknown;
 }
 
@@ -468,6 +475,7 @@ export declare interface PlayerSDKOptions {
     thumbnails?: ThumbnailConfig;
     drm?: DRMConfig;
     analyticsCallback?: AnalyticsCallback;
+    videoId?: string;
     analyticsSessionSeed?: AnalyticsSessionSnapshot;
     watchProgressInterval?: number;
     themeColor?: string;
@@ -492,6 +500,8 @@ export declare type SdkInitData = {
     tenantId: string;
     features: SdkInitFeatures;
     planTier: string;
+    /** How often to call /session/heartbeat. Falls back to 30s when absent. */
+    heartbeatIntervalSeconds?: number;
 };
 
 export declare type SdkInitFeatures = {
@@ -501,6 +511,11 @@ export declare type SdkInitFeatures = {
     [key: string]: boolean;
 };
 
+/** Optional context accepted by POST /init. `referrer` is intentionally not sent. */
+export declare interface SdkInitOptions {
+    videoUrl?: string;
+}
+
 export declare type SdkInitResponse = {
     result: {
         data: SdkInitData;
@@ -530,7 +545,26 @@ export declare interface SourceItem {
     url: string;
 }
 
-export declare function startSession(playerKey: string, sessionId: string, videoId: string, apiBase?: string): Promise<void>;
+export declare function startSession(playerKey: string, options: StartSessionOptions, apiBase?: string): Promise<void>;
+
+/**
+ * Body for POST /session/start. Only `sessionId` is required for HTTP acceptance,
+ * but `videoId`, `videoTitle` and `contentDurationSec` drive the video-level CMS
+ * analytics (Top Videos, retention, completion) — send them whenever they're known.
+ * `platform` and `referrer` are intentionally not sent by this SDK.
+ */
+export declare interface StartSessionOptions {
+    /** Client-generated UUID identifying this play. */
+    sessionId: string;
+    /** Stable content ID — the grouping key for video-level analytics. */
+    videoId?: string;
+    /** Display title for CMS dashboards. */
+    videoTitle?: string;
+    /** Playback URL. */
+    videoUrl?: string;
+    /** Full content length in seconds, when known. */
+    contentDurationSec?: number;
+}
 
 declare class SubtitlesModule {
     private tracks;
@@ -732,24 +766,11 @@ export declare class VideoPlayerSDK {
     private findFirstVariantUri;
     private resolveUrl;
     private static readonly AD_HOST_PATTERNS;
-    private static readonly AD_PATH_PATTERNS;
+    private static readonly AD_STITCHER_PATH_PATTERNS;
+    private static readonly AD_PATH_HINT_PATTERNS;
     private parseSegmentUrl;
     private isKnownAdSegment;
-    /**
-     * Classifies discontinuity-delimited segment groups as ad or content.
-     *
-     * SSAI stitchers insert one #EXT-X-DISCONTINUITY *per ad*, not per ad break — a
-     * three-ad pod becomes three consecutive ad groups separated by discontinuities.
-     * That makes continuity-counter parity (the previous heuristic) correct only for
-     * single-ad breaks: in a three-ad pod the second ad lands on an even counter and
-     * plays back as ordinary content, with content controls and no ad UI.
-     *
-     * Classify by where each group's segments are actually served from instead, since
-     * that is what separates stitched ads from origin content. Parity survives only as
-     * the last resort, for stitchers that proxy ads and content through one host.
-     *
-     * Returns one flag per group, true for ad.
-     */
+    private hasAdPathHint;
     private classifyAdGroups;
     private mergeAdjacentRanges;
     private parseAdBreaksFromFragments;
@@ -863,6 +884,7 @@ declare interface WebVideoPlayerProps {
     skipAdAfterSeconds?: number;
     overlayAdUrl?: string;
     adTrackingUrl?: string;
+    videoId?: string;
     sources?: SourceItem[];
     activeSourceIndex?: number;
     onSourceChange?: (index: number) => void;