@flowplayer/player 3.19.0 → 3.20.0-rc.6

package/plugins/google-analytics.d.ts

@@ -1,7 +1,11 @@
 /// <reference types="node" />
 
 import type { BitrateInfo } from 'dashjs';
+import type { Get } from 'type-fest';
+import type { Level } from 'hls.js';
 import type { MediaKeyFunc } from 'hls.js';
+import type { SetFieldType } from 'type-fest';
+import type { TupleToUnion } from 'type-fest';
 
 /* Excluded from this release type: AnyLoader */
 
@@ -79,6 +83,26 @@ declare const /**
  */
 CLICK = "click";
 
+/**
+ * For plugins that add new properties to all source types, combine their src-mixins into one SourceObject
+ * @example
+ * ```
+ * type Combined = CombineGlobalSrcExtensions<DRMPlugin, PluginWithFooFieldInSrc> // Combined = SourceObject<DRMConfig & FooFieldConfig>
+ * ```
+ */
+declare type CombineGlobalSrcExtensions<PluginSrcs extends unknown[]> = HasGlobalSrcExtensios<PluginSrcs> extends false ? SourceObj : SourceObj & ArrayToIntersection<PickGlobalSrcExtension<PluginSrcs>>;
+
+/**
+ * For plugins that define a new src type, make a union of all new src.type declarations
+ * @example
+ * ```
+ * type Combined = CombineNewSourceTypes<RTSPlugin, SSAIPlugin> // Combined = DRMConfig | FooFieldConfig
+ * ```
+ */
+declare type CombineNewSourceTypes<PluginSrcs extends unknown[]> = TupleToUnion<FilterNewSourceTypes<PluginSrcs>>;
+
+declare type CombineSrc<PluginSrcs extends unknown[]> = UnsafeSource<CombineGlobalSrcExtensions<PluginSrcs> | (CombineNewSourceTypes<PluginSrcs> & CombineGlobalSrcExtensions<PluginSrcs>)>;
+
 /* Excluded from this release type: Component */
 
 /* Excluded from this release type: Components */
@@ -139,6 +163,10 @@ declare interface Config {
  */
 declare type ConfigWith<T> = Config & T;
 
+declare type ConfigWithSourceExtensions<PluginBareConfigs extends unknown[]> = Omit<ConfigWith<ArrayToIntersection<PluginBareConfigs>>, "src"> & {
+    src?: CombineSrc<PickSrcExtensions<PluginBareConfigs>>;
+};
+
 /* Excluded from this release type: CONTENT_REAL_LOAD_START */
 
 /**
@@ -382,6 +410,7 @@ declare namespace events {
         SOURCE,
         REAP,
         QUALITIES,
+        QUALITY_CHANGE,
         VIDEO_TRACKS,
         SET_QUALITY,
         VIDEO_TRACK_SELECT,
@@ -397,8 +426,20 @@ declare namespace events {
     }
 }
 
+declare type ExtractBareConfig<Plugins extends PluginCtor> = Plugins extends PluginCtor<ConfigWith<infer ConfigType>> ? ConfigType : never;
+
+declare type ExtractPluginPlayerExtension<Plugin extends PluginCtor> = Plugin extends PluginCtor<infer _uConfigType, PlayerWith<infer PluginPlayer>> ? PluginPlayer : never;
+
 declare type ExtractPureAPI<T> = T extends PlayerWith<infer PureAPI> ? PureAPI : never;
 
+declare type ExtractSrcExtension<PluginBareConfig> = Get<PluginBareConfig, "src"> extends UnsafeSource<infer SrcMixinType> ? SrcMixinType : never;
+
+declare type FilterNewSourceTypes<PluginSrcs extends unknown[]> = {
+    [Index in keyof PluginSrcs]: PluginSrcs[Index] extends {
+        type: string;
+    } ? PluginSrcs[Index] : never;
+};
+
 /**
  * @public
  */
@@ -441,7 +482,7 @@ declare interface FlowplayerUMD extends FlowplayerUMDBase {
      * Register plugins in flowplayer
      * @returns flowplayer instance with registered plugins
      */
-    <PluginCtors extends PluginCtor[]>(...plugins: PluginCtors): FlowplayerUMDWithPlugins<ConfigWith<MergeConfigs<PluginCtors>>, PlayerWith<MergePlayerAPIExtensions<PluginCtors>>>;
+    <PluginCtors extends PluginCtor[]>(...plugins: PluginCtors): FlowplayerUMDWithPlugins<MergeConfigs<PluginCtors>, PlayerWith<MergePlayerExtensions<PluginCtors>>>;
 }
 
 declare interface FlowplayerUMDBase {
@@ -541,13 +582,17 @@ FULLSCREEN_EXIT = "fullscreenexit";
 /**
  * @public
  */
-declare const GoogleAnalyticsUA: PluginCtor<Config, Player>;
+declare const GoogleAnalyticsUA: PluginCtor<NoInfer<Config>, NoInfer<Player>>;
 export default GoogleAnalyticsUA;
 
 declare const GRABBING = "is-grabbing";
 
 declare const HAS_POSTER = "has-poster";
 
+declare type HasGlobalSrcExtensios<PluginSrcs extends unknown[]> = ArrayToIntersection<PickGlobalSrcExtension<PluginSrcs>>;
+
+declare type HasSrcExtensions<PluginBareConfigs extends unknown[]> = TupleToUnion<PickSrcExtensions<PluginBareConfigs>> extends never ? false : true;
+
 declare const HOVERED = "is-hovered";
 
 declare const IN_VIEWPORT = "is-in-viewport";
@@ -657,19 +702,24 @@ PluginPlayer extends PlayerWith<_AttachedEventCheck>> extends Plugin_2<PluginOwn
 
 declare const LOADING = "is-loading";
 
-declare type MapToConfigs<Arr extends PluginCtor[]> = {
-    [PluginType in keyof Arr]: Arr[PluginType] extends PluginCtor<ConfigWith<infer ConfigType>> ? ConfigType : never;
+declare type MapToBareConfigs<Plugins extends PluginCtor[]> = {
+    [PluginType in keyof Plugins]: ExtractBareConfig<Plugins[PluginType]>;
 };
 
-declare type MapToPlayerApiExtensions<Arr extends PluginCtor[]> = {
-    [PluginType in keyof Arr]: Arr[PluginType] extends PluginCtor<infer _uConfigType, PlayerWith<infer PlayerAPIExtension>> ? PlayerAPIExtension : never;
+declare type MapToPlayerExtensions<Plugins extends PluginCtor[]> = {
+    [PluginIndex in keyof Plugins]: ExtractPluginPlayerExtension<Plugins[PluginIndex]>;
 };
 
 declare const MENU_OPENED = "has-menu-opened";
 
-declare type MergeConfigs<Arr extends PluginCtor[]> = ArrayToIntersection<MapToConfigs<Arr>>;
+/**
+ * Combines plugin config and returns a type derived from Config
+ */
+declare type MergeConfigs<Plugins extends PluginCtor[]> = MergePluginConfigs<MapToBareConfigs<Plugins>>;
+
+declare type MergePlayerExtensions<Plugins extends PluginCtor[]> = ArrayToIntersection<MapToPlayerExtensions<Plugins>>;
 
-declare type MergePlayerAPIExtensions<Arr extends PluginCtor[]> = ArrayToIntersection<MapToPlayerApiExtensions<Arr>>;
+declare type MergePluginConfigs<PluginBareConfigs extends unknown[]> = HasSrcExtensions<PluginBareConfigs> extends true ? ConfigWithSourceExtensions<PluginBareConfigs> : ConfigWith<ArrayToIntersection<PluginBareConfigs>>;
 
 /**
  * @public
@@ -764,8 +814,6 @@ declare const NO_CONTROLS = "no-controls";
 
 declare const NO_DVR = "no-timeline";
 
-declare type NoInfer_2<T> = [T][T extends any ? 0 : never];
-
 /* Excluded from this release type: NON_RECOVERABLE_ERROR */
 
 /* Excluded from this release type: NonRecoverableErrorEventDetail */
@@ -784,6 +832,7 @@ declare type OVPMetadata = {
     category_name?: string;
     duration?: number;
     tags?: string;
+    playlist_title?: string;
 };
 
 /**
@@ -799,6 +848,26 @@ PAUSE = "pause";
 
 declare const PAUSED = "is-paused";
 
+declare type PickGlobalSrcExtension<PluginSrcs extends unknown[]> = {
+    [Index in keyof PluginSrcs]: PluginSrcs[Index] extends {
+        type: string;
+    } ? unknown : PluginSrcs[Index];
+};
+
+/**
+ * Maps incoming array to the src extension type
+ * @example
+ * ```
+ * PickSrcExtensions<[
+ *    {configProp: boolean, src: UnsafeSource<{srcProp: boolean}>},
+ *    {}
+ * ]> // = [{srcProp: boolean}, never]
+ * ```
+ */
+declare type PickSrcExtensions<PluginBareConfigs extends unknown[]> = {
+    [PluginType in keyof PluginBareConfigs]: ExtractSrcExtension<PluginBareConfigs[PluginType]>;
+};
+
 /**
  * @public
  */
@@ -920,6 +989,8 @@ declare type PlayerCustomEventsDetailMap = PlayerEmittableCustomEventsDetailMap
     [DVR]: DvrEventDetail;
     [RETRY]: RetryEventDetail;
     [RECOVER]: RecoverEventDetail;
+    [QUALITIES]: QualitiesEventDetail;
+    [QUALITY_CHANGE]: QualityChangeEventDetail;
     /* Excluded from this release type: audioonlysource */
     /* Excluded from this release type: renderplugin */
     /* Excluded from this release type: "seek:queued" */
@@ -976,7 +1047,10 @@ declare type PlayerCustomEventsOverloads = {
      * Emitted when the set of underlying qualities has changed.
      */
     on(event: typeof QUALITIES, handler: (e: FPEvent<PlayerCustomEventsDetailMap[typeof QUALITIES]>) => void): Player;
-    /* Excluded from this release type: on */
+    /**
+     * Emitted when the media changes quality.
+     */
+    on(event: typeof QUALITY_CHANGE, handler: (e: FPEvent<PlayerCustomEventsDetailMap[typeof QUALITY_CHANGE]>) => void): Player;
     /* Excluded from this release type: on */
     /**
      * Listen to this event to create a recommendations grid using the data passed with the event.
@@ -1031,7 +1105,6 @@ declare type PlayerCustomEventsOverloads = {
     /* Excluded from this release type: emit */
     /* Excluded from this release type: emit */
     /* Excluded from this release type: emit */
-    /* Excluded from this release type: emit */
 };
 
 declare type PlayerEmittableCustomEventsDetailMap = {
@@ -1039,7 +1112,6 @@ declare type PlayerEmittableCustomEventsDetailMap = {
     [CONTEXT_MENU]: ContextMenuEventDetail;
     [VIEW_ENTER]: ViewEnterEventDetail;
     [VIEW_LEAVE]: ViewLeaveEventDetail;
-    [QUALITIES]: QualitiesEventDetail;
     [RECOMMENDATIONS_READY]: RecommendationsReadyEventDetail;
 };
 
@@ -1141,11 +1213,16 @@ PROGRESS = "progress";
 /**
  * @public
  */
-declare type QselOption = {
-    height: number;
+declare type QselOption = (Level & {
     level: number;
-    text: string;
-    /* Excluded from this release type: videoCodec */
+}) | BitrateInfo | {
+    name: string | number;
+    encodingId: string;
+    spatialLayerId: number;
+    temporalLayerId: number;
+    maxSpatialLayerId: number;
+    maxTemporalLayerId: number;
+    height: number;
     width: number;
 };
 
@@ -1169,9 +1246,29 @@ QUALITIES = "qualities";
  */
 declare type QualitiesEventDetail = QselOption[];
 
-/* Excluded from this release type: _QualitiesEventDetail */
+/**
+ * @public
+ * emitted whenever the media changes quality
+ */
+declare const /**
+@public
+* when a new player is inserted into the HTML
+*/ /**
+ * @public
+ * emitted whenever the media changes quality
+ */
+QUALITY_CHANGE = "qualitychange";
 
-/* Excluded from this release type: _QualityDetail */
+/**
+ * @public
+ */
+declare type QualityChangeEventDetail = {
+    before: Level | BitrateInfo;
+    after: Level | BitrateInfo;
+    plugin: string;
+    automatic: boolean;
+    downscale: boolean;
+};
 
 declare enum QualityOpts {
     LOW = 1,
@@ -1377,14 +1474,14 @@ declare type SourceEventDetail = SourceObj;
 /**
  * @public
  */
-declare type SourceObj = {
+declare type SourceObj<T = unknown> = {
     src?: SourceStr;
     /**
      *  the MIME type (example `video/mp4` or `application/x-mpegurl`)
      */
     type?: string;
     drm?: DRMSourceConfiguration;
-};
+} & T;
 
 /**
  * @public
@@ -1511,7 +1608,7 @@ declare const TV = "is-tv";
 /**
  * @public
  */
-declare type UnsafeSource = SourceStr | SourceObj | Array<SourceStr | SourceObj>;
+declare type UnsafeSource<SrcMixin = unknown> = SourceStr | SourceObj<SrcMixin> | Array<SourceStr | SourceObj<SrcMixin>>;
 
 /**
  * @public
@@ -1607,9 +1704,6 @@ declare const WILL_PLAY = "will-play";
 
 declare const WILL_SEEK = "will-seek";
 
-declare type WithOpts<PluginPlayer extends Player = Player, PluginConfig extends Config = Config> = PluginPlayer & {
-    opts: PluginConfig;
-    setOpts(config: PluginConfig): void;
-};
+declare type WithOpts<PluginPlayer extends Player = Player, PluginConfig extends Config = Config> = SetFieldType<SetFieldType<PluginPlayer, "opts", PluginConfig>, "setOpts", (config: PluginConfig) => void>;
 
 export { }

package/plugins/google-analytics.js

@@ -1 +1 @@
-!function(e,t){"object"==typeof exports&&"undefined"!=typeof module?module.exports=t():"function"==typeof define&&define.amd?define(t):((e="undefined"!=typeof globalThis?globalThis:e||self).flowplayer=e.flowplayer||{},e.flowplayer.google_analytics=t())}(this,(function(){"use strict";return function(e,t){if("object"==typeof exports&&"undefined"!=typeof module)return t;if(null===document.currentScript)return t;"flowplayer"in e||(e.flowplayer={extensions:[]});const i=e.flowplayer;return"function"==typeof i?(i(t),t):(Array.isArray(i.extensions)||(i.extensions=[]),~i.extensions.indexOf(t)||i.extensions.push(t),t)}(window,class GoogleAnalyticsPlugin{constructor(e){this.muted=!1,this.ga_extensions=[],this.quartiles=[0,0,0],this.ad_type="preroll",this.preroll_counter=0,this.midroll_counter=0,this.postroll_counter=0,this.event_categories={live:"Live",videos:"Videos"},this.event_actions={fullscreen_enter:"fullscreen_enter",fullscreen_exit:"fullscreen_exit",video_player_load:"video_player_load",video_start:"video_start",video_click_play:"video_click_play",video_pause:"video_pause",video_resume:"video_resume",video_mute:"video_mute",video_unmute:"video_unmute",video_25_percent:"video_25_percent",video_50_percent:"video_50_percent",video_75_percent:"video_75_percent",video_complete:"video_complete",live_start:"live_start",live_click_play:"live_click_play",live_pause:"live_pause",live_resume:"live_resume",live_mute:"live_mute",live_unmute:"live_unmute",live_complete:"live_complete",ad_start_preroll:"ad_start_preroll",ad_start_midroll:"ad_start_midroll",ad_start_postroll:"ad_start_postroll",ad_completed_preroll:"ad_completed_preroll",ad_completed_midroll:"ad_completed_midroll",ad_completed_postroll:"ad_completed_postroll",ad_skipped_preroll:"ad_skipped_preroll",ad_skipped_midroll:"ad_skipped_midroll",ad_skipped_postroll:"ad_skipped_postroll",ad_break_completed:"ad_break_completed"},console.warn("universal analytics by Google has been sunset, please use the ga4 plugin"),this.flowplayer=e}init(e,t,i){this.config=e,this.video=i,this.muted=i.muted,i.on(["mount","timeupdate","play","ended","pause","playing","volumechange","ad-started","ad-completed","ad-skipped","ad-break-completed","config","play","fullscreenenter","fullscreenexit"],t=>{switch(t.type){case"playing":this.track(e.live?this.event_actions.live_resume:this.event_actions.video_resume);break;case"pause":if(Math.abs(i.duration-i.currentTime)<1)break;this.track(e.live?this.event_actions.live_pause:this.event_actions.video_pause);break;case"play":i.hasState("is-starting")&&this.track(e.live?this.event_actions.live_start:this.event_actions.video_start),this.track(e.live?this.event_actions.live_click_play:this.event_actions.video_click_play);break;case"mount":this.track(this.event_actions.video_player_load);break;case"timeupdate":this.progress(i);break;case"ended":setTimeout(()=>{this.track(e.live?this.event_actions.live_complete:this.event_actions.video_complete),this.reset()},0);break;case"volumechange":this.volumechange(i);break;case"ad-started":this.adstarted(t);break;case"ad-completed":this.adcompleted(t);break;case"ad-break-completed":this.adbreakcompleted();break;case"config":this.configured(t.detail);break;case"fullscreenenter":this.track(this.event_actions.fullscreen_enter);break;case"fullscreenexit":this.track(this.event_actions.fullscreen_exit);break;case"ad-skipped":this.adskipped()}})}setup_ga(e){window.ga&&!this.ga_extensions.length&&e.forEach((e,t)=>{var i;window.ga("create",e,"auto","ext"+(t+1)),(null===(i=this.config)||void 0===i?void 0:i.ga.custom_data)&&window.ga("ext"+(t+1)+".set",this.config.ga.custom_data),this.ga_extensions.push("ext"+(t+1))})}progress(e){e.opts.live||(e.currentTime/e.duration>.25&&0===this.quartiles[0]?(this.quartiles[0]=1,this.track(this.event_actions.video_25_percent)):e.currentTime/e.duration>.5&&0===this.quartiles[1]?(this.quartiles[1]=1,this.track(this.event_actions.video_50_percent)):e.currentTime/e.duration>.75&&0===this.quartiles[2]&&(this.quartiles[2]=1,this.track(this.event_actions.video_75_percent)))}volumechange(e){this.muted!==e.muted&&(this.muted=e.muted,e.muted?this.track(e.opts.live?this.event_actions.live_mute:this.event_actions.video_mute):this.track(e.opts.live?this.event_actions.live_unmute:this.event_actions.video_unmute))}reset(){this.quartiles=[0,0,0],this.preroll_counter=0,this.midroll_counter=0,this.postroll_counter=0}configured(e){var t,i;(null===(t=null==e?void 0:e.ga)||void 0===t?void 0:t.event_actions)&&(this.event_actions=e.ga.event_actions),(null===(i=null==e?void 0:e.ga)||void 0===i?void 0:i.event_categories)&&(this.event_categories=e.ga.event_categories)}checkForAdCounter(e,t){return e.replace("[x]",t+"")}adstarted(e){var t;switch((null===(t=e.data)||void 0===t?void 0:t.ad_type)||"preroll"){case"midroll":this.ad_type="midroll",this.midroll_counter++,this.track(this.checkForAdCounter(this.event_actions.ad_start_midroll,this.midroll_counter));break;case"postroll":this.ad_type="postroll",this.postroll_counter++,this.track(this.checkForAdCounter(this.event_actions.ad_start_postroll,this.postroll_counter));break;default:this.ad_type="preroll",this.preroll_counter++,this.track(this.checkForAdCounter(this.event_actions.ad_start_preroll,this.preroll_counter))}}adcompleted(e){var t;switch((null===(t=e.data)||void 0===t?void 0:t.ad_type)||"preroll"){case"midroll":this.track(this.event_actions.ad_completed_midroll);break;case"postroll":this.track(this.event_actions.ad_completed_postroll);break;default:this.track(this.event_actions.ad_completed_preroll)}}adskipped(){if(this.ad_type)switch(this.ad_type){case"midroll":this.track(this.event_actions.ad_skipped_midroll);break;case"postroll":this.track(this.event_actions.ad_skipped_postroll);break;default:this.track(this.event_actions.ad_skipped_preroll)}else this.track(this.event_actions.ad_skipped_preroll)}adbreakcompleted(){this.track(this.event_actions.ad_break_completed)}pushToDataLayer(e,t,i){var s;if(window.dataLayer)try{window.dataLayer.push({event:"Flowplayer",video_name:i,action:e,category:t,duration:null===(s=this.video)||void 0===s?void 0:s.duration})}catch(e){}}track(e){var t,i,s,o,a;if(!this.config||!this.config.ga||!e||(null===(t=null==this?void 0:this.video)||void 0===t?void 0:t.hasState("consent-no-tracking")))return;const l=(null===(i=this.video)||void 0===i?void 0:i.opts.live)?this.event_categories.live:this.event_categories.videos,r=null===(s=this.config.ga)||void 0===s?void 0:s.ga_instances,n=(null===(o=null==this?void 0:this.config)||void 0===o?void 0:o.title)||(null===(a=this.config.metadata)||void 0===a?void 0:a.title)||"unknown video";return this.config.ga.data_layer_tracking?this.pushToDataLayer(e,l,n):(this.setup_ga(r),this.ga_extensions.length&&void 0!==window.ga&&null!==window.ga?void this.ga_extensions.forEach(t=>{window.ga(t+".send","event",l,e,n)}):console.debug("ga console.send","event",l,e,n))}})}));
+!function(e,t){"object"==typeof exports&&"undefined"!=typeof module?module.exports=t():"function"==typeof define&&define.amd?define(t):((e="undefined"!=typeof globalThis?globalThis:e||self).flowplayer=e.flowplayer||{},e.flowplayer.google_analytics=t())}(this,(function(){"use strict";return function(e,t){if("object"==typeof exports&&"undefined"!=typeof module)return t;if(null===document.currentScript)return t;"flowplayer"in e||(e.flowplayer={extensions:[]});const i=e.flowplayer;return"function"==typeof i?(i(t),t):(Array.isArray(i.extensions)||(i.extensions=[]),~i.extensions.indexOf(t)||i.extensions.push(t),t)}(window,class GoogleAnalyticsPlugin{constructor(e){this.muted=!1,this.ga_extensions=[],this.quartiles=[0,0,0],this.ad_type="preroll",this.preroll_counter=0,this.midroll_counter=0,this.postroll_counter=0,this.event_categories={live:"Live",videos:"Videos"},this.event_actions={fullscreen_enter:"fullscreen_enter",fullscreen_exit:"fullscreen_exit",video_player_load:"video_player_load",video_start:"video_start",video_click_play:"video_click_play",video_pause:"video_pause",video_resume:"video_resume",video_seeking:"video_seeking",video_ratechange:"video_ratechange",video_qualitychange:"video_qualitychange",video_mute:"video_mute",video_unmute:"video_unmute",video_25_percent:"video_25_percent",video_50_percent:"video_50_percent",video_75_percent:"video_75_percent",video_complete:"video_complete",live_start:"live_start",live_click_play:"live_click_play",live_pause:"live_pause",live_resume:"live_resume",live_ratechange:"live_ratechange",live_seeking:"live_seeking",live_qualitychange:"live_qualitychange",live_mute:"live_mute",live_unmute:"live_unmute",live_complete:"live_complete",ad_start_preroll:"ad_start_preroll",ad_start_midroll:"ad_start_midroll",ad_start_postroll:"ad_start_postroll",ad_completed_preroll:"ad_completed_preroll",ad_completed_midroll:"ad_completed_midroll",ad_completed_postroll:"ad_completed_postroll",ad_skipped_preroll:"ad_skipped_preroll",ad_skipped_midroll:"ad_skipped_midroll",ad_skipped_postroll:"ad_skipped_postroll",ad_break_completed:"ad_break_completed"},console.warn("universal analytics by Google has been sunset, please use the ga4 plugin"),this.flowplayer=e}init(e,t,i){this.config=e,this.video=i,this.muted=i.muted,i.on(["mount","timeupdate","play","ended","pause","playing","volumechange","ad-started","ad-completed","ad-skipped","ad-break-completed","config","play","fullscreenenter","fullscreenexit"],t=>{switch(t.type){case"playing":this.track(e.live?this.event_actions.live_resume:this.event_actions.video_resume);break;case"pause":if(Math.abs(i.duration-i.currentTime)<1)break;this.track(e.live?this.event_actions.live_pause:this.event_actions.video_pause);break;case"play":i.hasState("is-starting")&&this.track(e.live?this.event_actions.live_start:this.event_actions.video_start),this.track(e.live?this.event_actions.live_click_play:this.event_actions.video_click_play);break;case"mount":this.track(this.event_actions.video_player_load);break;case"timeupdate":this.progress(i);break;case"ended":setTimeout(()=>{this.track(e.live?this.event_actions.live_complete:this.event_actions.video_complete),this.reset()},0);break;case"volumechange":this.volumechange(i);break;case"ad-started":this.adstarted(t);break;case"ad-completed":this.adcompleted(t);break;case"ad-break-completed":this.adbreakcompleted();break;case"config":this.configured(t.detail);break;case"fullscreenenter":this.track(this.event_actions.fullscreen_enter);break;case"fullscreenexit":this.track(this.event_actions.fullscreen_exit);break;case"ad-skipped":this.adskipped()}})}setup_ga(e){window.ga&&!this.ga_extensions.length&&e.forEach((e,t)=>{var i;window.ga("create",e,"auto","ext"+(t+1)),(null===(i=this.config)||void 0===i?void 0:i.ga.custom_data)&&window.ga("ext"+(t+1)+".set",this.config.ga.custom_data),this.ga_extensions.push("ext"+(t+1))})}progress(e){e.opts.live||(e.currentTime/e.duration>.25&&0===this.quartiles[0]?(this.quartiles[0]=1,this.track(this.event_actions.video_25_percent)):e.currentTime/e.duration>.5&&0===this.quartiles[1]?(this.quartiles[1]=1,this.track(this.event_actions.video_50_percent)):e.currentTime/e.duration>.75&&0===this.quartiles[2]&&(this.quartiles[2]=1,this.track(this.event_actions.video_75_percent)))}volumechange(e){this.muted!==e.muted&&(this.muted=e.muted,e.muted?this.track(e.opts.live?this.event_actions.live_mute:this.event_actions.video_mute):this.track(e.opts.live?this.event_actions.live_unmute:this.event_actions.video_unmute))}reset(){this.quartiles=[0,0,0],this.preroll_counter=0,this.midroll_counter=0,this.postroll_counter=0}configured(e){var t,i;(null===(t=null==e?void 0:e.ga)||void 0===t?void 0:t.event_actions)&&(this.event_actions=e.ga.event_actions),(null===(i=null==e?void 0:e.ga)||void 0===i?void 0:i.event_categories)&&(this.event_categories=e.ga.event_categories)}checkForAdCounter(e,t){return e.replace("[x]",t+"")}adstarted(e){var t;switch((null===(t=e.data)||void 0===t?void 0:t.ad_type)||"preroll"){case"midroll":this.ad_type="midroll",this.midroll_counter++,this.track(this.checkForAdCounter(this.event_actions.ad_start_midroll,this.midroll_counter));break;case"postroll":this.ad_type="postroll",this.postroll_counter++,this.track(this.checkForAdCounter(this.event_actions.ad_start_postroll,this.postroll_counter));break;default:this.ad_type="preroll",this.preroll_counter++,this.track(this.checkForAdCounter(this.event_actions.ad_start_preroll,this.preroll_counter))}}adcompleted(e){var t;switch((null===(t=e.data)||void 0===t?void 0:t.ad_type)||"preroll"){case"midroll":this.track(this.event_actions.ad_completed_midroll);break;case"postroll":this.track(this.event_actions.ad_completed_postroll);break;default:this.track(this.event_actions.ad_completed_preroll)}}adskipped(){if(this.ad_type)switch(this.ad_type){case"midroll":this.track(this.event_actions.ad_skipped_midroll);break;case"postroll":this.track(this.event_actions.ad_skipped_postroll);break;default:this.track(this.event_actions.ad_skipped_preroll)}else this.track(this.event_actions.ad_skipped_preroll)}adbreakcompleted(){this.track(this.event_actions.ad_break_completed)}pushToDataLayer(e,t,i){var s;if(window.dataLayer)try{window.dataLayer.push({event:"Flowplayer",video_name:i,action:e,category:t,duration:null===(s=this.video)||void 0===s?void 0:s.duration})}catch(e){}}track(e){var t,i,s,a,o;if(!this.config||!this.config.ga||!e||(null===(t=null==this?void 0:this.video)||void 0===t?void 0:t.hasState("consent-no-tracking")))return;const l=(null===(i=this.video)||void 0===i?void 0:i.opts.live)?this.event_categories.live:this.event_categories.videos,r=null===(s=this.config.ga)||void 0===s?void 0:s.ga_instances,n=(null===(a=null==this?void 0:this.config)||void 0===a?void 0:a.title)||(null===(o=this.config.metadata)||void 0===o?void 0:o.title)||"unknown video";return this.config.ga.data_layer_tracking?this.pushToDataLayer(e,l,n):(this.setup_ga(r),this.ga_extensions.length&&void 0!==window.ga&&null!==window.ga?void this.ga_extensions.forEach(t=>{window.ga(t+".send","event",l,e,n)}):console.debug("ga console.send","event",l,e,n))}})}));

package/plugins/hls.d.ts

@@ -1,9 +1,13 @@
 /// <reference types="node" />
 
 import type { BitrateInfo } from 'dashjs';
+import type { Get } from 'type-fest';
 import Hls from 'hls.js';
 import type { HlsConfig } from 'hls.js';
+import type { Level } from 'hls.js';
 import type { MediaKeyFunc } from 'hls.js';
+import type { SetFieldType } from 'type-fest';
+import type { TupleToUnion } from 'type-fest';
 
 /* Excluded from this release type: AnyLoader */
 
@@ -83,6 +87,26 @@ declare const /**
  */
 CLICK = "click";
 
+/**
+ * For plugins that add new properties to all source types, combine their src-mixins into one SourceObject
+ * @example
+ * ```
+ * type Combined = CombineGlobalSrcExtensions<DRMPlugin, PluginWithFooFieldInSrc> // Combined = SourceObject<DRMConfig & FooFieldConfig>
+ * ```
+ */
+declare type CombineGlobalSrcExtensions<PluginSrcs extends unknown[]> = HasGlobalSrcExtensios<PluginSrcs> extends false ? SourceObj : SourceObj & ArrayToIntersection<PickGlobalSrcExtension<PluginSrcs>>;
+
+/**
+ * For plugins that define a new src type, make a union of all new src.type declarations
+ * @example
+ * ```
+ * type Combined = CombineNewSourceTypes<RTSPlugin, SSAIPlugin> // Combined = DRMConfig | FooFieldConfig
+ * ```
+ */
+declare type CombineNewSourceTypes<PluginSrcs extends unknown[]> = TupleToUnion<FilterNewSourceTypes<PluginSrcs>>;
+
+declare type CombineSrc<PluginSrcs extends unknown[]> = UnsafeSource<CombineGlobalSrcExtensions<PluginSrcs> | (CombineNewSourceTypes<PluginSrcs> & CombineGlobalSrcExtensions<PluginSrcs>)>;
+
 /* Excluded from this release type: Component */
 
 /* Excluded from this release type: Components */
@@ -143,6 +167,10 @@ declare interface Config {
  */
 declare type ConfigWith<T> = Config & T;
 
+declare type ConfigWithSourceExtensions<PluginBareConfigs extends unknown[]> = Omit<ConfigWith<ArrayToIntersection<PluginBareConfigs>>, "src"> & {
+    src?: CombineSrc<PickSrcExtensions<PluginBareConfigs>>;
+};
+
 /* Excluded from this release type: CONTENT_REAL_LOAD_START */
 
 /**
@@ -392,6 +420,7 @@ declare namespace events_2 {
         SOURCE,
         REAP,
         QUALITIES,
+        QUALITY_CHANGE,
         VIDEO_TRACKS,
         SET_QUALITY,
         VIDEO_TRACK_SELECT,
@@ -407,8 +436,20 @@ declare namespace events_2 {
     }
 }
 
+declare type ExtractBareConfig<Plugins extends PluginCtor> = Plugins extends PluginCtor<ConfigWith<infer ConfigType>> ? ConfigType : never;
+
+declare type ExtractPluginPlayerExtension<Plugin extends PluginCtor> = Plugin extends PluginCtor<infer _uConfigType, PlayerWith<infer PluginPlayer>> ? PluginPlayer : never;
+
 declare type ExtractPureAPI<T> = T extends PlayerWith<infer PureAPI> ? PureAPI : never;
 
+declare type ExtractSrcExtension<PluginBareConfig> = Get<PluginBareConfig, "src"> extends UnsafeSource<infer SrcMixinType> ? SrcMixinType : never;
+
+declare type FilterNewSourceTypes<PluginSrcs extends unknown[]> = {
+    [Index in keyof PluginSrcs]: PluginSrcs[Index] extends {
+        type: string;
+    } ? PluginSrcs[Index] : never;
+};
+
 /**
  * @public
  */
@@ -451,7 +492,7 @@ declare interface FlowplayerUMD extends FlowplayerUMDBase {
      * Register plugins in flowplayer
      * @returns flowplayer instance with registered plugins
      */
-    <PluginCtors extends PluginCtor[]>(...plugins: PluginCtors): FlowplayerUMDWithPlugins<ConfigWith<MergeConfigs<PluginCtors>>, PlayerWith<MergePlayerAPIExtensions<PluginCtors>>>;
+    <PluginCtors extends PluginCtor[]>(...plugins: PluginCtors): FlowplayerUMDWithPlugins<MergeConfigs<PluginCtors>, PlayerWith<MergePlayerExtensions<PluginCtors>>>;
 }
 
 declare interface FlowplayerUMDBase {
@@ -552,10 +593,14 @@ declare const GRABBING = "is-grabbing";
 
 declare const HAS_POSTER = "has-poster";
 
+declare type HasGlobalSrcExtensios<PluginSrcs extends unknown[]> = ArrayToIntersection<PickGlobalSrcExtension<PluginSrcs>>;
+
+declare type HasSrcExtensions<PluginBareConfigs extends unknown[]> = TupleToUnion<PickSrcExtensions<PluginBareConfigs>> extends never ? false : true;
+
 /**
  *  @public
  */
-declare const HLS: PluginCtor<HLSConfig, HLSPlayer> & HLSAPI;
+declare const HLS: PluginCtor<NoInfer<HLSConfig>, NoInfer<HLSPlayer>> & NoInfer<HLSAPI>;
 export default HLS;
 
 /**
@@ -712,19 +757,24 @@ PluginPlayer extends PlayerWith<_AttachedEventCheck>> extends Plugin_2<PluginOwn
 
 declare const LOADING = "is-loading";
 
-declare type MapToConfigs<Arr extends PluginCtor[]> = {
-    [PluginType in keyof Arr]: Arr[PluginType] extends PluginCtor<ConfigWith<infer ConfigType>> ? ConfigType : never;
+declare type MapToBareConfigs<Plugins extends PluginCtor[]> = {
+    [PluginType in keyof Plugins]: ExtractBareConfig<Plugins[PluginType]>;
 };
 
-declare type MapToPlayerApiExtensions<Arr extends PluginCtor[]> = {
-    [PluginType in keyof Arr]: Arr[PluginType] extends PluginCtor<infer _uConfigType, PlayerWith<infer PlayerAPIExtension>> ? PlayerAPIExtension : never;
+declare type MapToPlayerExtensions<Plugins extends PluginCtor[]> = {
+    [PluginIndex in keyof Plugins]: ExtractPluginPlayerExtension<Plugins[PluginIndex]>;
 };
 
 declare const MENU_OPENED = "has-menu-opened";
 
-declare type MergeConfigs<Arr extends PluginCtor[]> = ArrayToIntersection<MapToConfigs<Arr>>;
+/**
+ * Combines plugin config and returns a type derived from Config
+ */
+declare type MergeConfigs<Plugins extends PluginCtor[]> = MergePluginConfigs<MapToBareConfigs<Plugins>>;
+
+declare type MergePlayerExtensions<Plugins extends PluginCtor[]> = ArrayToIntersection<MapToPlayerExtensions<Plugins>>;
 
-declare type MergePlayerAPIExtensions<Arr extends PluginCtor[]> = ArrayToIntersection<MapToPlayerApiExtensions<Arr>>;
+declare type MergePluginConfigs<PluginBareConfigs extends unknown[]> = HasSrcExtensions<PluginBareConfigs> extends true ? ConfigWithSourceExtensions<PluginBareConfigs> : ConfigWith<ArrayToIntersection<PluginBareConfigs>>;
 
 /**
  * @public
@@ -819,8 +869,6 @@ declare const NO_CONTROLS = "no-controls";
 
 declare const NO_DVR = "no-timeline";
 
-declare type NoInfer_2<T> = [T][T extends any ? 0 : never];
-
 /* Excluded from this release type: NON_RECOVERABLE_ERROR */
 
 /* Excluded from this release type: NonRecoverableErrorEventDetail */
@@ -839,6 +887,7 @@ declare type OVPMetadata = {
     category_name?: string;
     duration?: number;
     tags?: string;
+    playlist_title?: string;
 };
 
 /**
@@ -854,6 +903,26 @@ PAUSE = "pause";
 
 declare const PAUSED = "is-paused";
 
+declare type PickGlobalSrcExtension<PluginSrcs extends unknown[]> = {
+    [Index in keyof PluginSrcs]: PluginSrcs[Index] extends {
+        type: string;
+    } ? unknown : PluginSrcs[Index];
+};
+
+/**
+ * Maps incoming array to the src extension type
+ * @example
+ * ```
+ * PickSrcExtensions<[
+ *    {configProp: boolean, src: UnsafeSource<{srcProp: boolean}>},
+ *    {}
+ * ]> // = [{srcProp: boolean}, never]
+ * ```
+ */
+declare type PickSrcExtensions<PluginBareConfigs extends unknown[]> = {
+    [PluginType in keyof PluginBareConfigs]: ExtractSrcExtension<PluginBareConfigs[PluginType]>;
+};
+
 /**
  * @public
  */
@@ -975,6 +1044,8 @@ declare type PlayerCustomEventsDetailMap = PlayerEmittableCustomEventsDetailMap
     [DVR]: DvrEventDetail;
     [RETRY]: RetryEventDetail;
     [RECOVER]: RecoverEventDetail;
+    [QUALITIES]: QualitiesEventDetail;
+    [QUALITY_CHANGE]: QualityChangeEventDetail;
     /* Excluded from this release type: audioonlysource */
     /* Excluded from this release type: renderplugin */
     /* Excluded from this release type: "seek:queued" */
@@ -1031,7 +1102,10 @@ declare type PlayerCustomEventsOverloads = {
      * Emitted when the set of underlying qualities has changed.
      */
     on(event: typeof QUALITIES, handler: (e: FPEvent<PlayerCustomEventsDetailMap[typeof QUALITIES]>) => void): Player;
-    /* Excluded from this release type: on */
+    /**
+     * Emitted when the media changes quality.
+     */
+    on(event: typeof QUALITY_CHANGE, handler: (e: FPEvent<PlayerCustomEventsDetailMap[typeof QUALITY_CHANGE]>) => void): Player;
     /* Excluded from this release type: on */
     /**
      * Listen to this event to create a recommendations grid using the data passed with the event.
@@ -1086,7 +1160,6 @@ declare type PlayerCustomEventsOverloads = {
     /* Excluded from this release type: emit */
     /* Excluded from this release type: emit */
     /* Excluded from this release type: emit */
-    /* Excluded from this release type: emit */
 };
 
 declare type PlayerEmittableCustomEventsDetailMap = {
@@ -1094,7 +1167,6 @@ declare type PlayerEmittableCustomEventsDetailMap = {
     [CONTEXT_MENU]: ContextMenuEventDetail;
     [VIEW_ENTER]: ViewEnterEventDetail;
     [VIEW_LEAVE]: ViewLeaveEventDetail;
-    [QUALITIES]: QualitiesEventDetail;
     [RECOMMENDATIONS_READY]: RecommendationsReadyEventDetail;
 };
 
@@ -1196,11 +1268,16 @@ PROGRESS = "progress";
 /**
  * @public
  */
-declare type QselOption = {
-    height: number;
+declare type QselOption = (Level & {
     level: number;
-    text: string;
-    /* Excluded from this release type: videoCodec */
+}) | BitrateInfo | {
+    name: string | number;
+    encodingId: string;
+    spatialLayerId: number;
+    temporalLayerId: number;
+    maxSpatialLayerId: number;
+    maxTemporalLayerId: number;
+    height: number;
     width: number;
 };
 
@@ -1224,9 +1301,29 @@ QUALITIES = "qualities";
  */
 declare type QualitiesEventDetail = QselOption[];
 
-/* Excluded from this release type: _QualitiesEventDetail */
+/**
+ * @public
+ * emitted whenever the media changes quality
+ */
+declare const /**
+@public
+* when a new player is inserted into the HTML
+*/ /**
+ * @public
+ * emitted whenever the media changes quality
+ */
+QUALITY_CHANGE = "qualitychange";
 
-/* Excluded from this release type: _QualityDetail */
+/**
+ * @public
+ */
+declare type QualityChangeEventDetail = {
+    before: Level | BitrateInfo;
+    after: Level | BitrateInfo;
+    plugin: string;
+    automatic: boolean;
+    downscale: boolean;
+};
 
 declare enum QualityOpts {
     LOW = 1,
@@ -1437,14 +1534,14 @@ declare type SourceEventDetail = SourceObj;
 /**
  * @public
  */
-declare type SourceObj = {
+declare type SourceObj<T = unknown> = {
     src?: SourceStr;
     /**
      *  the MIME type (example `video/mp4` or `application/x-mpegurl`)
      */
     type?: string;
     drm?: DRMSourceConfiguration;
-};
+} & T;
 
 /**
  * @public
@@ -1571,7 +1668,7 @@ declare const TV = "is-tv";
 /**
  * @public
  */
-declare type UnsafeSource = SourceStr | SourceObj | Array<SourceStr | SourceObj>;
+declare type UnsafeSource<SrcMixin = unknown> = SourceStr | SourceObj<SrcMixin> | Array<SourceStr | SourceObj<SrcMixin>>;
 
 /**
  * @public
@@ -1667,9 +1764,6 @@ declare const WILL_PLAY = "will-play";
 
 declare const WILL_SEEK = "will-seek";
 
-declare type WithOpts<PluginPlayer extends Player = Player, PluginConfig extends Config = Config> = PluginPlayer & {
-    opts: PluginConfig;
-    setOpts(config: PluginConfig): void;
-};
+declare type WithOpts<PluginPlayer extends Player = Player, PluginConfig extends Config = Config> = SetFieldType<SetFieldType<PluginPlayer, "opts", PluginConfig>, "setOpts", (config: PluginConfig) => void>;
 
 export { }