@zelloptt/react-native-zello-sdk 2.0.0 → 3.0.0

package/src/sdk/index.ts

@@ -1,8 +1,8 @@
 // noinspection JSUnusedGlobalSymbols
 
 import {
+  DeviceEventEmitter,
   EmitterSubscription,
-  NativeEventEmitter,
   NativeModules,
 } from 'react-native';
 import {
@@ -48,8 +48,12 @@ import {
   bridgeIncomingEmergencyToSdkIncomingEmergency,
 } from '../utils';
 import { ZelloEvent } from '../events';
+import NativeZelloSdk from '../specs/NativeZelloSdk';
 
-const { ZelloAndroidSdkModule, ZelloIOSSdkModule } = NativeModules;
+// `ZelloIOSSdkModule` is the iOS RCTEventEmitter that owns the Zello delegate
+// (see `getSdk`). All method calls go through the unified `NativeZelloSdk`
+// TurboModule, which on Android also owns the delegate.
+const { ZelloIOSSdkModule } = NativeModules;
 
 /**
  * Zello SDK.
@@ -136,15 +140,12 @@ export class Zello extends EventEmitter {
 
   private constructor() {
     super();
+    // Accessing the native module instantiates it, which registers the SDK
+    // delegate that drives events. The events themselves arrive on the global
+    // DeviceEventEmitter 'zellosdk' channel (bridgeless-safe on both platforms).
     const sdk = Zello.getSdk();
     if (sdk) {
-      let eventEmitter: NativeEventEmitter;
-      if (isAndroid) {
-        eventEmitter = new NativeEventEmitter();
-      } else {
-        eventEmitter = new NativeEventEmitter(sdk);
-      }
-      this.setupEventListener(eventEmitter);
+      this.setupEventListener();
     }
   }
 
@@ -153,14 +154,7 @@ export class Zello extends EventEmitter {
    * @param config The configuration to set.
    */
   public configure(config: ZelloConfig) {
-    if (isAndroid) {
-      ZelloAndroidSdkModule.configure(
-        config.android.enableOfflineMessagePushNotifications,
-        config.android.enableForegroundService
-      );
-    } else {
-      ZelloIOSSdkModule.configure(config.ios.isDebugBuild, config.ios.appGroup);
-    }
+    NativeZelloSdk.configure(config);
   }
 
   /**
@@ -179,19 +173,11 @@ export class Zello extends EventEmitter {
    * @param credentials The credentials to use for signing in.
    */
   public connect(credentials: ZelloCredentials) {
-    if (isAndroid) {
-      ZelloAndroidSdkModule.connect(
-        credentials.network,
-        credentials.username,
-        credentials.password
-      );
-    } else {
-      ZelloIOSSdkModule.connect(
-        credentials.network,
-        credentials.username,
-        credentials.password
-      );
-    }
+    NativeZelloSdk.connect(
+      credentials.network,
+      credentials.username,
+      credentials.password
+    );
   }
 
   /**
@@ -199,11 +185,7 @@ export class Zello extends EventEmitter {
    * This will trigger the {@link ZelloEvent.DISCONNECTED} event.
    */
   public disconnect() {
-    if (isAndroid) {
-      ZelloAndroidSdkModule.disconnect();
-    } else {
-      ZelloIOSSdkModule.disconnect();
-    }
+    NativeZelloSdk.disconnect();
   }
 
   /**
@@ -242,11 +224,7 @@ export class Zello extends EventEmitter {
    * @param contact The contact to set as selected.
    */
   public setSelectedContact(contact: ZelloContact) {
-    if (isAndroid) {
-      ZelloAndroidSdkModule.setSelectedContact(contact.name, contact.type);
-    } else {
-      ZelloIOSSdkModule.selectContact(contact.name, contact.type);
-    }
+    NativeZelloSdk.selectContact(contact.name, contact.type);
   }
 
   /**
@@ -255,11 +233,7 @@ export class Zello extends EventEmitter {
    * @param status The account status to set.
    */
   public setAccountStatus(status: ZelloAccountStatus) {
-    if (isAndroid) {
-      ZelloAndroidSdkModule.setAccountStatus(status);
-    } else {
-      ZelloIOSSdkModule.setAccountStatus(status);
-    }
+    NativeZelloSdk.setAccountStatus(status);
   }
 
   /**
@@ -269,14 +243,10 @@ export class Zello extends EventEmitter {
    * @param channel The channel to connect to.
    */
   public connectChannel(channel: ZelloChannel) {
-    if (isAndroid) {
-      ZelloAndroidSdkModule.connectChannel(channel.name);
+    if (channel.type === ZelloContactType.GroupConversation) {
+      NativeZelloSdk.connectGroupConversation(channel.name);
     } else {
-      if (channel.type === ZelloContactType.GroupConversation) {
-        ZelloIOSSdkModule.connectGroupConversation(channel.name);
-      } else {
-        ZelloIOSSdkModule.connectChannel(channel.name);
-      }
+      NativeZelloSdk.connectChannel(channel.name);
     }
   }
 
@@ -287,14 +257,10 @@ export class Zello extends EventEmitter {
    * @param channel The channel to disconnect from.
    */
   public disconnectChannel(channel: ZelloChannel) {
-    if (isAndroid) {
-      ZelloAndroidSdkModule.disconnectChannel(channel.name);
+    if (channel.type === ZelloContactType.GroupConversation) {
+      NativeZelloSdk.disconnectGroupConversation(channel.name);
     } else {
-      if (channel.type === ZelloContactType.GroupConversation) {
-        ZelloIOSSdkModule.disconnectGroupConversation(channel.name);
-      } else {
-        ZelloIOSSdkModule.disconnectChannel(channel.name);
-      }
+      NativeZelloSdk.disconnectChannel(channel.name);
     }
   }
 
@@ -305,11 +271,7 @@ export class Zello extends EventEmitter {
    * @param contact The contact to start the voice message with.
    */
   public startVoiceMessage(contact: ZelloContact) {
-    if (isAndroid) {
-      ZelloAndroidSdkModule.startVoiceMessage(contact.name, contact.type);
-    } else {
-      ZelloIOSSdkModule.startVoiceMessage(contact.name, contact.type);
-    }
+    NativeZelloSdk.startVoiceMessage(contact.name, contact.type);
   }
 
   /**
@@ -317,11 +279,7 @@ export class Zello extends EventEmitter {
    * This will trigger the {@link ZelloEvent.OUTGOING_VOICE_MESSAGE_STOPPED} event.
    */
   public stopVoiceMessage() {
-    if (isAndroid) {
-      ZelloAndroidSdkModule.stopVoiceMessage();
-    } else {
-      ZelloIOSSdkModule.stopVoiceMessage();
-    }
+    NativeZelloSdk.stopVoiceMessage();
   }
 
   /**
@@ -331,11 +289,7 @@ export class Zello extends EventEmitter {
    * @param data The image data to send.
    */
   public sendImage(contact: ZelloContact, data: number[]) {
-    if (isAndroid) {
-      ZelloAndroidSdkModule.sendImage(contact.name, contact.type, data);
-    } else {
-      ZelloIOSSdkModule.sendImage(contact.name, contact.type, data);
-    }
+    NativeZelloSdk.sendImage(contact.name, contact.type, data);
   }
 
   /**
@@ -344,11 +298,7 @@ export class Zello extends EventEmitter {
    * @param contact The contact to send the alert to.
    */
   public sendLocation(contact: ZelloContact) {
-    if (isAndroid) {
-      ZelloAndroidSdkModule.sendLocation(contact.name, contact.type);
-    } else {
-      ZelloIOSSdkModule.sendLocation(contact.name, contact.type);
-    }
+    NativeZelloSdk.sendLocation(contact.name, contact.type);
   }
 
   /**
@@ -358,11 +308,7 @@ export class Zello extends EventEmitter {
    * @param text The text to send.
    */
   public sendText(contact: ZelloContact, text: string) {
-    if (isAndroid) {
-      ZelloAndroidSdkModule.sendText(contact.name, contact.type, text);
-    } else {
-      ZelloIOSSdkModule.sendText(contact.name, contact.type, text);
-    }
+    NativeZelloSdk.sendText(contact.name, contact.type, text);
   }
 
   /**
@@ -377,11 +323,7 @@ export class Zello extends EventEmitter {
     text: string,
     level?: ZelloChannelAlertLevel
   ) {
-    if (isAndroid) {
-      ZelloAndroidSdkModule.sendAlert(contact.name, contact.type, text, level);
-    } else {
-      ZelloIOSSdkModule.sendAlert(contact.name, contact.type, text, level);
-    }
+    NativeZelloSdk.sendAlert(contact.name, contact.type, text, level ?? '');
   }
 
   /**
@@ -389,11 +331,7 @@ export class Zello extends EventEmitter {
    * Additionally, please contact us to provide more information on what happened.
    */
   public submitProblemReport() {
-    if (isAndroid) {
-      ZelloAndroidSdkModule.submitProblemReport();
-    } else {
-      ZelloIOSSdkModule.submitProblemReport();
-    }
+    NativeZelloSdk.submitProblemReport();
   }
 
   /**
@@ -402,11 +340,7 @@ export class Zello extends EventEmitter {
    * @param contact The contact to mute.
    */
   public muteContact(contact: ZelloContact) {
-    if (isAndroid) {
-      ZelloAndroidSdkModule.muteContact(contact.name, contact.type);
-    } else {
-      ZelloIOSSdkModule.muteContact(contact.name, contact.type);
-    }
+    NativeZelloSdk.muteContact(contact.name, contact.type);
   }
 
   /**
@@ -415,11 +349,7 @@ export class Zello extends EventEmitter {
    * @param contact The contact to unmute.
    */
   public unmuteContact(contact: ZelloContact) {
-    if (isAndroid) {
-      ZelloAndroidSdkModule.unmuteContact(contact.name, contact.type);
-    } else {
-      ZelloIOSSdkModule.unmuteContact(contact.name, contact.type);
-    }
+    NativeZelloSdk.unmuteContact(contact.name, contact.type);
   }
 
   /**
@@ -428,11 +358,7 @@ export class Zello extends EventEmitter {
    * This will trigger the {@link ZelloEvent.OUTGOING_EMERGENCY_STARTED} event.
    */
   public startEmergency() {
-    if (isAndroid) {
-      ZelloAndroidSdkModule.startEmergency();
-    } else {
-      ZelloIOSSdkModule.startEmergency();
-    }
+    NativeZelloSdk.startEmergency();
   }
 
   /**
@@ -440,11 +366,20 @@ export class Zello extends EventEmitter {
    * This will trigger the {@link ZelloEvent.OUTGOING_EMERGENCY_STOPPED} event.
    */
   public stopEmergency() {
-    if (isAndroid) {
-      ZelloAndroidSdkModule.stopEmergency();
-    } else {
-      ZelloIOSSdkModule.stopEmergency();
-    }
+    NativeZelloSdk.stopEmergency();
+  }
+
+  /**
+   * Stops an incoming emergency started by another user on the emergency channel.
+   *
+   * This requires the emergency channel's {@link ZelloChannelOptions.allowEmergencyEndOthers | allowEmergencyEndOthers} option
+   * to be true; otherwise this method has no effect.
+   *
+   * On success, this will trigger the {@link ZelloEvent.INCOMING_EMERGENCY_STOPPED} event for the emergency.
+   * @param incomingEmergency The incoming emergency to stop. Must be one of the entries currently in {@link incomingEmergencies}.
+   */
+  public stopIncomingEmergency(incomingEmergency: ZelloIncomingEmergency) {
+    NativeZelloSdk.stopIncomingEmergency(incomingEmergency.emergencyId);
   }
 
   /**
@@ -453,38 +388,22 @@ export class Zello extends EventEmitter {
    * @param size Optional; The number of history items to retrieve. Defaults to 50.
    * @return The history items for the given contact.
    */
-  public getHistory(
+  public async getHistory(
     contact: ZelloContact,
     size?: number
   ): Promise<ZelloHistoryMessage[]> {
     const defaultHistorySize = 50;
-    return new Promise((resolve) => {
-      const callback = (history: any[] | undefined) => {
-        if (!history) {
-          resolve([]);
-          return;
-        }
-        const messages = history
-          .map((message) => bridgeHistoryMessageToSdkHistoryMessage(message))
-          .filter((item) => item !== undefined) as ZelloHistoryMessage[];
-        resolve(messages);
-      };
-      if (isAndroid) {
-        ZelloAndroidSdkModule.getHistory(
-          contact.name,
-          contact.type,
-          size ?? defaultHistorySize,
-          callback
-        );
-      } else {
-        ZelloIOSSdkModule.getHistory(
-          contact.name,
-          contact.type,
-          size ?? defaultHistorySize,
-          callback
-        );
-      }
-    });
+    const history = (await NativeZelloSdk.getHistory(
+      contact.name,
+      contact.type,
+      size ?? defaultHistorySize
+    )) as unknown as any[] | undefined;
+    if (!history) {
+      return [];
+    }
+    return history
+      .map((message) => bridgeHistoryMessageToSdkHistoryMessage(message))
+      .filter((item) => item !== undefined) as ZelloHistoryMessage[];
   }
 
   /**
@@ -493,19 +412,11 @@ export class Zello extends EventEmitter {
    * @param message The history message to play.
    */
   public playHistoryMessage(message: ZelloHistoryVoiceMessage) {
-    if (isAndroid) {
-      ZelloAndroidSdkModule.playHistoryMessage(
-        message.historyId,
-        message.contact.name,
-        message.contact.type
-      );
-    } else {
-      ZelloIOSSdkModule.playHistoryMessage(
-        message.historyId,
-        message.contact.name,
-        message.contact.type
-      );
-    }
+    NativeZelloSdk.playHistoryMessage(
+      message.historyId,
+      message.contact.name,
+      message.contact.type
+    );
   }
 
   /**
@@ -513,11 +424,7 @@ export class Zello extends EventEmitter {
    * This will trigger the {@link ZelloEvent.HISTORY_PLAYBACK_STOPPED} event.
    */
   public stopHistoryMessagePlayback() {
-    if (isAndroid) {
-      ZelloAndroidSdkModule.stopHistoryMessagePlayback();
-    } else {
-      ZelloIOSSdkModule.stopHistoryMessagePlayback();
-    }
+    NativeZelloSdk.stopHistoryMessagePlayback();
   }
 
   /**
@@ -528,23 +435,11 @@ export class Zello extends EventEmitter {
   public getImageDataForHistoryImageMessage(
     message: ZelloHistoryImageMessage
   ): Promise<string | undefined> {
-    return new Promise((resolve) => {
-      if (isAndroid) {
-        ZelloAndroidSdkModule.getImageDataForHistoryImageMessage(
-          message.historyId,
-          message.contact.name,
-          message.contact.type,
-          (data: string | undefined) => resolve(data)
-        );
-      } else {
-        ZelloIOSSdkModule.getHistoryImageData(
-          message.historyId,
-          message.contact.name,
-          message.contact.type,
-          (data: string | undefined) => resolve(data)
-        );
-      }
-    });
+    return NativeZelloSdk.getHistoryImageData(
+      message.historyId,
+      message.contact.name,
+      message.contact.type
+    ) as unknown as Promise<string | undefined>;
   }
 
   /**
@@ -556,11 +451,7 @@ export class Zello extends EventEmitter {
    * @param channel The dispatch channel to end the call for.
    */
   public endDispatchCall(channel: ZelloDispatchChannel) {
-    if (isAndroid) {
-      ZelloAndroidSdkModule.endDispatchCall(channel.name);
-    } else {
-      ZelloIOSSdkModule.endDispatchCall(channel.name);
-    }
+    NativeZelloSdk.endDispatchCall(channel.name);
   }
 
   /**
@@ -573,17 +464,10 @@ export class Zello extends EventEmitter {
     if (!this.consoleSettings?.allowGroupConversations) {
       return;
     }
-    if (isAndroid) {
-      ZelloAndroidSdkModule.createGroupConversation(
-        users.map((user) => user.name),
-        displayName
-      );
-    } else {
-      ZelloIOSSdkModule.createGroupConversation(
-        users.map((user) => user.name),
-        displayName
-      );
-    }
+    NativeZelloSdk.createGroupConversation(
+      users.map((user) => user.name),
+      displayName ?? ''
+    );
   }
 
   /**
@@ -599,17 +483,10 @@ export class Zello extends EventEmitter {
     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)
-      );
-    }
+    NativeZelloSdk.addUsersToGroupConversation(
+      groupConversation.name,
+      users.map((user) => user.name)
+    );
   }
 
   /**
@@ -621,11 +498,7 @@ export class Zello extends EventEmitter {
     if (!this.consoleSettings?.allowGroupConversations) {
       return;
     }
-    if (isAndroid) {
-      ZelloAndroidSdkModule.leaveGroupConversation(groupConversation.name);
-    } else {
-      ZelloIOSSdkModule.leaveGroupConversation(groupConversation.name);
-    }
+    NativeZelloSdk.leaveGroupConversation(groupConversation.name);
   }
 
   /**
@@ -641,18 +514,11 @@ export class Zello extends EventEmitter {
     if (!this.consoleSettings?.allowGroupConversations) {
       return;
     }
-    if (isAndroid) {
-      ZelloAndroidSdkModule.renameGroupConversation(
-        groupConversation.name,
-        name
-      );
-    } else {
-      ZelloIOSSdkModule.renameGroupConversation(groupConversation.name, name);
-    }
+    NativeZelloSdk.renameGroupConversation(groupConversation.name, name);
   }
 
-  private setupEventListener(eventEmitter: NativeEventEmitter) {
-    this.eventListener = eventEmitter.addListener('zellosdk', (event) => {
+  private setupEventListener() {
+    this.eventListener = DeviceEventEmitter.addListener('zellosdk', (event) => {
       const eventName = event.eventName;
       switch (eventName) {
         case 'onConnectFailed': {
@@ -742,7 +608,8 @@ export class Zello extends EventEmitter {
           this.incomingVoiceMessage = new ZelloIncomingVoiceMessage(
             contact,
             bridgeChannelUserToSdkChannelUser(event.channelUser),
-            parseInt(event.timestamp, 10)
+            parseInt(event.timestamp, 10),
+            event.isTranslation === true
           );
           this.emit(
             ZelloEvent.INCOMING_VOICE_MESSAGE_STARTED,
@@ -761,7 +628,8 @@ export class Zello extends EventEmitter {
             new ZelloIncomingVoiceMessage(
               contact,
               bridgeChannelUserToSdkChannelUser(event.channelUser),
-              parseInt(event.timestamp, 10)
+              parseInt(event.timestamp, 10),
+              event.isTranslation === true
             )
           );
           break;
@@ -996,7 +864,7 @@ export class Zello extends EventEmitter {
               event.longitude,
               event.accuracy,
               event.address
-            ).contact
+            )
           );
           break;
         }
@@ -1154,6 +1022,17 @@ export class Zello extends EventEmitter {
           );
           break;
         }
+        case 'onHistoryVoiceMessageTranscriptionAvailable': {
+          const message = bridgeHistoryMessageToSdkHistoryMessage(event);
+          if (!(message instanceof ZelloHistoryVoiceMessage)) {
+            break;
+          }
+          this.emit(
+            ZelloEvent.HISTORY_VOICE_MESSAGE_TRANSCRIPTION_AVAILABLE,
+            message
+          );
+          break;
+        }
         case 'onConsoleSettingsChanged': {
           this.consoleSettings =
             bridgeConsoleSettingsToSdkConsoleSettings(event);
@@ -1286,9 +1165,10 @@ export class Zello extends EventEmitter {
   }
 
   private static getSdk() {
-    if (isAndroid) {
-      return ZelloAndroidSdkModule;
-    }
-    return ZelloIOSSdkModule;
+    // On Android the TurboModule owns the Zello delegate and is already created
+    // by importing the spec; on iOS the ZelloIOSSdkModule RCTEventEmitter owns
+    // it and is instantiated on access. Either way this only needs to be truthy
+    // so the DeviceEventEmitter listener gets registered.
+    return isAndroid ? NativeZelloSdk : ZelloIOSSdkModule;
   }
 }

package/src/specs/NativeZelloSdk.ts

@@ -0,0 +1,89 @@
+import type { TurboModule } from 'react-native';
+import { TurboModuleRegistry } from 'react-native';
+import type { UnsafeObject } from 'react-native/Libraries/Types/CodegenTypes';
+
+/**
+ * Codegen spec for the unified Zello TurboModule.
+ *
+ * This single spec replaces the legacy, platform-divergent `ZelloIOSSdkModule`
+ * and `ZelloAndroidSdkModule` bridge modules. Both platforms implement the same
+ * interface. Events are not part of this spec: they are emitted on the global
+ * `DeviceEventEmitter` `'zellosdk'` channel and carry an `eventName`
+ * discriminator in their payload (see `src/events`).
+ *
+ * Codegen notes:
+ * - `configure` takes a single object so the platform-specific configuration
+ *   fields (`ios.isDebugBuild`, `ios.appGroup`, `android.enableOfflineMessagePushNotifications`,
+ *   `android.enableForegroundService`) can live in one signature.
+ * - The two legacy callback methods (`getHistory`, `getHistoryImageData`) are
+ *   modeled as Promises, which is the TurboModule-native async shape.
+ * - `UnsafeObject` is used where the payload is a heterogeneous SDK structure
+ *   that is normalized in the JS layer (`src/sdk`).
+ */
+export interface Spec extends TurboModule {
+  configure(config: UnsafeObject): void;
+
+  connect(network: string, username: string, password: string): void;
+  disconnect(): void;
+
+  setAccountStatus(status: string): void;
+
+  selectContact(name: string, contactType: string): void;
+
+  startVoiceMessage(name: string, contactType: string): void;
+  stopVoiceMessage(): void;
+
+  sendImage(name: string, contactType: string, data: Array<number>): void;
+  sendLocation(name: string, contactType: string): void;
+  sendText(name: string, contactType: string, text: string): void;
+  sendAlert(
+    name: string,
+    contactType: string,
+    text: string,
+    level: string
+  ): void;
+
+  connectChannel(name: string): void;
+  disconnectChannel(name: string): void;
+
+  connectGroupConversation(name: string): void;
+  disconnectGroupConversation(name: string): void;
+
+  submitProblemReport(): void;
+
+  muteContact(name: string, contactType: string): void;
+  unmuteContact(name: string, contactType: string): void;
+
+  startEmergency(): void;
+  stopEmergency(): void;
+  stopIncomingEmergency(emergencyId: string): void;
+
+  getHistory(
+    name: string,
+    contactType: string,
+    maxMessages: number
+  ): Promise<UnsafeObject>;
+  playHistoryMessage(
+    historyId: string,
+    contactName: string,
+    contactType: string
+  ): void;
+  stopHistoryMessagePlayback(): void;
+  getHistoryImageData(
+    historyId: string,
+    contactName: string,
+    contactType: string
+  ): Promise<UnsafeObject>;
+
+  endDispatchCall(channelName: string): void;
+
+  createGroupConversation(usernames: Array<string>, displayName: string): void;
+  addUsersToGroupConversation(
+    conversationName: string,
+    usernames: Array<string>
+  ): void;
+  leaveGroupConversation(conversationName: string): void;
+  renameGroupConversation(conversationName: string, newName: string): void;
+}
+
+export default TurboModuleRegistry.getEnforcing<Spec>('NativeZelloSdk');