@kaleyra/video-react-native-module 1.0.0

package/native-bridge/android/src/main/java/com/kaleyra/video_hybrid_native_bridge/DTOs.kt

@@ -0,0 +1,407 @@
+package com.kaleyra.video_hybrid_native_bridge
+
+data class AccessTokenRequest (
+    val requestID: String,
+    val userID: String
+)
+
+data class AccessTokenResponse (
+    val data: String,
+    val error: String? = null,
+    val requestID: String,
+    val success: Boolean
+)
+
+/**
+ * This class defines the display modes supported per call.
+ */
+enum class CallDisplayMode {
+    Background,
+    Foreground,
+    ForegroundPictureInPicture
+}
+
+/**
+ * Options to be used when creating a call
+ */
+data class CreateCallOptions (
+    /**
+     * Array of callees identifiers to call.
+     */
+    val callees: List<String>,
+
+    /**
+     * Type of call to create
+     */
+    val callType: CallType,
+
+    /**
+     * May have three different values, NONE, AUTOMATIC, MANUAL
+     * <br/>
+     * <br/>
+     * <b><font color="blue">default</font>: none</b>
+     */
+    val recordingType: RecordingType? = null
+)
+
+/**
+ * This class defines the types of calls supported.
+ *
+ * Type of call to create
+ */
+enum class CallType {
+    Audio,
+    AudioUpgradable,
+    AudioVideo
+}
+
+/**
+ * Recording type of the call
+ *
+ * May have three different values, NONE, AUTOMATIC, MANUAL
+ * <br/>
+ * <br/>
+ * <b><font color="blue">default</font>: none</b>
+ */
+enum class RecordingType {
+    Automatic,
+    Manual,
+    None
+}
+
+/**
+ * Generic configuration used for setup
+ */
+data class KaleyraVideoConfiguration (
+    /**
+     * This key will be provided to you by us.
+     */
+    val appID: String,
+
+    /**
+     * This variable defines the environment where you will be sandbox or production.
+     */
+    val environment: Environment,
+
+    /**
+     * Define to customize the iOS configuration
+     */
+    val iosConfig: IosConfiguration? = null,
+
+    /**
+     * Set to true to enable log, default value is false
+     */
+    val logEnabled: Boolean? = null,
+
+    /**
+     * This variable defines the region where you will be europe, india or us.
+     */
+    val region: Region,
+
+    /**
+     * Define the tools to use
+     */
+    val tools: Tools? = null
+)
+
+/**
+ * An environment where your integration will run
+ *
+ * This variable defines the environment where you will be sandbox or production.
+ */
+data class Environment (
+    /**
+     * name of the environment
+     */
+    val name: String
+)
+
+/**
+ * Configuration for iOS platform
+ *
+ * Define to customize the iOS configuration
+ */
+data class IosConfiguration (
+    /**
+     * Specify the callkit configuration to enable the usage and it's behaviour
+     * <br/>
+     * <br/>
+     * <b><font color="blue">default</font>: enabled</b>
+     */
+    val callkit: CallKitConfiguration? = null,
+
+    /**
+     * Specify the voip handling strategy.
+     * <br/>
+     * This allows you to disable or leave the plugin behaviour for handling the voip
+     * notifications.
+     * <br/>
+     * <br/>
+     * <b><font color="blue">default</font>: VoipHandlingStrategy.AUTOMATIC </b>
+     */
+    val voipHandlingStrategy: VoipHandlingStrategy? = null
+)
+
+/**
+ * Configuration for callkit
+ *
+ * Specify the callkit configuration to enable the usage and it's behaviour
+ * <br/>
+ * <br/>
+ * <b><font color="blue">default</font>: enabled</b>
+ */
+data class CallKitConfiguration (
+    /**
+     * The icon resource name to be used in the callkit UI to represent the app
+     * <br/>
+     * <br/>
+     * <b><font color="blue">default</font>: null</b>
+     */
+    val appIconName: String? = null,
+
+    /**
+     * Set to false to disable
+     * <br/>
+     * <br/>
+     * <b><font color="blue">default</font>: true</b>
+     */
+    val enabled: Boolean? = null,
+
+    /**
+     * The ringtone resource name to be used when callkit is launched
+     * <br/>
+     * <br/>
+     * <b><font color="blue">default</font>: system</b>
+     */
+    val ringtoneSoundName: String? = null
+)
+
+/**
+ * This class defines the voip notification strategy per call.
+ *
+ * Specify the voip handling strategy.
+ * <br/>
+ * This allows you to disable or leave the plugin behaviour for handling the voip
+ * notifications.
+ * <br/>
+ * <br/>
+ * <b><font color="blue">default</font>: VoipHandlingStrategy.AUTOMATIC </b>
+ */
+enum class VoipHandlingStrategy {
+    Automatic,
+    Disabled
+}
+
+/**
+ * A region where your integration will run
+ *
+ * This variable defines the region where you will be europe, india or us.
+ */
+data class Region (
+    /**
+     * name of the region
+     */
+    val name: String
+)
+
+/**
+ * Define the tools to use
+ */
+data class Tools (
+    /**
+     * Set to enable the chat feature
+     * <br/>
+     * <br/>
+     * <b><font color="blue">default</font>: no chat</b>
+     */
+    val chat: ChatToolConfiguration? = null,
+
+    /**
+     * Set to true to enable the feedback request after a call ends.
+     * <br/>
+     * <br/>
+     * <b><font color="blue">default</font>: false</b>
+     */
+    val feedback: Boolean? = null,
+
+    /**
+     * Set to true to enable the file sharing feature
+     * <br/>
+     * <br/>
+     * <b><font color="blue">default</font>: false</b>
+     */
+    val fileShare: Boolean? = null,
+
+    /**
+     * Set to enable the screen sharing feature
+     * <br/>
+     * <br/>
+     * <b><font color="blue">default</font>: no screen share</b>
+     */
+    val screenShare: ScreenShareToolConfiguration? = null,
+
+    /**
+     * Set to true to enable the whiteboard feature
+     * <br/>
+     * <br/>
+     * <b><font color="blue">default</font>: false</b>
+     */
+    val whiteboard: Boolean? = null
+)
+
+/**
+ * Chat tool configuration
+ *
+ * Set to enable the chat feature
+ * <br/>
+ * <br/>
+ * <b><font color="blue">default</font>: no chat</b>
+ */
+data class ChatToolConfiguration (
+    /**
+     * Defining this object will enable an option to start an audio call from chat UI
+     */
+    val audioCallOption: AudioCallOptions? = null,
+
+    /**
+     * Defining this object will enable an option to start an audio&video call from chat UI
+     */
+    val videoCallOption: CallOptions? = null
+)
+
+/**
+ * Audio call options used for chat
+ *
+ * Defining this object will enable an option to start an audio call from chat UI
+ */
+data class AudioCallOptions (
+    /**
+     * May have three different values, NONE, AUTOMATIC, MANUAL
+     * <br/>
+     * <br/>
+     * <b><font color="blue">default</font>: none</b>
+     */
+    val recordingType: RecordingType? = null,
+
+    /**
+     * Type of audioCall to launch when an option of the chat is tapped.
+     */
+    val type: AudioCallType
+)
+
+/**
+ * This class defines the types of audio calls supported.
+ *
+ * Type of audioCall to launch when an option of the chat is tapped.
+ */
+enum class AudioCallType {
+    Audio,
+    AudioUpgradable
+}
+
+/**
+ * Options available for a call
+ *
+ * Defining this object will enable an option to start an audio&video call from chat UI
+ */
+data class CallOptions (
+    /**
+     * May have three different values, NONE, AUTOMATIC, MANUAL
+     * <br/>
+     * <br/>
+     * <b><font color="blue">default</font>: none</b>
+     */
+    val recordingType: RecordingType? = null
+)
+
+/**
+ * Screen Share tool configuration
+ *
+ * Set to enable the screen sharing feature
+ * <br/>
+ * <br/>
+ * <b><font color="blue">default</font>: no screen share</b>
+ */
+data class ScreenShareToolConfiguration (
+    /**
+     * Set to true to enable the in app screen share
+     * <br/>
+     * <br/>
+     * <b><font color="blue">default</font>: false</b>
+     */
+    val inApp: Boolean? = null,
+
+    /**
+     * Set to true to enable the whole device screen share
+     * <br/>
+     * <br/>
+     * <b><font color="blue">default</font>: false</b>
+     */
+    val wholeDevice: Boolean? = null
+)
+
+/**
+ * Session
+ */
+data class Session (
+    /**
+     * The user id you want to connect
+     */
+    val userID: String
+)
+
+/**
+ * This is used to define the user details in the call/chat UI
+ */
+data class UserDetails (
+    /**
+     * Email of the user
+     */
+    val email: String? = null,
+
+    /**
+     * First name of the user
+     */
+    val firstName: String? = null,
+
+    /**
+     * Last name of the user
+     */
+    val lastName: String? = null,
+
+    /**
+     * Nickname for the user
+     */
+    val nickName: String? = null,
+
+    /**
+     * Image url to use as placeholder for the user.
+     */
+    val profileImageURL: String? = null,
+
+    /**
+     * User identifier
+     */
+    val userID: String
+)
+
+/**
+ * This is used to display the user details in the call/chat UI
+ */
+data class UserDetailsFormat (
+    /**
+     * Format to be used when displaying an android notification
+     * <br/>
+     * <br/>
+     * <b><font color="blue">default</font>: equals to UserDetailsFormatter.default</b>
+     */
+    val androidNotification: String? = null,
+
+    /**
+     * Format to be used to display a user details on the call/chat UI
+     * <br/>
+     * <br/>
+     * <b><font color="blue">default</font>: ${userAlias}</b>
+     */
+    val default: String
+)

package/native-bridge/android/src/main/java/com/kaleyra/video_hybrid_native_bridge/SDKAccessTokenProviderProxy.kt

@@ -0,0 +1,16 @@
+// Copyright © 2018-2023 Kaleyra S.p.a. All Rights Reserved.
+// See LICENSE for licensing information
+
+package com.kaleyra.video_hybrid_native_bridge
+
+import com.bandyer.android_sdk.client.AccessTokenProvider
+import com.bandyer.android_sdk.client.Completion
+
+internal class SDKAccessTokenProviderProxy(val tokenProvider: CrossPlatformAccessTokenProvider) : AccessTokenProvider {
+    override fun provideAccessToken(userId: String, completion: Completion<String>) {
+        tokenProvider.provideAccessToken(userId) {
+            if (it.isSuccess) completion.success(it.getOrThrow())
+            else completion.error(it.exceptionOrNull() ?: Throwable("connection error"))
+        }
+    }
+}

package/native-bridge/android/src/main/java/com/kaleyra/video_hybrid_native_bridge/VideoHybridBridge.kt

@@ -0,0 +1,21 @@
+// Copyright © 2018-2023 Kaleyra S.p.a. All Rights Reserved.
+// See LICENSE for licensing information
+
+package com.kaleyra.video_hybrid_native_bridge
+
+import com.kaleyra.video_hybrid_native_bridge.configurator.CachedSDKConfigurator
+import com.kaleyra.video_hybrid_native_bridge.connector.CachedUserConnector
+import com.kaleyra.video_hybrid_native_bridge.events.EventsEmitter
+import com.kaleyra.video_hybrid_native_bridge.ui.UserInterfacePresenter
+import com.kaleyra.video_hybrid_native_bridge.user_details.CachedUserDetails
+
+interface VideoHybridBridge : CachedUserConnector, UserInterfacePresenter, CachedUserDetails, CachedSDKConfigurator {
+
+    val contextContainer: ContextContainer
+
+    val tokenProvider: CrossPlatformAccessTokenProvider
+
+    val eventsEmitter: EventsEmitter
+    fun verifyCurrentCall(verify: Boolean)
+    fun handlePushNotificationPayload(payload: String)
+}

package/native-bridge/android/src/main/java/com/kaleyra/video_hybrid_native_bridge/VideoSDKHybridBridge.kt

@@ -0,0 +1,64 @@
+// Copyright © 2018-2023 Kaleyra S.p.a. All Rights Reserved.
+// See LICENSE for licensing information
+
+package com.kaleyra.video_hybrid_native_bridge
+
+import com.bandyer.android_sdk.client.BandyerSDK
+import com.bandyer.android_sdk.client.BandyerSDKInstance
+import com.kaleyra.video_hybrid_native_bridge.configurator.CachedSDKConfigurator
+import com.kaleyra.video_hybrid_native_bridge.configurator.VideoSDKConfigurator
+import com.kaleyra.video_hybrid_native_bridge.connector.VideoSDKCachedUserConnector
+import com.kaleyra.video_hybrid_native_bridge.connector.CachedUserConnector
+import com.kaleyra.video_hybrid_native_bridge.events.EventsEmitter
+import com.kaleyra.video_hybrid_native_bridge.events.EventsReporter
+import com.kaleyra.video_hybrid_native_bridge.events.reporter.SDKEventsReporter
+import com.kaleyra.video_hybrid_native_bridge.repository.VideoHybridBridgeRepository
+import com.kaleyra.video_hybrid_native_bridge.ui.SDKUserInterfacePresenter
+import com.kaleyra.video_hybrid_native_bridge.ui.UserInterfacePresenter
+import com.kaleyra.video_hybrid_native_bridge.user_details.CachedUserDetails
+import com.kaleyra.video_hybrid_native_bridge.user_details.SDKCachedUserDetails
+import kotlinx.coroutines.CoroutineScope
+import kotlinx.coroutines.asCoroutineDispatcher
+import java.util.concurrent.Executors
+
+class VideoSDKHybridBridge(
+  override val contextContainer: ContextContainer,
+  override val tokenProvider: CrossPlatformAccessTokenProvider,
+  override val eventsEmitter: EventsEmitter,
+  private val sdk: BandyerSDKInstance = BandyerSDK.getInstance(),
+  private val presenter: UserInterfacePresenter = SDKUserInterfacePresenter(sdk, contextContainer),
+  private val backgroundScope: CoroutineScope = CoroutineScope(Executors.newSingleThreadExecutor().asCoroutineDispatcher()),
+  private val eventsReporter: EventsReporter = SDKEventsReporter.create(sdk, eventsEmitter, backgroundScope),
+  private val repository: VideoHybridBridgeRepository = VideoHybridBridgeRepository.getInstance(contextContainer.context.applicationContext),
+  private val connector: CachedUserConnector = VideoSDKCachedUserConnector(sdk, repository, tokenProvider, eventsReporter, backgroundScope),
+  private val userDetails: CachedUserDetails = SDKCachedUserDetails(sdk, contextContainer, repository, backgroundScope),
+  private val createCallOptionsProxy: CreateCallOptionsProxy = CreateCallOptionsProxy(),
+  private val configurator: CachedSDKConfigurator = VideoSDKConfigurator(sdk, createCallOptionsProxy, repository, backgroundScope),
+) : VideoHybridBridge,
+    CachedUserConnector by connector,
+    UserInterfacePresenter by presenter,
+    CachedUserDetails by userDetails,
+    CachedSDKConfigurator by configurator {
+
+    override fun handlePushNotificationPayload(payload: String) = sdk.handleNotification(payload.replace("\\", ""))
+
+    override fun reset() {
+        configurator.reset()
+        clearUserCache()
+    }
+
+    override fun clearUserCache() {
+        connector.clearUserCache()
+        removeUserDetails()
+    }
+
+    override fun startCall(callOptions: CreateCallOptions) {
+        createCallOptionsProxy.createCallOptions = callOptions
+        presenter.startCall(callOptions)
+    }
+
+    override fun verifyCurrentCall(verify: Boolean) {
+        val ongoingCall = sdk.callModule?.ongoingCall ?: return
+        sdk.callModule?.setVerified(ongoingCall, verify)
+    }
+}

package/native-bridge/android/src/main/java/com/kaleyra/video_hybrid_native_bridge/configurator/CachedSDKConfigurator.kt

@@ -0,0 +1,15 @@
+// Copyright © 2018-2023 Kaleyra S.p.a. All Rights Reserved.
+// See LICENSE for licensing information
+
+package com.kaleyra.video_hybrid_native_bridge.configurator
+
+import com.kaleyra.video_hybrid_native_bridge.KaleyraVideoConfiguration
+
+interface CachedSDKConfigurator {
+
+    val lastConfiguration: KaleyraVideoConfiguration?
+
+    fun configureBridge(configuration: KaleyraVideoConfiguration)
+
+    fun reset()
+}

package/native-bridge/android/src/main/java/com/kaleyra/video_hybrid_native_bridge/configurator/VideoSDKConfigurator.kt

@@ -0,0 +1,46 @@
+// Copyright © 2018-2023 Kaleyra S.p.a. All Rights Reserved.
+// See LICENSE for licensing information
+
+package com.kaleyra.video_hybrid_native_bridge.configurator
+
+import com.bandyer.android_sdk.client.BandyerSDKInstance
+import com.kaleyra.video_hybrid_native_bridge.KaleyraVideoConfiguration
+import com.kaleyra.video_hybrid_native_bridge.CreateCallOptionsProxy
+import com.kaleyra.video_hybrid_native_bridge.extensions.toSDK
+import com.kaleyra.video_hybrid_native_bridge.repository.ConfigurationEntity
+import com.kaleyra.video_hybrid_native_bridge.repository.VideoHybridBridgeRepository
+import kotlinx.coroutines.CoroutineScope
+import kotlinx.coroutines.launch
+
+internal class VideoSDKConfigurator(
+    private val sdk: BandyerSDKInstance,
+    private val createCallOptionsProxy: CreateCallOptionsProxy,
+    private val repository: VideoHybridBridgeRepository,
+    private val scope: CoroutineScope
+) : CachedSDKConfigurator {
+
+    override var lastConfiguration: KaleyraVideoConfiguration? = null
+
+    override fun configureBridge(configuration: KaleyraVideoConfiguration) {
+        scope.launch {
+            repository.configurationDao().insert(ConfigurationEntity(configuration))
+            sdk.configure(configuration.toSDK(createCallOptionsProxy))
+            lastConfiguration = configuration
+        }
+    }
+
+    override fun reset() {
+        scope.launch {
+            repository.clearAllTables()
+            sdk.reset()
+            lastConfiguration = null
+        }
+    }
+
+    init {
+        scope.launch {
+            lastConfiguration = repository.configurationDao().configuration?.plugin
+        }
+    }
+
+}

package/native-bridge/android/src/main/java/com/kaleyra/video_hybrid_native_bridge/connector/CachedUserConnector.kt

@@ -0,0 +1,15 @@
+// Copyright © 2018-2023 Kaleyra S.p.a. All Rights Reserved.
+// See LICENSE for licensing information
+
+package com.kaleyra.video_hybrid_native_bridge.connector
+
+interface CachedUserConnector {
+
+    val lastConnectedUserId: String?
+
+    fun connect(userID: String)
+
+    fun disconnect()
+
+    fun clearUserCache()
+}

package/native-bridge/android/src/main/java/com/kaleyra/video_hybrid_native_bridge/connector/VideoSDKCachedUserConnector.kt

@@ -0,0 +1,60 @@
+// Copyright © 2018-2023 Kaleyra S.p.a. All Rights Reserved.
+// See LICENSE for licensing information
+
+package com.kaleyra.video_hybrid_native_bridge.connector
+
+import androidx.annotation.VisibleForTesting
+import com.bandyer.android_sdk.client.BandyerSDKInstance
+import com.bandyer.android_sdk.client.Session
+import com.kaleyra.video_hybrid_native_bridge.CrossPlatformAccessTokenProvider
+import com.kaleyra.video_hybrid_native_bridge.SDKAccessTokenProviderProxy
+import com.kaleyra.video_hybrid_native_bridge.events.EventsReporter
+import com.kaleyra.video_hybrid_native_bridge.repository.ConnectedUserEntity
+import com.kaleyra.video_hybrid_native_bridge.repository.VideoHybridBridgeRepository
+import kotlinx.coroutines.CoroutineScope
+import kotlinx.coroutines.launch
+
+internal class VideoSDKCachedUserConnector(
+    private val sdk: BandyerSDKInstance,
+    private val repository: VideoHybridBridgeRepository,
+    private val tokenProvider: CrossPlatformAccessTokenProvider,
+    private val eventsReporter: EventsReporter,
+    private val scope: CoroutineScope
+) : CachedUserConnector {
+
+    override var lastConnectedUserId: String? = null
+
+    @VisibleForTesting
+    internal val accessTokenProviderProxy = SDKAccessTokenProviderProxy(tokenProvider)
+
+    override fun connect(userID: String) {
+        scope.launch {
+            repository.connectedUserDao().insert(ConnectedUserEntity(userID))
+            eventsReporter.start()
+            sdk.connect(Session(userID, accessTokenProviderProxy))
+            lastConnectedUserId = userID
+        }
+    }
+
+    override fun disconnect() {
+        scope.launch {
+            eventsReporter.stop()
+            sdk.disconnect()
+        }
+    }
+
+    override fun clearUserCache() {
+        scope.launch {
+            repository.connectedUserDao().clear()
+            disconnect()
+            sdk.disconnect(true)
+            lastConnectedUserId = null
+        }
+    }
+
+    init {
+        scope.launch {
+            lastConnectedUserId = repository.connectedUserDao().user?.user
+        }
+    }
+}

package/native-bridge/android/src/main/java/com/kaleyra/video_hybrid_native_bridge/events/Events.kt

@@ -0,0 +1,29 @@
+// To parse the JSON, install kotlin's serialization plugin and do:
+//
+// val json   = Json { allowStructuredMapKeys = true }
+// val events = json.parse(Events.serializer(), jsonString)
+
+package com.kaleyra.video_hybrid_native_bridge.events
+
+import kotlinx.serialization.*
+import kotlinx.serialization.json.*
+import kotlinx.serialization.descriptors.*
+import kotlinx.serialization.encoding.*
+
+/**
+ * This enum defines all the events that may be handled
+ * <br/>
+ * <br/>
+ * You can listen to these events via [[BandyerPlugin.on]]
+ */
+@Serializable
+enum class Events(val value: String) {
+    @SerialName("accessTokenRequest") AccessTokenRequest("accessTokenRequest"),
+    @SerialName("callError") CallError("callError"),
+    @SerialName("callModuleStatusChanged") CallModuleStatusChanged("callModuleStatusChanged"),
+    @SerialName("chatError") ChatError("chatError"),
+    @SerialName("chatModuleStatusChanged") ChatModuleStatusChanged("chatModuleStatusChanged"),
+    @SerialName("iOSVoipPushTokenInvalidated") IOSVoipPushTokenInvalidated("iOSVoipPushTokenInvalidated"),
+    @SerialName("iOSVoipPushTokenUpdated") IOSVoipPushTokenUpdated("iOSVoipPushTokenUpdated"),
+    @SerialName("setupError") SetupError("setupError");
+}

package/native-bridge/android/src/main/java/com/kaleyra/video_hybrid_native_bridge/events/EventsEmitter.kt

@@ -0,0 +1,8 @@
+// Copyright © 2018-2023 Kaleyra S.p.a. All Rights Reserved.
+// See LICENSE for licensing information
+
+package com.kaleyra.video_hybrid_native_bridge.events
+
+interface EventsEmitter {
+    fun sendEvent(event: Events, args: Any?)
+}

package/native-bridge/android/src/main/java/com/kaleyra/video_hybrid_native_bridge/events/EventsReporter.kt

@@ -0,0 +1,9 @@
+// Copyright © 2018-2023 Kaleyra S.p.a. All Rights Reserved.
+// See LICENSE for licensing information
+
+package com.kaleyra.video_hybrid_native_bridge.events
+
+interface EventsReporter {
+    fun start()
+    fun stop()
+}