@zelloptt/react-native-zello-sdk 0.3.2 → 0.4.0

package/README.md

@@ -23,7 +23,20 @@ npm install @zelloptt/react-native-zello-sdk
 
 ### iOS
 
-Please reference the iOS Installation Guide.
+Before getting started, please reference the iOS Installation Guide.
+
+#### Troubleshooting
+
+While setting up your Notification Service Extension, you may receive an error:
+
+```
+Cycle inside YourApp; building could produce unreliable results.
+Cycle details:
+→ Target ‘YourApp’
+○ That command depends on command in Target ‘YourApp’: script phase “[CP-User] [RNFB] Core Configuration”
+```
+
+If you receive the above error, you should move the `Build Phases` phase named `Embed Foundation Extensions` to higher up in the order.
 
 ### Android
 

package/android/build.gradle

@@ -102,6 +102,8 @@ repositories {
 
 def kotlin_version = getExtOrDefault("kotlinVersion")
 
+def zelloSdkVersion = "0.4.0"
+
 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
@@ -110,9 +112,9 @@ dependencies {
   implementation "org.jetbrains.kotlin:kotlin-stdlib:$kotlin_version"
 
   // Required Dependencies to use the Zello SDK
-  api("com.zello:sdk:0.3.1")
-  api("com.zello:zello:0.3.1")
-  api("com.zello:core:0.3.1") {
+  api("com.zello:sdk:$zelloSdkVersion")
+  api("com.zello:zello:$zelloSdkVersion")
+  api("com.zello:core:$zelloSdkVersion") {
     exclude module: "unspecified"
   }
   implementation(platform("com.google.firebase:firebase-bom:33.1.2"))

package/android/src/main/java/com/zellosdk/ZelloAndroidSdkModule.kt

@@ -17,6 +17,7 @@ import com.zello.sdk.ZelloAlertMessage
 import com.zello.sdk.ZelloConnectionError
 import com.zello.sdk.ZelloContact
 import com.zello.sdk.ZelloCredentials
+import com.zello.sdk.ZelloDispatchChannel
 import com.zello.sdk.ZelloHistoryImageMessage
 import com.zello.sdk.ZelloHistoryVoiceMessage
 import com.zello.sdk.ZelloImageMessage
@@ -26,6 +27,8 @@ import com.zello.sdk.ZelloLocationMessage
 import com.zello.sdk.ZelloOutgoingEmergency
 import com.zello.sdk.ZelloOutgoingVoiceMessage
 import com.zello.sdk.ZelloRecentEntry
+import com.zello.sdk.ZelloConsoleSettings
+import com.zello.sdk.ZelloState
 import com.zello.sdk.ZelloTextMessage
 import javax.inject.Inject
 
@@ -177,6 +180,16 @@ class ZelloAndroidSdkModule @Inject constructor(
     }
   }
 
+  @ReactMethod
+  fun endDispatchCall(channelName: String) {
+    val dispatchChannel = zello.getChannel(channelName) as? ZelloDispatchChannel ?: return
+    val call = dispatchChannel.currentCall ?: return
+    zello.endDispatchCall(call, dispatchChannel)
+  }
+
+  override fun onStateChanged(sdk: Zello, state: ZelloState) {
+  }
+
   override fun onConnectFailed(zello: Zello, error: ZelloConnectionError) {
     sendEvent(reactApplicationContext, "onConnectFailed", Arguments.createMap().apply {
       putString("error", error.toString())
@@ -429,6 +442,38 @@ class ZelloAndroidSdkModule @Inject constructor(
     sendEvent(reactApplicationContext, "onHistoryUpdated", null)
   }
 
+  override fun onConsoleSettingsChanged(zello: Zello, settings: ZelloConsoleSettings) {
+    sendEvent(reactApplicationContext, "onConsoleSettingsChanged", ZelloAndroidSdkModuleHelper.consoleSettingsToWritableMap(settings))
+  }
+
+  override fun onDispatchCallPending(zello: Zello, channel: ZelloDispatchChannel, call: ZelloDispatchChannel.Call) {
+    sendEvent(reactApplicationContext, "onDispatchCallPending", Arguments.createMap().apply {
+      putMap("call", ZelloAndroidSdkModuleHelper.callToWritableMap(call))
+      putMap("channel", ZelloAndroidSdkModuleHelper.sdkContactToWritableMap(channel))
+    })
+  }
+
+  override fun onDispatchCallActive(zello: Zello, channel: ZelloDispatchChannel, call: ZelloDispatchChannel.Call) {
+    sendEvent(reactApplicationContext, "onDispatchCallActive", Arguments.createMap().apply {
+      putMap("call", ZelloAndroidSdkModuleHelper.callToWritableMap(call))
+      putMap("channel", ZelloAndroidSdkModuleHelper.sdkContactToWritableMap(channel))
+    })
+  }
+
+  override fun onDispatchCallTransferred(zello: Zello, channel: ZelloDispatchChannel, call: ZelloDispatchChannel.Call) {
+    sendEvent(reactApplicationContext, "onDispatchCallTransferred", Arguments.createMap().apply {
+      putMap("call", ZelloAndroidSdkModuleHelper.callToWritableMap(call))
+      putMap("channel", ZelloAndroidSdkModuleHelper.sdkContactToWritableMap(channel))
+    })
+  }
+
+  override fun onDispatchCallEnded(zello: Zello, channel: ZelloDispatchChannel, call: ZelloDispatchChannel.Call) {
+    sendEvent(reactApplicationContext, "onDispatchCallEnded", Arguments.createMap().apply {
+      putMap("call", ZelloAndroidSdkModuleHelper.callToWritableMap(call))
+      putMap("channel", ZelloAndroidSdkModuleHelper.sdkContactToWritableMap(channel))
+    })
+  }
+
   private fun sendEvent(reactContext: ReactContext, name: String, params: WritableMap?) {
     reactContext
       .getJSModule(DeviceEventManagerModule.RCTDeviceEventEmitter::class.java)

package/android/src/main/java/com/zellosdk/ZelloAndroidSdkModuleHelper.kt

@@ -7,7 +7,9 @@ import com.facebook.react.bridge.WritableMap
 import com.facebook.react.bridge.WritableNativeArray
 import com.facebook.react.bridge.WritableNativeMap
 import com.zello.sdk.ZelloChannel
+import com.zello.sdk.ZelloConsoleSettings
 import com.zello.sdk.ZelloContact
+import com.zello.sdk.ZelloDispatchChannel
 import com.zello.sdk.ZelloHistoryAlertMessage
 import com.zello.sdk.ZelloHistoryImageMessage
 import com.zello.sdk.ZelloHistoryLocationMessage
@@ -64,6 +66,12 @@ object ZelloAndroidSdkModuleHelper {
 					putBoolean("allowTextMessages", options.allowTextMessages)
 					putBoolean("allowLocations", options.allowLocations)
 				})
+				if (contact is ZelloDispatchChannel) {
+					putBoolean("isDispatchChannel", true)
+					contact.currentCall?.let { call ->
+						putMap("currentCall", callToWritableMap(call))
+					}
+				}
 			}
 
 			else -> WritableNativeMap()
@@ -195,4 +203,19 @@ object ZelloAndroidSdkModuleHelper {
 			putString("address", message.address)
 		}
 	}
+
+	fun consoleSettingsToWritableMap(settings: ZelloConsoleSettings): WritableMap {
+		return Arguments.createMap().apply {
+			putBoolean("allowNonDispatchersToEndCalls", settings.allowNonDispatchersToEndCalls)
+		}
+	}
+
+	fun callToWritableMap(call: ZelloDispatchChannel.Call): WritableMap {
+		return Arguments.createMap().apply {
+			putInt("id", call.id.toInt())
+			putString("status", call.status.toString())
+			putString("dispatcher", call.dispatcher)
+			putString("timestamp", call.timestamp.toString())
+		}
+	}
 }

package/ios/Extensions/ZelloConsoleSettings+Extension.swift

@@ -0,0 +1,9 @@
+import ZelloSDK
+
+extension ZelloConsoleSettings {
+  var jsonDictionary: [AnyHashable: Any] {
+    return [
+      "allowNonDispatchersToEndCalls": allowsNonDispatchersToEndCalls
+    ]
+  }
+}

package/ios/Extensions/ZelloContact+Extension.swift

@@ -13,7 +13,7 @@ extension ZelloContact {
 
 extension ZelloChannel {
   var jsonDictionary: [AnyHashable: Any] {
-    return [
+    var body: [AnyHashable: Any] = [
       "name": name,
       "isChannel": true,
       "isMuted": isMuted,
@@ -27,8 +27,13 @@ extension ZelloChannel {
         "allowAlerts": channelOptions.allowAlerts,
         "allowTextMessages": channelOptions.allowTextMessages,
         "allowLocations": channelOptions.allowLocations
-      ]
+      ],
+      "isDispatchChannel": dispatchInfo != nil
     ]
+    if let currentCall = dispatchInfo?.currentCall {
+      body["currentCall"] = currentCall.jsonDictionary
+    }
+    return body
   }
 }
 

package/ios/Extensions/ZelloDispatchCall+Extension.swift

@@ -0,0 +1,13 @@
+import ZelloSDK
+
+extension ZelloDispatchCall {
+  var jsonDictionary: [AnyHashable: Any] {
+    var body: [AnyHashable: Any] = [
+      "status": status.rawValue,
+    ]
+    if let dispatcher = dispatcher {
+      body["dispatcher"] = dispatcher
+    }
+    return body
+  }
+}

package/ios/Extensions/ZelloIOSSdkModule+Extension.swift

@@ -279,7 +279,43 @@ extension ZelloIOSSdkModule: Zello.Delegate {
     sendSdkEvent(withName: "onHistoryPlaybackStarted", body: message.jsonDictionary)
   }
 
-  func zello(_ zello: Zello, didStopHistoryPlayback message: ZelloHistoryVoiceMessage) {
+  func zello(_ zello: Zello, didFinishHistoryPlayback message: ZelloHistoryVoiceMessage) {
     sendSdkEvent(withName: "onHistoryPlaybackStopped", body: message.jsonDictionary)
   }
+
+  func zello(_ zello: Zello, callDidBecomePending call: ZelloDispatchCall, on channel: ZelloChannel) {
+    let body: [AnyHashable: Any] = [
+      "call": call.jsonDictionary,
+      "channel": channel.jsonDictionary
+    ]
+    sendSdkEvent(withName: "onDispatchCallPending", body: body)
+  }
+
+  func zello(_ zello: Zello, callDidEnd call: ZelloDispatchCall, on channel: ZelloChannel) {
+    let body: [AnyHashable: Any] = [
+      "call": call.jsonDictionary,
+      "channel": channel.jsonDictionary
+    ]
+    sendSdkEvent(withName: "onDispatchCallEnded", body: body)
+  }
+
+  func zello(_ zello: Zello, callDidBecomeActive call: ZelloDispatchCall, on channel: ZelloChannel) {
+    let body: [AnyHashable: Any] = [
+      "call": call.jsonDictionary,
+      "channel": channel.jsonDictionary
+    ]
+    sendSdkEvent(withName: "onDispatchCallActive", body: body)
+  }
+
+  func zello(_ zello: Zello, callDidTransfer call: ZelloDispatchCall, on channel: ZelloChannel, toDispatcherNamed dispatcher: String) {
+    let body: [AnyHashable: Any] = [
+      "call": call.jsonDictionary,
+      "channel": channel.jsonDictionary
+    ]
+    sendSdkEvent(withName: "onDispatchCallTransferred", body: body)
+  }
+
+  func zello(_ zello: Zello, didUpdate consoleSettings: ZelloConsoleSettings) {
+    sendSdkEvent(withName: "onConsoleSettingsChanged", body: consoleSettings.jsonDictionary)
+  }
 }

package/ios/ZelloIOSSdkModule.swift

@@ -12,8 +12,13 @@ import ZelloSDK
     zello.delegate = self
   }
 
-  @objc func configure(_ isDebugBuild: Bool) {
-    zello.configure(isDebugBuild: isDebugBuild)
+  @objc func configure(_ isDebugBuild: Bool, appGroup: String) {
+    var group: String? = appGroup
+    if appGroup.isEmpty {
+      group = nil
+    }
+    var configuration = ZelloConfiguration(appGroup: group)
+    configuration.pushNotificationEnvironment = isDebugBuild ? .development : .production
   }
 
   @objc func connect(_ network: String, username: String, password: String) {
@@ -189,6 +194,16 @@ import ZelloSDK
     }
     callback([base64String])
   }
+
+  @objc func endDispatchCall(_ channelName: String) {
+    guard 
+      let dispatchChannel = zello.channel(named: channelName),
+      let call = dispatchChannel.dispatchInfo?.currentCall
+    else {
+      return
+    }
+    zello.end(call, on: dispatchChannel)
+  }
 }
 
 extension ZelloIOSSdkModule {

package/ios/ZelloIOSSdkModuleBridge.m

@@ -2,7 +2,7 @@
 
 @interface RCT_EXTERN_MODULE(ZelloIOSSdkModule, NSObject)
 
-RCT_EXTERN_METHOD(configure:(BOOL)isDebugBuild)
+RCT_EXTERN_METHOD(configure:(BOOL)isDebugBuild appGroup:(NSString *)appGroup)
 
 RCT_EXTERN_METHOD(connect:(NSString *)network username:(NSString *)username password:(NSString *)password)
 RCT_EXTERN_METHOD(disconnect)
@@ -41,4 +41,6 @@ RCT_EXTERN_METHOD(stopHistoryMessagePlayback)
 
 RCT_EXTERN_METHOD(getHistoryImageData:(NSString *)historyId contactName:(NSString *)contactName isChannel:(BOOL)isChannel callback:(RCTResponseSenderBlock)callback)
 
+RCT_EXTERN_METHOD(endDispatchCall:(NSString *)channelName)
+
 @end

package/lib/commonjs/docs/assets/highlight.css

@@ -7,12 +7,14 @@
     --dark-hl-2: #CE9178;
     --light-hl-3: #001080;
     --dark-hl-3: #9CDCFE;
-    --light-hl-4: #008000;
-    --dark-hl-4: #6A9955;
-    --light-hl-5: #000000;
-    --dark-hl-5: #C8C8C8;
-    --light-hl-6: #0000FF;
-    --dark-hl-6: #569CD6;
+    --light-hl-4: #000000;
+    --dark-hl-4: #C8C8C8;
+    --light-hl-5: #0000FF;
+    --dark-hl-5: #569CD6;
+    --light-hl-6: #0070C1;
+    --dark-hl-6: #4FC1FF;
+    --light-hl-7: #008000;
+    --dark-hl-7: #6A9955;
     --light-code-background: #FFFFFF;
     --dark-code-background: #1E1E1E;
 }
@@ -25,6 +27,7 @@
     --hl-4: var(--light-hl-4);
     --hl-5: var(--light-hl-5);
     --hl-6: var(--light-hl-6);
+    --hl-7: var(--light-hl-7);
     --code-background: var(--light-code-background);
 } }
 
@@ -36,6 +39,7 @@
     --hl-4: var(--dark-hl-4);
     --hl-5: var(--dark-hl-5);
     --hl-6: var(--dark-hl-6);
+    --hl-7: var(--dark-hl-7);
     --code-background: var(--dark-code-background);
 } }
 
@@ -47,6 +51,7 @@
     --hl-4: var(--light-hl-4);
     --hl-5: var(--light-hl-5);
     --hl-6: var(--light-hl-6);
+    --hl-7: var(--light-hl-7);
     --code-background: var(--light-code-background);
 }
 
@@ -58,6 +63,7 @@
     --hl-4: var(--dark-hl-4);
     --hl-5: var(--dark-hl-5);
     --hl-6: var(--dark-hl-6);
+    --hl-7: var(--dark-hl-7);
     --code-background: var(--dark-code-background);
 }
 
@@ -68,4 +74,5 @@
 .hl-4 { color: var(--hl-4); }
 .hl-5 { color: var(--hl-5); }
 .hl-6 { color: var(--hl-6); }
+.hl-7 { color: var(--hl-7); }
 pre, code { background: var(--code-background); }

package/lib/commonjs/docs/assets/main.js

@@ -1403,7 +1403,7 @@ window.translations = {
   function be(t, e, n) {
     if (t.path) {
       let r = e.appendChild(document.createElement("a"));
-      r.href = K + t.path, n && (r.className = n), location.pathname === r.pathname && r.classList.add("current"), t.kind && (r.innerHTML = `<svg width="20" height="20" viewBox="0 0 24 24" fill="none" class="tsd-kind-icon"><use href="#icon-${t.kind}"></use></svg>`), r.appendChild(document.createElement("span")).textContent = t.text;
+      r.href = K + t.path, n && (r.className = n), location.pathname === r.pathname && !r.href.includes("#") && r.classList.add("current"), t.kind && (r.innerHTML = `<svg width="20" height="20" viewBox="0 0 24 24" fill="none" class="tsd-kind-icon"><use href="#icon-${t.kind}"></use></svg>`), r.appendChild(document.createElement("span")).textContent = t.text;
     } else e.appendChild(document.createElement("span")).textContent = t.text;
   }
   G(X, "a[data-toggle]");