stormcloud-video-player 0.3.59 → 0.3.61

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (27) hide show
  1. package/dist/stormcloud-vp.min.js +1 -1
  2. package/lib/index.cjs +288 -233
  3. package/lib/index.cjs.map +1 -1
  4. package/lib/index.d.cts +25 -16
  5. package/lib/index.d.ts +25 -16
  6. package/lib/index.js +288 -233
  7. package/lib/index.js.map +1 -1
  8. package/lib/player/StormcloudVideoPlayer.cjs +288 -233
  9. package/lib/player/StormcloudVideoPlayer.cjs.map +1 -1
  10. package/lib/player/StormcloudVideoPlayer.d.cts +1 -1
  11. package/lib/players/HlsPlayer.cjs +288 -233
  12. package/lib/players/HlsPlayer.cjs.map +1 -1
  13. package/lib/players/HlsPlayer.d.cts +1 -1
  14. package/lib/players/index.cjs +288 -233
  15. package/lib/players/index.cjs.map +1 -1
  16. package/lib/sdk/hlsAdPlayer.cjs +46 -22
  17. package/lib/sdk/hlsAdPlayer.cjs.map +1 -1
  18. package/lib/sdk/hlsAdPlayer.d.cts +1 -1
  19. package/lib/sdk/ima.d.cts +1 -1
  20. package/lib/{types-Vj55FghO.d.cts → types-XKUJJhlG.d.cts} +13 -4
  21. package/lib/ui/StormcloudVideoPlayer.cjs +288 -233
  22. package/lib/ui/StormcloudVideoPlayer.cjs.map +1 -1
  23. package/lib/ui/StormcloudVideoPlayer.d.cts +1 -1
  24. package/lib/utils/tracking.cjs +210 -217
  25. package/lib/utils/tracking.cjs.map +1 -1
  26. package/lib/utils/tracking.d.cts +11 -13
  27. package/package.json +1 -1
package/lib/index.d.cts CHANGED
@@ -98,27 +98,38 @@ interface ClientInfo {
98
98
  interface TrackingData extends ClientInfo {
99
99
  browserId: string;
100
100
  }
101
+ interface PlayerAnalyticsContext {
102
+ inputStreamType?: string;
103
+ }
101
104
  interface HeartbeatData {
102
105
  browserId: string;
106
+ player_id: string;
107
+ device_type: ClientInfo["deviceType"];
108
+ input_stream_type?: string;
109
+ os: string;
110
+ ad_loaded?: boolean;
111
+ ad_detect?: boolean;
112
+ license_key?: string;
113
+ capture_at: string;
103
114
  timestamp: string;
104
115
  }
105
116
  interface AdDetectInfo {
106
- source: string;
117
+ source: "scte35";
107
118
  durationSeconds?: number;
108
119
  ptsSeconds?: number;
109
120
  detectedAtFragmentSn?: number;
110
121
  timestamp: string;
111
122
  }
112
- type AdTrackingSource = "prebid" | "ima" | "hls";
113
123
  interface AdLoadedInfo {
114
- source: AdTrackingSource;
124
+ source: "vast" | "ima" | "hls";
115
125
  vastUrl?: string;
116
126
  durationSeconds?: number;
117
127
  timestamp: string;
118
128
  }
119
129
  interface AdImpressionInfo {
120
- source: AdTrackingSource;
130
+ source: "vast" | "ima" | "hls";
121
131
  adIndex: number;
132
+ adUrl?: string;
122
133
  durationSeconds?: number;
123
134
  timestamp: string;
124
135
  }
@@ -4050,18 +4061,16 @@ declare const SUPPORTS_DASH: () => boolean;
4050
4061
 
4051
4062
  declare function getClientInfo(): ClientInfo;
4052
4063
  declare function getBrowserID(clientInfo: ClientInfo): Promise<string>;
4053
- declare function sendInitialTracking(licenseKey?: string): Promise<void>;
4054
- declare function sendHeartbeat(licenseKey?: string): Promise<void>;
4055
- declare function sendAdDetectTracking(licenseKey: string | undefined, payload: Omit<AdDetectInfo, "source" | "timestamp"> & Partial<Pick<AdDetectInfo, "source" | "timestamp">>): Promise<void>;
4056
- declare function sendAdLoadedTracking(licenseKey: string | undefined, payload: Omit<AdLoadedInfo, "timestamp" | "source"> & {
4057
- source?: AdTrackingSource | string;
4058
- }, adPlayerType?: "ima" | "hls"): Promise<void>;
4059
- type AdImpressionTrackingPayload = {
4060
- adIndex: number;
4061
- source?: AdTrackingSource | string;
4062
- durationSeconds?: number;
4064
+ type PlayerMetricFlags = {
4065
+ adLoaded?: boolean;
4066
+ adDetect?: boolean;
4067
+ captureAt?: string;
4063
4068
  };
4064
- declare function sendAdImpressionTracking(licenseKey: string | undefined, payload: AdImpressionTrackingPayload, adPlayerType?: "ima" | "hls"): Promise<void>;
4069
+ declare function sendInitialTracking(licenseKey?: string, context?: PlayerAnalyticsContext): Promise<void>;
4070
+ declare function sendAdDetectTracking(licenseKey: string | undefined, adDetectInfo: AdDetectInfo, context?: PlayerAnalyticsContext): Promise<void>;
4071
+ declare function sendAdLoadedTracking(licenseKey: string | undefined, adLoadedInfo: AdLoadedInfo, context?: PlayerAnalyticsContext): Promise<void>;
4072
+ declare function sendAdImpressionTracking(licenseKey: string | undefined, adImpressionInfo: AdImpressionInfo, context?: PlayerAnalyticsContext): Promise<void>;
4073
+ declare function sendHeartbeat(licenseKey?: string, context?: PlayerAnalyticsContext, flags?: PlayerMetricFlags): Promise<void>;
4065
4074
 
4066
4075
  declare function initializePolyfills(): void;
4067
4076
 
@@ -4118,4 +4127,4 @@ declare function createHlsAdPlayer(contentVideo: HTMLVideoElement, options?: {
4118
4127
  mainHlsInstance?: Hls;
4119
4128
  }): ImaController;
4120
4129
 
4121
- export { type AdBreak, type AdDetectInfo, type AdImpressionInfo, type AdLoadedInfo, type AdSchedule, type AdTrackingSource, type BaseStormcloudPlayerProps, type BrowserInfo, type ClientInfo, type HeartbeatData, IS_BROWSER, IS_GLOBAL, IS_IOS, IS_SAFARI, type ImaController, type ImaControllerOptions, type LateJoinPolicy, type OnProgressProps, SUPPORTS_DASH, SUPPORTS_HLS, StormcloudPlayer, StormcloudVideoPlayer, StormcloudVideoPlayerComponent, type StormcloudVideoPlayerConfig, type StormcloudVideoPlayerProps, type TrackingData, canPlay, createHlsAdPlayer, createImaController, createStormcloudPlayer, StormcloudVideoPlayerComponent as default, detectBrowser, getBrowserConfigOverrides, getBrowserID, getClientInfo, getRecommendedAdPlayer, initializePolyfills, isMediaStream, lazy, logBrowserInfo, merge, omit, parseQuery, players, randomString, sendAdDetectTracking, sendAdImpressionTracking, sendAdLoadedTracking, sendHeartbeat, sendInitialTracking, supportsFeature, supportsGoogleIMA, supportsModernJS, supportsWebKitPresentationMode };
4130
+ export { type AdBreak, type AdDetectInfo, type AdImpressionInfo, type AdLoadedInfo, type AdSchedule, type BaseStormcloudPlayerProps, type BrowserInfo, type ClientInfo, type HeartbeatData, IS_BROWSER, IS_GLOBAL, IS_IOS, IS_SAFARI, type ImaController, type ImaControllerOptions, type LateJoinPolicy, type OnProgressProps, type PlayerAnalyticsContext, SUPPORTS_DASH, SUPPORTS_HLS, StormcloudPlayer, StormcloudVideoPlayer, StormcloudVideoPlayerComponent, type StormcloudVideoPlayerConfig, type StormcloudVideoPlayerProps, type TrackingData, canPlay, createHlsAdPlayer, createImaController, createStormcloudPlayer, StormcloudVideoPlayerComponent as default, detectBrowser, getBrowserConfigOverrides, getBrowserID, getClientInfo, getRecommendedAdPlayer, initializePolyfills, isMediaStream, lazy, logBrowserInfo, merge, omit, parseQuery, players, randomString, sendAdDetectTracking, sendAdImpressionTracking, sendAdLoadedTracking, sendHeartbeat, sendInitialTracking, supportsFeature, supportsGoogleIMA, supportsModernJS, supportsWebKitPresentationMode };
package/lib/index.d.ts CHANGED
@@ -98,27 +98,38 @@ interface ClientInfo {
98
98
  interface TrackingData extends ClientInfo {
99
99
  browserId: string;
100
100
  }
101
+ interface PlayerAnalyticsContext {
102
+ inputStreamType?: string;
103
+ }
101
104
  interface HeartbeatData {
102
105
  browserId: string;
106
+ player_id: string;
107
+ device_type: ClientInfo["deviceType"];
108
+ input_stream_type?: string;
109
+ os: string;
110
+ ad_loaded?: boolean;
111
+ ad_detect?: boolean;
112
+ license_key?: string;
113
+ capture_at: string;
103
114
  timestamp: string;
104
115
  }
105
116
  interface AdDetectInfo {
106
- source: string;
117
+ source: "scte35";
107
118
  durationSeconds?: number;
108
119
  ptsSeconds?: number;
109
120
  detectedAtFragmentSn?: number;
110
121
  timestamp: string;
111
122
  }
112
- type AdTrackingSource = "prebid" | "ima" | "hls";
113
123
  interface AdLoadedInfo {
114
- source: AdTrackingSource;
124
+ source: "vast" | "ima" | "hls";
115
125
  vastUrl?: string;
116
126
  durationSeconds?: number;
117
127
  timestamp: string;
118
128
  }
119
129
  interface AdImpressionInfo {
120
- source: AdTrackingSource;
130
+ source: "vast" | "ima" | "hls";
121
131
  adIndex: number;
132
+ adUrl?: string;
122
133
  durationSeconds?: number;
123
134
  timestamp: string;
124
135
  }
@@ -4050,18 +4061,16 @@ declare const SUPPORTS_DASH: () => boolean;
4050
4061
 
4051
4062
  declare function getClientInfo(): ClientInfo;
4052
4063
  declare function getBrowserID(clientInfo: ClientInfo): Promise<string>;
4053
- declare function sendInitialTracking(licenseKey?: string): Promise<void>;
4054
- declare function sendHeartbeat(licenseKey?: string): Promise<void>;
4055
- declare function sendAdDetectTracking(licenseKey: string | undefined, payload: Omit<AdDetectInfo, "source" | "timestamp"> & Partial<Pick<AdDetectInfo, "source" | "timestamp">>): Promise<void>;
4056
- declare function sendAdLoadedTracking(licenseKey: string | undefined, payload: Omit<AdLoadedInfo, "timestamp" | "source"> & {
4057
- source?: AdTrackingSource | string;
4058
- }, adPlayerType?: "ima" | "hls"): Promise<void>;
4059
- type AdImpressionTrackingPayload = {
4060
- adIndex: number;
4061
- source?: AdTrackingSource | string;
4062
- durationSeconds?: number;
4064
+ type PlayerMetricFlags = {
4065
+ adLoaded?: boolean;
4066
+ adDetect?: boolean;
4067
+ captureAt?: string;
4063
4068
  };
4064
- declare function sendAdImpressionTracking(licenseKey: string | undefined, payload: AdImpressionTrackingPayload, adPlayerType?: "ima" | "hls"): Promise<void>;
4069
+ declare function sendInitialTracking(licenseKey?: string, context?: PlayerAnalyticsContext): Promise<void>;
4070
+ declare function sendAdDetectTracking(licenseKey: string | undefined, adDetectInfo: AdDetectInfo, context?: PlayerAnalyticsContext): Promise<void>;
4071
+ declare function sendAdLoadedTracking(licenseKey: string | undefined, adLoadedInfo: AdLoadedInfo, context?: PlayerAnalyticsContext): Promise<void>;
4072
+ declare function sendAdImpressionTracking(licenseKey: string | undefined, adImpressionInfo: AdImpressionInfo, context?: PlayerAnalyticsContext): Promise<void>;
4073
+ declare function sendHeartbeat(licenseKey?: string, context?: PlayerAnalyticsContext, flags?: PlayerMetricFlags): Promise<void>;
4065
4074
 
4066
4075
  declare function initializePolyfills(): void;
4067
4076
 
@@ -4118,4 +4127,4 @@ declare function createHlsAdPlayer(contentVideo: HTMLVideoElement, options?: {
4118
4127
  mainHlsInstance?: Hls;
4119
4128
  }): ImaController;
4120
4129
 
4121
- export { type AdBreak, type AdDetectInfo, type AdImpressionInfo, type AdLoadedInfo, type AdSchedule, type AdTrackingSource, type BaseStormcloudPlayerProps, type BrowserInfo, type ClientInfo, type HeartbeatData, IS_BROWSER, IS_GLOBAL, IS_IOS, IS_SAFARI, type ImaController, type ImaControllerOptions, type LateJoinPolicy, type OnProgressProps, SUPPORTS_DASH, SUPPORTS_HLS, StormcloudPlayer, StormcloudVideoPlayer, StormcloudVideoPlayerComponent, type StormcloudVideoPlayerConfig, type StormcloudVideoPlayerProps, type TrackingData, canPlay, createHlsAdPlayer, createImaController, createStormcloudPlayer, StormcloudVideoPlayerComponent as default, detectBrowser, getBrowserConfigOverrides, getBrowserID, getClientInfo, getRecommendedAdPlayer, initializePolyfills, isMediaStream, lazy, logBrowserInfo, merge, omit, parseQuery, players, randomString, sendAdDetectTracking, sendAdImpressionTracking, sendAdLoadedTracking, sendHeartbeat, sendInitialTracking, supportsFeature, supportsGoogleIMA, supportsModernJS, supportsWebKitPresentationMode };
4130
+ export { type AdBreak, type AdDetectInfo, type AdImpressionInfo, type AdLoadedInfo, type AdSchedule, type BaseStormcloudPlayerProps, type BrowserInfo, type ClientInfo, type HeartbeatData, IS_BROWSER, IS_GLOBAL, IS_IOS, IS_SAFARI, type ImaController, type ImaControllerOptions, type LateJoinPolicy, type OnProgressProps, type PlayerAnalyticsContext, SUPPORTS_DASH, SUPPORTS_HLS, StormcloudPlayer, StormcloudVideoPlayer, StormcloudVideoPlayerComponent, type StormcloudVideoPlayerConfig, type StormcloudVideoPlayerProps, type TrackingData, canPlay, createHlsAdPlayer, createImaController, createStormcloudPlayer, StormcloudVideoPlayerComponent as default, detectBrowser, getBrowserConfigOverrides, getBrowserID, getClientInfo, getRecommendedAdPlayer, initializePolyfills, isMediaStream, lazy, logBrowserInfo, merge, omit, parseQuery, players, randomString, sendAdDetectTracking, sendAdImpressionTracking, sendAdLoadedTracking, sendHeartbeat, sendInitialTracking, supportsFeature, supportsGoogleIMA, supportsModernJS, supportsWebKitPresentationMode };