Merge pull request #283 from bitmovin/fix-api-docs-problems

Fix API docs problems

src/components/PlayerView/index.tsx

@@ -83,6 +83,8 @@ function dispatch(command: string, node: NodeHandle, ...args: any[]) {
 /**
  * Component that provides the Bitmovin Player UI and default UI handling to an attached `Player` instance.
  * This component needs a `Player` instance to work properly so make sure one is passed to it as a prop.
+ *
+ * @param options configuration options
  */
 export function PlayerView({
   style,

src/index.ts

@@ -15,3 +15,6 @@ export * from './offline';
 export * from './thumbnail';
 export * from './remoteControlConfig';
 export * from './bitmovinCastManager';
+export * from './audioTrack';
+export * from './media';
+export * from './tweaksConfig';

src/offline/offlineContentManager.ts

@@ -8,8 +8,8 @@ import NativeInstance from '../nativeInstance';
 import { SourceConfig } from '../source';
 import {
   BitmovinNativeOfflineEventData,
-  handleBitmovinNativeOfflineEvent,
   OfflineContentManagerListener,
+  OfflineEventType,
 } from './offlineContentManagerListener';
 import { OfflineContentConfig } from './offlineContentConfig';
 import { OfflineDownloadRequest } from './offlineDownloadRequest';
@@ -39,6 +39,35 @@ interface NativeOfflineModule extends NativeModule {
 const OfflineModule =
   NativeModules.BitmovinOfflineModule as NativeOfflineModule;
 
+const handleBitmovinNativeOfflineEvent = (
+  data: BitmovinNativeOfflineEventData,
+  listeners: Set<OfflineContentManagerListener>
+) => {
+  listeners.forEach((listener) => {
+    if (!listener) return;
+
+    if (data.eventType === OfflineEventType.onCompleted) {
+      listener.onCompleted?.(data);
+    } else if (data.eventType === OfflineEventType.onError) {
+      listener.onError?.(data);
+    } else if (data.eventType === OfflineEventType.onProgress) {
+      listener.onProgress?.(data);
+    } else if (data.eventType === OfflineEventType.onOptionsAvailable) {
+      listener.onOptionsAvailable?.(data);
+    } else if (data.eventType === OfflineEventType.onDrmLicenseUpdated) {
+      listener.onDrmLicenseUpdated?.(data);
+    } else if (data.eventType === OfflineEventType.onDrmLicenseExpired) {
+      listener.onDrmLicenseExpired?.(data);
+    } else if (data.eventType === OfflineEventType.onSuspended) {
+      listener.onSuspended?.(data);
+    } else if (data.eventType === OfflineEventType.onResumed) {
+      listener.onResumed?.(data);
+    } else if (data.eventType === OfflineEventType.onCanceled) {
+      listener.onCanceled?.(data);
+    }
+  });
+};
+
 /**
  * Provides the means to download and store sources locally that can be played back with a Player
  * without an active network connection. An OfflineContentManager instance can be created via

src/offline/offlineContentManagerListener.ts

@@ -156,32 +156,3 @@ export interface OfflineContentManagerListener {
   onResumed?: (e: OnResumedEvent) => void;
   onCanceled?: (e: OnCanceledEvent) => void;
 }
-
-export const handleBitmovinNativeOfflineEvent = (
-  data: BitmovinNativeOfflineEventData,
-  listeners: Set<OfflineContentManagerListener>
-) => {
-  listeners.forEach((listener) => {
-    if (!listener) return;
-
-    if (data.eventType === OfflineEventType.onCompleted) {
-      listener.onCompleted?.(data);
-    } else if (data.eventType === OfflineEventType.onError) {
-      listener.onError?.(data);
-    } else if (data.eventType === OfflineEventType.onProgress) {
-      listener.onProgress?.(data);
-    } else if (data.eventType === OfflineEventType.onOptionsAvailable) {
-      listener.onOptionsAvailable?.(data);
-    } else if (data.eventType === OfflineEventType.onDrmLicenseUpdated) {
-      listener.onDrmLicenseUpdated?.(data);
-    } else if (data.eventType === OfflineEventType.onDrmLicenseExpired) {
-      listener.onDrmLicenseExpired?.(data);
-    } else if (data.eventType === OfflineEventType.onSuspended) {
-      listener.onSuspended?.(data);
-    } else if (data.eventType === OfflineEventType.onResumed) {
-      listener.onResumed?.(data);
-    } else if (data.eventType === OfflineEventType.onCanceled) {
-      listener.onCanceled?.(data);
-    }
-  });
-};

src/subtitleTrack.ts

@@ -1,5 +1,3 @@
-import { MakeRequired } from './utils';
-
 /**
  * Supported subtitle/caption file formats.
  */
@@ -10,7 +8,7 @@ export enum SubtitleFormat {
 }
 
 /**
- * Represents a custom subtitle track source that can be added to `SourceConfig.subtitleTracks`.
+ * Describes a subtitle track.
  */
 export interface SubtitleTrack {
   /**
@@ -48,13 +46,12 @@ export interface SubtitleTrack {
 }
 
 /**
- * Helper type that represents an entry in `SourceConfig.subtitleTracks` list.
+ * A subtitle track that can be added to `SourceConfig.subtitleTracks`.
  *
- * Since `SubtitleTrack` has all of its properties as optionals for total compatibility with
- * values that may be sent from native code, this type serves as a reinforcer of what properties
- * should be required during the registration of an external subtitle track from JS.
  */
-export type SideLoadedSubtitleTrack = MakeRequired<
-  SubtitleTrack,
-  'url' | 'label' | 'language' | 'format'
->;
+export interface SideLoadedSubtitleTrack extends SubtitleTrack {
+  url: string;
+  label: string;
+  language: string;
+  format: SubtitleFormat;
+}

src/ui/custommessagehandler.ts

@@ -1,5 +1,22 @@
 import { CustomMessageSender } from './custommessagesender';
 
+export interface CustomMessageHandlerProps {
+  /**
+   * A function that will be called when the Player UI sends a synchronous message to the integration.
+   */
+  onReceivedSynchronousMessage: (
+    message: string,
+    data: string | undefined
+  ) => string | undefined;
+  /**
+   * A function that will be called when the Player UI sends an asynchronous message to the integration.
+   */
+  onReceivedAsynchronousMessage: (
+    message: string,
+    data: string | undefined
+  ) => void;
+}
+
 /**
  * Android and iOS only.
  * For Android it requires Player SDK version 3.39.0 or higher.
@@ -16,29 +33,20 @@ export class CustomMessageHandler {
     data: string | undefined
   ) => void;
 
+  /** @internal */
   customMessageSender?: CustomMessageSender;
 
   /**
    * Android and iOS only.
    *
    * Creates a new `CustomMessageHandler` instance to handle two-way communication between the integation and the Player UI.
    *
-   * @param onReceivedSynchronousMessage - A function that will be called when the Player UI sends a synchronous message to the integration.
-   * @param onReceivedAsynchronousMessage - A function that will be called when the Player UI sends an asynchronous message to the integration.
+   * @param options - Configuration options for the `CustomMessageHandler` instance.
    */
   constructor({
     onReceivedSynchronousMessage,
     onReceivedAsynchronousMessage,
-  }: {
-    onReceivedSynchronousMessage: (
-      message: string,
-      data: string | undefined
-    ) => string | undefined;
-    onReceivedAsynchronousMessage: (
-      message: string,
-      data: string | undefined
-    ) => void;
-  }) {
+  }: CustomMessageHandlerProps) {
     this.onReceivedSynchronousMessage = onReceivedSynchronousMessage;
     this.onReceivedAsynchronousMessage = onReceivedAsynchronousMessage;
   }

src/ui/custommessagesender.ts

@@ -1,3 +1,4 @@
+/** @internal */
 export interface CustomMessageSender {
   sendMessage(message: string, data: string | undefined): void;
 }

typedoc.json

@@ -8,5 +8,6 @@
   "excludeExternals": true,
   "includeVersion": true,
   "entryPoints": ["./src"],
-  "exclude": ["./example/**/*"]
+  "exclude": ["./example/**/*"],
+  "treatWarningsAsErrors": true
 }