voice-react-native-sdk 1.6.2-fork.9 → 2.0.0-preview.fork.2

package/LICENSE

@@ -1,5 +1,5 @@
 
-   Copyright (C) 2023-2024 Twilio, Inc.
+   Copyright (C) 2023-2026 Twilio, Inc.
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.
 

package/README.md

@@ -1,5 +1,4 @@
 # Twilio Voice React Native SDK
-
 [![NPM](https://img.shields.io/npm/v/%40twilio/voice-react-native-sdk.svg?color=blue)](https://www.npmjs.com/package/%40twilio/voice-react-native-sdk) [![CircleCI](https://dl.circleci.com/status-badge/img/gh/twilio/twilio-voice-react-native/tree/main.svg?style=shield)](https://dl.circleci.com/status-badge/redirect/gh/twilio/twilio-voice-react-native/tree/main)
 
 Twilio's Voice React Native SDK allows you to add real-time voice and PSTN calling to your React Native apps.
@@ -14,7 +13,6 @@ Please check out the following if you are new to Twilio's Programmable Voice or
 - [React Native](https://reactnative.dev/docs/getting-started)
 
 ## Installation
-
 The package is available through [npm](https://www.npmjs.com/package/@twilio/voice-react-native-sdk).
 
 ```sh
@@ -23,144 +21,44 @@ yarn add @twilio/voice-react-native-sdk
 
 Once the package has been installed to your React Native application, there are further steps that you will need to take for both iOS and Android platforms. Please see the supporting documentation below.
 
-## Building and Publishing New Versions
-
-This is a forked version of the Twilio Voice React Native SDK. If you need to build and publish new versions of this package to npm, follow these steps:
-
-### Prerequisites
-
-1. **Node.js and Yarn**: Ensure you have Node.js and Yarn installed
-2. **NPM Account**: You need to be logged into npm with the appropriate permissions
-3. **Git Repository**: Make sure your changes are committed to your fork
-
-### Build Process
-
-1. **Install Dependencies**:
-
-   ```bash
-   yarn install
-   ```
-
-2. **Build the Package**:
-
-   ```bash
-   yarn prepare
-   ```
+## 2.x Documentation
 
-   This command will:
+### Expo support
 
-   - Generate constants from source files
-   - Build CommonJS, ES modules, and TypeScript definitions
-   - Create source maps for debugging
-   - Output files to the `lib/` directory
+With the release of `2.x` versions (including our preview versions available through `npm` and Github Releases), the Twilio Voice React Native SDK officially supports the Expo framework out-of-the-box.
 
-3. **Verify Build Output**:
-   Check that the following directories are created:
-   - `lib/commonjs/` - CommonJS modules
-   - `lib/module/` - ES modules
-   - `lib/typescript/` - TypeScript definitions
+**Please note that `2.x` versions of the SDK do not support framework-less ("bare") React Native applications!**
 
-### Publishing to NPM
+**Please note that `2.0.0-preview.1` only supports Expo v52 at this time. Other versions of Expo are not tested or guaranteed to work!**
 
-1. **Update Version**:
-   Edit `package.json` and increment the version number:
-
-   ```json
-   {
-     "version": "1.6.2-fork.2" // Increment from previous version
-   }
-   ```
-
-2. **Verify Package Configuration**:
-   Ensure your `package.json` has the correct:
-
-   - Package name (e.g., `@your-username/voice-react-native-sdk`)
-   - Repository URLs pointing to your fork
-   - Author information
-
-3. **Login to NPM**:
-
-   ```bash
-   npm login
-   ```
-
-4. **Publish the Package**:
-   ```bash
-   npm publish --access public
-   ```
-
-### Using Your Published Package
-
-Once published, you can install your forked version in any React Native project:
-
-```bash
-# Install your forked version
-npm install @your-username/voice-react-native-sdk
-# or
-yarn add @your-username/voice-react-native-sdk
-```
+After installing the Twilio Voice React Native SDK to your Expo application, please follow this [doc](./docs/expo/app-config.md) for steps on configuring your Expo app with the proper permissions and grants to use Twilio Voice features.
 
-Then import and use it exactly like the original Twilio SDK:
-
-```javascript
-import { Voice } from '@your-username/voice-react-native-sdk';
-
-const voice = new Voice();
-// Use the SDK as normal
-```
-
-### Package Structure
-
-The published package includes:
-
-- **Source Code**: Original TypeScript/JavaScript source files
-- **Built Libraries**: Compiled CommonJS and ES modules
-- **Type Definitions**: Complete TypeScript definitions
-- **Native Code**: Android (Java) and iOS (Objective-C) implementations
-- **Assets**: Audio files, icons, and other resources
-- **Source Maps**: For debugging compiled code
-
-### Troubleshooting
-
-- **Build Errors**: Run `yarn install` to ensure all dependencies are installed
-- **Publish Errors**: Verify you're logged into npm with `npm whoami`
-- **Permission Errors**: Ensure you have publish rights to the npm scope/organization
-- **Version Conflicts**: Make sure the version number is unique and higher than the previous version
-
-## Supporting Documentation
+## 1.x Documentation
 
 ### Getting Started
 
 #### iOS
-
 Learn how to get started for the [iOS platform](/docs/getting-started-ios.md).
 
 #### Android
-
 Learn how to get started for the Android platform if you are using [Java](/docs/getting-started-android-java.md) or [Kotlin](/docs/getting-started-android-kotlin.md).
 
 ### Migration Guide
-
 If you are migrating from a version of the Twilio Voice React Native SDK `< 1.0.0.beta.4` to a version `>= 1.0.0.beta.4`, please see [this](/docs/migration-guide-beta.4.md) document.
 
 ### Customizing Notifications
-
 To customize the appearance and content of your application's notifications, please see [this](/docs/customize-notifications.md) document.
 
 ### Outgoing Call Ringback Tone
-
 To enable your application to play a ringback tone while making an outgoing call, please see [this](/docs/play-outgoing-call-ringback-tone.md) document.
 
 ### Out-of-band PushKit Handling
-
 To have your application implement or use its own `PushKit` delegate module, please see [this](/docs/applications-own-pushkit-handler.md) document.
 
 ### Out-of-band Firebase Messaging Service
-
 To have your application implement or use a different `FirebaseMessagingService` (such as OneSignal or RNFirebase), please see [this](/docs/out-of-band-firebase-messaging-service.md) document.
 
 ## Issues and Support
-
 Please check out our [common issues](/COMMON_ISSUES.md) page or file any issues you find here on Github. For general inquiries related to the Voice SDK you can file a support ticket.
 
 Please ensure that you are not sharing any [Personally Identifiable Information(PII)](https://www.twilio.com/docs/glossary/what-is-personally-identifiable-information-pii) or sensitive account information (API keys, credentials, etc.) when reporting an issue.
@@ -168,12 +66,10 @@ Please ensure that you are not sharing any [Personally Identifiable Information(
 Please check out our [known issues](/KNOWN_ISSUES.md) for known bugs and workarounds.
 
 ## Related
-
 - [Reference App](https://github.com/twilio/twilio-voice-react-native-app)
 - [Twilio Voice JS](https://github.com/twilio/twilio-voice.js)
 - [Twilio Voice iOS](https://github.com/twilio/voice-quickstart-ios)
 - [Twilio Voice Android](https://github.com/twilio/voice-quickstart-android)
 
 ## License
-
 See [LICENSE](/LICENSE)

package/android/build.gradle

@@ -8,7 +8,7 @@ buildscript {
     'androidxLifecycle'  : '2.2.0',
     'audioSwitch'        : '1.2.2',
     'firebaseMessaging'  : '23.4.0',
-    'kotlin': '1.9.24'
+    'kotlin'             : '1.9.25'
   ]
   if (project == rootProject) {
     repositories {
@@ -77,7 +77,7 @@ dependencies {
   implementation "com.google.firebase:firebase-messaging:${versions.firebaseMessaging}"
   implementation "com.twilio:audioswitch:${versions.audioSwitch}"
   implementation 'com.google.android.material:material:1.1.0'
-  implementation "org.jetbrains.kotlin:kotlin-stdlib:${versions.kotlin}"
+
   implementation project(':expo-modules-core')
 
   constraints {

package/android/src/main/java/com/twiliovoicereactnative/CallInviteModuleProxy.java

@@ -0,0 +1,114 @@
+package com.twiliovoicereactnative;
+
+import android.os.Handler;
+import android.os.Looper;
+
+import com.facebook.react.bridge.ReactApplicationContext;
+import com.twilio.voice.CallMessage;
+
+import java.util.function.Consumer;
+import java.util.UUID;
+
+class CallInviteModuleProxy {
+  private static final SDKLog logger = new SDKLog(CallInviteModuleProxy.class);
+
+  private final Handler mainHandler = new Handler(Looper.getMainLooper());
+
+  private final ReactApplicationContext reactApplicationContext;
+
+  public CallInviteModuleProxy(ReactApplicationContext reactApplicationContext) {
+    this.reactApplicationContext = reactApplicationContext;
+  }
+
+  private void getCallRecord(
+    String uuidStr,
+    ModuleProxy.UniversalPromise promise,
+    Consumer<CallRecordDatabase.CallRecord> onSuccess
+  ) {
+    logger.debug(String.format(".getCallRecord(%s)", uuidStr));
+
+    final UUID uuid = UUID.fromString(uuidStr);
+
+    CallRecordDatabase.CallRecord callRecord = VoiceApplicationProxy
+      .getCallRecordDatabase()
+      .get(new CallRecordDatabase.CallRecord(uuid));
+
+    if (null == callRecord || null == callRecord.getCallInvite()) {
+      final String warningMsg = this.reactApplicationContext
+        .getString(R.string.missing_callinvite_uuid, uuid);
+      promise.rejectWithName(CommonConstants.ErrorCodeInvalidArgumentError, warningMsg);
+      return;
+    }
+
+    mainHandler.post(() -> {
+      logger.debug(String.format(".getCallRecord(%s) > runnable", uuid));
+      onSuccess.accept(callRecord);
+    });
+  }
+
+  public void accept(String uuid, ModuleProxy.UniversalPromise promise) {
+    logger.debug(String.format(".accept(%s)", uuid));
+
+    getCallRecord(uuid, promise, (callRecord) -> {
+      logger.debug(String.format(".accept(%s) > runnable", uuid));
+
+      callRecord.setCallAcceptedPromise(promise);
+
+      try {
+        VoiceApplicationProxy
+          .getVoiceServiceApi()
+          .acceptCall(callRecord);
+      } catch (SecurityException e) {
+        logger.error(e.toString());
+        promise.rejectWithCode(31401, e.getMessage());
+      }
+    });
+  }
+
+  public void reject(String uuid, ModuleProxy.UniversalPromise promise) {
+    logger.debug(String.format(".reject(%s)", uuid));
+
+    getCallRecord(uuid, promise, (callRecord) -> {
+      logger.debug(String.format(".reject(%s) > runnable", uuid));
+
+      // Store promise for callback
+      callRecord.setCallRejectedPromise(promise);
+
+      // Send Event to service
+      VoiceApplicationProxy
+        .getVoiceServiceApi()
+        .rejectCall(callRecord);
+    });
+  }
+
+  public void sendMessage(
+    String uuid,
+    String content,
+    String contentType,
+    String messageType,
+    ModuleProxy.UniversalPromise promise
+  ) {
+    logger.debug(String.format(".sendMessage(%s)", uuid));
+
+    getCallRecord(uuid, promise, (callRecord) -> {
+      logger.debug(String.format(".sendMessage(%s) > runnable", uuid));
+
+      final CallMessage callMessage = new CallMessage.Builder(messageType)
+        .contentType(contentType)
+        .content(content)
+        .build();
+
+      if (CallRecordDatabase.CallRecord.CallInviteState.ACTIVE != callRecord.getCallInviteState()) {
+        promise.rejectWithName(
+          CommonConstants.ErrorCodeInvalidStateError,
+          "Attempt to send call message on settled call invite"
+        );
+        return;
+      }
+
+      final String callMessageSid = callRecord.getCallInvite().sendMessage(callMessage);
+
+      promise.resolve(callMessageSid);
+    });
+  }
+}

package/android/src/main/java/com/twiliovoicereactnative/CallModuleProxy.java

@@ -0,0 +1,223 @@
+package com.twiliovoicereactnative;
+
+import android.os.Handler;
+import android.os.Looper;
+
+import com.facebook.react.bridge.ReactApplicationContext;
+import com.twilio.voice.Call;
+import com.twilio.voice.CallMessage;
+
+import java.util.function.Consumer;
+import java.util.Map;
+import java.util.UUID;
+
+class CallModuleProxy {
+  /**
+   * Map of common constant score strings to the Call.Score enum.
+   */
+  public static final Map<String, Call.Score> scoreMap = Map.of(
+    CommonConstants.CallFeedbackScoreNotReported, Call.Score.NOT_REPORTED,
+    CommonConstants.CallFeedbackScoreOne, Call.Score.ONE,
+    CommonConstants.CallFeedbackScoreTwo, Call.Score.TWO,
+    CommonConstants.CallFeedbackScoreThree, Call.Score.THREE,
+    CommonConstants.CallFeedbackScoreFour, Call.Score.FOUR,
+    CommonConstants.CallFeedbackScoreFive, Call.Score.FIVE
+  );
+
+  /**
+   * Map of common constant issue strings to the Call.Issue enum.
+   */
+  public static final Map<String, Call.Issue> issueMap = Map.of(
+    CommonConstants.CallFeedbackIssueAudioLatency, Call.Issue.AUDIO_LATENCY,
+    CommonConstants.CallFeedbackIssueChoppyAudio, Call.Issue.CHOPPY_AUDIO,
+    CommonConstants.CallFeedbackIssueEcho, Call.Issue.ECHO,
+    CommonConstants.CallFeedbackIssueDroppedCall, Call.Issue.DROPPED_CALL,
+    CommonConstants.CallFeedbackIssueNoisyCall, Call.Issue.NOISY_CALL,
+    CommonConstants.CallFeedbackIssueNotReported, Call.Issue.NOT_REPORTED,
+    CommonConstants.CallFeedbackIssueOneWayAudio, Call.Issue.ONE_WAY_AUDIO
+  );
+
+  /**
+   * Use the score map to get a Call.Score value from a string.
+   * @param score The score as a string passed from the JS layer.
+   * @return a Call.Score enum value. If the passed string is not in the enum, defaults to
+   * Call.Score.NOT_REPORTED.
+   */
+  public static Call.Score getScoreFromString(String score) {
+    return scoreMap.getOrDefault(score, Call.Score.NOT_REPORTED);
+  }
+
+  /**
+   * Use the issue map to get a Call.Issue value from a string.
+   * @param issue The issue as a string passed from the JS layer.
+   * @return a Call.Issue enum value. If the passed string is not in the enum, defaults to
+   * Call.Issue.NOT_REPORTED.
+   */
+  public static Call.Issue getIssueFromString(String issue) {
+    return issueMap.getOrDefault(issue, Call.Issue.NOT_REPORTED);
+  }
+
+  private final SDKLog logger = new SDKLog(CallModuleProxy.class);
+
+  private final Handler mainHandler = new Handler(Looper.getMainLooper());
+
+  private final ReactApplicationContext reactApplicationContext;
+
+  public CallModuleProxy(ReactApplicationContext reactApplicationContext) {
+    this.reactApplicationContext = reactApplicationContext;
+  }
+
+  private void getCallRecord(
+    String uuidStr,
+    ModuleProxy.UniversalPromise promise,
+    Consumer<CallRecordDatabase.CallRecord> onSuccess
+  ) {
+    logger.debug(String.format(".getCallRecord(%s)", uuidStr));
+
+    final UUID uuid = UUID.fromString(uuidStr);
+
+    final CallRecordDatabase.CallRecord callRecord = VoiceApplicationProxy
+      .getCallRecordDatabase()
+      .get(new CallRecordDatabase.CallRecord(uuid));
+
+    if (null == callRecord || null == callRecord.getVoiceCall()) {
+      final String warningMsg = this.reactApplicationContext
+        .getString(R.string.missing_call_uuid, uuid);
+      promise.rejectWithName(CommonConstants.ErrorCodeInvalidArgumentError, warningMsg);
+      return;
+    }
+
+    mainHandler.post(() -> {
+      logger.debug(".getCallRecord() > runnable");
+      onSuccess.accept(callRecord);
+    });
+  }
+
+  public void getState(String uuid, ModuleProxy.UniversalPromise promise) {
+    logger.debug(".getState()");
+
+    getCallRecord(uuid, promise, (callRecord) -> {
+      final String state = callRecord
+        .getVoiceCall()
+        .getState()
+        .toString()
+        .toLowerCase();
+      promise.resolve(state);
+    });
+  }
+
+  public void isMuted(String uuid, ModuleProxy.UniversalPromise promise) {
+    logger.debug(".isMuted()");
+
+    getCallRecord(uuid, promise, (callRecord) -> {
+      final boolean isMuted = callRecord
+        .getVoiceCall()
+        .isMuted();
+      promise.resolve(isMuted);
+    });
+  }
+
+  public void isOnHold(String uuid, ModuleProxy.UniversalPromise promise) {
+    logger.debug(".isOnHold()");
+
+    getCallRecord(uuid, promise, (callRecord) -> {
+      final boolean isOnHold = callRecord
+        .getVoiceCall()
+        .isOnHold();
+      promise.resolve(isOnHold);
+    });
+  }
+
+  public void disconnect(String uuid, ModuleProxy.UniversalPromise promise) {
+    logger.debug(String.format(".disconnect(%s)", uuid));
+
+    getCallRecord(uuid, promise, (callRecord) -> {
+      callRecord
+        .getVoiceCall()
+        .disconnect();
+      promise.resolve(null);
+    });
+  }
+
+  public void hold(String uuid, boolean hold, ModuleProxy.UniversalPromise promise) {
+    logger.debug(".hold()");
+
+    getCallRecord(uuid, promise, (callRecord) -> {
+      callRecord
+        .getVoiceCall()
+        .hold(hold);
+      promise.resolve(hold);
+    });
+  }
+
+  public void mute(String uuid, boolean mute, ModuleProxy.UniversalPromise promise) {
+    logger.debug(".mute()");
+
+    getCallRecord(uuid, promise, (callRecord) -> {
+      callRecord
+        .getVoiceCall()
+        .mute(mute);
+      promise.resolve(mute);
+    });
+  }
+
+  public void sendDigits(String uuid, String digits, ModuleProxy.UniversalPromise promise) {
+    logger.debug(".sendDigits()");
+
+    getCallRecord(uuid, promise, (callRecord) -> {
+      callRecord
+        .getVoiceCall()
+        .sendDigits(digits);
+      promise.resolve(null);
+    });
+  }
+
+  public void postFeedback(String uuid, String score, String issue, ModuleProxy.UniversalPromise promise) {
+    logger.debug(".postFeedback()");
+
+    getCallRecord(uuid, promise, (callRecord) -> {
+      Call.Score parsedScore = CallModuleProxy.getScoreFromString(score);
+      Call.Issue parsedIssue = CallModuleProxy.getIssueFromString(issue);
+
+      callRecord
+        .getVoiceCall()
+        .postFeedback(parsedScore, parsedIssue);
+
+      promise.resolve(null);
+    });
+  }
+
+  public void getStats(String uuid, ModuleProxy.UniversalPromise promise) {
+    logger.debug(".getStats()");
+
+    getCallRecord(uuid, promise, (callRecord) -> {
+      callRecord
+        .getVoiceCall()
+        .getStats(new StatsListenerProxy(promise));
+    });
+  }
+
+  public void sendMessage(
+    String uuid,
+    String content,
+    String contentType,
+    String messageType,
+    ModuleProxy.UniversalPromise promise
+  ) {
+    logger.debug(".sendMessage()");
+
+    getCallRecord(uuid, promise, (callRecord) -> {
+      final CallMessage callMessage = new CallMessage.Builder(messageType)
+        .contentType(contentType)
+        .content(content)
+        .build();
+
+      final String callMessageSid =
+        CallRecordDatabase.CallRecord.CallInviteState.ACTIVE == callRecord.getCallInviteState()
+          ? callRecord.getCallInvite().sendMessage(callMessage)
+          : callRecord.getVoiceCall().sendMessage(callMessage);
+
+      promise.resolve(callMessageSid);
+    });
+  }
+}

package/android/src/main/java/com/twiliovoicereactnative/CallRecordDatabase.java

@@ -13,7 +13,6 @@ import java.util.Map;
 
 import androidx.annotation.NonNull;
 
-import com.facebook.react.bridge.Promise;
 import com.twilio.voice.Call;
 import com.twilio.voice.CallException;
 import com.twilio.voice.CallInvite;
@@ -32,8 +31,8 @@ class CallRecordDatabase  {
     private CallInvite callInvite = null;
     private CallInviteState callInviteState = NONE;
     private CancelledCallInvite cancelledCallInvite = null;
-    private Promise callAcceptedPromise = null;
-    private Promise callRejectedPromise = null;
+    private ModuleProxy.UniversalPromise callAcceptedPromise = null;
+    private ModuleProxy.UniversalPromise callRejectedPromise = null;
     private CallException callException = null;
     private Map<String, String> customParameters = null;
     private String notificationDisplayName = null;
@@ -103,16 +102,18 @@ class CallRecordDatabase  {
     public CancelledCallInvite getCancelledCallInvite() {
       return this.cancelledCallInvite;
     }
-    public Promise getCallAcceptedPromise() {
+    public ModuleProxy.UniversalPromise getCallAcceptedPromise() {
       return this.callAcceptedPromise;
     }
-    public Promise getCallRejectedPromise() {
+    public ModuleProxy.UniversalPromise getCallRejectedPromise() {
       return this.callRejectedPromise;
     }
     public CallException getCallException() {
       return this.callException;
     }
-    public String getCallRecipient() { return this.callRecipient; }
+    public String getCallRecipient() {
+      return this.callRecipient;
+    }
     public void setNotificationId(int notificationId) {
       this.notificationId = notificationId;
     }
@@ -124,7 +125,9 @@ class CallRecordDatabase  {
       this.voiceCall = voiceCall;
     }
     public void setCallInviteUsedState() {
-      this.callInviteState = (this.callInviteState == ACTIVE) ? USED : this.callInviteState;
+      this.callInviteState = this.callInviteState == ACTIVE
+        ? USED
+        : this.callInviteState;
     }
     public void setCancelledCallInvite(@NonNull CancelledCallInvite cancelledCallInvite) {
       this.callSid = cancelledCallInvite.getCallSid();
@@ -132,10 +135,10 @@ class CallRecordDatabase  {
       this.callInvite = null;
       this.callInviteState = NONE;
     }
-    public void setCallAcceptedPromise(@NonNull Promise callAcceptedPromise) {
+    public void setCallAcceptedPromise(@NonNull ModuleProxy.UniversalPromise callAcceptedPromise) {
       this.callAcceptedPromise = callAcceptedPromise;
     }
-    public void setCallRejectedPromise(@NonNull Promise callRejectedPromise) {
+    public void setCallRejectedPromise(@NonNull ModuleProxy.UniversalPromise callRejectedPromise) {
       this.callRejectedPromise = callRejectedPromise;
     }
     public void setCallException(CallException callException) {