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

package/src/sdk/index.ts

@@ -7,6 +7,7 @@ import {
 } from 'react-native';
 import {
   bridgeCallToSdkCall,
+  bridgeChannelUserToSdkChannelUser,
   bridgeConsoleSettingsToSdkConsoleSettings,
   isAndroid,
 } from '../utils';
@@ -15,7 +16,6 @@ import {
   ZelloAlertMessage,
   ZelloChannel,
   ZelloChannelAlertLevel,
-  ZelloChannelUser,
   ZelloConfig,
   ZelloConnectionError,
   ZelloConnectionState,
@@ -24,6 +24,7 @@ import {
   ZelloContactType,
   ZelloCredentials,
   ZelloDispatchChannel,
+  ZelloGroupConversation,
   ZelloHistoryImageMessage,
   ZelloHistoryMessage,
   ZelloHistoryVoiceMessage,
@@ -82,6 +83,10 @@ export class Zello extends EventEmitter {
    * The list of {@link ZelloChannel} in the contact list. Sorted by name, ascending.
    */
   public channels: ZelloChannel[] = [];
+  /**
+   * The list of {@link ZelloGroupConversation} in the contact list. Sorted by name, ascending.
+   */
+  public groupConversations: ZelloGroupConversation[] = [];
 
   /**
    * The current account status. undefined when {@link state} is not {@link ZelloConnectionState.Connected}.
@@ -145,9 +150,6 @@ export class Zello extends EventEmitter {
 
   /**
    * Sets configuration variables for the SDK.
-   *
-   * At the moment, this is only functional on Android.
-   *
    * @param config The configuration to set.
    */
   public configure(config: ZelloConfig) {
@@ -222,6 +224,17 @@ export class Zello extends EventEmitter {
     return sortedArrayFind(this.channels, name, compareNameAscending);
   }
 
+  /**
+   * Returns the group conversation with the given name. Case-insensitive.
+   * @param name The name of the group conversation to search for.
+   * @return The group conversation with the given name, or null if no group conversation with that name exists.
+   */
+  public getGroupConversation(
+    name: string
+  ): ZelloGroupConversation | undefined {
+    return sortedArrayFind(this.groupConversations, name, compareNameAscending);
+  }
+
   /**
    * Sets the selected contact.
    * While optional, this is typically used for tracking the contact that the user is currently interacting with.
@@ -229,11 +242,10 @@ export class Zello extends EventEmitter {
    * @param contact The contact to set as selected.
    */
   public setSelectedContact(contact: ZelloContact) {
-    const isChannel = contact.type === ZelloContactType.Channel;
     if (isAndroid) {
-      ZelloAndroidSdkModule.setSelectedContact(contact.name, isChannel);
+      ZelloAndroidSdkModule.setSelectedContact(contact.name, contact.type);
     } else {
-      ZelloIOSSdkModule.selectContact(contact.name, isChannel);
+      ZelloIOSSdkModule.selectContact(contact.name, contact.type);
     }
   }
 
@@ -260,7 +272,11 @@ export class Zello extends EventEmitter {
     if (isAndroid) {
       ZelloAndroidSdkModule.connectChannel(channel.name);
     } else {
-      ZelloIOSSdkModule.connectChannel(channel.name);
+      if (channel.type === ZelloContactType.GroupConversation) {
+        ZelloIOSSdkModule.connectGroupConversation(channel.name);
+      } else {
+        ZelloIOSSdkModule.connectChannel(channel.name);
+      }
     }
   }
 
@@ -274,7 +290,11 @@ export class Zello extends EventEmitter {
     if (isAndroid) {
       ZelloAndroidSdkModule.disconnectChannel(channel.name);
     } else {
-      ZelloIOSSdkModule.disconnectChannel(channel.name);
+      if (channel.type === ZelloContactType.GroupConversation) {
+        ZelloIOSSdkModule.disconnectGroupConversation(channel.name);
+      } else {
+        ZelloIOSSdkModule.disconnectChannel(channel.name);
+      }
     }
   }
 
@@ -285,11 +305,10 @@ export class Zello extends EventEmitter {
    * @param contact The contact to start the voice message with.
    */
   public startVoiceMessage(contact: ZelloContact) {
-    const isChannel = contact.type === ZelloContactType.Channel;
     if (isAndroid) {
-      ZelloAndroidSdkModule.startVoiceMessage(contact.name, isChannel);
+      ZelloAndroidSdkModule.startVoiceMessage(contact.name, contact.type);
     } else {
-      ZelloIOSSdkModule.startVoiceMessage(contact.name, isChannel);
+      ZelloIOSSdkModule.startVoiceMessage(contact.name, contact.type);
     }
   }
 
@@ -312,11 +331,10 @@ export class Zello extends EventEmitter {
    * @param data The image data to send.
    */
   public sendImage(contact: ZelloContact, data: number[]) {
-    const isChannel = contact.type === ZelloContactType.Channel;
     if (isAndroid) {
-      ZelloAndroidSdkModule.sendImage(contact.name, isChannel, data);
+      ZelloAndroidSdkModule.sendImage(contact.name, contact.type, data);
     } else {
-      ZelloIOSSdkModule.sendImage(contact.name, isChannel, data);
+      ZelloIOSSdkModule.sendImage(contact.name, contact.type, data);
     }
   }
 
@@ -326,11 +344,10 @@ export class Zello extends EventEmitter {
    * @param contact The contact to send the alert to.
    */
   public sendLocation(contact: ZelloContact) {
-    const isChannel = contact.type === ZelloContactType.Channel;
     if (isAndroid) {
-      ZelloAndroidSdkModule.sendLocation(contact.name, isChannel);
+      ZelloAndroidSdkModule.sendLocation(contact.name, contact.type);
     } else {
-      ZelloIOSSdkModule.sendLocation(contact.name, isChannel);
+      ZelloIOSSdkModule.sendLocation(contact.name, contact.type);
     }
   }
 
@@ -341,11 +358,10 @@ export class Zello extends EventEmitter {
    * @param text The text to send.
    */
   public sendText(contact: ZelloContact, text: string) {
-    const isChannel = contact.type === ZelloContactType.Channel;
     if (isAndroid) {
-      ZelloAndroidSdkModule.sendText(contact.name, isChannel, text);
+      ZelloAndroidSdkModule.sendText(contact.name, contact.type, text);
     } else {
-      ZelloIOSSdkModule.sendText(contact.name, isChannel, text);
+      ZelloIOSSdkModule.sendText(contact.name, contact.type, text);
     }
   }
 
@@ -361,11 +377,10 @@ export class Zello extends EventEmitter {
     text: string,
     level?: ZelloChannelAlertLevel
   ) {
-    const isChannel = contact.type === ZelloContactType.Channel;
     if (isAndroid) {
-      ZelloAndroidSdkModule.sendAlert(contact.name, isChannel, text, level);
+      ZelloAndroidSdkModule.sendAlert(contact.name, contact.type, text, level);
     } else {
-      ZelloIOSSdkModule.sendAlert(contact.name, isChannel, text, level);
+      ZelloIOSSdkModule.sendAlert(contact.name, contact.type, text, level);
     }
   }
 
@@ -387,11 +402,10 @@ export class Zello extends EventEmitter {
    * @param contact The contact to mute.
    */
   public muteContact(contact: ZelloContact) {
-    const isChannel = contact.type === ZelloContactType.Channel;
     if (isAndroid) {
-      ZelloAndroidSdkModule.muteContact(contact.name, isChannel);
+      ZelloAndroidSdkModule.muteContact(contact.name, contact.type);
     } else {
-      ZelloIOSSdkModule.muteContact(contact.name, isChannel);
+      ZelloIOSSdkModule.muteContact(contact.name, contact.type);
     }
   }
 
@@ -401,11 +415,10 @@ export class Zello extends EventEmitter {
    * @param contact The contact to unmute.
    */
   public unmuteContact(contact: ZelloContact) {
-    const isChannel = contact.type === ZelloContactType.Channel;
     if (isAndroid) {
-      ZelloAndroidSdkModule.unmuteContact(contact.name, isChannel);
+      ZelloAndroidSdkModule.unmuteContact(contact.name, contact.type);
     } else {
-      ZelloIOSSdkModule.unmuteContact(contact.name, isChannel);
+      ZelloIOSSdkModule.unmuteContact(contact.name, contact.type);
     }
   }
 
@@ -446,7 +459,6 @@ export class Zello extends EventEmitter {
   ): Promise<ZelloHistoryMessage[]> {
     const defaultHistorySize = 50;
     return new Promise((resolve) => {
-      const isChannel = contact.type === ZelloContactType.Channel;
       const callback = (history: any[] | undefined) => {
         if (!history) {
           resolve([]);
@@ -460,14 +472,14 @@ export class Zello extends EventEmitter {
       if (isAndroid) {
         ZelloAndroidSdkModule.getHistory(
           contact.name,
-          isChannel,
+          contact.type,
           size ?? defaultHistorySize,
           callback
         );
       } else {
         ZelloIOSSdkModule.getHistory(
           contact.name,
-          isChannel,
+          contact.type,
           size ?? defaultHistorySize,
           callback
         );
@@ -481,18 +493,17 @@ export class Zello extends EventEmitter {
    * @param message The history message to play.
    */
   public playHistoryMessage(message: ZelloHistoryVoiceMessage) {
-    const isChannel = message.contact.type === ZelloContactType.Channel;
     if (isAndroid) {
       ZelloAndroidSdkModule.playHistoryMessage(
         message.historyId,
         message.contact.name,
-        isChannel
+        message.contact.type
       );
     } else {
       ZelloIOSSdkModule.playHistoryMessage(
         message.historyId,
         message.contact.name,
-        isChannel
+        message.contact.type
       );
     }
   }
@@ -518,19 +529,18 @@ export class Zello extends EventEmitter {
     message: ZelloHistoryImageMessage
   ): Promise<string | undefined> {
     return new Promise((resolve) => {
-      const isChannel = message.contact.type === ZelloContactType.Channel;
       if (isAndroid) {
         ZelloAndroidSdkModule.getImageDataForHistoryImageMessage(
           message.historyId,
           message.contact.name,
-          isChannel,
+          message.contact.type,
           (data: string | undefined) => resolve(data)
         );
       } else {
         ZelloIOSSdkModule.getHistoryImageData(
           message.historyId,
           message.contact.name,
-          isChannel,
+          message.contact.type,
           (data: string | undefined) => resolve(data)
         );
       }
@@ -553,6 +563,94 @@ export class Zello extends EventEmitter {
     }
   }
 
+  /**
+   * Creates a new group conversation with the given users.
+   * This will trigger the {@link ZelloEvent.GROUP_CONVERSATION_CREATED} and {@link ZelloEvent.CONTACT_LIST_UPDATED} events.
+   * @param users The users to create the group conversation with.
+   * @param displayName Optional; The display name of the group conversation. The conversation can be renamed later by using {@link renameGroupConversation}.
+   */
+  public createGroupConversation(users: ZelloUser[], displayName?: string) {
+    if (!this.consoleSettings?.allowGroupConversations) {
+      return;
+    }
+    if (isAndroid) {
+      ZelloAndroidSdkModule.createGroupConversation(
+        users.map((user) => user.name),
+        displayName
+      );
+    } else {
+      ZelloIOSSdkModule.createGroupConversation(
+        users.map((user) => user.name),
+        displayName
+      );
+    }
+  }
+
+  /**
+   * Adds users to the given group conversation.
+   * This will trigger the {@link ZelloEvent.GROUP_CONVERSATION_USERS_ADDED} and {@link ZelloEvent.CONTACT_LIST_UPDATED} events.
+   * @param groupConversation The group conversation to add users to.
+   * @param users The users to add to the group conversation.
+   */
+  public addUsersToGroupConversation(
+    groupConversation: ZelloGroupConversation,
+    users: ZelloUser[]
+  ) {
+    if (!this.consoleSettings?.allowGroupConversations) {
+      return;
+    }
+    if (isAndroid) {
+      ZelloAndroidSdkModule.addUsersToGroupConversation(
+        groupConversation.name,
+        users.map((user) => user.name)
+      );
+    } else {
+      ZelloIOSSdkModule.addUsersToGroupConversation(
+        groupConversation.name,
+        users.map((user) => user.name)
+      );
+    }
+  }
+
+  /**
+   * Removes the user from the group conversation.
+   * This will trigger the {@link ZelloEvent.GROUP_CONVERSATION_LEFT} and {@link ZelloEvent.CONTACT_LIST_UPDATED} events.
+   * @param groupConversation The group conversation to leave.
+   */
+  public leaveGroupConversation(groupConversation: ZelloGroupConversation) {
+    if (!this.consoleSettings?.allowGroupConversations) {
+      return;
+    }
+    if (isAndroid) {
+      ZelloAndroidSdkModule.leaveGroupConversation(groupConversation.name);
+    } else {
+      ZelloIOSSdkModule.leaveGroupConversation(groupConversation.name);
+    }
+  }
+
+  /**
+   * Renames the group conversation.
+   * This will trigger the {@link ZelloEvent.GROUP_CONVERSATION_RENAMED} and {@link ZelloEvent.CONTACT_LIST_UPDATED} events.
+   * @param groupConversation The group conversation to rename.
+   * @param name The new name for the group conversation.
+   */
+  public renameGroupConversation(
+    groupConversation: ZelloGroupConversation,
+    name: string
+  ) {
+    if (!this.consoleSettings?.allowGroupConversations) {
+      return;
+    }
+    if (isAndroid) {
+      ZelloAndroidSdkModule.renameGroupConversation(
+        groupConversation.name,
+        name
+      );
+    } else {
+      ZelloIOSSdkModule.renameGroupConversation(groupConversation.name, name);
+    }
+  }
+
   private setupEventListener(eventEmitter: NativeEventEmitter) {
     this.eventListener = eventEmitter.addListener('zellosdk', (event) => {
       const eventName = event.eventName;
@@ -598,13 +696,24 @@ export class Zello extends EventEmitter {
           );
           this.channels.sort(compareNameAscending);
 
+          this.groupConversations = event.groupConversations.map(
+            (groupConversation: any) =>
+              bridgeContactToSdkContact(groupConversation)
+          );
+          this.groupConversations.sort(compareNameAscending);
+
           if (event.emergencyChannel) {
             this.emergencyChannel = bridgeContactToSdkContact(
               event.emergencyChannel
             ) as ZelloChannel;
           }
 
-          this.emit(ZelloEvent.CONTACT_LIST_UPDATED, this.users, this.channels);
+          this.emit(
+            ZelloEvent.CONTACT_LIST_UPDATED,
+            this.users,
+            this.channels,
+            this.groupConversations
+          );
           break;
         }
         case 'onSelectedContactChanged': {
@@ -632,7 +741,7 @@ export class Zello extends EventEmitter {
           }
           this.incomingVoiceMessage = new ZelloIncomingVoiceMessage(
             contact,
-            new ZelloChannelUser(event.channelUserName),
+            bridgeChannelUserToSdkChannelUser(event.channelUser),
             parseInt(event.timestamp, 10)
           );
           this.emit(
@@ -651,7 +760,7 @@ export class Zello extends EventEmitter {
             ZelloEvent.INCOMING_VOICE_MESSAGE_STOPPED,
             new ZelloIncomingVoiceMessage(
               contact,
-              new ZelloChannelUser(event.channelUserName),
+              bridgeChannelUserToSdkChannelUser(event.channelUser),
               parseInt(event.timestamp, 10)
             )
           );
@@ -724,7 +833,7 @@ export class Zello extends EventEmitter {
             ZelloEvent.INCOMING_IMAGE_MESSAGE_RECEIVED,
             new ZelloImageMessage(
               contact,
-              new ZelloChannelUser(event.channelUserName),
+              bridgeChannelUserToSdkChannelUser(event.channelUser),
               true,
               parseInt(event.timestamp, 10),
               event.thumbnail,
@@ -778,7 +887,7 @@ export class Zello extends EventEmitter {
             ZelloEvent.INCOMING_ALERT_MESSAGE_RECEIVED,
             new ZelloAlertMessage(
               contact,
-              new ZelloChannelUser(event.channelUserName),
+              bridgeChannelUserToSdkChannelUser(event.channelUser),
               true,
               parseInt(event.timestamp, 10),
               event.text
@@ -829,7 +938,7 @@ export class Zello extends EventEmitter {
             ZelloEvent.INCOMING_TEXT_MESSAGE_RECEIVED,
             new ZelloTextMessage(
               contact,
-              new ZelloChannelUser(event.channelUserName),
+              bridgeChannelUserToSdkChannelUser(event.channelUser),
               true,
               parseInt(event.timestamp, 10),
               event.text
@@ -880,7 +989,7 @@ export class Zello extends EventEmitter {
             ZelloEvent.INCOMING_LOCATION_MESSAGE_RECEIVED,
             new ZelloLocationMessage(
               contact,
-              new ZelloChannelUser(event.channelUserName),
+              bridgeChannelUserToSdkChannelUser(event.channelUser),
               true,
               parseInt(event.timestamp, 10),
               event.latitude,
@@ -1009,12 +1118,9 @@ export class Zello extends EventEmitter {
               if (!contact) {
                 return undefined;
               }
-              const channelUser = recent.channelUser
-                ? new ZelloChannelUser(recent.channelUser)
-                : undefined;
               return new ZelloRecentEntry(
                 contact,
-                channelUser,
+                bridgeChannelUserToSdkChannelUser(event.channelUser),
                 parseInt(recent.timestamp, 10),
                 recent.type.toLowerCase(),
                 recent.incoming
@@ -1061,6 +1167,86 @@ export class Zello extends EventEmitter {
           this.processDispatchCallEvent(event);
           break;
         }
+        case 'onGroupConversationLeft': {
+          const groupConversation = bridgeContactToSdkContact(
+            event.conversation
+          ) as ZelloGroupConversation;
+          if (!groupConversation) {
+            break;
+          }
+          this.emit(ZelloEvent.GROUP_CONVERSATION_LEFT, groupConversation);
+          break;
+        }
+        case 'onGroupConversationInvite': {
+          const groupConversation = bridgeContactToSdkContact(
+            event.conversation
+          ) as ZelloGroupConversation;
+          if (!groupConversation) {
+            break;
+          }
+          this.emit(ZelloEvent.GROUP_CONVERSATION_INVITE, groupConversation);
+          break;
+        }
+        case 'onGroupConversationCreated': {
+          const groupConversation = bridgeContactToSdkContact(
+            event.conversation
+          ) as ZelloGroupConversation;
+          if (!groupConversation) {
+            break;
+          }
+          this.emit(ZelloEvent.GROUP_CONVERSATION_CREATED, groupConversation);
+          break;
+        }
+        case 'onGroupConversationRenamed': {
+          const groupConversation = bridgeContactToSdkContact(
+            event.conversation
+          ) as ZelloGroupConversation;
+          if (!groupConversation) {
+            break;
+          }
+          this.emit(ZelloEvent.GROUP_CONVERSATION_RENAMED, groupConversation);
+          break;
+        }
+        case 'onGroupConversationUsersAdded': {
+          const groupConversation = bridgeContactToSdkContact(
+            event.conversation
+          ) as ZelloGroupConversation;
+          if (!groupConversation) {
+            break;
+          }
+          const users = event.users.map((user: any) =>
+            bridgeChannelUserToSdkChannelUser(user)
+          );
+          if (!users || users.length === 0) {
+            return;
+          }
+          this.emit(
+            ZelloEvent.GROUP_CONVERSATION_USERS_ADDED,
+            groupConversation,
+            users
+          );
+          break;
+        }
+        case 'onGroupConversationUsersLeft': {
+          const groupConversation = bridgeContactToSdkContact(
+            event.conversation
+          ) as ZelloGroupConversation;
+          if (!groupConversation) {
+            break;
+          }
+          const users = event.users.map((user: any) =>
+            bridgeChannelUserToSdkChannelUser(user)
+          );
+          if (!users || users.length === 0) {
+            return;
+          }
+          this.emit(
+            ZelloEvent.GROUP_CONVERSATION_USERS_LEFT,
+            groupConversation,
+            users
+          );
+          break;
+        }
         default:
           break;
       }
@@ -1096,6 +1282,7 @@ export class Zello extends EventEmitter {
   private clearContactList() {
     this.users = [];
     this.channels = [];
+    this.groupConversations = [];
   }
 
   private static getSdk() {