@gcorevideo/player 2.20.8 → 2.20.9

package/src/plugins/dvr-controls/DvrControls.ts

@@ -10,7 +10,8 @@ import { trace } from '@gcorevideo/utils'
 const T = 'plugins.dvr_controls'
 
 /**
- * Adds the DVR controls to the media control UI
+ * PLUGIN that adds the DVR controls to the media control UI
+ *
  * @beta
  *
  * @remarks
@@ -18,7 +19,7 @@ const T = 'plugins.dvr_controls'
  *
  * - {@link MediaControl}
  *
- * The plugin renders the live stream indicator and the DVR seek bar, if DVR is enabled, in the media control UI.
+ * The plugin renders live stream indicator and the DVR seek bar, if DVR is enabled, in the media control UI.
  */
 export class DvrControls extends UICorePlugin {
   private static readonly template = template(dvrHTML)

package/src/plugins/error-screen/ErrorScreen.ts

@@ -8,6 +8,10 @@ import templateHtml from '../../../assets/error-screen/error_screen.ejs'
 import '../../../assets/error-screen/error_screen.scss'
 import { PlaybackErrorCode } from '../../playback.types.js'
 
+/**
+ * An error fired in the player and plugins code to be handled in the UI
+ * @beta
+ */
 export type ErrorDesc = {
   description: string
   level: string
@@ -29,14 +33,21 @@ type ErrorScreenDesc = {
   icon?: string
 }
 
+/**
+ * Configuration options for the {@link ErrorScreen | error screen} plugin.
+ * @beta
+ */
 export type ErrorScreenPluginSettings = {
+  /**
+   * Whether to hide the reload button.
+   */
   noReload?: boolean
 }
 
 const T = 'plugins.error_screen'
 
 /**
- * Displays an error nicely in the overlay on top of the player.
+ * PLUGIN that displays errors nicely in the overlay on top of the player.
  * @beta
  */
 export class ErrorScreen extends UICorePlugin {

package/src/plugins/favicon/Favicon.ts

@@ -1,7 +1,7 @@
 import { CorePlugin, Events, $, Core, Container } from '@clappr/core';
 
 import { CLAPPR_VERSION } from '../../build.js';
-import { ZeptoResult } from '../../utils/types.js';
+import { ZeptoResult } from '../../types.js';
 
 import playIcon from '../../../assets/icons/new/play.svg';
 import pauseIcon from '../../../assets/icons/new/pause.svg';

package/src/plugins/index.ts

@@ -19,7 +19,6 @@ export * from "./error-screen/ErrorScreen.js";
 export * from "./favicon/Favicon.js";
 // _ ga-events
 export * from "./google-analytics/GoogleAnalytics.js";
-export * from "./kibo/index.js";
 export * from "./level-selector/LevelSelector.js";
 export * from "./logo/Logo.js";
 export * from "./media-control/MediaControl.js";

package/src/plugins/kibo/index.ts

@@ -11,9 +11,6 @@ type KeyboardEventBindings = {
 
 type UpDown = 'up' | 'down';
 
-/**
- * @internal
- */
 export class Kibo {
   private lastKeyCode = -1;
 

package/src/plugins/level-selector/LevelSelector.ts

@@ -4,7 +4,7 @@ import assert from 'assert'
 
 import { type QualityLevel } from '../../playback.types.js'
 import { CLAPPR_VERSION } from '../../build.js'
-import { ZeptoResult } from '../../utils/types.js'
+import { ZeptoResult } from '../../types.js'
 import { TemplateFunction } from '../types.js'
 import { BottomGear } from '../bottom-gear/BottomGear.js'
 
@@ -20,6 +20,10 @@ import { MediaControl, MediaControlEvents } from '../media-control/MediaControl.
 const T = 'plugins.level_selector'
 const VERSION = '2.19.4'
 
+/**
+ * Configuration options for the {@link LevelSelector | level selector} plugin.
+ * @beta
+ */
 export interface LevelSelectorPluginSettings {
   /**
    * The maximum resolution to allow in the level selector.
@@ -36,7 +40,7 @@ export interface LevelSelectorPluginSettings {
 }
 
 /**
- * A {@link MediaControl | media control} plugin that provides a UI to control the quality level of the playback.
+ * PLUGIN that provides a UI to select the desired quality level of the playback.
  * @beta
  *
  * @remarks
@@ -46,9 +50,7 @@ export interface LevelSelectorPluginSettings {
  *
  * - {@link BottomGear}
  *
- * The plugin is rendered as an item in the gear menu.
- *
- * When clicked, it shows a list of quality levels to choose from.
+ * The plugin is rendered as an item in the gear menu, which, when clicked, shows a list of quality levels to choose from.
  *
  * Configuration options - {@link LevelSelectorPluginSettings}
  *

package/src/plugins/logo/Logo.ts

@@ -2,7 +2,7 @@ import { UIContainerPlugin, Events, template as t, Container } from '@clappr/cor
 
 import { CLAPPR_VERSION } from '../../build.js';
 import { calculateSize } from './utils/index.js';
-import { ZeptoResult } from '../../utils/types.js';
+import { ZeptoResult } from '../../types.js';
 
 import logoHTML from '../../../assets/logo/templates/logo.ejs';
 import '../../../assets/logo/styles/logo.scss';

package/src/plugins/media-control/MediaControl.ts

@@ -20,7 +20,7 @@ import { type TimeProgress } from '../../playback.types.js'
 import { Kibo } from '../kibo/index.js'
 
 import { CLAPPR_VERSION } from '../../build.js'
-import { ZeptoResult } from '../../utils/types.js'
+import { ZeptoResult } from '../../types.js'
 import { getPageX, isFullscreen } from '../utils.js'
 
 import '../../../assets/media-control/media-control.scss'
@@ -88,7 +88,7 @@ type DisabledClickable = {
 }
 
 /**
- * The MediaControl provides a foundation for developing custom media controls UI.
+ * PLUGIN that provides a foundation for developing custom media controls UI.
  * @beta
  * @remarks
  * The methods exposed are to be used by the other plugins that extend the media control UI.
@@ -218,7 +218,7 @@ export class MediaControl extends UICorePlugin {
 
   /**
    * @internal
-   * @deprecated
+   * @deprecated Use core.activeContainer directly
    */
   get container() {
     return this.core.activeContainer
@@ -226,7 +226,7 @@ export class MediaControl extends UICorePlugin {
 
   /**
    * @internal
-   * @deprecated
+   * @deprecated Use core.activePlayback directly
    */
   get playback() {
     return this.core.activePlayback

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

@@ -9,7 +9,7 @@ import '../../../assets/multi-camera/style.scss';
 import streamsIcon from '../../../assets/icons/old/streams.svg';
 import streamsMomentoIcon from '../../../assets/icons/old/language.svg';
 import streamsWhiteNightsIcon from '../../../assets/icons/old/wn.svg';
-import { ZeptoResult } from '../../utils/types.js';
+import { ZeptoResult } from '../../types.js';
 
 type MultisourcesMode = 'one_first' | 'only_live' | 'show_all';
 
@@ -26,7 +26,7 @@ const VERSION = '0.0.1';
 const T = 'plugins.multicamera';
 
 /**
- * The plugin adds support for loading multiple streams and switching between them using the media control UI.
+ * PLUGIN that adds support for loading multiple streams and switching between them using the media control UI.
  * @beta
  */
 export class MultiCamera extends UICorePlugin {
@@ -381,11 +381,11 @@ export class MultiCamera extends UICorePlugin {
     this.toggleContextMenu();
   }
 
-  getCamerasList() {
+  private getCamerasList() {
     return this.multicamera;
   }
 
-  getCurrentCamera() {
+  private getCurrentCamera() {
     return this.currentCamera;
   }
 

package/src/plugins/playback-rate/PlaybackRate.ts

@@ -3,7 +3,7 @@ import { trace } from '@gcorevideo/utils';
 import assert from 'assert';
 
 import { CLAPPR_VERSION } from '../../build.js';
-import type { ZeptoResult } from '../../utils/types.js';
+import type { ZeptoResult } from '../../types.js';
 
 import buttonHtml from '../../../assets/playback-rate/button.ejs';
 import listHtml from '../../../assets/playback-rate/list.ejs';

package/src/plugins/poster/Poster.ts

@@ -14,14 +14,14 @@ import {
 import { trace } from '@gcorevideo/utils'
 
 import { CLAPPR_VERSION } from '../../build.js'
-import type { ZeptoResult } from '../../utils/types.js'
+import type { ZeptoResult } from '../../types.js'
 
 import '../../../assets/poster/poster.scss'
 import posterHTML from '../../../assets/poster/poster.ejs'
 import playIcon from '../../../assets/icons/new/play.svg'
 import { PlaybackError } from '../../playback.types.js'
 
-const T = 'plugins.poster_custom'
+const T = 'plugins.poster'
 
 /**
  * Displays a poster image in the background and a big play button on top when playback is stopped
@@ -65,7 +65,7 @@ export class Poster extends UIContainerPlugin {
    * @internal
    */
   get name() {
-    return 'poster_custom'
+    return 'poster'
   }
 
   /**

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

@@ -9,7 +9,7 @@ import { CLAPPR_VERSION } from '../../build.js';
 
 import seekTimeHTML from '../../../assets/seek-time/seek-time.html';
 import '../../../assets/seek-time/seek-time.scss';
-import { ZeptoResult } from '../../utils/types.js';
+import { ZeptoResult } from '../../types.js';
 
 const { formatTime } = Utils;
 

package/src/plugins/share/Share.ts

@@ -10,7 +10,8 @@ import fbIcon from '../../../assets/icons/old/fb.svg';
 import twIcon from '../../../assets/icons/old/twitter.svg';
 
 /**
- * The plugin adds a share button to the media control UI.
+ * PLUGIN that adds a share button to the media control UI.
+ * @beta
  */
 export class Share extends UICorePlugin {
   private hide = false;

package/src/plugins/skip-time/SkipTime.ts

@@ -8,7 +8,8 @@ import '../../../assets/skip-time/style.scss';
 type Position = 'mid' | 'left' | 'right';
 
 /**
- * The plugin adds skip controls to the media control UI.
+ * PLUGIN that adds skip controls to the media control UI.
+ * @beta
  */
 export class SkipTime extends UICorePluginOriginal {
   get name() {

package/src/plugins/source-controller/SourceController.ts

@@ -153,7 +153,7 @@ export class SourceController extends CorePlugin {
     }
     this.bindContainerEventListeners()
     if (this.active) {
-      this.core.activeContainer?.getPlugin('poster_custom')?.disable()
+      this.core.activeContainer?.getPlugin('poster')?.disable()
       spinner?.show(0)
     }
   }
@@ -177,7 +177,7 @@ export class SourceController extends CorePlugin {
         }
         switch (error.code) {
           case PlaybackErrorCode.MediaSourceUnavailable:
-            this.core.activeContainer?.getPlugin('poster_custom')?.disable()
+            this.core.activeContainer?.getPlugin('poster')?.disable()
             this.retryPlayback()
             break
           default:
@@ -192,7 +192,7 @@ export class SourceController extends CorePlugin {
       })
       if (this.active) {
         this.reset()
-        this.core.activeContainer?.getPlugin('poster_custom')?.enable()
+        this.core.activeContainer?.getPlugin('poster')?.enable()
         this.core.activeContainer?.getPlugin('spinner')?.hide()
       }
     })

package/src/plugins/source-controller/__tests__/SourceController.test.ts

@@ -116,7 +116,7 @@ describe('SourceController', () => {
           poster = createMockPlugin()
           spinner = createSpinnerPlugin()
           core.activeContainer.getPlugin.mockImplementation((name: string) => {
-            if (name === 'poster_custom') {
+            if (name === 'poster') {
               return poster
             }
             if (name === 'spinner') {
@@ -183,7 +183,7 @@ describe('SourceController', () => {
         poster = createMockPlugin()
         spinner = createSpinnerPlugin()
         core.activeContainer.getPlugin.mockImplementation((name: string) => {
-          if (name === 'poster_custom') {
+          if (name === 'poster') {
             return poster
           }
           if (name === 'spinner') {

package/src/plugins/spinner-three-bounce/SpinnerThreeBounce.ts

@@ -20,6 +20,7 @@ const T = 'plugins.spinner'
 
 /**
  * Custom events emitted by the plugin
+ * @beta
  */
 export enum SpinnerEvents {
   /**
@@ -30,10 +31,12 @@ export enum SpinnerEvents {
 }
 
 /**
- * Shows a pending operation indicator when playback is buffering or in other appropriate cases
+ * PLUGIN that shows a pending operation indicator when playback is buffering or in a similar state
  * @beta
  * @remarks
- * The plugin emits
+ * Events emitted- {@link SpinnerEvents}
+ * Other plugins can use {@link SpinnerThreeBounce.show | show} and {@link SpinnerThreeBounce.hide | hide} methods to
+ * implement custom pending/progress indication scenarios.
  */
 export class SpinnerThreeBounce extends UIContainerPlugin {
   private userShown = false
@@ -134,7 +137,7 @@ export class SpinnerThreeBounce extends UIContainerPlugin {
   /**
    * Shows the spinner.
    *
-   * When called, the spinner will not hide (due to its built-in logic) until {@link SpinnerThreeBounce#hide} is called
+   * When called, the spinner will not hide (due to its built-in logic) until {@link SpinnerThreeBounce.hide} is called
    */
   show(delay = 300) {
     trace(`${T} show`)

package/src/plugins/subtitles/Subtitles.ts

@@ -17,7 +17,7 @@ import comboboxHTML from '../../../assets/subtitles/combobox.ejs'
 import stringHTML from '../../../assets/subtitles/string.ejs'
 
 import { isFullscreen } from '../utils.js'
-import type { ZeptoResult } from '../../utils/types.js'
+import type { ZeptoResult } from '../../types.js'
 
 const VERSION: string = '2.19.14'
 

package/src/plugins/telemetry/Telemetry.ts

@@ -77,7 +77,7 @@ export type TelemetryRecord = {
  * @param data - The telemetry record to send.
  * @beta
  */
-type TelemetrySendFn = (data: TelemetryRecord) => void
+export type TelemetrySendFn = (data: TelemetryRecord) => void
 
 /**
  * Plugin settings
@@ -103,7 +103,7 @@ export enum TelemetryEvent {
 }
 
 /**
- * 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

@@ -8,7 +8,7 @@ import { CLAPPR_VERSION } from '../../build.js'
 
 import pluginHtml from '../../../assets/thumbnails/scrub-thumbnails.ejs'
 import '../../../assets/thumbnails/style.scss'
-import { ZeptoResult } from '../../utils/types.js'
+import { ZeptoResult } from '../../types.js'
 import { getPageX } from '../utils.js'
 
 /**

package/src/plugins/vast-ads/VastAds.ts

@@ -16,7 +16,8 @@ import assert from 'assert'
 import { TimePosition } from '../../playback.types.js'
 
 import { CLAPPR_VERSION } from '../../build.js'
-import { TimerId, ZeptoResult } from '../../utils/types.js'
+import { ZeptoResult } from '../../types.js'
+import { TimerId } from '../../utils/types.js'
 import RollManager from './rollmanager.js'
 import SCTEManager from './sctemanager.js'
 import { VolumeFadeEvents } from '../volume-fade/VolumeFade.js'
@@ -286,7 +287,7 @@ export class VastAds extends UICorePlugin {
 
   private onPlaybackPlay() {
     setTimeout(() => {
-      const posterPlugin = this.container?.getPlugin('poster_custom')
+      const posterPlugin = this.container?.getPlugin('poster')
 
       posterPlugin?.enable()
       posterPlugin?.$el.hide()
@@ -618,7 +619,7 @@ export class VastAds extends UICorePlugin {
       this._pluginError('failed to get Clappr playback')
     }
     // Attempt to get poster plugin. (May interfere with media control)
-    this._posterPlugin = this._container?.getPlugin('poster_custom')
+    this._posterPlugin = this._container?.getPlugin('poster')
 
     // Attempt to get click-to-pause plugin. (May interfere with advert click handling)
     this._clickToPausePlugin = this._container?.getPlugin(
@@ -721,7 +722,7 @@ export class VastAds extends UICorePlugin {
 
   private adsPlaying() {
     assert(this.container, 'container is not defined')
-    const poster = this.container.getPlugin('poster_custom')
+    const poster = this.container.getPlugin('poster')
 
     poster && poster.disable()
     try {

package/src/plugins/vast-ads/roll.ts

@@ -3,7 +3,8 @@ import { $, Container, Core, Events, Log, Playback } from '@clappr/core';
 import { reportError } from '@gcorevideo/utils';
 import assert from 'assert';
 
-import type { TimerId, ZeptoResult } from '../../utils/types.js';
+import type { ZeptoResult } from '../../types.js';
+import type { TimerId } from '../../utils/types.js';
 
 type RollConstructorOptions = {
   core: Core;

package/src/plugins/vast-ads/rollmanager.ts

@@ -4,7 +4,7 @@ import assert from 'assert';
 
 import LoaderXML from './loaderxml.js';
 import Roll from './roll.js';
-import { ZeptoResult } from '../../utils/types.js';
+import { ZeptoResult } from '../../types.js';
 import { AdRollDesc, AdRollItem, AdRollType, VastAdsOptions } from './types.js';
 
 type CoreOptions = Record<string, unknown>;
@@ -71,7 +71,7 @@ export default class RollManager extends Events {
     this.$areaClick = $areaClick;
     this._playback = this.core.activePlayback;
     this._contentElement = this._playback.el as HTMLMediaElement;
-    this._posterPlugin = this._container.getPlugin('poster_custom');
+    this._posterPlugin = this._container.getPlugin('poster');
     this._clickToPausePlugin = this._container.getPlugin('click_to_pause_custom');
     this._adContainer = _adContainer;
     this._events = {};
@@ -210,7 +210,7 @@ export default class RollManager extends Events {
     //чтобы реклама шла одна за другой
     this._allURLRequest = !!roll.oneByOne;
     try {
-      const customPosterPlugin = this.container.getPlugin('poster_custom');
+      const customPosterPlugin = this.container.getPlugin('poster');
 
       customPosterPlugin.hidePlayButton();
     } catch (error) {

package/src/types.ts

@@ -1,3 +1,5 @@
+import { $, Container, Core } from "@clappr/core";
+
 /**
  * Describes a media source with its MIME type and URL.
  *
@@ -61,17 +63,28 @@ export type TransportPreference = MediaTransport
  * {@link https://clappr.github.io/classes/ContainerPlugin.html}
  */
 export type PlayerPlugin = {
-  new (...args: any[]): unknown
   name: string
 }
 
+/**
+ * @beta
+ */
 export type PlayerPluginConstructor = CorePluginConstructor | ContainerPluginConstructor
-export type CorePluginConstructor = ((core: unknown) => PlayerPlugin) & {
-  type: 'core'
+
+/**
+ * @beta
+ */
+export type CorePluginConstructor = {
+  new (core: Core): PlayerPlugin
+  type: string // 'core', but it's a nuisance to type it in the plugins definition
 }
 
-export type ContainerPluginConstructor = ((container: unknown) => PlayerPlugin) & {
-  type: 'container'
+/**
+ * @beta
+ */
+export type ContainerPluginConstructor = {
+  new (container: Container): PlayerPlugin
+  type: string // 'container', but it's a nuisance to type it in the plugins definition
 }
 
 /**
@@ -289,3 +302,9 @@ export enum PlayerEvent {
    */
   VolumeUpdate = 'volumeupdate',
 }
+
+/**
+ * {@link https://zeptojs.com/#$() | Zepto query result}
+ * @beta
+ */
+export type ZeptoResult = ReturnType<typeof $>;

package/src/utils/types.ts

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