@kaleyra/video-react-native-module 1.1.1 → 1.2.0

package/README.md

@@ -24,7 +24,9 @@ yarn link
 cd example
 # nano .env use your own keys
 yarn link @kaleyra/video-react-native-module
-yarn android/ios
+yarn pods
+yarn ios
+yarn android
 ```
 
 ## How to install the module:
@@ -35,6 +37,37 @@ Open the **terminal** in your React-Native-App folder and run the following comm
 npm install @kaleyra/video-react-native-module
 ```
 
+# Android additional configuration may be required (depends on your integration)
+ -  add tools:replace="android:allowBackup" to AndroidManifest.xml. See here for an [example](https://github.com/KaleyraVideo/VideoReactNativeModule/blob/main/example/android/app/src/main/AndroidManifest.xml#L8)
+ -  add maven { url 'https://maven.bandyer.com/releases' } in build.gradle. See here for an [example](https://github.com/KaleyraVideo/VideoReactNativeModule/blob/1599d0f355e4a699a92404c450102e519cfe2866/example/android/build.gradle#L32)
+
+### Standalone iOS framework
+
+In case your application already provides the WebRTC framework in a third party module, a conflict may arise when trying to install the depedencies through Cocoapods.
+In order to resolve the conflict you can download and install the Kaleyra Video iOS framework as a standalone package.
+To enable the standalone framework you must change your application's Podfile declaring the `$KaleyraNoWebRTC` variable before the first target definition. You can give whatever value you want to the variable as long as it is defined before the target definitions.
+
+```ruby
+platform :ios, min_ios_version_supported
+prepare_react_native_project!
+
+# use_frameworks! is required for using Bandyer framework, linkage static is required by React Native instead.
+use_frameworks! :linkage => :static
+
+$KaleyraNoWebRTC = ''
+
+target 'KaleyraVideoReact' do
+  config = use_native_modules!
+
+  # Flags change depending on the env values.
+  flags = get_default_flags()
+[...]
+end
+```
+
+> [!CAUTION]
+> Use the standalone framework only as a last resort in case you have a WebRTC framework conflict. Because we cannot guarantee that the WebRTC framework you are using is compatible with our SDK, you are responsible for assess the compatibility with our module. However, WebRTC versions greater than or equal to M100 should work fine.
+
 ## How to remove the module:
 
 ```shell
@@ -134,7 +167,7 @@ kaleyraVideo.events.oniOSVoipPushTokenUpdated = (token: string) => {
 ```
 **Warning:** Make sure this listener is attached before calling kaleyraVideo.connect(_), otherwise the event reporting the device token could be missed.
 
-The token provided in the callback is the **string** representation of your device token. 
+The token provided in the callback is the **string** representation of your device token.
 Here's an example of a device token: **dec105f879924349fd2fa9aa8bb8b70431d5f41d57bfa8e31a5d80a629774fd9**
 
 ### VoIP notification payload
@@ -145,7 +178,11 @@ Here's an example of a device token: **dec105f879924349fd2fa9aa8bb8b70431d5f41d5
 ## Module connect
 
 To connect the plugin to the Kaleyra Video system you will need to provide a Session object.
-The session needs a userID and a function returning a promise with the access token for that user
+The session needs a userID and a function returning a promise with the access token for that user.
+
+> [!IMPORTANT]
+> - The *userID* should aready exists in our service. Your backend needs to create it by invoking this api [create_user](https://developers.kaleyra.io/reference/video-v2-user-post)
+> - The *accessToken* should be generated from your backend by invoking this api [get_credentials](https://developers.kaleyra.io/reference/video-v2-sdk-post). Be aware that it expires. The callback will be called multiple times every time a new token is needed to refresh the user session.
 
 ```javascript
 kaleyraVideo.connect({
@@ -305,7 +342,7 @@ Example of acceptable payload
 }
 ```
 
-## Proguard 
+## Proguard
 ```groovy
 # Bandyer now Kaleyra proprietary SDK
 -keep class com.bandyer.** { *; }

package/android/src/main/assets/kaleyra_video_wrapper_info.txt

@@ -1 +1 @@
-React/1.1.1
+React/1.2.0

package/ios/PluginInfo/_KaleyraVideoHybridVersionInfo.swift

@@ -7,7 +7,7 @@ import Foundation
 class _KaleyraVideoHybridVersionInfo: NSObject {
 
     @objc
-    static let krvVersion: String = "1.1.1"
+    static let krvVersion: String = "1.2.0"
 
     @objc
     static let krvPlatform: String = "react"

package/native-bridge/android/build.gradle

@@ -48,7 +48,7 @@ android {
 dependencies {
   implementation 'com.google.code.gson:gson:2.9.1'
   implementation "com.kaleyra:collaboration-suite-utils:3.0.6"
-  implementation "com.bandyer:bandyer-android-sdk:3.7.3"
+  implementation "com.bandyer:bandyer-android-sdk:3.8.1"
   implementation "org.jetbrains.kotlin:kotlin-reflect:$kotlin_version"
   compileOnly "org.jetbrains.kotlinx:kotlinx-serialization-json:1.3.1"
   implementation "androidx.room:room-runtime:2.4.0-beta02"

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kaleyra/video-react-native-module",
-  "version": "1.1.1",
+  "version": "1.2.0",
   "private": false,
   "description": "Kaleyra Video module for react native.",
   "main": "lib/commonjs/index.js",

package/video-react-native-module.podspec

@@ -17,7 +17,12 @@ Pod::Spec.new do |s|
   s.source_files = "ios/**/*.{h,m,mm,swift}", "native-bridge/iOS/Source/**/*.swift"
 
   s.dependency "React-Core"
-  s.dependency "Bandyer", "~> 3.10.0"
+
+  if defined?($KaleyraNoWebRTC)
+    s.dependency "Bandyer/Core", "~> 3.11.0"
+  else
+    s.dependency "Bandyer", "~> 3.11.0"
+  end
 
   # Don't install the dependencies when we run `pod install` in the old architecture.
   if ENV['RCT_NEW_ARCH_ENABLED'] == '1' then