@gcorevideo/player 2.20.9 → 2.20.12

package/src/plugins/telemetry/Telemetry.ts

@@ -103,7 +103,7 @@ export enum TelemetryEvent {
 }
 
 /**
- * PLUGIN that collects and reports the performance statistics.
+ * `PLUGIN` that collects and reports the performance statistics.
  * @beta
  * @remarks
  * This plugin is experimental and its API is likely to change.

package/src/plugins/thumbnails/Thumbnails.ts

@@ -38,7 +38,7 @@ type Thumb = {
 const T = 'plugins.thumbnails'
 
 /**
- * Displays the thumbnails of the video when available.
+ * `PLUGIN` that displays the thumbnails of the video when available.
  * @beta
  * @example
  * ```ts

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

@@ -12,7 +12,7 @@ export enum VolumeFadeEvents {
 }
 
 /**
- * Applies fade effect to the player's volume change.
+ * `PLUGIN` that applies fade effect to the player's volume change.
  * @beta
  */
 export class VolumeFade extends UICorePlugin {

package/src/testUtils.ts

@@ -82,7 +82,10 @@ export class _MockPlayback extends Events {
   }
 }
 
-export function createMockCore(options: Record<string, unknown> = {}, container: any = createMockContainer()) {
+export function createMockCore(
+  options: Record<string, unknown> = {},
+  container: any = createMockContainer(),
+) {
   const el = document.createElement('div')
   const emitter = new Events()
   return Object.assign(emitter, {
@@ -90,10 +93,14 @@ export function createMockCore(options: Record<string, unknown> = {}, container:
     $el: $(el),
     activePlayback: container.playback,
     activeContainer: container,
+    i18n: {
+      t: vi.fn().mockImplementation((key: string) => key),
+    },
     options: {
       ...options,
     },
     configure: vi.fn(),
+    getPlaybackType: vi.fn(),
     getPlugin: vi.fn(),
     load: vi.fn(),
     trigger: emitter.emit,
@@ -165,20 +172,37 @@ export function createMockPlayback(name = 'mock') {
 
 export function createMockContainer(playback: any = createMockPlayback()) {
   const el = document.createElement('div')
-  return Object.assign(new Events(), {
-    $el: $(el),
+  const emitter = new Events()
+  return Object.assign(emitter, {
     el,
-    getPlugin: vi.fn(),
     playback,
+    $el: $(el),
+    getDuration: vi.fn().mockReturnValue(0),
+    getPlugin: vi.fn(),
+    isPlaying: vi.fn().mockReturnValue(false),
+    play: vi.fn(),
+    seek: vi.fn(),
+    trigger: emitter.emit,
   })
 }
 
 export function createMockMediaControl(core: any) {
   const mediaControl = new UICorePlugin(core)
+  mediaControl.$el.html(
+    `<div class="media-control-left-panel" data-media-control></div>
+    <div class="media-control-right-panel" data-media-control></div>
+    <div class="media-control-center-panel" data-media-control></div>`,
+  )
   const elements = {
     gear: $(document.createElement('div')),
   }
   // @ts-ignore
   mediaControl.getElement = vi.fn().mockImplementation((name) => elements[name])
+  // @ts-ignore
+  mediaControl.getLeftPanel = vi.fn().mockImplementation(() => mediaControl.$el.find('.media-control-left-panel'))
+  // @ts-ignore
+  mediaControl.getRightPanel = vi.fn().mockImplementation(() => mediaControl.$el.find('.media-control-right-panel'))
+  // @ts-ignore
+  mediaControl.getCenterPanel = vi.fn().mockImplementation(() => mediaControl.$el.find('.media-control-center-panel'))
   return mediaControl
 }

package/src/types.ts

@@ -6,7 +6,7 @@ import { $, Container, Core } from "@clappr/core";
  * @remarks
  * When the MIME type is provided, it helps the player determine the appropriate playback engine.
  * If omitted, the player will attempt to detect the type from the source URL extension.
- * @beta
+ * @public
  */
 export interface PlayerMediaSourceDesc {
   /**
@@ -23,42 +23,36 @@ export interface PlayerMediaSourceDesc {
 
 /**
  * A media source to fetch the media data from
- * @beta
+ * @public
  */
 export type PlayerMediaSource = string | PlayerMediaSourceDesc
 
 /**
  * Debug output category selector
- * @beta
+ * @public
  */
 export type PlayerDebugTag = 'all' | 'clappr' | 'dash' | 'hls' | 'none'
 
 /**
  * @remarks `true` is equivalent to `'all'`, `false` is equivalent to `'none'`
- * @beta
+ * @public
  */
 export type PlayerDebugSettings = PlayerDebugTag | boolean
 
 /**
- * Type of a stream playback
- * @beta
+ * Type of a stream
+ * @public
  */
 export type PlaybackType = 'live' | 'vod'
 
 /**
- * Media delivery protocol
- * @beta
+ * Preferred streaming media delivery protocol
+ * @public
  */
-export type MediaTransport = 'dash' | 'hls'
+export type TransportPreference = 'dash' | 'hls'
 
 /**
- * Preferred media delivery protocol
- * @beta
- */
-export type TransportPreference = MediaTransport
-
-/**
- * @beta
+ * @public
  * @see {@link https://clappr.github.io/classes/UIContainerPlugin.html},
  * {@link https://clappr.github.io/classes/ContainerPlugin.html}
  */
@@ -67,12 +61,12 @@ export type PlayerPlugin = {
 }
 
 /**
- * @beta
+ * @public
  */
 export type PlayerPluginConstructor = CorePluginConstructor | ContainerPluginConstructor
 
 /**
- * @beta
+ * @public
  */
 export type CorePluginConstructor = {
   new (core: Core): PlayerPlugin
@@ -80,7 +74,7 @@ export type CorePluginConstructor = {
 }
 
 /**
- * @beta
+ * @public
  */
 export type ContainerPluginConstructor = {
   new (container: Container): PlayerPlugin
@@ -126,7 +120,7 @@ export type ContainerPluginConstructor = {
  *   },
  * }
  * ```
- * @beta
+ * @public
  */
 export interface PlayerConfig extends Record<string, unknown> {
   /**
@@ -194,18 +188,18 @@ export interface PlayerConfig extends Record<string, unknown> {
 /**
  * An ISO 639-1 language code.
  * @example `pt`
- * @beta
+ * @public
  */
 export type LangTag = string
 
 /**
- * @beta
+ * @public
  */
 export type TranslationKey = string
 
 /**
  * A plain JS object that must conform to the DASH.js settings schema.
- * @beta
+ * @public
  * {@link https://cdn.dashjs.org/latest/jsdoc/module-Settings.html | DASH.js settings}
  */
 export type DashSettings = Record<string, unknown>
@@ -232,7 +226,7 @@ export type DashSettings = Record<string, unknown>
  * }
  * ```
  *
- * @beta
+ * @public
  */
 export type TranslationSettings = Partial<
   Record<LangTag, Record<TranslationKey, string>>
@@ -240,7 +234,7 @@ export type TranslationSettings = Partial<
 
 /**
  * Dimensions of the player container DOM element.
- * @beta
+ * @public
  */
 export type ContainerSize = {
   width: number
@@ -249,7 +243,7 @@ export type ContainerSize = {
 
 /**
  * A top-level event on the player object
- * @beta
+ * @public
  */
 export enum PlayerEvent {
   /**