@flowplayer/spins 0.1.0-rc.8 → 0.2.0

package/dist/types.d.ts

@@ -3,7 +3,6 @@ import { PlayerIMAConfig } from '@flowplayer/player/plugins/ads';
 import { ConsentConfig } from '@flowplayer/player/plugins/consent';
 import { ShareConfig } from '@flowplayer/player/plugins/share';
 import { SubtitlesConfig } from '@flowplayer/player/plugins/subtitles';
-import { ThumbnailsConfig } from '@flowplayer/player/plugins/thumbnails';
 
 /**
  * Emitted when a new spin is created.
@@ -13,10 +12,6 @@ declare const SPIN_CREATED = "spin:created";
  * Emitted when a different spin enters the viewport.
  */
 declare const SPIN_IN_VIEWPORT = "spin:viewport";
-/**
- * Should be emitted in order to add more spins dynamically.
- */
-declare const ADD_SPINS = "spins:add";
 
 /**
  * All supported plugin identifiers for configuring the player.
@@ -24,20 +19,61 @@ declare const ADD_SPINS = "spins:add";
 declare const PlayerPlugins: readonly ["subtitles", "vtsel", "ads", "share", "thumbnails", "asel", "qsel"];
 
 interface SpinsConfig {
+    /**
+     * The playlist value should either be a composite media ID with a playlist ID,
+     * or an array of SpinItem.
+     *
+     * @see https://developer.wowza.com/docs/wowza-flowplayer/plugins/wowza-video-platform-integration/#add-composite-media-ids
+     * @see {@link SpinItem}
+     */
     playlist: string | Array<SpinItem>;
+    /**
+     * Sets the language of your preference.
+     * @default english
+     * @see https://developer.wowza.com/docs/wowza-flowplayer/player/translations/#configure-translations
+     */
     lang?: Config["lang"];
+    /**
+     * Your token.
+     * @see https://developer.wowza.com/docs/wowza-flowplayer/player/configure/#token-configuration
+     */
     token?: Config["token"];
+    /**
+     * User interface configuration
+     * @see https://developer.wowza.com/docs/wowza-flowplayer/player/configure/#user-interface-configuration
+     */
     ui?: Config["ui"];
+    /**
+     * Ads configuration
+     * @see https://developer.wowza.com/docs/wowza-flowplayer/plugins/advertising/#ima-object-configuration
+     */
     ima?: PlayerIMAConfig;
+    /**
+     * Configuration for Share plugin
+     * @see https://developer.wowza.com/docs/wowza-flowplayer/plugins/sharing/
+     */
     share?: ShareConfig["share"];
+    /**
+     * Consent plugin configuration. A bitmask property where the possible values can be found from `Consent.tracking` and `Consent.storage` enumerations.
+     * @see https://developer.wowza.com/docs/wowza-flowplayer/plugins/consent/
+     */
     consent?: ConsentConfig["consent"];
     /**
      * A list of plugins to configure the player.
      * @default ["subtitles", "vtsel", "ads", "share", "thumbnails", "asel"]
+     * @see https://developer.wowza.com/docs/wowza-flowplayer/plugins/about-plugins/#plugin-descriptions
      */
     plugins?: (typeof PlayerPlugins)[number][];
 }
+/**
+ * Describes an individual item used in a Spin playlist.
+ * @see {@link SpinsConfig.playlist}
+ */
 interface SpinItem {
+    /**
+     * The value should either be a media ID
+     * or a [Video source](https://developer.wowza.com/docs/wowza-flowplayer/player/configure#video-source)
+     */
     url: string | {
         src: string;
         type: string;
@@ -45,15 +81,27 @@ interface SpinItem {
     title?: Config["title"];
     poster?: Config["poster"];
     description?: Config["description"];
+    /**
+     * Subtitles plugin configuration. Requires Subtitles plugin to be attached.
+     * @see https://developer.wowza.com/docs/wowza-flowplayer/plugins/html-subtitles/#configure-the-plugin
+     */
     subtitles?: SubtitlesConfig["subtitles"];
-    thumbnails?: ThumbnailsConfig["thumbnails"];
 }
 type SpinEventData = {
+    /**
+     * The SpinItem associated with the spin.
+     */
     config: SpinItem;
+    /**
+     * The spin container element
+     */
     spin: HTMLElement;
+    /**
+     * the index of the spin
+     */
+    index: number;
 };
-type AddSpinsEventData = SpinItem[];
-interface SpinsContainer extends HTMLDivElement {
+interface SpinsContainer extends HTMLElement {
     /**
      * Adds a listener for the SpinsEvents["SPIN_CREATED"] event
      */
@@ -65,25 +113,20 @@ interface SpinsContainer extends HTMLDivElement {
     /**
      * Removes a listener for the SpinsEvents["SPIN_IN_VIEWPORT"] event
      */
-    off(e: typeof SPIN_IN_VIEWPORT, handler: (e: CustomEvent<SpinEventData>) => void): void;
+    off(e: typeof SPIN_IN_VIEWPORT, handler: (e?: CustomEvent<SpinEventData>) => void): void;
     /**
      * Removes a listener for the SpinsEvents["SPIN_CREATED"] event
      */
-    off(e: typeof SPIN_CREATED, handler: (e: CustomEvent<SpinEventData>) => void): void;
-    /**
-     * Triggers dynamic addition of new spins
-     */
-    emit(e: typeof ADD_SPINS, data: AddSpinsEventData): void;
+    off(e: typeof SPIN_CREATED, handler: (e?: CustomEvent<SpinEventData>) => void): void;
     /**
-     * All the spins events.
+     * Add more spins dynamically.
      */
-    events: typeof events;
+    addSpins(spins: SpinItem[]): void;
 }
 declare const events: {
     SPIN_IN_VIEWPORT: typeof SPIN_IN_VIEWPORT;
     SPIN_CREATED: typeof SPIN_CREATED;
-    ADD_SPINS: typeof ADD_SPINS;
 };
 declare function createSpins(config: SpinsConfig): SpinsContainer;
 
-export { type AddSpinsEventData, type SpinEventData, type SpinItem, type SpinsConfig, type SpinsContainer, createSpins, events };
+export { type SpinEventData, type SpinItem, type SpinsConfig, type SpinsContainer, createSpins, events };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@flowplayer/spins",
   "module": "dist/index.js",
-  "version": "0.1.0-rc.8",
+  "version": "0.2.0",
   "type": "module",
   "types": "./dist/types.d.ts",
   "exports": {