@gcorevideo/player 2.20.1 → 2.20.4

package/release_notes

@@ -0,0 +1,297 @@
+commit e0fdb8709baf62055124303f46ed3a18d47dca27
+Author: Dmitrii Tkach <dmitrii.tkach@gcore.com>
+Date:   Fri Feb 21 18:56:59 2025 +0400
+
+    Add documentation on the Favicon, GoogleAnalytics plugins
+
+commit 11e82a088643cf9b4ef9e244b472887325c87605
+Author: Dmitrii Tkach <dmitrii.tkach@gcore.com>
+Date:   Fri Feb 21 18:52:09 2025 +0400
+
+    Add AudioSelector docs
+
+commit 4cf62967bbea6906b00961f1d2631aff4a7a255b
+Author: Dmitrii Tkach <dmitrii.tkach@gcore.com>
+Date:   Fri Feb 21 18:10:07 2025 +0400
+
+    Add DvrControls plugin docs
+
+commit b0df7f005024912cba46cc9f478a7355efeefb5a
+Author: Dmitrii Tkach <dmitrii.tkach@gcore.com>
+Date:   Fri Feb 21 17:31:43 2025 +0400
+
+    Add documentation on ContextMenu plugin
+
+commit 24c3ce396a8d69e60433a126b5a7c5efdee94957
+Author: Dmitrii Tkach <dmitrii.tkach@gcore.com>
+Date:   Fri Feb 21 17:17:46 2025 +0400
+
+    Add documentation on the ClickToPause and Clips plugins
+
+commit 141e43d009c95fab701007b0c6886e02d8edcaac
+Author: Dmitrii Tkach <dmitrii.tkach@gcore.com>
+Date:   Fri Feb 21 17:03:58 2025 +0400
+
+    Add ClapprStats plugin documentation
+
+commit 9e777c289b81cc2fe2393496a0b1d6dcf4da375e
+Author: Dmitrii Tkach <dmitrii.tkach@gcore.com>
+Date:   Fri Feb 21 16:57:21 2025 +0400
+
+    Add documentation on the Thumbnails and BigMuteButton plugins
+
+commit 4e3e080fa9dfdc2778ad1a2578d4ddfa4a36063f
+Author: Dmitrii Tkach <dmitrii.tkach@gcore.com>
+Date:   Fri Feb 21 16:41:30 2025 +0400
+
+    Refactor Telemetry plugin
+
+commit ab7d3a300526047256ecedb3e79a70f368dd6b4e
+Author: Dmitrii Tkach <dmitrii.tkach@gcore.com>
+Date:   Thu Feb 20 20:04:00 2025 +0400
+
+    Add documentation on PictuerInPicture plugin
+
+commit ee9cfdd684c762b8fb01dc38eab4783f2cd20301
+Author: Dmitrii Tkach <dmitrii.tkach@gcore.com>
+Date:   Thu Feb 20 19:54:25 2025 +0400
+
+    Add docs on PlaybackRate plugin
+
+commit f80f4612b5e06a61b88ce79f8fc7fff22bd6a8f8
+Author: Dmitrii Tkach <dmitrii.tkach@gcore.com>
+Date:   Thu Feb 20 19:33:54 2025 +0400
+
+    Refactor Subtitles plugin
+
+commit 389ea9ff869852270c2f946e36c2f88a99007e0f
+Author: Dmitrii Tkach <dmitrii.tkach@gcore.com>
+Date:   Thu Feb 20 16:10:26 2025 +0400
+
+    Media control plugins refactoring
+
+commit 2eb75ea01af24723ddeb16596b4c031cac6802fd
+Author: Dmitrii Tkach <dmitrii.tkach@gcore.com>
+Date:   Wed Feb 19 19:22:23 2025 +0400
+
+    Refactor MediaControl. Add documentation on plugins
+
+commit 8b2e7b99a6f546491597f5dd8fcf095b85d736e6
+Author: Dmitrii Tkach <dmitrii.tkach@gcore.com>
+Date:   Wed Feb 19 12:38:34 2025 +0400
+
+    Rename CI directory
+
+commit 51d26f1bb79e9d6f18d85a95884d5703b1db28e8
+Author: Dmitrii Tkach <dmitrii.tkach@gcore.com>
+Date:   Wed Feb 19 12:33:42 2025 +0400
+
+    Fix premature autoplay
+
+commit 500baf2d59ed9c7a93574c2607629f9fcd30c2ea
+Author: Dmitrii Tkach <dmitrii.tkach@gcore.com>
+Date:   Tue Feb 18 15:31:06 2025 +0400
+
+    Update documentation on media control plugin
+
+commit 584c36655f6b5943992ae22cf9e8e3f0784a3ce2
+Author: Dmitrii Tkach <dmitrii.tkach@gcore.com>
+Date:   Tue Feb 18 14:04:43 2025 +0400
+
+    2.0.0
+
+commit 2339ad64729136df35f55b4e316ae2ac8d8721e1
+Author: Dmitrii Tkach <dmitrii.tkach@gcore.com>
+Date:   Tue Feb 18 14:04:35 2025 +0400
+
+    Install husky
+
+commit 620088cafb283b71d8b2abc63b80fbfb243da99c
+Author: Dmitrii Tkach <dmitrii.tkach@gcore.com>
+Date:   Tue Feb 18 14:04:00 2025 +0400
+
+    Fix vertical formats treatment in level selector
+
+commit 5411aeac00da59a2d4fe44fd661af55571398b77
+Author: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
+Date:   Mon Feb 17 15:34:59 2025 +0000
+
+    Bump oxlint from 0.13.2 to 0.15.11
+    
+    Bumps [oxlint](https://github.com/oxc-project/oxc/tree/HEAD/npm/oxlint) from 0.13.2 to 0.15.11.
+    - [Release notes](https://github.com/oxc-project/oxc/releases)
+    - [Changelog](https://github.com/oxc-project/oxc/blob/main/npm/oxlint/CHANGELOG.md)
+    - [Commits](https://github.com/oxc-project/oxc/commits/oxlint_v0.15.11/npm/oxlint)
+    
+    ---
+    updated-dependencies:
+    - dependency-name: oxlint
+      dependency-type: direct:development
+      update-type: version-update:semver-minor
+    ...
+    
+    Signed-off-by: dependabot[bot] <support@github.com>
+
+commit bb92071ee144d26ec75d5e0c2fb6cd858fb5b03a
+Author: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
+Date:   Tue Feb 18 11:50:09 2025 +0400
+
+    Update documentation (#14)
+    
+    Co-authored-by: dmitritz <dmitritz@users.noreply.github.com>
+
+commit fb93868502059f3e39e5d242e4e4f2703a5ada86
+Author: Dmitrii Tkach <dmitrii.tkach@gcore.com>
+Date:   Tue Feb 18 11:44:07 2025 +0400
+
+    Fix docs update workflow
+
+commit 59fea91631903d4e6cc47ee9d6b89d7778f9cf3a
+Author: Dmitrii Tkach <dmitrii.tkach@gcore.com>
+Date:   Tue Feb 18 11:13:53 2025 +0400
+
+    Set the commiter username and email in docs update workflow
+
+commit 1e08c59d3a3cddf2f4e71cc02167fc872ca771fa
+Author: Dmitrii Tkach <dmitrii.tkach@gcore.com>
+Date:   Tue Feb 18 10:52:15 2025 +0400
+
+    Add documentation update workflow
+
+commit 28317d9233fa1fa3524dba636161cf8adceff736
+Author: Dmitrii Tkach <dmitrii.tkach@gcore.com>
+Date:   Mon Feb 17 19:33:43 2025 +0400
+
+    Update documentation
+
+commit edfeaecc20293c59cf2d73505d6313cf90f94277
+Author: Dmitrii Tkach <dmitrii.tkach@gcore.com>
+Date:   Mon Feb 17 17:22:03 2025 +0400
+
+    Fix wrong plugins build output
+
+commit 5a26abe259aee23c47cfc6174c23cb2e9e6b9ced
+Author: Dmitrii Tkach <dmitrii.tkach@gcore.com>
+Date:   Mon Feb 17 17:18:19 2025 +0400
+
+    Fix wrong dist data upload
+
+commit eff63fc92e3ab24cc781a3919f21567e172ea2db
+Author: Dmitrii Tkach <dmitrii.tkach@gcore.com>
+Date:   Mon Feb 17 16:51:21 2025 +0400
+
+    Fix uploaded package version
+
+commit 57542e2d111b633f270e90030c915038c98fd581
+Author: Dmitrii Tkach <dmitrii.tkach@gcore.com>
+Date:   Mon Feb 17 16:43:56 2025 +0400
+
+    Fix version ref in publishing workflow
+
+commit 7a00e2e88eeff3ebc9a57531f18c1a60006cb38a
+Author: Dmitrii Tkach <dmitrii.tkach@gcore.com>
+Date:   Mon Feb 17 16:35:46 2025 +0400
+
+    Fix publishing workflow
+
+commit cbab766280d71472583f1dabab857d3516293488
+Author: Dmitrii Tkach <dmitrii.tkach@gcore.com>
+Date:   Mon Feb 17 16:31:57 2025 +0400
+
+    Fix no event listeners after container change in LevelSelector
+
+commit d19638c072222eb113fab9486e2a702adb012c22
+Author: Dmitrii Tkach <dmitrii.tkach@gcore.com>
+Date:   Mon Feb 17 14:36:17 2025 +0400
+
+    Merge player and plugins into single package
+
+commit 39cbb56f3d55959d5c7470a21dd2a96a2e53386d
+Author: Dmitrii Tkach <dmitrii.tkach@gcore.com>
+Date:   Mon Feb 17 13:49:34 2025 +0400
+
+    Fix initial bitrate detection dash
+
+commit 7e6e8160c139e74e81d453d63a0fb569c33b0447
+Author: Dmitrii Tkach <dmitrii.tkach@gcore.com>
+Date:   Fri Feb 14 18:47:10 2025 +0400
+
+    Add isMuted method in Player API
+
+commit 12fb16cf335b9b69c6deaf6b26f54bbd72a794b9
+Author: Dmitrii Tkach <dmitrii.tkach@gcore.com>
+Date:   Fri Feb 14 17:59:10 2025 +0400
+
+    Add isDvrInUse in Player API
+
+commit 3fb532b2eff0b57ccf21912c125897a314977f27
+Author: Dmitrii Tkach <dmitrii.tkach@gcore.com>
+Date:   Fri Feb 14 15:00:43 2025 +0400
+
+    Fix empty labels in level selector due to missed config option
+
+commit cbca60708e5349d126a4942ba3bfd7659a668705
+Author: Dmitrii Tkach <dmitrii.tkach@gcore.com>
+Date:   Fri Feb 14 13:51:34 2025 +0400
+
+    Ability to restrict resolution in LevelSelector
+
+commit e157dfa386b39ffb2f1c3b3d6eb5776531124a2f
+Author: Dmitrii Tkach <dmitrii.tkach@gcore.com>
+Date:   Thu Feb 13 21:35:21 2025 +0400
+
+    Update docs
+
+commit 7c381d03037caa77d4f4e7c42ecd4db98dfa1c1a
+Author: Dmitrii Tkach <dmitrii.tkach@gcore.com>
+Date:   Thu Feb 13 21:30:45 2025 +0400
+
+    Update docs
+
+commit 17e0d1a6a2337833f6d3da7fc8d6abfc2d3bfb81
+Author: Dmitrii Tkach <dmitrii.tkach@gcore.com>
+Date:   Thu Feb 13 19:20:14 2025 +0400
+
+    Add public API methods. Update documentation
+
+commit 549e87ff0ddfea8c1d087a38e1dc73e21141d4bc
+Author: Dmitrii Tkach <dmitrii.tkach@gcore.com>
+Date:   Thu Feb 13 16:30:37 2025 +0400
+
+    Update documentation
+
+commit d3a532e2c702273637baf6c22216c91900036297
+Author: Dmitrii Tkach <dmitrii.tkach@gcore.com>
+Date:   Wed Feb 12 20:46:11 2025 +0400
+
+    Update docs
+
+commit acab9ab142460d6872568f97e2976032fe09a54f
+Author: Dmitrii Tkach <dmitrii.tkach@gcore.com>
+Date:   Wed Feb 12 20:44:53 2025 +0400
+
+    Add docs
+
+commit 159c3c8dd9da1105b01c892a1af1b47d8fb1a093
+Author: Dmitrii Tkach <dmitrii.tkach@gcore.com>
+Date:   Wed Feb 12 18:49:49 2025 +0400
+
+    Rename packages directories, refactor tracing code
+
+commit 66762d433c72382fe691d46a416d8715799fdbf4
+Author: Dmitrii Tkach <dmitrii.tkach@gcore.com>
+Date:   Wed Feb 12 18:45:50 2025 +0400
+
+    Rename plugins directory
+
+commit 69b8528562d25c14cb5e7a0419cce50248dbcba0
+Author: Dmitrii Tkach <dmitrii.tkach@gcore.com>
+Date:   Mon Feb 10 14:25:58 2025 +0400
+
+    Fix MIME type guess
+
+commit b94f32aa3c0bf16c9a27e3ccc26e5b411d23c1bb
+Author: Dmitrii Tkach <dmitrii.tkach@gcore.com>
+Date:   Mon Feb 10 14:07:13 2025 +0400
+
+    Add dash.js & hls.js error codes handling. Rewrite sources selection

package/src/Player.ts

@@ -15,12 +15,13 @@ import type {
   CoreOptions,
   CorePluginOptions,
 } from './internal.types.js'
-import type { ContainerSize, PlayerMediaSourceDesc, PlayerPlugin } from './types.js'
+import type {
+  ContainerSize,
+  PlayerMediaSourceDesc,
+  PlayerPluginConstructor,
+} from './types.js'
 import { PlayerConfig, PlayerEvent } from './types.js'
-import {
-  buildMediaSourcesList,
-  wrapSource,
-} from './utils/mediaSources.js'
+import { buildMediaSourcesList, wrapSource } from './utils/mediaSources.js'
 import { registerPlaybacks } from './playback/index.js'
 import { PlaybackError, TimePosition } from './playback.types.js'
 
@@ -28,20 +29,28 @@ import { PlaybackError, TimePosition } from './playback.types.js'
  * @beta
  */
 export type PlayerEventParams<E extends PlayerEvent> =
-  E extends PlayerEvent.Seek ? [number]
-  : E extends PlayerEvent.VolumeUpdate ? [number]
-  : E extends PlayerEvent.TimeUpdate ? [TimePosition]
-  : E extends PlayerEvent.Resize ? [{ width: number, height: number }]
-  : E extends PlayerEvent.Fullscreen ? [boolean]
-  : E extends PlayerEvent.Error ? [PlaybackError]
-  : []
+  E extends PlayerEvent.Seek
+    ? [number]
+    : E extends PlayerEvent.VolumeUpdate
+    ? [number]
+    : E extends PlayerEvent.TimeUpdate
+    ? [TimePosition]
+    : E extends PlayerEvent.Resize
+    ? [{ width: number; height: number }]
+    : E extends PlayerEvent.Fullscreen
+    ? [boolean]
+    : E extends PlayerEvent.Error
+    ? [PlaybackError]
+    : []
 
 /**
  * Type of a listener callback function for a player event.
  * See the description of the event parameters in {@link PlayerEvent}.
  * @beta
  */
-export type PlayerEventHandler<E extends PlayerEvent> = (...args: PlayerEventParams<E>) => void
+export type PlayerEventHandler<E extends PlayerEvent> = (
+  ...args: PlayerEventParams<E>
+) => void
 
 const T = 'GPlayer'
 
@@ -157,7 +166,7 @@ export class Player {
     }
 
     const coreOpts = this.buildCoreOptions(playerElement)
-    const { core, container } = Loader.registeredPlugins
+    const { core, container } = Player.getRegisteredPlugins()
     trace(`${T} init`, {
       registeredPlaybacks: Loader.registeredPlaybacks.map((p) => p.name),
     })
@@ -331,19 +340,51 @@ export class Player {
    * @example
    * ```ts
    * import MyPlugin from './MyPlugin.js'
-   * 
+   *
    * Player.registerPlugin(MyPlugin)
    * ```
    */
-  static registerPlugin(plugin: PlayerPlugin) {
+  static registerPlugin(plugin: PlayerPluginConstructor) {
+    assert.ok(
+      plugin.type === 'core' || plugin.type === 'container',
+      'Invalid plugin type',
+    )
+    if (plugin.type === 'core') {
+      if (plugin.prototype.name === 'media_control') {
+        Player.corePlugins.unshift(plugin)
+      } else {
+        Player.corePlugins.push(plugin)
+      }
+      return
+    }
     Loader.registerPlugin(plugin)
   }
 
+  private static getRegisteredPlugins(): {
+    core: Record<string, PlayerPluginConstructor>
+    container: Record<string, PlayerPluginConstructor>
+  } {
+    for (const plugin of Player.corePlugins) {
+      Loader.registerPlugin(plugin)
+    }
+    return Loader.registeredPlugins
+  }
+
+  private static corePlugins: PlayerPluginConstructor[] = []
+
   /**
    * Unregisters a plugin registered earlier with {@link Player.registerPlugin}.
    * @param plugin - a plugin class
    */
-  static unregisterPlugin(plugin: PlayerPlugin) {
+  static unregisterPlugin(plugin: PlayerPluginConstructor) {
+    assert.ok(
+      plugin.type === 'core' || plugin.type === 'container',
+      'Invalid plugin type',
+    )
+    if (plugin.type === 'core') {
+      Player.corePlugins = Player.corePlugins.filter((p) => p !== plugin)
+      return
+    }
     Loader.unregisterPlugin(plugin)
   }
 
@@ -392,7 +433,10 @@ export class Player {
     }, 0)
   }
 
-  private safeTriggerEvent<E extends PlayerEvent>(event: E, ...args: PlayerEventParams<E>) {
+  private safeTriggerEvent<E extends PlayerEvent>(
+    event: E,
+    ...args: PlayerEventParams<E>
+  ) {
     try {
       this.emitter.emit(event, ...args)
     } catch (e) {
@@ -445,29 +489,34 @@ export class Player {
 
     this.rootNode = rootNode
 
-    const coreOptions: CoreOptions & PluginOptions = $.extend(true, {
-      allowUserInteraction: true,
-      debug: 'none',
-      events: this.events,
-      height: rootNode.clientHeight,
-      playback: {
-        controls: false,
-        playInline: true,
-        preload: Browser.isiOS ? 'metadata' : 'none',
-        mute: this.config.mute,
-        crossOrigin: 'anonymous', // TODO
-        hlsjsConfig: {
-          debug: this.config.debug === 'all' || this.config.debug === 'hls',
+    const coreOptions: CoreOptions & PluginOptions = $.extend(
+      true,
+      {
+        allowUserInteraction: true,
+        debug: 'none',
+        events: this.events,
+        height: rootNode.clientHeight,
+        playback: {
+          controls: false,
+          playInline: true,
+          preload: Browser.isiOS ? 'metadata' : 'none',
+          mute: this.config.mute,
+          crossOrigin: 'anonymous', // TODO
+          hlsjsConfig: {
+            debug: this.config.debug === 'all' || this.config.debug === 'hls',
+          },
         },
+        parent: rootNode,
+        width: rootNode.clientWidth,
       },
-      parent: rootNode,
-      width: rootNode.clientWidth,
-    }, this.config, {
-      autoPlay: false,
-      mimeType: source ? source.mimeType : undefined,
-      source: source ? source.source : undefined,
-      sources,
-    })
+      this.config,
+      {
+        autoPlay: false,
+        mimeType: source ? source.mimeType : undefined,
+        source: source ? source.source : undefined,
+        sources,
+      },
+    )
     return coreOptions
   }
 
@@ -496,14 +545,20 @@ export class Player {
         }
       })
     }
-    activeContainer?.on(ClapprEvents.CONTAINER_VOLUME, (volume: number) => {
-      this.safeTriggerEvent(PlayerEvent.VolumeUpdate, volume)
-    }, null)
+    activeContainer?.on(
+      ClapprEvents.CONTAINER_VOLUME,
+      (volume: number) => {
+        this.safeTriggerEvent(PlayerEvent.VolumeUpdate, volume)
+      },
+      null,
+    )
   }
 
   private bindCoreListeners() {
-    const core = this.player?.core
-    core?.on(
+    // TODO create an class inherited from PlayerClappr
+    assert.ok(this.player, 'Player is not initialized')
+    const core = this.player.core
+    core.on(
       ClapprEvents.CORE_SCREEN_ORIENTATION_CHANGED,
       ({ orientation }: { orientation: 'landscape' | 'portrait' }) => {
         trace(`${T} on CORE_SCREEN_ORIENTATION_CHANGED`, {
@@ -522,7 +577,7 @@ export class Player {
       },
       null,
     )
-    core?.on(
+    core.on(
       ClapprEvents.CORE_RESIZE,
       ({ width, height }: { width: number; height: number }) => {
         trace(`${T} on CORE_RESIZE`, {
@@ -533,7 +588,7 @@ export class Player {
       },
       null,
     )
-    core?.on(
+    core.on(
       ClapprEvents.CORE_FULLSCREEN,
       (isFullscreen: boolean) => {
         trace(`${T} CORE_FULLSCREEN`, {

package/src/__tests__/Player.test.ts

@@ -12,7 +12,7 @@ import { Loader, Player as PlayerClappr } from '@clappr/core'
 import EventLite from 'event-lite'
 
 import { Player } from '../Player'
-import { TransportPreference } from '../types'
+import { CorePluginConstructor, TransportPreference } from '../types'
 import { canPlayDash, canPlayHls } from '../playback'
 import { isDashSource, isHlsSource } from '../utils/mediaSources'
 
@@ -167,4 +167,26 @@ describe('Player', () => {
       })
     })
   })
+  describe('registerPlugin', () => {
+    it('should register plugins with respect to dependencies order', () => {
+      class MockMediaControl {
+        get name() {
+          return 'media_control'
+        }
+      }
+      (MockMediaControl as any).type = 'core';
+      class MockMediaControlButtonPlugin {
+        get name() {
+          return 'media_control_button'
+        }
+      }
+      (MockMediaControlButtonPlugin as any).type = 'core'
+      Player.registerPlugin(MockMediaControlButtonPlugin as unknown as CorePluginConstructor)
+      Player.registerPlugin(MockMediaControl as unknown as CorePluginConstructor)
+      const player = new Player({ sources: [] })
+      player.attachTo(document.createElement('div'))
+      expect(Loader.registerPlugin).toHaveBeenNthCalledWith(1, MockMediaControl)
+      expect(Loader.registerPlugin).toHaveBeenNthCalledWith(2, MockMediaControlButtonPlugin)
+    })
+  })
 })

package/src/index.plugins.ts

@@ -8,7 +8,6 @@ export * from "./plugins/clappr-stats/ClapprStats.js";
 export * from "./plugins/click-to-pause/ClickToPause.js";
 export * from "./plugins/clips/Clips.js";
 export * from "./plugins/context-menu/ContextMenu.js";
-export * from "./plugins/disable-controls/DisableControls.js";
 export * from "./plugins/dvr-controls/DvrControls.js";
 export * from "./plugins/error-screen/ErrorScreen.js";
 export * from "./plugins/favicon/Favicon.js";