@flowplayer/player 3.19.0 → 3.20.0-rc.5

package/plugins/dash.d.ts

@@ -2,10 +2,14 @@
 
 import type { BitrateInfo } from 'dashjs';
 import type * as DashJS from 'dashjs';
+import type { Get } from 'type-fest';
+import type { Level } from 'hls.js';
 import type { MediaKeyFunc } from 'hls.js';
 import type { MediaPlayerClass } from 'dashjs';
 import type { MediaSettings } from 'dashjs';
 import type { ProtectionDataSet } from 'dashjs';
+import type { SetFieldType } from 'type-fest';
+import type { TupleToUnion } from 'type-fest';
 
 declare namespace allEvents {
     export {
@@ -95,6 +99,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 */
@@ -155,6 +179,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 */
 
 /**
@@ -449,6 +477,7 @@ declare namespace events {
         SOURCE,
         REAP,
         QUALITIES,
+        QUALITY_CHANGE,
         VIDEO_TRACKS,
         SET_QUALITY,
         VIDEO_TRACK_SELECT,
@@ -464,8 +493,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
  */
@@ -508,7 +549,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 {
@@ -609,6 +650,10 @@ 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";
@@ -718,19 +763,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
@@ -825,8 +875,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 */
@@ -845,6 +893,7 @@ declare type OVPMetadata = {
     category_name?: string;
     duration?: number;
     tags?: string;
+    playlist_title?: string;
 };
 
 /**
@@ -860,6 +909,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
  */
@@ -981,6 +1050,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" */
@@ -1037,7 +1108,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.
@@ -1092,7 +1166,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 = {
@@ -1100,7 +1173,6 @@ declare type PlayerEmittableCustomEventsDetailMap = {
     [CONTEXT_MENU]: ContextMenuEventDetail;
     [VIEW_ENTER]: ViewEnterEventDetail;
     [VIEW_LEAVE]: ViewLeaveEventDetail;
-    [QUALITIES]: QualitiesEventDetail;
     [RECOMMENDATIONS_READY]: RecommendationsReadyEventDetail;
 };
 
@@ -1202,11 +1274,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;
 };
 
@@ -1230,9 +1307,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,
@@ -1438,14 +1535,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
@@ -1572,7 +1669,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
@@ -1668,9 +1765,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 { }