react-native-meshstream 0.0.0-stage → 1.0.0

package/CHANGELOG.md

@@ -0,0 +1,8 @@
+# Changelog
+
+## 1.0.0
+
+- Unified Android and iOS React Native bridges over the respective native MeshStream SDKs.
+- Multi-client and multi-session lifecycle API.
+- Playback URL, preload, player telemetry, status, statistics, diagnostics, and typed events.
+- CDN-safe fallback semantics preserved from the native SDK.

package/LICENSE

@@ -0,0 +1,176 @@
+Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS

package/MeshStreamP2P.podspec

@@ -0,0 +1,20 @@
+Pod::Spec.new do |s|
+  s.name         = 'MeshStreamP2P'
+  s.version      = '1.0.0'
+  s.summary      = 'MeshStream P2P playback URL bridge for React Native.'
+  s.homepage     = 'https://github.com/Mesh-Stream/meshstream-p2p-react-native-sdk'
+  s.license      = { :type => 'Apache-2.0' }
+  s.author       = { 'MeshStream' => 'support@meshstream.net' }
+  s.platforms    = { :ios => '13.0' }
+  s.source       = { :git => 'https://github.com/Mesh-Stream/meshstream-p2p-react-native-sdk.git', :tag => s.version.to_s }
+  s.source_files = 'ios/**/*.{h,m}'
+  s.public_header_files = 'ios/MeshStreamP2P.h'
+  s.private_header_files = 'ios/MeshStreamP2PValidation.h'
+  s.dependency 'React-Core'
+  s.dependency 'MeshStreamKit', '= 1.0.2'
+  s.frameworks = 'Foundation', 'Network', 'Security'
+
+  s.test_spec 'Validation' do |test_spec|
+    test_spec.source_files = 'tests/ios/MeshStreamP2PValidationTests.m'
+  end
+end

package/README.md

@@ -1,3 +1,126 @@
-# Temporary Holding Version
+# MeshStream React Native SDK
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+React Native binding for MeshStream P2P playback acceleration. It creates a CDN-safe local playback URL; use that URL with `react-native-video` or your existing player. The SDK does not include a player and does not control your player lifecycle.
+
+> This is one cross-platform React Native package. It bridges to the MeshStream Android SDK on Android and MeshStreamKit on iOS. The JavaScript API and client/session lifecycle are identical on both platforms.
+
+[中文文档](./README.zh-CN.md) | [Web SDK](https://github.com/Mesh-Stream/meshstream-p2p-web-sdk) | [Android SDK](https://github.com/Mesh-Stream/meshstream-p2p-android-sdk) | [iOS SDK](https://github.com/Mesh-Stream/meshstream-p2p-ios-sdk) | [Windows SDK](https://github.com/Mesh-Stream/meshstream-p2p-Windows-sdk) | [Online demo](https://demo.meshstream.net/)
+
+## Requirements
+
+- React Native `0.72+`
+- Android API 24+ (Android 7.0+) or iOS 13+
+- MeshStream SDK key enabled for the target platform
+
+## Install
+
+```bash
+npm install react-native-meshstream
+```
+
+For Android, add the MeshStream Maven repository to `android/settings.gradle` in the app's `dependencyResolutionManagement.repositories` block:
+
+```kotlin
+repositories {
+    google()
+    mavenCentral()
+    maven {
+        url = uri("https://pub-61830e1369904d19af505ff74fd55ba4.r2.dev/maven")
+        content { includeGroup("io.meshstream") }
+    }
+}
+```
+
+For iOS, the bridge resolves the public `MeshStreamKit 1.0.2` CocoaPod. After installation, run `pod install --repo-update` from the app's `ios` directory and rebuild the native app. Do not add a local `MeshStreamKit` pod path or embed its XCFramework yourself.
+
+## Basic usage
+
+```tsx
+import Video from 'react-native-video';
+import { MeshStream } from 'react-native-meshstream';
+
+const client = await MeshStream.create({ key: 'key_your_android_key' });
+const session = await client.createPlaybackSession({
+  url: 'https://cdn.example.com/live/playlist.m3u8',
+  contentId: 'live-channel-42', // Stable across rotating signed URLs.
+  mimeType: 'm3u8',
+});
+
+// Keep the session alive while the player uses this URL.
+<Video source={{ uri: session.playbackUrl }} controls />;
+
+// On player teardown:
+await session.close();
+await client.close();
+```
+
+`createPlaybackSession` returns promptly with a CDN-safe URL. P2P policy/bootstrap work proceeds in the background. A policy, tracker, or peer issue falls back to your origin/CDN and does not intentionally stop an already running player.
+
+## Multiple players and preload
+
+One client can host several sessions. A session is independent and must be closed when its player is no longer using the URL.
+
+```ts
+const next = await client.createPlaybackSession({
+  url: nextItem.url,
+  contentId: nextItem.id,
+  mimeType: 'mp4',
+});
+
+await next.preload();
+// Give next.playbackUrl to the player only when it becomes active.
+```
+
+Close the `MeshStream` client or session created by this binding instead of shutting down a native SDK globally. This keeps other React Native players in the same process isolated.
+
+## Player telemetry
+
+Forward state from the active player at a low frequency. These methods do not cause reporting by themselves; native SDK reporting remains internal.
+
+```ts
+await session.updateBufferedDurationMs(bufferedDurationMs);
+await session.updateCurrentPositionMs(currentPositionMs);
+```
+
+## Events, status, and diagnostics
+
+Events always include `clientId` and `sessionId`, which makes multiple players safe to observe.
+
+```ts
+import { MeshStream, addMeshStreamEventListener } from 'react-native-meshstream';
+
+const subscription = addMeshStreamEventListener((event) => {
+  if (event.type === 'p2pUnavailable') {
+    console.info('P2P unavailable for this session:', event.reason);
+  }
+}, { clientId: client.clientId });
+
+const status = await client.getStatus();
+const stats = await session.getStats();
+const diagnostics = await session.getDiagnostics();
+
+subscription.remove();
+```
+
+Available event types: `peerCountChanged`, `playbackPrepared`, `p2pReady`, `p2pUnavailable`, `statistics`, `cdnFallback`, `trackerError`, and `peerConnectError`.
+
+## Supported media
+
+The binding forwards to the platform-native SDK. HLS (`m3u8`), DASH (`mpd`), MP4, and MP3 can be declared through `mimeType`; provide a stable `contentId` for any URL that rotates credentials. Your chosen React Native player must independently support the source format.
+
+## Native dependencies
+
+The package is a unified JavaScript layer, not an Android SDK repackaged for React Native:
+
+### Versioning
+
+- `react-native-meshstream` follows its own React Native package version. This release is `1.0.0`.
+- The Android bridge keeps its independent native dependency: `io.meshstream:meshstream-android-sdk:1.0.2`.
+- The iOS bridge keeps its independent native dependency: `MeshStreamKit >= 1.0.0`.
+
+Updating the React Native package does not implicitly upgrade either native SDK.
+
+- Android resolves `io.meshstream:meshstream-android-sdk:1.0.2` from the MeshStream Maven repository.
+- iOS resolves the public `MeshStreamKit 1.0.2` CocoaPod.
+
+Both bridges maintain client/session isolation. Closing a client only closes its own sessions and never interrupts another React Native player in the same process.

package/README.zh-CN.md

@@ -0,0 +1,126 @@
+# MeshStream React Native SDK
+
+面向 React Native 的 MeshStream P2P 播放加速绑定。SDK 返回可直接交给播放器的本地代理播放地址；应用可继续使用 `react-native-video` 或现有播放器。SDK 不内置播放器，也不接管播放器生命周期。
+
+> 这是一个统一的跨端 React Native 包：Android 运行时桥接 MeshStream Android SDK，iOS 运行时桥接 MeshStreamKit。两端使用相同的 JavaScript API、client/session 生命周期和事件模型。
+
+[English](./README.md) | [Web SDK](https://github.com/Mesh-Stream/meshstream-p2p-web-sdk) | [Android SDK](https://github.com/Mesh-Stream/meshstream-p2p-android-sdk) | [iOS SDK](https://github.com/Mesh-Stream/meshstream-p2p-ios-sdk) | [Windows SDK](https://github.com/Mesh-Stream/meshstream-p2p-Windows-sdk) | [在线 Demo](https://demo.meshstream.net/)
+
+## 环境要求
+
+- React Native `0.72+`
+- Android API 24+（Android 7.0+）或 iOS 13+
+- 已启用对应目标平台的 MeshStream SDK Key
+
+## 安装
+
+```bash
+npm install react-native-meshstream
+```
+
+在 React Native Android 工程的 `android/settings.gradle` 中，向 `dependencyResolutionManagement.repositories` 添加 MeshStream Maven 仓库：
+
+```kotlin
+repositories {
+    google()
+    mavenCentral()
+    maven {
+        url = uri("https://pub-61830e1369904d19af505ff74fd55ba4.r2.dev/maven")
+        content { includeGroup("io.meshstream") }
+    }
+}
+```
+
+接入 iOS 时，bridge 会解析公开的 `MeshStreamKit 1.0.2` CocoaPod。安装 npm 包后，请在应用的 `ios` 目录执行 `pod install --repo-update` 并重新编译原生工程；不要添加本地 `MeshStreamKit` Pod 路径，也不需要手动嵌入 XCFramework。
+
+## 基础接入
+
+```tsx
+import Video from 'react-native-video';
+import { MeshStream } from 'react-native-meshstream';
+
+const client = await MeshStream.create({ key: 'key_your_android_key' });
+const session = await client.createPlaybackSession({
+  url: 'https://cdn.example.com/live/playlist.m3u8',
+  contentId: 'live-channel-42', // 签名 URL 轮换时保持稳定。
+  mimeType: 'm3u8',
+});
+
+// 播放期间保持 session 存活。
+<Video source={{ uri: session.playbackUrl }} controls />;
+
+// 播放器销毁时：
+await session.close();
+await client.close();
+```
+
+`createPlaybackSession` 会立即返回 CDN 安全的播放地址；P2P 策略和网络初始化在后台执行。策略、Tracker 或对等连接不可用时会回源 CDN，不会主动硬中断正在播放的会话。
+
+## 多播放器与预热
+
+一个 client 可管理多个独立 session。每个 session 对应一个播放项，用完必须关闭。
+
+```ts
+const next = await client.createPlaybackSession({
+  url: nextItem.url,
+  contentId: nextItem.id,
+  mimeType: 'mp4',
+});
+
+await next.preload();
+// 仅在下一条真正播放时，将 next.playbackUrl 交给播放器。
+```
+
+请关闭本绑定创建的 `MeshStream` client 或 session，而不是全局关闭原生 SDK；这样不会影响同一进程内的其他 React Native 播放器实例。
+
+## 播放器状态上报
+
+从当前活跃播放器以低频更新状态。以下调用不会自行发起用量上报，原生 SDK 的统计上报仍由其内部控制。
+
+```ts
+await session.updateBufferedDurationMs(bufferedDurationMs);
+await session.updateCurrentPositionMs(currentPositionMs);
+```
+
+## 事件、状态与诊断
+
+所有事件都带有 `clientId`、`sessionId`，可安全用于多播放器场景。
+
+```ts
+import { addMeshStreamEventListener } from 'react-native-meshstream';
+
+const subscription = addMeshStreamEventListener((event) => {
+  if (event.type === 'p2pUnavailable') {
+    console.info('当前会话 P2P 不可用：', event.reason);
+  }
+}, { clientId: client.clientId });
+
+const status = await client.getStatus();
+const stats = await session.getStats();
+const diagnostics = await session.getDiagnostics();
+
+subscription.remove();
+```
+
+事件类型包括：`peerCountChanged`、`playbackPrepared`、`p2pReady`、`p2pUnavailable`、`statistics`、`cdnFallback`、`trackerError`、`peerConnectError`。
+
+## 支持的媒体格式
+
+底层调用平台原生 SDK。可通过 `mimeType` 声明 HLS（`m3u8`）、DASH（`mpd`）、MP4、MP3；签名 URL 或播放地址会变化时，应传入稳定的 `contentId`。最终格式支持能力仍以所选 React Native 播放器为准。
+
+## 原生依赖
+
+这个包是统一的 JavaScript 层，不是将 Android SDK 重新打包：
+
+### 版本说明
+
+- `react-native-meshstream` 使用独立的 React Native 包版本；当前首发版本为 `1.0.0`。
+- Android 桥接使用独立的原生依赖：`io.meshstream:meshstream-android-sdk:1.0.2`。
+- iOS 桥接使用独立的原生依赖：`MeshStreamKit >= 1.0.0`。
+
+升级 React Native 包不会隐式升级任一原生 SDK。
+
+- Android 从 MeshStream Maven 仓库解析 `io.meshstream:meshstream-android-sdk:1.0.2`。
+- iOS 通过 CocoaPods 解析公开的 `MeshStreamKit 1.0.2`。
+
+两个 bridge 都保证 client/session 隔离。关闭某一个 client 只会关闭其所属会话，不会中断同一进程中的其他 React Native 播放器。

package/android/build.gradle

@@ -0,0 +1,23 @@
+buildscript {
+  ext {
+    kotlinVersion = project.findProperty('kotlinVersion') ?: '1.9.25'
+  }
+}
+
+apply plugin: 'com.android.library'
+apply plugin: 'kotlin-android'
+
+android {
+  namespace 'net.meshstream.reactnative'
+  compileSdkVersion 35
+
+  defaultConfig {
+    minSdkVersion 24
+  }
+}
+
+dependencies {
+  implementation 'com.facebook.react:react-android'
+  implementation "org.jetbrains.kotlin:kotlin-stdlib:$kotlinVersion"
+  implementation 'io.meshstream:meshstream-android-sdk:1.0.2'
+}

package/android/src/main/AndroidManifest.xml

@@ -0,0 +1,4 @@
+<manifest xmlns:android="http://schemas.android.com/apk/res/android"
+  package="net.meshstream.reactnative">
+  <uses-permission android:name="android.permission.INTERNET" />
+</manifest>