bitmovin-player-react-native 0.44.1-alpha.0 → 1.0.0-alpha.0

package/plugin/src/withBitmovinIosConfig.ts

@@ -0,0 +1,71 @@
+import {
+  ConfigPlugin,
+  withInfoPlist,
+  withPodfileProperties,
+} from 'expo/config-plugins';
+import FeatureFlags from './FeatureFlags';
+
+const withBitmovinIosConfig: ConfigPlugin<{
+  playerLicenseKey: string;
+  features: FeatureFlags;
+}> = (config, { playerLicenseKey, features }) => {
+  const offlineFeatureConfig =
+    typeof features.offline === 'object'
+      ? features.offline
+      : {
+          android: {
+            isEnabled: !!features.offline,
+            externalStoragePermission: false,
+          },
+          ios: { isEnabled: !!features.offline },
+        };
+  const googleCastIosConfig = features.googleCastSDK?.ios
+    ? typeof features.googleCastSDK.ios === 'string'
+      ? { version: features.googleCastSDK.ios }
+      : features.googleCastSDK.ios
+    : null;
+
+  config = withInfoPlist(config, (config) => {
+    config.modResults['BitmovinPlayerLicenseKey'] = playerLicenseKey;
+    if (
+      features.backgroundPlayback ||
+      features.airPlay ||
+      features.pictureInPicture
+    ) {
+      let backgroundModes = new Set(
+        config.modResults['UIBackgroundModes'] || []
+      );
+      backgroundModes.add('audio');
+      config.modResults['UIBackgroundModes'] = Array.from(backgroundModes);
+    }
+    if (offlineFeatureConfig?.ios?.isEnabled) {
+      config.modResults['BitmovinPlayerOfflineSupportEnabled'] = true;
+    }
+    if (googleCastIosConfig) {
+      const appId = googleCastIosConfig.appId || 'FFE417E5';
+      const localNetworkUsageDescription =
+        googleCastIosConfig.localNetworkUsageDescription ||
+        '${PRODUCT_NAME} uses the local network to discover Cast-enabled devices on your WiFi network.';
+
+      config.modResults['NSBonjourServices'] = [
+        '_googlecast._tcp',
+        `_${appId}._googlecast._tcp`,
+      ];
+      config.modResults['NSLocalNetworkUsageDescription'] =
+        localNetworkUsageDescription;
+    }
+    return config;
+  });
+
+  config = withPodfileProperties(config, (config) => {
+    if (googleCastIosConfig) {
+      config.modResults['BITMOVIN_GOOGLE_CAST_SDK_VERSION'] =
+        googleCastIosConfig.version;
+    }
+    return config;
+  });
+
+  return config;
+};
+
+export default withBitmovinIosConfig;

package/plugin/tsconfig.json

@@ -0,0 +1,9 @@
+{
+  "extends": "expo-module-scripts/tsconfig.plugin",
+  "compilerOptions": {
+    "outDir": "build",
+    "rootDir": "src"
+  },
+  "include": ["./src"],
+  "exclude": ["**/__mocks__/*", "**/__tests__/*"]
+}

package/plugin/tsconfig.tsbuildinfo

@@ -0,0 +1 @@
+{"root":["./src/FeatureFlags.ts","./src/index.ts","./src/withAppGradleDependencies.ts","./src/withBitmovinAndroidConfig.ts","./src/withBitmovinConfig.ts","./src/withBitmovinIosConfig.ts"],"version":"5.8.3"}

package/prettier.config.js

@@ -0,0 +1,7 @@
+module.exports = {
+  quoteProps: 'consistent',
+  singleQuote: true,
+  tabWidth: 2,
+  trailingComma: 'es5',
+  useTabs: false,
+};

package/scripts/format-android.sh

@@ -0,0 +1,2 @@
+#!/bin/bash
+cd android && ./gradlew -b ktlint.gradle ktlintFormat

package/scripts/format-swift.sh

@@ -0,0 +1,3 @@
+#!/bin/bash
+# Run SwiftLint with auto-correction to fix formatting issues
+swiftlint ios --autocorrect

package/scripts/lint-android.sh

@@ -0,0 +1,2 @@
+#!/bin/bash
+cd android && ./gradlew -b ktlint.gradle ktlintCheck --quiet --console=plain

package/scripts/lint-swift.sh

@@ -0,0 +1,3 @@
+#!/bin/bash
+# Run SwiftLint in strict and quiet mode - treat warnings as errors, only show violations
+swiftlint ios --strict --quiet

package/scripts/pre-commit.sh

@@ -0,0 +1,14 @@
+#!/bin/sh
+# Pre-commit hook to run lint-staged
+
+# Load common paths where Node.js might be installed
+export PATH="/usr/local/bin:/opt/homebrew/bin:$HOME/.nvm/current/bin:$HOME/.volta/bin:$HOME/.fnm/current/bin:$PATH"
+
+# Try to find npx
+NPX=$(command -v npx)
+if [ -z "$NPX" ]; then
+  echo "Error: npx not found in PATH"
+  exit 1
+fi
+
+$NPX lint-staged

package/scripts/setup-hooks.sh

@@ -0,0 +1,58 @@
+#!/bin/bash
+
+# Setup git pre-commit hooks for the project
+echo "Setting up pre-commit hooks..."
+
+# Check if .git directory exists
+if [ ! -d ".git" ]; then
+    echo "Error: Not a git repository. Please run this from the root of the project."
+    exit 1
+fi
+
+# Check if hooks directory exists
+if [ ! -d ".git/hooks" ]; then
+    echo "Creating .git/hooks directory..."
+    mkdir -p .git/hooks
+fi
+
+# Get the directory where this script is located
+SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
+PRE_COMMIT_SOURCE="$SCRIPT_DIR/pre-commit.sh"
+
+# Check if the pre-commit.sh template exists
+if [ ! -f "$PRE_COMMIT_SOURCE" ]; then
+    echo "Error: pre-commit.sh template not found at $PRE_COMMIT_SOURCE"
+    exit 1
+fi
+
+# Check if pre-commit hook already exists and compare content
+HOOK_PATH=".git/hooks/pre-commit"
+NEEDS_UPDATE=true
+
+if [ -f "$HOOK_PATH" ]; then
+    # Compare the existing hook with the template
+    if cmp -s "$PRE_COMMIT_SOURCE" "$HOOK_PATH"; then
+        NEEDS_UPDATE=false
+        echo "✅ Pre-commit hook is already up to date"
+    else
+        echo "📝 Pre-commit hook exists but differs from template, updating..."
+    fi
+else
+    echo "📦 Installing pre-commit hook..."
+fi
+
+# Install or update the hook if needed
+if [ "$NEEDS_UPDATE" = true ]; then
+    cp "$PRE_COMMIT_SOURCE" "$HOOK_PATH"
+    chmod +x "$HOOK_PATH"
+    echo "✅ Pre-commit hook installed successfully!"
+fi
+echo ""
+echo "The pre-commit hook will now run automatically on every commit and will:"
+echo "  - Run ESLint (quiet mode) on TypeScript/JavaScript files"
+echo "  - Auto-format Swift files with SwiftLint, then run SwiftLint (strict mode)"
+echo "  - Auto-format Kotlin files with ktlint, then run ktlint"
+echo "  - Auto-format files with Prettier"
+echo ""
+echo "To test all linting manually, run: yarn lint:all"
+echo "To bypass the hook temporarily, commit with: git commit --no-verify"

package/src/BitmovinPlayerReactNative.types.ts

@@ -0,0 +1,19 @@
+import type { StyleProp, ViewStyle } from 'react-native';
+
+export type OnLoadEventPayload = {
+  url: string;
+};
+
+export type BitmovinPlayerReactNativeModuleEvents = {
+  onChange: (params: ChangeEventPayload) => void;
+};
+
+export type ChangeEventPayload = {
+  value: string;
+};
+
+export type BitmovinPlayerReactNativeViewProps = {
+  url: string;
+  onLoad: (event: { nativeEvent: OnLoadEventPayload }) => void;
+  style?: StyleProp<ViewStyle>;
+};

package/src/adaptationConfig.ts

@@ -11,7 +11,7 @@ export interface AdaptationConfig {
   /**
    * The initial bandwidth estimate in bits per second the player uses to select the optimal media tracks before actual bandwidth data is available. Overriding this value should only be done in specific cases and will most of the time not result in better selection logic.
    *
-   * @platform Android
+   * @remarks Platform: Android
    * @see https://cdn.bitmovin.com/player/android/3/docs/player-core/com.bitmovin.player.api.media/-adaptation-config/initial-bandwidth-estimate-override.html
    */
   initialBandwidthEstimateOverride?: number;

package/src/advertising.ts

@@ -83,7 +83,7 @@ export interface AdItem {
    *
    * Default value is 0.0
    *
-   * @platform Android
+   * @remarks Platform: Android
    */
   preloadOffset?: number;
 }

package/src/analytics/config.ts

@@ -44,17 +44,17 @@ export interface SourceMetadata extends CustomDataConfig {
   /**
    * ID of the video in the CMS system
    */
-  videoId?: String;
+  videoId?: string;
 
   /**
    * Human readable title of the video asset currently playing
    */
-  title?: String;
+  title?: string;
 
   /**
    * Breadcrumb path to show where in the app the user is
    */
-  path?: String;
+  path?: string;
 
   /**
    * Flag to see if stream is live before stream metadata is available
@@ -64,7 +64,7 @@ export interface SourceMetadata extends CustomDataConfig {
   /**
    * CDN Provider that the video playback session is using
    */
-  cdnProvider?: String;
+  cdnProvider?: string;
 }
 
 /**

package/src/analytics/player.ts

@@ -1,7 +1,5 @@
-import { NativeModules } from 'react-native';
 import { CustomDataConfig } from './config';
-
-const PlayerAnalyticsModule = NativeModules.PlayerAnalyticsModule;
+import PlayerAnalyticsModule from './playerAnalyticsModule';
 
 /**
  * Provides the means to control the analytics collected by a `Player`.
@@ -21,8 +19,8 @@ export class AnalyticsApi {
    * Sends a sample with the provided custom data.
    * Does not change the configured custom data of the collector or source.
    */
-  sendCustomDataEvent = (customData: CustomDataConfig) => {
-    PlayerAnalyticsModule.sendCustomDataEvent(this.playerId, customData);
+  sendCustomDataEvent = async (customData: CustomDataConfig) => {
+    await PlayerAnalyticsModule.sendCustomDataEvent(this.playerId, customData);
   };
 
   /**
@@ -30,7 +28,7 @@ export class AnalyticsApi {
    *
    * @returns The current user id.
    */
-  getUserId = async (): Promise<string> => {
+  getUserId = async (): Promise<string | null> => {
     return PlayerAnalyticsModule.getUserId(this.playerId);
   };
 }

package/src/analytics/playerAnalyticsModule.ts

@@ -0,0 +1,19 @@
+import { NativeModule, requireNativeModule } from 'expo-modules-core';
+
+export type PlayerAnalyticsModuleEvents = Record<string, any>;
+
+/**
+ * Native PlayerAnalyticsModule using Expo modules API.
+ * Provides modern async/await interface while maintaining backward compatibility.
+ */
+declare class PlayerAnalyticsModule extends NativeModule<PlayerAnalyticsModuleEvents> {
+  sendCustomDataEvent(
+    playerId: string,
+    customData: Record<string, any>
+  ): Promise<void>;
+  getUserId(playerId: string): Promise<string | null>;
+}
+
+export default requireNativeModule<PlayerAnalyticsModule>(
+  'PlayerAnalyticsModule'
+);

package/src/audioSession.ts

@@ -1,6 +1,4 @@
-import { NativeModules } from 'react-native';
-
-const AudioSessionModule = NativeModules.AudioSessionModule;
+import AudioSessionModule from './modules/AudioSessionModule';
 
 /**
  * An audio session category defines a set of audio behaviors.
@@ -15,7 +13,7 @@ const AudioSessionModule = NativeModules.AudioSessionModule;
  * - `record`: The category for recording audio while also silencing playback audio.
  * - `soloAmbient`: The default audio session category.
  *
- * @platform iOS
+ * @remarks Platform: iOS
  * @see https://developer.apple.com/documentation/avfaudio/avaudiosession/category
  */
 export type AudioSessionCategory =
@@ -29,14 +27,14 @@ export type AudioSessionCategory =
 /**
  * An object that communicates to the system how you intend to use audio in your app.
  *
- * @platform iOS
+ * @remarks Platform: iOS
  * @see https://developer.apple.com/documentation/avfaudio/avaudiosession
  */
 export const AudioSession = {
   /**
    * Sets the audio session's category.
    *
-   * @platform iOS
+   * @remarks Platform: iOS
    * @see https://developer.apple.com/documentation/avfaudio/avaudiosession/1616583-setcategory
    */
   setCategory: async (category: AudioSessionCategory): Promise<void> => {

package/src/audioTrack.ts

@@ -31,7 +31,7 @@ export interface AudioTrack {
    */
   roles?: MediaTrackRole[];
   /**
-   * A list of AudioQuality associated with this AudioTrack.
+   * The AudioQuality array associated with this AudioTrack.
    *
    * @platform Android
    */

package/src/bitmovinCastManager.ts

@@ -1,10 +1,9 @@
-import { NativeModules, Platform } from 'react-native';
-
-const BitmovinCastManagerModule = NativeModules.BitmovinCastManagerModule;
+import { Platform } from 'react-native';
+import BitmovinCastManagerModule from './modules/BitmovinCastManagerModule';
 
 /**
  * The options to be used for initializing `BitmovinCastManager`
- * @platform Android, iOS
+ * @remarks Platform: Android, iOS
  */
 export interface BitmovinCastManagerOptions {
   /**
@@ -24,7 +23,7 @@ export interface BitmovinCastManagerOptions {
  * The `BitmovinCastManager` needs to be initialized by calling `BitmovinCastManager.initialize`
  * before `Player` creation to enable casting features.
  *
- * @platform Android, iOS
+ * @remarks Platform: Android, iOS
  */
 export const BitmovinCastManager = {
   /**
@@ -54,7 +53,9 @@ export const BitmovinCastManager = {
     if (Platform.OS === 'ios' && Platform.isTV) {
       return Promise.resolve();
     }
-    return BitmovinCastManagerModule.initializeCastManager(options);
+    return BitmovinCastManagerModule.initializeCastManager(
+      options || undefined
+    );
   },
 
   /**
@@ -62,13 +63,13 @@ export const BitmovinCastManager = {
    * Make sure to call this method on every Android Activity switch.
    *
    * @returns A promise that resolves when the context was updated successfully
-   * @platform Android
+   * @remarks Platform: Android
    */
   updateContext: async (): Promise<void> => {
     if (Platform.OS === 'ios') {
       return Promise.resolve();
     }
-    return BitmovinCastManagerModule.updateContext();
+    return BitmovinCastManagerModule.updateContext?.() || Promise.resolve();
   },
 
   /**
@@ -78,10 +79,13 @@ export const BitmovinCastManager = {
    * @param messageNamespace The message namespace to be used, in case of null the default message namespace will be used
    * @returns A promise that resolves when the message was sent successfully
    */
-  sendMessage: (message: String, messageNamespace: String | null = null) => {
+  sendMessage: (message: string, messageNamespace: string | null = null) => {
     if (Platform.OS === 'ios' && Platform.isTV) {
       return Promise.resolve();
     }
-    return BitmovinCastManagerModule.sendMessage(message, messageNamespace);
+    return BitmovinCastManagerModule.sendMessage(
+      message,
+      messageNamespace || undefined
+    );
   },
 };

package/src/bufferApi.ts

@@ -1,6 +1,4 @@
-import { NativeModules } from 'react-native';
-
-const BufferModule = NativeModules.BufferModule;
+import BufferModule from './modules/BufferModule';
 
 /**
  * Represents different types of media.

package/src/bufferConfig.ts

@@ -27,7 +27,7 @@ export interface BufferConfig {
    *
    * Default is `5` seconds.
    *
-   * @platform Android
+   * @remarks Platform: Android
    */
   restartThreshold?: number;
   /**
@@ -36,7 +36,7 @@ export interface BufferConfig {
    *
    * Default is `2.5` seconds.
    *
-   * @platform Android
+   * @remarks Platform: Android
    */
   startupThreshold?: number;
 }