Merge pull request #16 from CleverTap/develop

Develop[VC-473] Release Signed Call React Native SDK v0.0.5.5

Author: ankursaini-clevertap

CHANGELOG.md

@@ -1,6 +1,49 @@
 # Change Log
 
-### Version 0.0.5 (February 08, 2024 )
+### Version 0.0.6 (June 21, 2024)
+
+---
+
+**What's new**
+
+- **[Android Platform]**
+
+  - Supports [Signed Call Android SDK v0.0.5.5](https://repo1.maven.org/maven2/com/clevertap/android/clevertap-signedcall-sdk/0.0.5.5) which is compatible with [CleverTap Android SDK v6.2.0](https://github.com/CleverTap/clevertap-android-sdk/blob/master/docs/CTCORECHANGELOG.md#version-620-april-3-2024).
+  - Enables back button functionality across call screens (incoming, outgoing, and ongoing) to allow users to navigate to other parts of the application while staying on a call.
+  - Adds new public API `SignedCall.getBackToCall()` to navigate the user to the active call.
+  - Adds new public API `SignedCall.getCallState()` to retrieve the current call state.
+  - Supports following new properties to the `initProperties` object which gets passed to the `SignedCall.initialize(initProperties)` method:
+    - The `notificationPermissionRequired` of `boolean` type to make notification permission as optional during the Signed Call initialization on Android 13 and onwards.
+    - The `swipeOffBehaviourInForegroundService` property of custom `SCSwipeOffBehaviour` enum type to define the swipe off behavior for an active call within the foreground service managed by host application. 
+    Please ensure to check the SDK documentation for detailed information on usage of initProperties listed above.
+  - Introduces the following events to the `SignedCall.SignedCallOnCallStatusChanged` listener:
+    - The `CancelledDueToRingTimeout` event which allows to handle the SDK-initiated cancellations due to ring-timeout. This event is reported when the SDK fails to establish communication with the receiver, often due to an offline device or a device with low bandwidth.
+    - The `DeclinedDueToBusyOnVoIP` and `DeclinedDueToBusyOnPSTN`, to differentiate calls declined due to another Signed Call(VoIP) or declined due to a PSTN call respectively.
+  - Exposes `callId` (call-specific identifier) parameter via `CallDetails` object provided in the result of the `SignedCall.SignedCallOnCallStatusChanged` listener. 
+
+- **[iOS Platform]**
+
+  - Supports [Signed Call iOS SDK v0.0.7](https://github.com/CleverTap/clevertap-signedcall-ios-sdk/blob/main/CHANGELOG.md#version-007-march-15-2024) which is compatible with [CleverTap iOS SDK v6.1.0](https://github.com/CleverTap/clevertap-ios-sdk/blob/master/CHANGELOG.md#version-610-february-22-2024).
+  - Supports [Socket.io v16.1.0](https://github.com/socketio/socket.io-client-swift/releases/tag/v16.1.0) and [Starscream v4.0.8](https://github.com/daltoniam/Starscream/releases/tag/4.0.8) dependency.
+  - Adds privacy manifest.
+  - Expose socket usage logging for debugging purpose.  
+
+**Behaviour Changes**
+
+- **[Android Platform]**
+
+  - Adds heads up behaviour to the call-notifications to prompt the user every time the call-screen goes invisible, triggered by either a back button press or putting the app in the background. The heads up notifications allow users to return to the call interface by tapping on the notification.
+  - Improved Bluetooth audio experience during calls. Dial tone of an outgoing call will now play through the connected Bluetooth headset instead of the internal speaker.
+  Note: The SDK requires the runtime [BLUETOOTH_CONNECT](https://developer.android.com/reference/android/Manifest.permission#BLUETOOTH_CONNECT) permission for Android 12 and onwards to enable the Bluetooth management during calls.
+
+**Bug Fixes**
+
+- **[Android Platform]**
+
+  - Resolves an intermittent issue where the dialing tone at the initiator's side of the call plays on the loudspeaker instead of the internal speaker.
+  - Resolves NPE crash occurring when calls are simultaneously initiated to each other, which disrupts the order of signals exchanged between participants.
+
+### Version 0.0.5 (February 08, 2024)
 
 ---
 
@@ -10,9 +53,7 @@
 
   - Supports [Signed Call Android SDK v0.0.5](https://repo1.maven.org/maven2/com/clevertap/android/clevertap-signedcall-sdk/0.0.5) which is compatible with [CleverTap Android SDK v5.2.2](https://github.com/CleverTap/clevertap-android-sdk/blob/master/docs/CTCORECHANGELOG.md#version-522-december-22-2023).
   - Introduces new properties `initiatorImage` and `receiverImage` in the `MissedCallActionClickResult` instance provided through the `SignedCall.addListener(SignedCall.SignedCallOnMissedCallActionClicked,(result:MissedCallActionClickResult) => {})` listener.
-  - Introduces a new public API: `SignedCallOnCallStatusListener.register(applicationContext)`. This API allows your application to receive VoIP call events through the `SignedCall.SignedCallOnCallStatusChanged` listener even when the app is in a killed state.
-      
-      For detailed integration instructions, please refer to the documentation.
+  - Introduces a new public API: `SignedCallOnCallStatusListener.register(applicationContext)`. This API allows your application to receive VoIP call events through the `SignedCall.SignedCallOnCallStatusChanged` listener even when the app is in a killed state. For detailed integration instructions, please refer to the documentation.
 
 - **[iOS Platform]**
   - Supports [Signed Call iOS SDK v0.0.6](https://github.com/CleverTap/clevertap-signedcall-ios-sdk/blob/main/CHANGELOG.md#version-006-january-19-2024) which is compatible with [CleverTap iOS SDK v5.2.2](https://github.com/CleverTap/clevertap-ios-sdk/blob/master/CHANGELOG.md#version-522-november-21-2023).

android/build.gradle

@@ -73,8 +73,8 @@ dependencies {
   implementation "org.jetbrains.kotlin:kotlin-stdlib:$kotlin_version"
   //Required dependencies for Signed Call Android SDK
   implementation 'androidx.constraintlayout:constraintlayout:2.1.3'
-  compileOnly "com.clevertap.android:clevertap-android-sdk:5.2.2"
-  compileOnly "com.clevertap.android:clevertap-signedcall-sdk:0.0.5"
+  compileOnly "com.clevertap.android:clevertap-android-sdk:6.2.0"
+  compileOnly "com.clevertap.android:clevertap-signedcall-sdk:0.0.5.5"
   compileOnly 'androidx.work:work-runtime:2.7.1'
   compileOnly('io.socket:socket.io-client:2.1.0') {
     exclude group: 'org.json', module: 'json'

android/src/main/java/com/clevertap/rnsignedcallandroid/CleverTapSignedCallModule.kt

@@ -13,6 +13,7 @@ import com.clevertap.rnsignedcallandroid.internal.Events.ON_CALL_STATUS_CHANGED
 import com.clevertap.rnsignedcallandroid.internal.Events.ON_MISSED_CALL_ACTION_CLICKED
 import com.clevertap.rnsignedcallandroid.internal.events.EventEmitter
 import com.clevertap.rnsignedcallandroid.internal.util.InitConfigSerializer.getInitConfigFromReadableMap
+import com.clevertap.rnsignedcallandroid.internal.util.PayloadConverter.formattedCallState
 import com.clevertap.rnsignedcallandroid.internal.util.PayloadConverter.signedCallResponseToWritableMap
 import com.clevertap.rnsignedcallandroid.internal.util.PayloadConverter.toSignedCallLogLevel
 import com.clevertap.rnsignedcallandroid.internal.util.PayloadConverter.toWriteableMap
@@ -101,7 +102,7 @@ class CleverTapSignedCallModule(private val reactContext: ReactApplicationContex
       try {
         val initConfiguration: SignedCallInitConfiguration? = getInitConfigFromReadableMap(it)
         signedCallAPI.init(
-            reactContext,
+            reactContext.applicationContext,
             initConfiguration,
             cleverTapAPI,
             object : SignedCallInitResponse {
@@ -155,6 +156,26 @@ class CleverTapSignedCallModule(private val reactContext: ReactApplicationContex
     }
   }
 
+  /**
+   * Attempts to return to the active call screen.
+   *
+   * This method checks if there is an active call and if the client is on VoIP call.
+   * If both conditions are met, it starts the call screen activity.
+   */
+  @ReactMethod
+  fun getBackToCall(promise: Promise) {
+    promise.resolve(getSignedCallAPI().callController?.getBackToCall(reactContext))
+  }
+
+  /**
+   * Retrieves the current call state.
+   * @return The current call state.
+   */
+  @ReactMethod
+  fun getCallState(promise: Promise) {
+    promise.resolve(getSignedCallAPI().callController?.callState?.formattedCallState())
+  }
+
   /** Logs out the Signed Call SDK session */
   @ReactMethod
   fun logout() {

android/src/main/java/com/clevertap/rnsignedcallandroid/internal/util/Constants.kt

@@ -12,6 +12,10 @@ object Constants {
   const val KEY_PROMPT_PUSH_PRIMER = "promptPushPrimer"
   const val KEY_PROMPT_RECEIVER_READ_PHONE_STATE_PERMISSION =
     "promptReceiverReadPhoneStatePermission"
+  const val KEY_NOTIFICATION_PERMISSION_REQUIRED =
+    "notificationPermissionRequired"
+  const val KEY_SWIPE_OFF_BEHAVIOUR_IN_FOREGROUND_SERVICE =
+    "swipeOffBehaviourInForegroundService"
   const val KEY_OVERRIDE_DEFAULT_BRANDING = "overrideDefaultBranding"
   const val KEY_MISSED_CALL_ACTIONS = "missedCallActions"
   const val KEY_BG_COLOR = "bgColor"
@@ -31,6 +35,7 @@ object Constants {
   const val KEY_ACTION_ID = "actionId"
   const val KEY_ACTION_LABEL = "actionLabel"
   const val KEY_CALL_DETAILS = "callDetails"
+  const val KEY_CALL_ID = "callId"
   const val KEY_CALLER_CUID = "callerCuid"
   const val KEY_CALLEE_CUID = "calleeCuid"
   const val KEY_IS_SUCCESSFUL = "isSuccessful"

android/src/main/java/com/clevertap/rnsignedcallandroid/internal/util/InitConfigSerializer.kt

@@ -1,6 +1,7 @@
 package com.clevertap.rnsignedcallandroid.internal.util
 
 import com.clevertap.android.signedcall.init.SignedCallInitConfiguration
+import com.clevertap.android.signedcall.init.SignedCallInitConfiguration.SCSwipeOffBehaviour
 import com.clevertap.android.signedcall.models.MissedCallAction
 import com.clevertap.android.signedcall.models.SignedCallScreenBranding
 import com.clevertap.rnsignedcallandroid.internal.handlers.MissedCallActionClickHandler
@@ -101,6 +102,24 @@ object InitConfigSerializer {
     }
   }
 
+  /**
+   * Retrieves the swipeOffBehaviour from the given initProperties object and parses to the instance of [SCSwipeOffBehaviour]
+   */
+  @JvmStatic
+  @Throws(Exception::class)
+  fun getSwipeOffBehaviourFromReadableConfig(readableMap: ReadableMap): SCSwipeOffBehaviour {
+    val swipeOffBehaviour: String? = readableMap.getValue(Constants.KEY_SWIPE_OFF_BEHAVIOUR_IN_FOREGROUND_SERVICE)
+    swipeOffBehaviour?.let {
+      return if (it == "EndCall") {
+        SCSwipeOffBehaviour.END_CALL
+      } else {
+        SCSwipeOffBehaviour.PERSIST_CALL
+      }
+    } ?: run {
+      return SCSwipeOffBehaviour.END_CALL
+    }
+  }
+
   /**
    * Retrieves the initConfiguration from the input initProperties object and
    * parses into the [SignedCallInitConfiguration] object.
@@ -134,12 +153,19 @@ object InitConfigSerializer {
           parsePushPrimerConfigFromInitOptions(pushPrimerReadableConfig)
         }
 
+        val notificationPermissionRequired: Boolean = getValue(Constants.KEY_NOTIFICATION_PERMISSION_REQUIRED) ?: true
+
+        val swipeOffBehaviour: SCSwipeOffBehaviour = getSwipeOffBehaviourFromReadableConfig(readableMap)
+
         initConfiguration =
           SignedCallInitConfiguration.Builder(initOptions, allowPersistSocketConnection)
             .promptPushPrimer(pushPrimerJson)
             .promptReceiverReadPhoneStatePermission(promptReceiverReadPhoneStatePermission)
+            .setNotificationPermissionRequired(notificationPermissionRequired)
             .overrideDefaultBranding(callScreenBranding)
-            .setMissedCallActions(missedCallActionsList, missedCallActionClickHandlerPath).build()
+            .setMissedCallActions(missedCallActionsList, missedCallActionClickHandlerPath)
+            .setSwipeOffBehaviourInForegroundService(swipeOffBehaviour)
+            .build()
       } catch (throwable: Throwable) {
         log(message = "issue occurs while de-serializing the initProperties: ${throwable.localizedMessage}")
         throwable.printStackTrace()

android/src/main/java/com/clevertap/rnsignedcallandroid/internal/util/PayloadConverter.kt

@@ -1,5 +1,6 @@
 package com.clevertap.rnsignedcallandroid.internal.util
 
+import com.clevertap.android.signedcall.enums.SCCallState
 import com.clevertap.android.signedcall.enums.VoIPCallStatus
 import com.clevertap.android.signedcall.exception.BaseException
 import com.clevertap.android.signedcall.init.SignedCallAPI
@@ -81,7 +82,7 @@ internal object PayloadConverter {
    *
    * @return A formatted call event string.
    */
-  private fun VoIPCallStatus.formattedCallEvent(): String {
+  private fun VoIPCallStatus.formattedCallEvent(): String? {
     return when (this) {
       VoIPCallStatus.CALL_IS_PLACED -> "CallIsPlaced"
       VoIPCallStatus.CALL_CANCELLED -> "Cancelled"
@@ -94,6 +95,25 @@ internal object PayloadConverter {
       VoIPCallStatus.CALL_DECLINED_DUE_TO_LOGGED_OUT_CUID -> "DeclinedDueToLoggedOutCuid"
       VoIPCallStatus.CALL_DECLINED_DUE_TO_NOTIFICATIONS_DISABLED -> "DeclinedDueToNotificationsDisabled"
       VoIPCallStatus.CALLEE_MICROPHONE_PERMISSION_NOT_GRANTED -> "DeclinedDueToMicrophonePermissionsNotGranted"
+      VoIPCallStatus.CALL_DECLINED_DUE_TO_BUSY_ON_VOIP -> "DeclinedDueToBusyOnVoIP"
+      VoIPCallStatus.CALL_DECLINED_DUE_TO_BUSY_ON_PSTN -> "DeclinedDueToBusyOnPSTN"
+      VoIPCallStatus.CALL_CANCELLED_DUE_TO_RING_TIMEOUT -> "CancelledDueToRingTimeout"
+      else -> null
+    }
+  }
+
+  /**
+   * Converts [SCCallState] to a formatted string.
+   *
+   * @return A formatted call state string.
+   */
+  fun SCCallState.formattedCallState(): String? {
+    return when (this) {
+      SCCallState.OUTGOING_CALL -> "OutgoingCall"
+      SCCallState.INCOMING_CALL -> "IncomingCall"
+      SCCallState.ONGOING_CALL -> "OngoingCall"
+      SCCallState.NO_CALL -> "NoCall"
+      else -> null
     }
   }
 
@@ -104,6 +124,7 @@ internal object PayloadConverter {
    */
   fun CallDetails.toWriteableMap(): WritableMap {
     return Arguments.createMap().apply {
+      putString(Constants.KEY_CALL_ID, (callId))
       putString(Constants.KEY_CALLER_CUID, (callerCuid ?: ""))
       putString(Constants.KEY_CALLEE_CUID, (calleeCuid ?: ""))
       putString(Constants.KEY_CALL_CONTEXT, (callContext ?: ""))

clevertap-signed-call-react-native.podspec

@@ -10,7 +10,7 @@ Pod::Spec.new do |s|
   s.homepage     = package["homepage"]
   s.license      = package["license"]
   s.authors      = package["author"]
-
+c
   s.platforms    = { :ios => "10.0" }
   s.source       = { :git => "https://github.com/CleverTap/clevertap-signed-call-react-native-sdk.git", :tag => "#{s.version}" }
 
@@ -22,7 +22,7 @@ Pod::Spec.new do |s|
   s.requires_arc = true
 
   s.dependency 'React', '>= 0.13.0', '< 1.0.0'
-  s.dependency 'CleverTap-SignedCall-SDK', '0.0.6'
+  s.dependency 'CleverTap-SignedCall-SDK', '0.0.7'
 
   # Don't install the dependencies when we run `pod install` in the old architecture.
   if ENV['RCT_NEW_ARCH_ENABLED'] == '1' then

example/android/app/build.gradle

@@ -1,5 +1,6 @@
 apply plugin: "com.android.application"
 apply plugin: 'com.google.gms.google-services'
+apply plugin: 'com.google.firebase.crashlytics'
 
 import com.android.build.OutputFile
 
@@ -254,9 +255,10 @@ dependencies {
     //noinspection GradleDynamicVersion
     implementation "com.facebook.react:react-native:+"  // From node_modules
 
-    implementation "com.clevertap.android:clevertap-android-sdk:5.2.2"
-
-    implementation "com.clevertap.android:clevertap-signedcall-sdk:0.0.5"
+    implementation "com.clevertap.android:clevertap-android-sdk:6.2.0"
+    implementation 'com.google.firebase:firebase-crashlytics'
+    implementation "com.clevertap.android:clevertap-signedcall-sdk:0.0.5.5"
+    // implementation project (":clevertap-signedcall")
     implementation('io.socket:socket.io-client:2.1.0') {
       exclude group: 'org.json', module: 'json'
     }

example/android/app/src/main/AndroidManifest.xml

@@ -2,6 +2,7 @@
   package="com.example.rnsignedcall">
 
     <uses-permission android:name="android.permission.INTERNET" />
+    <uses-permission android:name="android.permission.FOREGROUND_SERVICE"/>
 
     <application
       android:name=".MainApplication"
@@ -15,7 +16,7 @@
         android:label="@string/app_name"
         android:icon="@mipmap/app_logo"
         android:configChanges="keyboard|keyboardHidden|orientation|screenLayout|screenSize|smallestScreenSize|uiMode"
-        android:launchMode="singleTask"
+        android:launchMode="standard"
         android:windowSoftInputMode="adjustResize"
         android:exported="true">
         <intent-filter>
@@ -36,12 +37,14 @@
       <!-- CleverTap Account Credentials -->
              <meta-data
             android:name="CLEVERTAP_ACCOUNT_ID"
-            android:value="679-8Z7-W66Z"/>
+            android:value="CLEVERTAP_ACCOUNT_ID"/>
         <meta-data
             android:name="CLEVERTAP_TOKEN"
-            android:value="a1b-ca6"/>
+            android:value="CLEVERTAP_TOKEN"/>
         <meta-data
             android:name="CLEVERTAP_REGION"
-            android:value="sk1"/>
+            android:value="CLEVERTAP_REGION"/>
+
+      <service android:name="com.voximplant.foregroundservice.VIForegroundService"> </service>
     </application>
 </manifest>

example/android/build.gradle

@@ -24,6 +24,7 @@ buildscript {
         classpath("com.facebook.react:react-native-gradle-plugin")
         classpath("de.undercouch:gradle-download-task:5.0.1")
         classpath 'com.google.gms:google-services:4.3.3'
+        classpath 'com.google.firebase:firebase-crashlytics-gradle:2.9.0'
       // NOTE: Do not place your application dependencies here; they belong
         // in the individual module build.gradle files
     }

example/android/settings.gradle

@@ -1,6 +1,6 @@
 rootProject.name = 'ClevertapSignedCallReactNativeExample'
 apply from: file("../node_modules/@react-native-community/cli-platform-android/native_modules.gradle"); applyNativeModulesSettingsGradle(settings)
-include ':app'
+include ':app', ':clevertap-signedcall'
 includeBuild('../node_modules/react-native-gradle-plugin')
 
 if (settings.hasProperty("newArchEnabled") && settings.newArchEnabled == "true") {
@@ -9,3 +9,5 @@ if (settings.hasProperty("newArchEnabled") && settings.newArchEnabled == "true")
     include(":ReactAndroid:hermes-engine")
     project(":ReactAndroid:hermes-engine").projectDir = file('../node_modules/react-native/ReactAndroid/hermes-engine')
 }
+
+project(':clevertap-signedcall').projectDir = new File('<path>')

example/firebase.json

@@ -0,0 +1,6 @@
+{
+  "react-native": {
+    "crashlytics_auto_collection_enabled": true,
+    "crashlytics_debug_enabled": true
+  }
+}