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

package/CONTRIBUTING.md

@@ -0,0 +1,255 @@
+# Contributing
+
+## Issues
+
+With bugs and problems, please try to describe the issue as detailed as possible to help us reproduce it.
+
+## Pull Requests
+
+Before creating a pull request, please
+
+- Make sure all guidelines are followed
+- Make sure your branch is free of merge conflicts
+
+## Development workflow
+
+To get started with the project, run `yarn bootstrap` in the root directory to install the required dependencies for each package and cocoapods dependencies for the example app:
+
+```sh
+yarn bootstrap
+```
+
+> While it's possible to use [`npm`](https://github.com/npm/cli), the tooling is built around [`yarn`](https://classic.yarnpkg.com/), so you'll have an easier time if you use `yarn` for development.
+
+While developing, you can run the [example app](/example/) to test your changes. Any changes you make in your library's JavaScript code will be reflected in the example app without a rebuild. If you change any native code, then you'll need to rebuild the example app.
+
+To start the packager, run in the root directory:
+
+```sh
+yarn example start
+```
+
+To build and run the example app on Android:
+
+```sh
+yarn example android
+```
+
+To build and run the example app on iOS:
+
+```sh
+yarn example ios
+```
+
+To edit the Swift/Objective-C files, open `example/ios/BitmovinPlayerReactNativeExample.xcworkspace` in Xcode and find the source files at `Pods > Development Pods > RNBitmovinPlayer`.
+
+To edit the Kotlin files, open `example/android` in Android Studio and find the source files at `bitmovin-player-react-native` under `Android`.
+
+## For iOS/tvOS on-device development
+
+To build the example project for an iOS or tvOS device, you need to create a file at `example/ios/Developer.xcconfig`. In this file, add your development team like this:
+
+```yml
+DEVELOPMENT_TEAM = YOUR_TEAM_ID
+```
+
+## TypeScript Code Style
+
+- Follow the `eslint` rules (`yarn lint`). They are enforced automatically via a pre-commit git hook.
+- Always add return values to functions (even if `void`)
+- No unused imports
+- Public functions should be documented with a description that explains _what_ it does
+- Every code block that does not obviously explain itself should be commented with an explanation of _why_ and _what_ it does
+
+## Linting
+
+### Pre-commit Hooks
+
+The project uses pre-commit hooks to automatically enforce code quality standards across all languages (TypeScript, Swift, Kotlin). The hooks will:
+
+- Run ESLint (quiet mode) on TypeScript/JavaScript files
+- Auto-format Swift files with SwiftLint, then run SwiftLint (strict mode)
+- Auto-format Kotlin files with ktlint, then run ktlint
+- Auto-format files with Prettier
+
+**Setup:**
+
+```sh
+yarn setup-hooks
+```
+
+Or manually install the pre-commit hook:
+
+```sh
+# Copy the pre-commit hook (done automatically by yarn setup-hooks)
+cp scripts/pre-commit.sh .git/hooks/pre-commit
+chmod +x .git/hooks/pre-commit
+```
+
+**Testing all linting:**
+
+```sh
+yarn lint:all
+```
+
+### Typescript
+
+[ESLint](https://eslint.org/), [Prettier](https://prettier.io/), [TypeScript](https://www.typescriptlang.org/)
+
+We use [TypeScript](https://www.typescriptlang.org/) for type checking, [ESLint](https://eslint.org/) with [Prettier](https://prettier.io/) for linting and formatting the code, and [Jest](https://jestjs.io/) for testing.
+
+Make sure your code passes TypeScript and ESLint. Run the following to verify:
+
+```sh
+yarn typecheck
+yarn lint
+```
+
+To run TypeScript checking for all packages:
+
+```sh
+yarn typecheck:all
+```
+
+To fix formatting errors, run the following:
+
+```sh
+yarn format:all
+```
+
+Or for specific platforms:
+
+```sh
+yarn format        # Prettier (TypeScript/JavaScript/Markdown/JSON/YAML)
+yarn format:ios    # SwiftLint auto-correction
+yarn format:android # ktlint formatting
+```
+
+### Kotlin
+
+For Kotlin code [ktlint](https://pinterest.github.io/ktlint/) is used with [ktlint gradle plugin](https://github.com/jlleitschuh/ktlint-gradle).
+
+Run the following to verify code format:
+
+```sh
+yarn lint:android
+```
+
+To fix formatting errors, run the following:
+
+```sh
+yarn format:android
+```
+
+Or manually inside `android` folder:
+
+```sh
+./gradlew ktlintFormat
+```
+
+### Swift
+
+For Swift code [SwiftLint](https://github.com/realm/SwiftLint) is used.
+To install SwiftLint, run `brew bundle install` in the root directory.
+
+To verify Swift code, run the following:
+
+```sh
+yarn lint:ios
+```
+
+To fix auto-fixable SwiftLint violations, run the following:
+
+```sh
+yarn format:ios
+```
+
+Or manually:
+
+```sh
+swiftlint ios --autocorrect
+```
+
+## Testing
+
+Remember to add tests for your change if possible. Run the player tests by:
+
+```sh
+yarn integration-test test:android
+yarn integration-test test:ios
+```
+
+To set the license key to be used for the tests, you can set the key `"licenseKey"` in `integration_test/app.json`.
+
+See available API for testing [here](/integration_test/playertesting/PlayerTesting.ts).
+
+### Adding new tests
+
+To add new tests:
+
+1. create a new file in the `specs/` folder.
+1. import the new file to the `specs/index.ts` file and add it to the default exported array.
+
+A Player Test has the following structure always:
+
+```ts
+export default (spec: TestScope) => {
+  spec.describe('SCENARIO TO TEST', () => {
+    spec.it('EXPECTATION', async () => {
+      await startPlayerTest({}, async () => {
+        // TEST CODE
+      });
+    });
+  });
+};
+```
+
+For example:
+
+```ts
+export default (spec: TestScope) => {
+  spec.describe('playing a source', () => {
+    spec.it('emits TimeChanged events', async () => {
+      await startPlayerTest({}, async () => {
+        await loadSourceConfig({
+          url: 'https://cdn.bitmovin.com/content/internal/assets/MI201109210084/m3u8s/f08e80da-bf1d-4e3d-8899-f0f6155f6efa.m3u8',
+          type: SourceType.HLS,
+        });
+        await callPlayerAndExpectEvents(
+          (player) => {
+            player.play();
+          },
+          EventSequence(EventType.Play, EventType.Playing)
+        );
+        await expectEvents(RepeatedEvent(EventType.TimeChanged, 5));
+      });
+    });
+  });
+};
+```
+
+## Scripts
+
+The `package.json` file contains various scripts for common tasks:
+
+- `yarn bootstrap`: setup the whole project by installing all dependencies and pods.
+- `yarn bootstrap:example`: setup example project by installing all dependencies and pods.
+- `yarn bootstrap:integration-test`: setup integration tests project by installing all dependencies and pods.
+- `yarn build`: compile TypeScript files into `lib/` with ESBuild.
+- `yarn typecheck`: type-check files with TypeScript.
+- `yarn typecheck:all`: type-check files with TypeScript in all packages.
+- `yarn lint`: lint files with ESLint.
+- `yarn format`: format files with Prettier.
+- `yarn format:ios`: auto-fix SwiftLint violations.
+- `yarn format:android`: format Kotlin files with ktlint.
+- `yarn format:all`: format all files (Prettier, SwiftLint, ktlint).
+- `yarn docs`: generate documentation with TypeDoc.
+- `yarn brew`: install all dependencies for iOS development with Homebrew.
+- `yarn example start`: start the Metro server for the example app.
+- `yarn example android`: run the example app on Android.
+- `yarn example pods`: install pods only.
+- `yarn integration-test start`: start the Metro server for the integration tests.
+- `yarn integration-test test:android`: run the player tests on Android emulator.
+- `yarn integration-test test:ios`: run the player tests on iOS simulator.
+- `yarn integration-test pods`: install pods only.
+- `yarn example ios`: run the example app on iOS.

package/android/.editorconfig

@@ -0,0 +1,8 @@
+[*.{kt,kts}]
+ktlint_code_style=android_studio
+max_line_length=120
+# Allow wildcard imports for react native bridge, since IntelliJ does this automatically when performing
+# imports optimization.
+ij_kotlin_packages_to_use_import_on_demand = com.facebook.react.bridge.*
+ij_kotlin_allow_trailing_comma=true
+ij_kotlin_allow_trailing_comma_on_call_site=true

package/android/build.gradle

@@ -1,8 +1,15 @@
+import groovy.json.JsonSlurper
+
+// Read version from package.json
+def packageJsonFile = new File("$rootDir/../package.json")
+def packageJson = new JsonSlurper().parseText(packageJsonFile.text)
+def packageVersion = packageJson.version
+
 buildscript {
     // Buildscript is evaluated before everything else so we can't use getExtOrDefault
     def kotlin_version = rootProject.ext.has("kotlinVersion") ? rootProject.ext.get("kotlinVersion") : project.properties["BitmovinPlayerReactNative_kotlinVersion"]
     def ktlint_version = rootProject.ext.has("ktlintVersion") ? rootProject.ext.get("ktlintVersion") : project.properties["BitmovinPlayerReactNative_ktlintVersion"]
-    def android_tools_version = rootProject.ext.has("androidToolsVersion") ? rootProject.ext.get("androidToolsVersion") : project.properties["BitmovinPlayerReactNative_androidToolsVersion"]
+    def android_plugin_version = rootProject.ext.has("androidPluginVersion") ? rootProject.ext.get("androidPluginVersion") : project.properties["BitmovinPlayerReactNative_androidPluginVersion"]
 
     repositories {
         google()
@@ -12,99 +19,95 @@ buildscript {
         }
     }
     dependencies {
-        classpath "com.android.tools.build:gradle:$android_tools_version"
-        classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlin_version"
+        classpath "com.android.tools.build:gradle:$android_plugin_version"
         classpath "org.jlleitschuh.gradle:ktlint-gradle:$ktlint_version"
     }
 }
 
-def isNewArchitectureEnabled() {
-    return rootProject.hasProperty("newArchEnabled") && rootProject.getProperty("newArchEnabled") == "true"
-}
-
 apply plugin: 'com.android.library'
-apply plugin: 'kotlin-android'
 apply plugin: 'org.jlleitschuh.gradle.ktlint'
 
-if (isNewArchitectureEnabled()) {
-    apply plugin: "com.facebook.react"
-}
-
-def getExtOrDefault(name) {
-    return rootProject.ext.has(name) ? rootProject.ext.get(name) : project.properties["BitmovinPlayerReactNative_" + name]
-}
-
-def getExtOrIntegerDefault(name) {
-    return rootProject.ext.has(name) ? rootProject.ext.get(name) : (project.properties["BitmovinPlayerReactNative_" + name]).toInteger()
-}
-
-def supportsNamespace() {
-    def parsed = com.android.Version.ANDROID_GRADLE_PLUGIN_VERSION.tokenize('.')
-    def major = parsed[0].toInteger()
-    def minor = parsed[1].toInteger()
-
-    // Namespace support was added in 7.3.0
-    return (major == 7 && minor >= 3) || major >= 8
-}
-
-android {
-    if (supportsNamespace()) {
-        namespace "com.bitmovin.player.reactnative"
-
-        sourceSets {
-            main {
-                manifest.srcFile "src/main/AndroidManifestNew.xml"
-            }
-        }
+group = 'com.bitmovin.player.reactnative'
+version = packageVersion
+
+def expoModulesCorePlugin = new File(project(":expo-modules-core").projectDir.absolutePath, "ExpoModulesCorePlugin.gradle")
+apply from: expoModulesCorePlugin
+applyKotlinExpoModulesCorePlugin()
+useCoreDependencies()
+useExpoPublishing()
+
+// If you want to use the managed Android SDK versions from expo-modules-core, set this to true.
+// The Android SDK versions will be bumped from time to time in SDK releases and may introduce breaking changes in your module code.
+// Most of the time, you may like to manage the Android SDK versions yourself.
+def useManagedAndroidSdkVersions = false
+if (useManagedAndroidSdkVersions) {
+  useDefaultAndroidSdkVersions()
+} else {
+  buildscript {
+    // Simple helper that allows the root project to override versions declared by this library.
+    ext.safeExtGet = { prop, fallback ->
+      rootProject.ext.has(prop) ? rootProject.ext.get(prop) : fallback
     }
-
-    compileSdkVersion getExtOrIntegerDefault("compileSdkVersion")
-
+  }
+  project.android {
+    compileSdkVersion safeExtGet("compileSdkVersion", 34)
     defaultConfig {
-        minSdkVersion getExtOrIntegerDefault("minSdkVersion")
-        targetSdkVersion getExtOrIntegerDefault("targetSdkVersion")
-
+      minSdkVersion safeExtGet("minSdkVersion", 24)
+      targetSdkVersion safeExtGet("targetSdkVersion", 35)
     }
+  }
+}
 
-    buildTypes {
-        release {
-            minifyEnabled false
-        }
+android {
+  namespace "com.bitmovin.player.reactnative"
+  
+  defaultConfig {
+    versionCode 1
+    versionName packageVersion
+  }
+
+  buildTypes {
+    release {
+      minifyEnabled false
     }
+  }
 
-    lintOptions {
-        disable "GradleCompatible"
-    }
+  lintOptions {
+    disable "GradleCompatible"
+    abortOnError false
+  }
 
-    compileOptions {
-        sourceCompatibility JavaVersion.VERSION_1_8
-        targetCompatibility JavaVersion.VERSION_1_8
-    }
+  compileOptions {
+    sourceCompatibility JavaVersion.VERSION_1_8
+    targetCompatibility JavaVersion.VERSION_1_8
+  }
 
-    buildFeatures {
-        buildConfig true
-    }
+  buildFeatures {
+    buildConfig true
+  }
 }
 
 repositories {
-    google()
-    mavenCentral()
+  google()
+  mavenCentral()
+  maven {
+    url "https://artifacts.bitmovin.com/artifactory/public-releases"
+  }
 }
 
-def kotlin_version = getExtOrDefault("kotlinVersion")
-
 dependencies {
-    // For < 0.71, this will be from the local maven repo
-    // For > 0.71, this will be replaced by `com.facebook.react:react-android:$version` by react gradle plugin
-    //noinspection GradleDynamicVersion
-    implementation 'com.facebook.react:react-native:+' // From node_modules
-    implementation "org.jetbrains.kotlin:kotlin-stdlib:$kotlin_version"
-    implementation "androidx.concurrent:concurrent-futures:1.1.0"
-    implementation "androidx.concurrent:concurrent-futures-ktx:1.1.0"
-
-    // Bitmovin
-    implementation 'com.google.ads.interactivemedia.v3:interactivemedia:3.35.1'
-    implementation 'com.google.android.gms:play-services-ads-identifier:18.0.1'
-    implementation 'com.bitmovin.player:player:3.119.0+jason'
-    implementation 'com.bitmovin.player:player-media-session:3.119.0+jason'
+  // React Native (needed for hybrid bridge modules)
+  //noinspection GradleDynamicVersion
+  implementation 'com.facebook.react:react-native:+' // From node_modules
+  
+  implementation "androidx.concurrent:concurrent-futures:1.1.0"
+  implementation "androidx.concurrent:concurrent-futures-ktx:1.1.0"
+
+  // Google IMA
+  implementation 'com.google.ads.interactivemedia.v3:interactivemedia:3.35.1'
+
+  // Bitmovin
+  implementation 'com.google.android.gms:play-services-ads-identifier:18.0.1'
+  implementation 'com.bitmovin.player:player:3.119.0+jason'
+  implementation 'com.bitmovin.player:player-media-session:3.119.0+jason'
 }

package/android/gradle/wrapper/gradle-wrapper.properties

@@ -0,0 +1,7 @@
+distributionBase=GRADLE_USER_HOME
+distributionPath=wrapper/dists
+distributionUrl=https\://services.gradle.org/distributions/gradle-8.2-bin.zip
+networkTimeout=10000
+validateDistributionUrl=true
+zipStoreBase=GRADLE_USER_HOME
+zipStorePath=wrapper/dists

package/android/gradle.properties

@@ -7,4 +7,5 @@ BitmovinPlayerReactNative_compileSdkVersion=35
 BitmovinPlayerReactNative_buildToolsVersion=34.0.0
 BitmovinPlayerReactNative_ndkversion=25.1.8937393
 BitmovinPlayerReactNative_androidToolsVersion=8.1.0
+BitmovinPlayerReactNative_androidPluginVersion=8.1.0
 BitmovinPlayerReactNative_ktlintVersion=11.6.0