@gcorevideo/player 2.20.3 → 2.20.4

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/internal.types.ts

@@ -2,22 +2,29 @@ import type {
   CorePlugin,
   ContainerPlugin,
   Playback as ClapprPlayback,
-} from "@clappr/core";
+} from '@clappr/core'
 
-import { ContainerSize, PlaybackType, PlayerDebugTag, PlayerMediaSource } from "./types";
-import { PlaybackError } from "./playback.types.js";
+import {
+  ContainerSize,
+  PlaybackType,
+  PlayerDebugTag,
+  PlayerMediaSource,
+  type CorePluginConstructor,
+  type ContainerPluginConstructor,
+} from './types'
+import { PlaybackError } from './playback.types.js'
 
 type ExternalTrack = {
-  kind?: "subtitles" | "captions";
-  src: string;
-  label: string;
-  lang: string;
+  kind?: 'subtitles' | 'captions'
+  src: string
+  label: string
+  lang: string
 }
 
 type MediacontrolStyles = {
   // TODO
-  seekbar?: string;
-  buttons?: string;
+  seekbar?: string
+  buttons?: string
 }
 
 /**
@@ -25,11 +32,11 @@ type MediacontrolStyles = {
  * @beta
  */
 type HlsjsConfig = {
-  debug?: boolean;
-  startLevel?: number;
-} & Record<string, unknown>;
+  debug?: boolean
+  startLevel?: number
+} & Record<string, unknown>
 
-type ShakaConfig = Record<string, unknown>;
+type ShakaConfig = Record<string, unknown>
 
 /**
  * @see {@link https://github.com/clappr/clappr-core?tab=readme-ov-file#playback-configuration | the Clappr playback settings}
@@ -37,25 +44,25 @@ type ShakaConfig = Record<string, unknown>;
  */
 export interface CorePlaybackConfig {
   // audioOnly: boolean;
-  disableContextMenu?: boolean;
-  controls?: boolean;
-  crossOrigin?: 'anonymous' | 'use-credentials';
+  disableContextMenu?: boolean
+  controls?: boolean
+  crossOrigin?: 'anonymous' | 'use-credentials'
   // enableAutomaticABR?: boolean;
-  externalTracks?: ExternalTrack[];
-  hlsjsConfig?: HlsjsConfig;
+  externalTracks?: ExternalTrack[]
+  hlsjsConfig?: HlsjsConfig
   // initialBandwidthEstimate?: number;
   // maxBufferLength?: number;
   // maxBackBufferLength?: number;
   // minBufferLength?: number;
-  minimumDvrSize?: number; // TODO ?
+  minimumDvrSize?: number // TODO ?
   // maxAdaptiveBitrate?: number;
   // maxAdaptiveVideoDimensions?: unknown; // TODO
-  mute?: boolean;
-  playInline: boolean;
-  preload?: 'metadata' | 'auto' | 'none';
+  mute?: boolean
+  playInline: boolean
+  preload?: 'metadata' | 'auto' | 'none'
   // preferredAudioLanguage?: string;
-  recycleVideo?: boolean;
-  shakaConfiguration?: ShakaConfig;
+  recycleVideo?: boolean
+  shakaConfiguration?: ShakaConfig
 }
 
 /**
@@ -63,34 +70,34 @@ export interface CorePlaybackConfig {
  */
 export type CorePlayerEvents = {
   // TODO event arguments types
-  onReady?: () => void;
-  onResize?: (data: ContainerSize) => void;
-  onPlay?: (metadata: unknown) => void;
-  onPause?: (metadata: unknown) => void;
-  onStop?: (metadata: unknown) => void;
-  onEnded?: () => void;
-  onSeek?: (currentTime: number) => void;
-  onError?: (err: PlaybackError) => void;
-  onTimeUpdate?: (timeProgress: { current: number; total: number }) => void;
-  onVolumeUpdate?: (value: number) => void;
-  onSubtitleAvailable?: () => void;
+  onReady?: () => void
+  onResize?: (data: ContainerSize) => void
+  onPlay?: (metadata: unknown) => void
+  onPause?: (metadata: unknown) => void
+  onStop?: (metadata: unknown) => void
+  onEnded?: () => void
+  onSeek?: (currentTime: number) => void
+  onError?: (err: PlaybackError) => void
+  onTimeUpdate?: (timeProgress: { current: number; total: number }) => void
+  onVolumeUpdate?: (value: number) => void
+  onSubtitleAvailable?: () => void
 }
 
 /**
  * @internal
  */
-export type PlaybackPluginFactory = typeof ClapprPlayback;
+export type PlaybackPluginFactory = typeof ClapprPlayback
 
 /**
  * For the plugin development
  * @internal
  */
 export type CorePluginOptions = {
-  core?: CorePlugin[];
-  container?: ContainerPlugin[];
-  playback?: PlaybackPluginFactory[];
-  loadExternalPluginsFirst?: boolean;
-  loadExternalPlaybacksFirst?: boolean;
+  core?: CorePluginConstructor[]
+  container?: ContainerPluginConstructor[]
+  playback?: PlaybackPluginFactory[]
+  loadExternalPluginsFirst?: boolean
+  loadExternalPlaybacksFirst?: boolean
 }
 
 /**
@@ -98,41 +105,41 @@ export type CorePluginOptions = {
  * @internal
  */
 export type CoreOptions = {
-  actualLiveTime?: boolean;
-  actualLiveServerTime?: string;
-  allowUserInteraction?: boolean;
-  autoPlay?: boolean;
-  autoSeekFromUrl?: boolean;
-  chromeless?: boolean;
-  debug?: PlayerDebugTag | boolean;
-  disableCanAutoPlay?: boolean; // custom, for reconfiguration
-  disableKeyboardShortcuts?: boolean;
-  disableVideoTagContextMenu?: boolean;
-  events?: CorePlayerEvents;
-  exitFullscreenOnEnd?: boolean;
-  gaAccount?: string;
-  gaTrackerName?: string;
-  height?: number;
-  hideMediaControl?: boolean;
-  hideVolumeBar?: boolean;
-  language?: string;
-  loop?: boolean;
-  maxBufferLength?: number;
-  mediacontrol?: MediacontrolStyles;
-  mimeType?: string;
-  mute?: boolean;
-  persistConfig?: boolean;
-  preload?: "auto" | "metadata" | "none";
-  parentId?: string;
-  parent?: HTMLElement;
-  playback?: CorePlaybackConfig;
-  playbackNotSupportedMessage?: string;
-  playbackType?: PlaybackType;
-  plugins?: CorePluginOptions | CorePlugin[];
-  poster?: string;
-  source?: string;
-  sources?: PlayerMediaSource[];
-  watermark?: string;
-  watermarkLink?: string;
-  width?: number;
-}
+  actualLiveTime?: boolean
+  actualLiveServerTime?: string
+  allowUserInteraction?: boolean
+  autoPlay?: boolean
+  autoSeekFromUrl?: boolean
+  chromeless?: boolean
+  debug?: PlayerDebugTag | boolean
+  disableCanAutoPlay?: boolean // custom, for reconfiguration
+  disableKeyboardShortcuts?: boolean
+  disableVideoTagContextMenu?: boolean
+  events?: CorePlayerEvents
+  exitFullscreenOnEnd?: boolean
+  gaAccount?: string
+  gaTrackerName?: string
+  height?: number
+  hideMediaControl?: boolean
+  hideVolumeBar?: boolean
+  language?: string
+  loop?: boolean
+  maxBufferLength?: number
+  mediacontrol?: MediacontrolStyles
+  mimeType?: string
+  mute?: boolean
+  persistConfig?: boolean
+  preload?: 'auto' | 'metadata' | 'none'
+  parentId?: string
+  parent?: HTMLElement
+  playback?: CorePlaybackConfig
+  playbackNotSupportedMessage?: string
+  playbackType?: PlaybackType
+  plugins?: CorePluginOptions | CorePlugin[]
+  poster?: string
+  source?: string
+  sources?: PlayerMediaSource[]
+  watermark?: string
+  watermarkLink?: string
+  width?: number
+}

package/src/plugins/context-menu/ContextMenu.ts

@@ -19,6 +19,10 @@ type MenuOption = {
   name: string
 }
 
+/**
+ * The plugin adds a context menu to the player.
+ * @beta
+ */
 export interface ContextMenuPluginSettings {
   label?: string
   url?: string

package/src/plugins/multi-camera/MultiCamera.ts

@@ -23,10 +23,11 @@ type MediaSourceInfo = {
 
 const VERSION = '0.0.1';
 
-const T = 'plugins.media_control_multicamera';
+const T = 'plugins.multicamera';
 
 /**
  * The plugin adds support for loading multiple streams and switching between them using the media control UI.
+ * @beta
  */
 export class MultiCamera extends UICorePlugin {
   private currentCamera: MediaSourceInfo | null = null;
@@ -40,7 +41,7 @@ export class MultiCamera extends UICorePlugin {
   private noActiveStreams = false;
 
   get name() {
-    return 'media_control_multicamera';
+    return 'multicamera';
   }
 
   get supportedVersion() {

package/src/plugins/seek-time/SeekTime.ts

@@ -19,7 +19,7 @@ const { formatTime } = Utils;
  */
 export class SeekTime extends UICorePlugin {
   get name() {
-    return 'media_control_seek_time';
+    return 'seek_time';
   }
 
   get supportedVersion() {

package/src/plugins/share/Share.ts

@@ -18,7 +18,7 @@ export class Share extends UICorePlugin {
   private container: Container | null = null;
 
   get name() {
-    return 'media_control_share';
+    return 'share';
   }
 
   get supportedVersion() {

package/src/plugins/volume-fade/VolumeFade.ts

@@ -3,6 +3,10 @@ import { reportError } from '@gcorevideo/utils';
 
 import { TimerId } from '../../utils/types.js';
 
+/**
+ * Events emitted by the VolumeFade plugin.
+ * @beta
+ */
 export enum VolumeFadeEvents {
   FADE = 'core:volume:fade',
 }

package/src/types.ts

@@ -57,13 +57,23 @@ export type TransportPreference = MediaTransport
 
 /**
  * @beta
- * @see {@link https://clappr.github.io/classes/UIContainerPlugin.html}, {@link https://clappr.github.io/classes/ContainerPlugin.html}
+ * @see {@link https://clappr.github.io/classes/UIContainerPlugin.html},
+ * {@link https://clappr.github.io/classes/ContainerPlugin.html}
  */
 export type PlayerPlugin = {
   new (...args: any[]): unknown
   name: string
 }
 
+export type PlayerPluginConstructor = CorePluginConstructor | ContainerPluginConstructor
+export type CorePluginConstructor = ((core: unknown) => PlayerPlugin) & {
+  type: 'core'
+}
+
+export type ContainerPluginConstructor = ((container: unknown) => PlayerPlugin) & {
+  type: 'container'
+}
+
 /**
  * Configuration options for the player
  *

package/src/utils/types.ts

@@ -1,6 +1,7 @@
 import { $ } from "@clappr/core";
 
 /**
+ * {@link https://zeptojs.com/#$() | Zepto query result}
  * @beta
  */
 export type ZeptoResult = ReturnType<typeof $>;

package/temp/player.api.json

@@ -1017,7 +1017,7 @@
         {
           "kind": "Interface",
           "canonicalReference": "@gcorevideo/player!ContextMenuPluginSettings:interface",
-          "docComment": "",
+          "docComment": "/**\n * The plugin adds a context menu to the player.\n *\n * @beta\n */\n",
           "excerptTokens": [
             {
               "kind": "Content",
@@ -1025,7 +1025,7 @@
             }
           ],
           "fileUrlPath": "src/plugins/context-menu/ContextMenu.ts",
-          "releaseTag": "Public",
+          "releaseTag": "Beta",
           "name": "ContextMenuPluginSettings",
           "preserveMemberOrder": false,
           "members": [
@@ -1049,7 +1049,7 @@
               ],
               "isReadonly": false,
               "isOptional": true,
-              "releaseTag": "Public",
+              "releaseTag": "Beta",
               "name": "label",
               "propertyTypeTokenRange": {
                 "startIndex": 1,
@@ -1076,7 +1076,7 @@
               ],
               "isReadonly": false,
               "isOptional": true,
-              "releaseTag": "Public",
+              "releaseTag": "Beta",
               "name": "preventShowContextMenu",
               "propertyTypeTokenRange": {
                 "startIndex": 1,
@@ -1103,7 +1103,7 @@
               ],
               "isReadonly": false,
               "isOptional": true,
-              "releaseTag": "Public",
+              "releaseTag": "Beta",
               "name": "url",
               "propertyTypeTokenRange": {
                 "startIndex": 1,
@@ -3471,7 +3471,7 @@
         {
           "kind": "Class",
           "canonicalReference": "@gcorevideo/player!MultiCamera:class",
-          "docComment": "/**\n * The plugin adds support for loading multiple streams and switching between them using the media control UI.\n */\n",
+          "docComment": "/**\n * The plugin adds support for loading multiple streams and switching between them using the media control UI.\n *\n * @beta\n */\n",
           "excerptTokens": [
             {
               "kind": "Content",
@@ -3488,7 +3488,7 @@
             }
           ],
           "fileUrlPath": "src/plugins/multi-camera/MultiCamera.ts",
-          "releaseTag": "Public",
+          "releaseTag": "Beta",
           "isAbstract": false,
           "name": "MultiCamera",
           "preserveMemberOrder": false,
@@ -3512,7 +3512,7 @@
                   "text": ");"
                 }
               ],
-              "releaseTag": "Public",
+              "releaseTag": "Beta",
               "isProtected": false,
               "overloadIndex": 1,
               "parameters": [
@@ -3565,7 +3565,7 @@
                 "startIndex": 5,
                 "endIndex": 6
               },
-              "releaseTag": "Public",
+              "releaseTag": "Beta",
               "isProtected": false,
               "overloadIndex": 1,
               "parameters": [
@@ -3610,7 +3610,7 @@
               ],
               "isReadonly": true,
               "isOptional": false,
-              "releaseTag": "Public",
+              "releaseTag": "Beta",
               "name": "attributes",
               "propertyTypeTokenRange": {
                 "startIndex": 1,
@@ -3643,7 +3643,7 @@
                 "startIndex": 1,
                 "endIndex": 2
               },
-              "releaseTag": "Public",
+              "releaseTag": "Beta",
               "isProtected": false,
               "overloadIndex": 1,
               "parameters": [],
@@ -3671,7 +3671,7 @@
               ],
               "isReadonly": true,
               "isOptional": false,
-              "releaseTag": "Public",
+              "releaseTag": "Beta",
               "name": "events",
               "propertyTypeTokenRange": {
                 "startIndex": 1,
@@ -3709,7 +3709,7 @@
                 "startIndex": 1,
                 "endIndex": 3
               },
-              "releaseTag": "Public",
+              "releaseTag": "Beta",
               "isProtected": false,
               "overloadIndex": 1,
               "parameters": [],
@@ -3745,7 +3745,7 @@
                 "startIndex": 1,
                 "endIndex": 3
               },
-              "releaseTag": "Public",
+              "releaseTag": "Beta",
               "isProtected": false,
               "overloadIndex": 1,
               "parameters": [],
@@ -3773,7 +3773,7 @@
               ],
               "isReadonly": true,
               "isOptional": false,
-              "releaseTag": "Public",
+              "releaseTag": "Beta",
               "name": "name",
               "propertyTypeTokenRange": {
                 "startIndex": 1,
@@ -3806,7 +3806,7 @@
                 "startIndex": 1,
                 "endIndex": 2
               },
-              "releaseTag": "Public",
+              "releaseTag": "Beta",
               "isProtected": false,
               "overloadIndex": 1,
               "parameters": [],
@@ -3834,7 +3834,7 @@
               ],
               "isReadonly": true,
               "isOptional": false,
-              "releaseTag": "Public",
+              "releaseTag": "Beta",
               "name": "supportedVersion",
               "propertyTypeTokenRange": {
                 "startIndex": 1,
@@ -3864,7 +3864,7 @@
               ],
               "isReadonly": true,
               "isOptional": false,
-              "releaseTag": "Public",
+              "releaseTag": "Beta",
               "name": "template",
               "propertyTypeTokenRange": {
                 "startIndex": 1,
@@ -3897,7 +3897,7 @@
                 "startIndex": 1,
                 "endIndex": 2
               },
-              "releaseTag": "Public",
+              "releaseTag": "Beta",
               "isProtected": false,
               "overloadIndex": 1,
               "parameters": [],
@@ -3925,7 +3925,7 @@
               ],
               "isReadonly": true,
               "isOptional": false,
-              "releaseTag": "Public",
+              "releaseTag": "Beta",
               "name": "version",
               "propertyTypeTokenRange": {
                 "startIndex": 1,
@@ -9188,7 +9188,7 @@
         {
           "kind": "Enum",
           "canonicalReference": "@gcorevideo/player!VolumeFadeEvents:enum",
-          "docComment": "",
+          "docComment": "/**\n * Events emitted by the VolumeFade plugin.\n *\n * @beta\n */\n",
           "excerptTokens": [
             {
               "kind": "Content",
@@ -9196,7 +9196,7 @@
             }
           ],
           "fileUrlPath": "src/plugins/volume-fade/VolumeFade.ts",
-          "releaseTag": "Public",
+          "releaseTag": "Beta",
           "name": "VolumeFadeEvents",
           "preserveMemberOrder": false,
           "members": [
@@ -9218,7 +9218,7 @@
                 "startIndex": 1,
                 "endIndex": 2
               },
-              "releaseTag": "Public",
+              "releaseTag": "Beta",
               "name": "FADE"
             }
           ]
@@ -9272,7 +9272,7 @@
         {
           "kind": "TypeAlias",
           "canonicalReference": "@gcorevideo/player!ZeptoResult:type",
-          "docComment": "/**\n * @beta\n */\n",
+          "docComment": "/**\n * {@link https://zeptojs.com/#$() | Zepto query result}\n *\n * @beta\n */\n",
           "excerptTokens": [
             {
               "kind": "Content",