@kaleyra/video-react-native-module 1.0.0

package/LICENSE

@@ -0,0 +1,165 @@
+                   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

package/README.md

@@ -0,0 +1,292 @@
+![Kaleyra Logo](https://github.com/KaleyraVideo/VideoReactNativeModule/blob/main/doc/img/kaleyra-video.png)
+
+# Kaleyra Video React Native Module
+
+[![npm version](https://img.shields.io/npm/v/@kaleyra/video-react-native-module?color=brightgreen&label=npm%20package)][LinkNpm]
+
+## Our machine development setup
+
+```
+ruby = 2.7.6
+node >= v16
+react >= 0.71.x
+yarn >= 1.22.17
+```
+
+## How to run the example
+
+Execute the following commands from the repository root folder
+
+```shell
+yarn
+yarn prepack
+yarn link
+cd example
+# nano .env use your own keys
+yarn link @kaleyra/video-react-native-module
+yarn android/ios
+```
+
+## How to install the module:
+
+Open the **terminal** in your React-Native-App folder and run the following commands
+
+```shell
+npm install @kaleyra/video-react-native-module
+```
+
+## How to remove the module:
+
+```shell
+npm uninstall @kaleyra/video-react-native-module
+```
+
+## How to use the Kaleyra Video module in your React Native app
+
+You can refer to the Kaleyra Video module in your React Native app via
+
+```javascript
+KaleyraVideo
+```
+
+## Module setup
+
+The first thing you need to do is to configure the module specifying your keys and your options.
+
+##### Configure params
+
+```javascript
+var kaleyraVideo = KaleyraVideo.configure({
+    environment: Environments.sandbox(), // production()
+    appID: 'mAppId_xxx', // your mobile appId
+    region: Regions.europe(), // india(), us()
+    logEnabled: true, // enable the logger
+    tools: { // by default no tools will be set
+        chat: {
+            audioCallOption: {
+                type: AudioCallType.AUDIO, // AUDIO or AUDIO_UPGRADABLE
+                recordingType: RecordingType.NONE, // NONE, MANUAL or AUTOMATIC
+            },
+            videoCallOption: {
+                recordingType: RecordingType.NONE, // NONE, MANUAL or AUTOMATIC
+            }
+        },
+        fileShare: true,
+        whiteboard: true,
+        screenShare: {
+            inApp: true, // screenshare only the app
+            wholeDevice: true // screenshare the whole device
+        },
+        feedback: true
+    },
+
+    // optional you can set one or more of the following capabilities, by default callkit is enabled
+    iosConfig: {
+        voipHandlingStrategy: VoipHandlingStrategy.AUTOMATIC, // implement to be able to receive voips
+        callkit: {
+            enabled: true, // enable callkit on iOS 10+
+            appIconName: "logo_transparent", // optional but recommended
+            ringtoneSoundName: "custom_ringtone.mp3" // optional
+        }
+    }
+});
+```
+
+If screenShare.wholeDevice is set to true look [here][BroadcastAchor] for the required additional setup.
+
+## Module listen for errors/events
+
+To listen for events and/or errors register
+Check the documentation [here][EventsDoc] for a complete list.
+
+Example:
+
+```javascript
+kaleyraVideo.events.onCallModuleStatusChanged = (status: String) => {};
+```
+
+## Listening for VoIP push token
+
+In order to get your device push token, you must listen for the **KaleyraVideo.events.iOSVoipPushTokenUpdated** event registering a callback as follows:
+
+```javascript
+kaleyraVideo.events.oniOSVoipPushTokenUpdated = (token: string) => {
+    // register the VoIP push token on your server
+});
+```
+The token provided in the callback is the **string** representation of your device token.
+Here's an example of a device token: **dec105f879924349fd2fa9aa8bb8b70431d5f41d57bfa8e31a5d80a629774fd9**
+
+## 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
+
+```javascript
+kaleyraVideo.connect({
+    userID: "usr_xxx",
+    accessTokenProvider(userId: string): Promise<string> {
+        // get token for user_xxx and invoke success or error depending on the result
+        return Promise.resolve("jwt_xxx");
+    },
+});
+```
+
+## Start a call
+
+To make a call you need to specify some params.
+
+##### Start call params
+
+```javascript
+kaleyraVideo.startCall({
+    callees: ['usr_yyy','usr_zzz'], //  an array of user ids of the users you want to call
+    callType: CallType.AUDIO_VIDEO, // AUDIO, AUDIO_UPGRADABLE or AUDIO_VIDEO - the type of the call you want to start
+    recordingType: RecordingType.NONE // NONE, MANUAL or AUTOMATIC
+});
+```
+
+## Start a chat
+
+To make a chat you need to specify some params.
+
+##### Start chat params
+
+```javascript
+kaleyraVideo.startChat('usr_yyy');// the user_id of the user you want to create a chat with
+```
+
+## Set user details
+
+This method will allow you to set your user details DB from which the sdk will read when needed to show the information.
+> Be sure to have this always up to date, otherwise if an incoming call is received and the user is missing in this set the user ids will be printed on the UI.
+
+```javascript
+kaleyraVideo.addUsersDetails([
+    {userID: "usr_yyy", firstName: "User1Name", lastName: "User1Surname"},
+    {userID: "usr_zzz", firstName: "User2Name", lastName: "User2Surname"},
+]);
+```
+
+## Remove all user details
+
+This method will allow you to remove all the user info from the local app DB.
+
+```javascript
+kaleyraVideo.removeUsersDetails();
+```
+
+## Set user details format
+
+This method will allow you to specify how you want your user details to be displayed.
+> Be aware that you can specify only keywords which exist in the UserDetails type.
+
+For example: if you wish to show only the firstName while your dataset contains also the lastName you may change it here.
+
+```javascript
+kaleyraVideo.setUserDetailsFormat({
+    default: "${firstName} ${lastName}",
+    androidNotification: "${firstName} ${lastName}" // optional if you wish to personalize the details in the notification.
+});
+```
+
+## Remove all the cached info in preferences and DBs
+
+```javascript
+kaleyraVideo.clearUserCache();
+```
+
+## Android change display mode
+
+This method is useful for use-cases where you need to show a prompt and don't want it to be invalidated by the call going into pip.
+For example: if you wish to show fingerprint dialog you should first put the current call in background, execute the fingerprint validation and then put back the call in foreground.
+
+```javascript
+kaleyraVideo.setDisplayModeForCurrentCall(CallDisplayMode.FOREGROUND); // FOREGROUND, FOREGROUND_PICTURE_IN_PICTURE or CallDisplayMode.BACKGROUND
+```
+
+## Verify user
+
+To verify a user for the current call.
+
+```javascript
+kaleyraVideo.verifyCurrentCall(true);
+```
+
+## iOS Podfile Setup
+
+Please pay attention to the Podfile setup for your iOS application. Is required to add this to your Podfile:
+
+```ruby
+use_frameworks! :linkage => :static
+```
+
+## iOS Broadcast Screen sharing
+
+To enable whole device screen share is required and additional setup.
+Open the iOS Xcode project of your React Native application and follow [this guide][BroadcastSceenSharing].
+After completing the procedure described in the guide above you need to add to your Podfile this lines:
+
+```ruby
+target 'BroadcastExtension' do
+  use_frameworks! :linkage => :dynamic
+
+  pod 'BandyerBroadcastExtension'
+end
+```
+
+Furthermore, to allow a correct configuration of the SDK it is necessary to create a file called "KaleyraVideoConfig.plist" and add it to the same target of the application. This file must have the following content:
+
+```xml
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+	<key>broadcast</key>
+	<dict>
+		<key>appGroupIdentifier</key>
+		<string><!-- PUT HERE THE BUNDLE ID OF YOUR APP GROUP --></string>
+		<key>extensionBundleIdentifier</key>
+		<string><!-- PUT HERE THE BUNDLE ID OF YOUR BROADCAST EXTENSION --></string>
+	</dict>
+</dict>
+</plist>
+```
+
+## iOS Notifications
+The module supports **on_call_incoming** notification.
+You will need to set the **voipHandlingStrategy** and subscribe to **iOSVoipPushTokenUpdated** event to receive the voip token to use on your backend to notify the plugin.
+
+## Android Notifications
+Supports only **on_call_incoming** and **on_message_sent** notification types.
+
+```javascript
+kaleyraVideo.handlePushNotificationPayload(payload);
+```
+
+Example of acceptable payload
+```json
+{
+  "google.delivered_priority":"high",
+  "content-available":"1",
+  "google.sent_time":1663347601917,
+  "google.ttl":60,
+  "google.original_priority":"high",
+  "from":"320",
+  "title":"",
+  "google.message_id":"0:1123%ac212d7bf9fd7ecd",
+  "message":"{\"kaleyra\":{\"payload\":{\"event\":\"on_call_incoming\",\"room_id\":\"room_b36f162\",\"data\":{\"initiator\":\"user1\",\"users\":[{\"user\":{\"userAlias\":\"user2\"},\"status\":\"invited\"},{\"user\":{\"userAlias\":\"user1\"},\"status\":\"invited\"}],\"roomAlias\":\"room_b37a64c6f162\",\"options\":{\"duration\":0,\"record\":true,\"recordingType\":\"manual\",\"recording\":\"manual\",\"creationDate\":\"2022-09-16T17:00:01.457Z\",\"callType\":\"audio_upgradable\",\"live\":true}}},\"user_token\":\"eyJhtokenksadfjoiasdjfoaidjfsoasidjfoi\"}}",
+  "google.c.sender.id":"320"
+}
+```
+
+## TSDoc
+
+The API documentation is available on the github pages link:
+[https://kaleyravideo.github.io/VideoReactNativeModule/][TSDoc]
+
+[LinkNpm]: https://www.npmjs.com/package/@kaleyra/video-react-native-module
+[BroadcastAchor]: #ios-broadcast-screen-sharing
+[BroadcastSceenSharing]: https://github.com/Bandyer/Bandyer-iOS-SDK/wiki/Screen-sharing#broadcast-screen-sharing
+[EventsDoc]: https://kaleyravideo.github.io/VideoReactNativeModule/interfaces/src_events_Events.Events.html
+[TSDoc]: https://kaleyravideo.github.io/VideoReactNativeModule/

package/android/build.gradle

@@ -0,0 +1,100 @@
+// Copyright © 2018-2023 Kaleyra S.p.a. All Rights Reserved.
+// See LICENSE for licensing information
+
+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["ReactNativePlugin_kotlinVersion"]
+
+  repositories {
+    google()
+    mavenCentral()
+  }
+
+  dependencies {
+    classpath "com.android.tools.build:gradle:7.2.1"
+    // noinspection DifferentKotlinGradleVersion
+    classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlin_version"
+  }
+}
+
+def isNewArchitectureEnabled() {
+  return rootProject.hasProperty("newArchEnabled") && rootProject.getProperty("newArchEnabled") == "true"
+}
+
+apply plugin: "com.android.library"
+apply plugin: "kotlin-android"
+apply plugin: 'kotlin-kapt'
+apply from: "../native-bridge/android/build.gradle"
+
+if (isNewArchitectureEnabled()) {
+  apply plugin: "com.facebook.react"
+}
+
+def getExtOrDefault(name) {
+  return rootProject.ext.has(name) ? rootProject.ext.get(name) : project.properties["ReactNativePlugin_" + name]
+}
+
+def getExtOrIntegerDefault(name) {
+  return rootProject.ext.has(name) ? rootProject.ext.get(name) : (project.properties["ReactNativePlugin_" + name]).toInteger()
+}
+
+android {
+  compileSdkVersion getExtOrIntegerDefault("compileSdkVersion")
+
+  defaultConfig {
+    minSdkVersion getExtOrIntegerDefault("minSdkVersion")
+    targetSdkVersion getExtOrIntegerDefault("targetSdkVersion")
+    buildConfigField "boolean", "IS_NEW_ARCHITECTURE_ENABLED", isNewArchitectureEnabled().toString()
+  }
+  buildTypes {
+    release {
+      minifyEnabled false
+    }
+  }
+
+  sourceSets {
+    main.java.srcDirs += '../native-bridge/android/src/main/java'
+    test.java.srcDirs += '../native-bridge/android/src/test/java'
+    test.resources.srcDirs += '../native-bridge/android/src/test/resources'
+  }
+
+  lintOptions {
+    disable "GradleCompatible"
+  }
+
+  compileOptions {
+    sourceCompatibility JavaVersion.VERSION_1_8
+    targetCompatibility JavaVersion.VERSION_1_8
+  }
+
+}
+
+repositories {
+  mavenCentral()
+  google()
+  maven { url 'https://maven.bandyer.com/releases' }
+}
+
+def REACT_NATIVE_VERSION = new File(['node', '--print',"JSON.parse(require('fs').readFileSync(require.resolve('react-native/package.json'), 'utf-8')).version"].execute(null, rootDir).text.trim())
+
+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-android:$REACT_NATIVE_VERSION"
+  implementation "org.jetbrains.kotlin:kotlin-stdlib:$kotlin_version"
+}
+
+subprojects { project ->
+  apply plugin: 'com.android.library'
+}
+
+if (isNewArchitectureEnabled()) {
+  react {
+    jsRootDir = file("../src/")
+    libraryName = "VideoReactNativeModule"
+    codegenJavaPackageName = "com.kaleyra.video_react_native_module"
+  }
+}

package/android/gradle.properties

@@ -0,0 +1,9 @@
+# Copyright © 2018-2023 Kaleyra S.p.a. All Rights Reserved.
+# See LICENSE for licensing information
+
+ReactNativePlugin_kotlinVersion=1.7.0
+ReactNativePlugin_minSdkVersion=21
+ReactNativePlugin_targetSdkVersion=31
+ReactNativePlugin_compileSdkVersion=31
+ReactNativePlugin_ndkversion=21.4.7075529
+android.useAndroidX=true

package/android/settings.gradle

@@ -0,0 +1,6 @@
+rootProject.name = 'video_react'
+
+include ':video_hybrid_native_bridge'
+
+project(':video_hybrid_native_bridge').projectDir = new File('../native-bridge/android')
+

package/android/src/main/AndroidManifest.xml

@@ -0,0 +1 @@
+<manifest package="com.kaleyra.video_react_native_module"/>

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

@@ -0,0 +1 @@
+React/1.0.0

package/android/src/main/java/com/kaleyra/video_react_native_module/ReactNativeAccessTokenProvider.kt

@@ -0,0 +1,22 @@
+package com.kaleyra.video_react_native_module
+
+import com.kaleyra.video_hybrid_native_bridge.AccessTokenRequest
+import com.kaleyra.video_hybrid_native_bridge.AccessTokenResponse
+import com.kaleyra.video_hybrid_native_bridge.CrossPlatformAccessTokenProvider
+import java.util.UUID
+
+class ReactNativeAccessTokenProvider(private val videoNativeEmitter: VideoNativeEmitter) : CrossPlatformAccessTokenProvider {
+
+  private var tokenCompletion: ((Result<String>) -> Unit)? = null
+
+  override fun provideAccessToken(userId: String, completion: (Result<String>) -> Unit) {
+    videoNativeEmitter.sendAccessTokenRequest(AccessTokenRequest(UUID.randomUUID().toString(), userId))
+    tokenCompletion = completion
+  }
+
+  fun setAccessTokenResponse(accessTokenResponse: AccessTokenResponse) {
+    val tokenCompletion = tokenCompletion ?: return
+    if (accessTokenResponse.success) tokenCompletion(Result.success(accessTokenResponse.data))
+    else tokenCompletion(Result.failure(Throwable(accessTokenResponse.error ?: "error")))
+  }
+}

package/android/src/main/java/com/kaleyra/video_react_native_module/ReactNativeContextContainer.kt

@@ -0,0 +1,9 @@
+package com.kaleyra.video_react_native_module
+
+import android.content.Context
+import com.kaleyra.video_hybrid_native_bridge.ContextContainer
+import com.facebook.react.bridge.ReactApplicationContext
+
+class ReactNativeContextContainer(private val reactContext: ReactApplicationContext) : ContextContainer {
+    override val context: Context get() = reactContext.currentActivity ?: reactContext.applicationContext
+}

package/android/src/main/java/com/kaleyra/video_react_native_module/ReactNativeVideoHybridBridge.kt

@@ -0,0 +1,30 @@
+package com.kaleyra.video_react_native_module
+
+import com.kaleyra.video_hybrid_native_bridge.AccessTokenResponse
+import com.kaleyra.video_hybrid_native_bridge.VideoHybridBridge
+import com.kaleyra.video_hybrid_native_bridge.VideoSDKHybridBridge
+import com.facebook.react.bridge.ReactApplicationContext
+
+class ReactNativeVideoHybridBridge private constructor(
+  override val contextContainer: ReactNativeContextContainer,
+  private val accessTokenProvider: ReactNativeAccessTokenProvider,
+  override val eventsEmitter: VideoNativeEmitter
+) : VideoHybridBridge by VideoSDKHybridBridge(
+  contextContainer = contextContainer,
+  tokenProvider = accessTokenProvider,
+  eventsEmitter = eventsEmitter
+) {
+
+  constructor(
+    reactContext: ReactApplicationContext,
+    videoNativeEmitter: VideoNativeEmitter
+  ) : this(
+    ReactNativeContextContainer(reactContext),
+    ReactNativeAccessTokenProvider(videoNativeEmitter),
+    videoNativeEmitter
+  )
+
+  fun setAccessTokenResponse(accessTokenResponse: AccessTokenResponse) {
+    accessTokenProvider.setAccessTokenResponse(accessTokenResponse)
+  }
+}