@flowplayer/player 3.15.0-rc.8 → 3.15.0

package/plugins/vtsel.d.ts

@@ -315,6 +315,8 @@ declare const /**
  */
 ENDED_2 = "ended";
 
+declare type EnsureOnAttached<P extends Function, T extends Player> = ExtractPureAPI<T> extends _AttachedEventCheck ? P : "Loaders must implement on('<pluginname>:attached') event";
+
 /**
  * @public
  */
@@ -397,6 +399,8 @@ declare namespace events {
     }
 }
 
+declare type ExtractPureAPI<T> = T extends PlayerWith<infer PureAPI> ? PureAPI : never;
+
 /**
  * @public
  */
@@ -474,19 +478,19 @@ declare interface FlowplayerUMDBase {
 /**
  * @public
  */
-declare interface FlowplayerUMDWithPlugins<ConfigWithPlugins extends Config = Config, PluginPlayerAPIExtension extends Player = Player> extends FlowplayerUMDBase {
+declare interface FlowplayerUMDWithPlugins<ConfigWithPlugins extends Config = Config, PluginPlayer extends Player = Player> extends FlowplayerUMDBase {
     /**
      * Configure flowplayer, it's attached plugins and display flowplayer it in the UI
      * @param selector - query selector of the HTML element where player will render
      * @param config - Configuration of the flowplayer and the attached plugins
      */
-    (selector: string, config?: ConfigWithPlugins): PluginPlayerAPIExtension;
+    (selector: string, config?: ConfigWithPlugins): PluginPlayer;
     /**
      * Configure flowplayer, it's attached plugins and display flowplayer it in the UI
      * @param element - HTML element where player will render
      * @param config - Configuration of the flowplayer and the attached plugins
      */
-    (element: HTMLElement, config?: ConfigWithPlugins): PluginPlayerAPIExtension;
+    (element: HTMLElement, config?: ConfigWithPlugins): PluginPlayer;
 }
 
 /**
@@ -638,10 +642,11 @@ declare const LOADED = "is-loaded";
 
 /**
  * @public A plugin that supports loading new media formats. Use 'class MyPlugin implements Loader\<...\>' when writing your custom Loader
- * @typeParam PluginPlayerAPIExtension - additional Player API that will be implemented by the loader. Loader at least must implement on(\<loader-name\>:attached, ...) event handler
+ * @typeParam PluginPlayer- Player API that will be implemented by the loader. Loader at least must implement on(\<loader-name\>:attached, ...) event handler
  */
-declare interface Loader<PluginOwnConfig extends KeyValue, PluginPlayerAPIExtension extends _AttachedEventCheck> extends Plugin_2<PluginOwnConfig, PlayerWith<PluginPlayerAPIExtension>> {
-    onload(config: ConfigWith<PluginOwnConfig>, root: PlayerRoot, video: PlayerWith<PluginPlayerAPIExtension>, src?: SourceObj): void;
+declare interface Loader<PluginOwnConfig extends KeyValue, // FIXME extends Config
+PluginPlayer extends PlayerWith<_AttachedEventCheck>> extends Plugin_2<PluginOwnConfig, PluginPlayer> {
+    onload: EnsureOnAttached<(config: ConfigWith<PluginOwnConfig>, root: PlayerRoot, video: PlayerWith<PluginPlayer>, src: SourceObj) => void, PluginPlayer>;
     wants<S = SourceObj>(srcString: SourceStr, srcObj: S, config: ConfigWith<PluginOwnConfig>): boolean;
     wants<S = KeyValue>(srcString: SourceStr, srcObj: SourceWith<S>, config: ConfigWith<PluginOwnConfig>): boolean;
 }
@@ -1038,6 +1043,7 @@ declare type PlayerNativeEventsOverloads = {
 
 /**
  * @public
+ * The root element of the video player. This is the immediate parent element of the video tag.
  */
 declare type PlayerRoot = HTMLElement & {
     /* Excluded from this release type: prevWidth */
@@ -1073,11 +1079,11 @@ PLAYING_2 = "playing";
 /**
  * @public
  */
-declare interface Plugin_2<PluginConfig extends Config = Config, PluginPlayerAPI extends Player = Player> {
+declare interface Plugin_2<PluginConfig extends Config = Config, PluginPlayer extends Player = Player> {
     /**
      * a plugin must always implement the init method so a player instance knows how to initialize it
      */
-    init(config: PluginConfig, container: PlayerRoot, player: PluginPlayerAPI): void;
+    init(config: PluginConfig, container: PlayerRoot, player: PluginPlayer): void;
 }
 
 /* Excluded from this release type: PLUGIN_REGISTERED */
@@ -1085,8 +1091,8 @@ declare interface Plugin_2<PluginConfig extends Config = Config, PluginPlayerAPI
 /**
  * @public
  */
-declare interface PluginCtor<PluginConfig extends Config = Config, PluginPlayerAPI extends Player = Player> {
-    new (umd: FlowplayerUMD, player: PluginPlayerAPI): Plugin_2<PluginConfig, PluginPlayerAPI>;
+declare interface PluginCtor<PluginConfig extends Config = Config, PluginPlayer extends Player = Player> {
+    new (umd: FlowplayerUMD, player: PluginPlayer): Plugin_2<PluginConfig, PluginPlayer>;
 }
 
 /* Excluded from this release type: PluginRegisteredEventDetail */

package/plugins/webos.d.ts

@@ -315,6 +315,8 @@ declare const /**
  */
 ENDED_2 = "ended";
 
+declare type EnsureOnAttached<P extends Function, T extends Player> = ExtractPureAPI<T> extends _AttachedEventCheck ? P : "Loaders must implement on('<pluginname>:attached') event";
+
 /**
  * @public
  */
@@ -397,6 +399,8 @@ declare namespace events {
     }
 }
 
+declare type ExtractPureAPI<T> = T extends PlayerWith<infer PureAPI> ? PureAPI : never;
+
 /**
  * @public
  */
@@ -474,19 +478,19 @@ declare interface FlowplayerUMDBase {
 /**
  * @public
  */
-declare interface FlowplayerUMDWithPlugins<ConfigWithPlugins extends Config = Config, PluginPlayerAPIExtension extends Player = Player> extends FlowplayerUMDBase {
+declare interface FlowplayerUMDWithPlugins<ConfigWithPlugins extends Config = Config, PluginPlayer extends Player = Player> extends FlowplayerUMDBase {
     /**
      * Configure flowplayer, it's attached plugins and display flowplayer it in the UI
      * @param selector - query selector of the HTML element where player will render
      * @param config - Configuration of the flowplayer and the attached plugins
      */
-    (selector: string, config?: ConfigWithPlugins): PluginPlayerAPIExtension;
+    (selector: string, config?: ConfigWithPlugins): PluginPlayer;
     /**
      * Configure flowplayer, it's attached plugins and display flowplayer it in the UI
      * @param element - HTML element where player will render
      * @param config - Configuration of the flowplayer and the attached plugins
      */
-    (element: HTMLElement, config?: ConfigWithPlugins): PluginPlayerAPIExtension;
+    (element: HTMLElement, config?: ConfigWithPlugins): PluginPlayer;
 }
 
 /**
@@ -638,10 +642,11 @@ declare const LOADED = "is-loaded";
 
 /**
  * @public A plugin that supports loading new media formats. Use 'class MyPlugin implements Loader\<...\>' when writing your custom Loader
- * @typeParam PluginPlayerAPIExtension - additional Player API that will be implemented by the loader. Loader at least must implement on(\<loader-name\>:attached, ...) event handler
+ * @typeParam PluginPlayer- Player API that will be implemented by the loader. Loader at least must implement on(\<loader-name\>:attached, ...) event handler
  */
-declare interface Loader<PluginOwnConfig extends KeyValue, PluginPlayerAPIExtension extends _AttachedEventCheck> extends Plugin_2<PluginOwnConfig, PlayerWith<PluginPlayerAPIExtension>> {
-    onload(config: ConfigWith<PluginOwnConfig>, root: PlayerRoot, video: PlayerWith<PluginPlayerAPIExtension>, src?: SourceObj): void;
+declare interface Loader<PluginOwnConfig extends KeyValue, // FIXME extends Config
+PluginPlayer extends PlayerWith<_AttachedEventCheck>> extends Plugin_2<PluginOwnConfig, PluginPlayer> {
+    onload: EnsureOnAttached<(config: ConfigWith<PluginOwnConfig>, root: PlayerRoot, video: PlayerWith<PluginPlayer>, src: SourceObj) => void, PluginPlayer>;
     wants<S = SourceObj>(srcString: SourceStr, srcObj: S, config: ConfigWith<PluginOwnConfig>): boolean;
     wants<S = KeyValue>(srcString: SourceStr, srcObj: SourceWith<S>, config: ConfigWith<PluginOwnConfig>): boolean;
 }
@@ -1038,6 +1043,7 @@ declare type PlayerNativeEventsOverloads = {
 
 /**
  * @public
+ * The root element of the video player. This is the immediate parent element of the video tag.
  */
 declare type PlayerRoot = HTMLElement & {
     /* Excluded from this release type: prevWidth */
@@ -1073,11 +1079,11 @@ PLAYING_2 = "playing";
 /**
  * @public
  */
-declare interface Plugin_2<PluginConfig extends Config = Config, PluginPlayerAPI extends Player = Player> {
+declare interface Plugin_2<PluginConfig extends Config = Config, PluginPlayer extends Player = Player> {
     /**
      * a plugin must always implement the init method so a player instance knows how to initialize it
      */
-    init(config: PluginConfig, container: PlayerRoot, player: PluginPlayerAPI): void;
+    init(config: PluginConfig, container: PlayerRoot, player: PluginPlayer): void;
 }
 
 /* Excluded from this release type: PLUGIN_REGISTERED */
@@ -1085,8 +1091,8 @@ declare interface Plugin_2<PluginConfig extends Config = Config, PluginPlayerAPI
 /**
  * @public
  */
-declare interface PluginCtor<PluginConfig extends Config = Config, PluginPlayerAPI extends Player = Player> {
-    new (umd: FlowplayerUMD, player: PluginPlayerAPI): Plugin_2<PluginConfig, PluginPlayerAPI>;
+declare interface PluginCtor<PluginConfig extends Config = Config, PluginPlayer extends Player = Player> {
+    new (umd: FlowplayerUMD, player: PluginPlayer): Plugin_2<PluginConfig, PluginPlayer>;
 }
 
 /* Excluded from this release type: PluginRegisteredEventDetail */

package/util/loader.d.ts

@@ -237,8 +237,8 @@ DBL_CLICK = "dblclick";
  * adds support for asynchronous plugin loading
  * issue/127
  */
-export declare function define<PluginConfig extends Config = Config, PluginPlayerAPI extends Player = Player, PublicAPI = unknown>(root: any, // TODO type this to PlayerRoot
-plugin: PluginCtor<NoInfer<PluginConfig>, NoInfer<PluginPlayerAPI>> & NoInfer<PublicAPI>): typeof plugin;
+export declare function define<PluginConfig extends Config = Config, PluginPlayer extends Player = Player, PublicAPI = unknown>(root: any, // TODO type this to PlayerRoot
+plugin: PluginCtor<NoInfer<PluginConfig>, NoInfer<PluginPlayer>> & NoInfer<PublicAPI>): typeof plugin;
 
 declare const DESTROYED = "is-destroyed";
 
@@ -323,6 +323,8 @@ declare const /**
  */
 ENDED_2 = "ended";
 
+declare type EnsureOnAttached<P extends Function, T extends Player> = ExtractPureAPI<T> extends _AttachedEventCheck ? P : "Loaders must implement on('<pluginname>:attached') event";
+
 /**
  * @public
  */
@@ -405,6 +407,8 @@ declare namespace events {
     }
 }
 
+declare type ExtractPureAPI<T> = T extends PlayerWith<infer PureAPI> ? PureAPI : never;
+
 /**
  * @public
  */
@@ -482,19 +486,19 @@ declare interface FlowplayerUMDBase {
 /**
  * @public
  */
-declare interface FlowplayerUMDWithPlugins<ConfigWithPlugins extends Config = Config, PluginPlayerAPIExtension extends Player = Player> extends FlowplayerUMDBase {
+declare interface FlowplayerUMDWithPlugins<ConfigWithPlugins extends Config = Config, PluginPlayer extends Player = Player> extends FlowplayerUMDBase {
     /**
      * Configure flowplayer, it's attached plugins and display flowplayer it in the UI
      * @param selector - query selector of the HTML element where player will render
      * @param config - Configuration of the flowplayer and the attached plugins
      */
-    (selector: string, config?: ConfigWithPlugins): PluginPlayerAPIExtension;
+    (selector: string, config?: ConfigWithPlugins): PluginPlayer;
     /**
      * Configure flowplayer, it's attached plugins and display flowplayer it in the UI
      * @param element - HTML element where player will render
      * @param config - Configuration of the flowplayer and the attached plugins
      */
-    (element: HTMLElement, config?: ConfigWithPlugins): PluginPlayerAPIExtension;
+    (element: HTMLElement, config?: ConfigWithPlugins): PluginPlayer;
 }
 
 /**
@@ -651,10 +655,11 @@ declare const LOADED = "is-loaded";
 
 /**
  * @public A plugin that supports loading new media formats. Use 'class MyPlugin implements Loader\<...\>' when writing your custom Loader
- * @typeParam PluginPlayerAPIExtension - additional Player API that will be implemented by the loader. Loader at least must implement on(\<loader-name\>:attached, ...) event handler
+ * @typeParam PluginPlayer- Player API that will be implemented by the loader. Loader at least must implement on(\<loader-name\>:attached, ...) event handler
  */
-declare interface Loader<PluginOwnConfig extends KeyValue, PluginPlayerAPIExtension extends _AttachedEventCheck> extends Plugin_2<PluginOwnConfig, PlayerWith<PluginPlayerAPIExtension>> {
-    onload(config: ConfigWith<PluginOwnConfig>, root: PlayerRoot, video: PlayerWith<PluginPlayerAPIExtension>, src?: SourceObj): void;
+declare interface Loader<PluginOwnConfig extends KeyValue, // FIXME extends Config
+PluginPlayer extends PlayerWith<_AttachedEventCheck>> extends Plugin_2<PluginOwnConfig, PluginPlayer> {
+    onload: EnsureOnAttached<(config: ConfigWith<PluginOwnConfig>, root: PlayerRoot, video: PlayerWith<PluginPlayer>, src: SourceObj) => void, PluginPlayer>;
     wants<S = SourceObj>(srcString: SourceStr, srcObj: S, config: ConfigWith<PluginOwnConfig>): boolean;
     wants<S = KeyValue>(srcString: SourceStr, srcObj: SourceWith<S>, config: ConfigWith<PluginOwnConfig>): boolean;
 }
@@ -1058,6 +1063,7 @@ declare type PlayerNativeEventsOverloads = {
 
 /**
  * @public
+ * The root element of the video player. This is the immediate parent element of the video tag.
  */
 declare type PlayerRoot = HTMLElement & {
     /* Excluded from this release type: prevWidth */
@@ -1093,11 +1099,11 @@ PLAYING_2 = "playing";
 /**
  * @public
  */
-declare interface Plugin_2<PluginConfig extends Config = Config, PluginPlayerAPI extends Player = Player> {
+declare interface Plugin_2<PluginConfig extends Config = Config, PluginPlayer extends Player = Player> {
     /**
      * a plugin must always implement the init method so a player instance knows how to initialize it
      */
-    init(config: PluginConfig, container: PlayerRoot, player: PluginPlayerAPI): void;
+    init(config: PluginConfig, container: PlayerRoot, player: PluginPlayer): void;
 }
 
 /* Excluded from this release type: PLUGIN_REGISTERED */
@@ -1105,8 +1111,8 @@ declare interface Plugin_2<PluginConfig extends Config = Config, PluginPlayerAPI
 /**
  * @public
  */
-declare interface PluginCtor<PluginConfig extends Config = Config, PluginPlayerAPI extends Player = Player> {
-    new (umd: FlowplayerUMD, player: PluginPlayerAPI): Plugin_2<PluginConfig, PluginPlayerAPI>;
+declare interface PluginCtor<PluginConfig extends Config = Config, PluginPlayer extends Player = Player> {
+    new (umd: FlowplayerUMD, player: PluginPlayer): Plugin_2<PluginConfig, PluginPlayer>;
 }
 
 /* Excluded from this release type: PluginRegisteredEventDetail */