feat(SDK-548): React Native SDK feature parity epic

.github/workflows/ci.yml

@@ -109,6 +109,10 @@ jobs:
         run: |
           yarn turbo run build:android --cache-dir="${{ env.TURBO_CACHE_DIR }}"
 
+      - name: Run Android library unit tests
+        if: env.turbo_cache_hit != 1
+        run: yarn test:android:unit
+
   build-ios:
     runs-on: macos-15
     env:

.gitignore

@@ -97,6 +97,7 @@ docs/
 
 # Agents
 .agent/
+.artifacts/
 .claude/
 .cursor/
 .opencode/

CHANGELOG.md

@@ -1,3 +1,31 @@
+## Unreleased
+
+### Fixes
+
+- Fixed `Iterable.trackPushOpenWithCampaignId` on Android so the `appAlreadyRunning` argument is forwarded to the native SDK instead of always being sent as `false`.
+
+### Updates
+
+- Added optional placement IDs to `Iterable.embeddedManager.syncMessages()` so apps can sync embedded messages for specific placements only (SDK-751). When omitted, null, or empty, behavior matches the previous sync-all call.
+  - **Android:** Scoped sync (`syncMessages([id, …])`) matches the pinned iterableapi behavior and may remove cached messages for placements not included in the sync response (SDK-798). iOS preserves unrequested placements. Prefer `syncMessages()` without placement IDs on Android until the native fix ships and the Android SDK pin is bumped.
+- Added `IterableInAppMessage.jsonOnly` so `inAppHandler` and in-app message fetches can distinguish JSON-only messages from HTML in-apps (SDK-750).
+- Added `IterableConfig.onEmbeddedMessagingSyncSucceeded` and
+  `IterableConfig.onEmbeddedMessagingSyncFailed` so apps can observe embedded
+  messaging sync outcomes (SDK-749). Failure callbacks receive a nullable reason
+  string forwarded from the native SDKs. On iOS, subscription-inactive or
+  invalid API key failures may invoke both `onEmbeddedMessagingDisabled` and
+  `onEmbeddedMessagingSyncFailed`; on Android only
+  `onEmbeddedMessagingDisabled` is invoked for those cases (native SDK
+  behavior).
+- Added `Iterable.authManager.getAuthToken()` to read the JWT currently held by the native SDK (SDK-559).
+  - iOS: `IterableAPI.authToken`.
+  - Android: `IterableApi.getAuthToken()`.
+- Added `IterableConfig.decryptionFailureHandler` (Android only) to notify the app when native keychain decryption fails (SDK-557). The SDK clears stored PII and disables encryption for the device before invoking the callback; iOS has no equivalent native API and ignores this option.
+- Added `IterableConfig.keychainEncryption` (default `true`, Android only) so React Native apps can control native `IterableConfig.Builder.setKeychainEncryption`.
+- Deprecated `IterableConfig.encryptionEnforced`, which never had an effect.
+- Added `Iterable.disableDeviceForAllUsers()` to unregister this device's push token from every user associated with the device (SDK-550).
+  - iOS: forwards to native `IterableAPI.disableDeviceForAllUsers()`.
+  - Android: graceful no-op that logs a warning; use `disableDeviceForCurrentUser()` to disable push for the current user. There is no public native "all users" equivalent.
 ## 3.2.1
 
 ### Fixes

android/build.gradle

@@ -81,6 +81,14 @@ android {
     targetCompatibility JavaVersion.VERSION_1_8
   }
 
+  testOptions {
+    unitTests.all {
+      testLogging {
+        exceptionFormat "full"
+      }
+    }
+  }
+
   sourceSets {
     main {
       if (isNewArchitectureEnabled()) {

android/src/main/java/com/iterable/iterableapi/RNIterableInternal.java

@@ -2,12 +2,11 @@
 
 import androidx.annotation.Nullable;
 
+import org.json.JSONException;
 import org.json.JSONObject;
 
 public class RNIterableInternal {
 
-    private static String TAG = "RNIterableInternal";
-
     public static String getEmail() {
         return IterableApi.getInstance().getEmail();
     }
@@ -16,16 +15,31 @@ public static String getUserId() {
         return IterableApi.getInstance().getUserId();
     }
 
-    public static JSONObject getInAppMessageJson(IterableInAppMessage message) {
-        return message.toJSONObject();
+    @Nullable
+    public static String getAuthToken() {
+        return IterableApi.getInstance().getAuthToken();
+    }
+
+    public static JSONObject getInAppMessageJson(IterableInAppMessage message)
+            throws JSONException {
+        JSONObject messageJson = message.toJSONObject();
+        // Overwrite native serialization (may use integer 1) so the bridge sends a boolean for JS.
+        messageJson.put("jsonOnly", message.isJsonOnly());
+        return messageJson;
     }
 
     public static IterableInAppMessage getMessageById(String messageId) {
         return IterableApi.getInstance().getInAppManager().getMessageById(messageId);
     }
 
-    public static void trackPushOpenWithCampaignId(Integer campaignId, Integer templateId, String messageId, @Nullable JSONObject dataFields) {
-        IterableApi.getInstance().trackPushOpen(campaignId, templateId, messageId, dataFields);
+    public static void trackPushOpenWithCampaignId(
+            Integer campaignId,
+            Integer templateId,
+            String messageId,
+            boolean appAlreadyRunning,
+            @Nullable JSONObject dataFields) {
+        IterableApi.getInstance().trackPushOpen(
+                campaignId, templateId, messageId, appAlreadyRunning, dataFields);
     }
 
     public static void setAttributionInfo(IterableAttributionInfo attributionInfo) {

android/src/main/java/com/iterable/reactnative/RNIterableAPIModuleImpl.java

@@ -29,6 +29,7 @@
 import com.iterable.iterableapi.IterableAuthManager;
 import com.iterable.iterableapi.IterableConfig;
 import com.iterable.iterableapi.IterableCustomActionHandler;
+import com.iterable.iterableapi.IterableDecryptionFailureHandler;
 import com.iterable.iterableapi.IterableEmbeddedMessage;
 import com.iterable.iterableapi.IterableEmbeddedUpdateHandler;
 import com.iterable.iterableapi.IterableHelper;
@@ -53,7 +54,7 @@
 import java.util.concurrent.CountDownLatch;
 import java.util.concurrent.TimeUnit;
 
-public class RNIterableAPIModuleImpl implements IterableUrlHandler, IterableCustomActionHandler, IterableInAppHandler, IterableAuthHandler, IterableInAppManager.Listener, IterableEmbeddedUpdateHandler {
+public class RNIterableAPIModuleImpl implements IterableUrlHandler, IterableCustomActionHandler, IterableInAppHandler, IterableAuthHandler, IterableDecryptionFailureHandler, IterableInAppManager.Listener, IterableEmbeddedUpdateHandler {
     public static final String NAME = "RNIterableAPI";
 
     private static String TAG = "RNIterableAPIModule";
@@ -93,6 +94,10 @@ public void initializeWithApiKey(String apiKey, ReadableMap configReadableMap, S
             configBuilder.setAuthHandler(this);
         }
 
+        // IterableKeychain is created once with config.decryptionFailureHandler; the JS
+        // listener remains conditional on decryptionFailureHandlerPresent.
+        configBuilder.setDecryptionFailureHandler(this);
+
         // Check if embedded messaging is enabled before building config
         boolean enableEmbeddedMessaging = configReadableMap.hasKey("enableEmbeddedMessaging") && configReadableMap.getBoolean("enableEmbeddedMessaging");
 
@@ -161,6 +166,9 @@ public void initialize2WithApiKey(String apiKey, ReadableMap configReadableMap,
             configBuilder.setAuthHandler(this);
         }
 
+        // See initializeWithApiKey — keychain caches this handler at first construction.
+        configBuilder.setDecryptionFailureHandler(this);
+
         // NOTE: There does not seem to be a way to set the API endpoint
         // override in the Android SDK.  Check with @Ayyanchira and @evantk91 to
         // see what the best approach is.
@@ -249,6 +257,10 @@ public void getUserId(Promise promise) {
         promise.resolve(RNIterableInternal.getUserId());
     }
 
+    public void getAuthToken(Promise promise) {
+        promise.resolve(RNIterableInternal.getAuthToken());
+    }
+
     public void trackEvent(String name, @Nullable ReadableMap dataFields) {
         IterableLogger.v(TAG, "trackEvent");
         IterableApi.getInstance().track(name, optSerializedDataFields(dataFields));
@@ -265,7 +277,12 @@ public void trackPurchase(double total, ReadableArray items, @Nullable ReadableM
     }
 
     public void trackPushOpenWithCampaignId(double campaignId, @Nullable Double templateId, String messageId, boolean appAlreadyRunning, @Nullable ReadableMap dataFields) {
-        RNIterableInternal.trackPushOpenWithCampaignId((int) campaignId, templateId != null ? templateId.intValue() : null, messageId, optSerializedDataFields(dataFields));
+        RNIterableInternal.trackPushOpenWithCampaignId(
+                (int) campaignId,
+                templateId != null ? templateId.intValue() : null,
+                messageId,
+                appAlreadyRunning,
+                optSerializedDataFields(dataFields));
     }
 
     public void updateSubscriptions(@Nullable ReadableArray emailListIds, @Nullable ReadableArray unsubscribedChannelIds, @Nullable ReadableArray unsubscribedMessageTypeIds, @Nullable ReadableArray subscribedMessageTypeIds, double campaignId, double templateId) {
@@ -391,6 +408,10 @@ public void disableDeviceForCurrentUser() {
         IterableApi.getInstance().disablePush();
     }
 
+    public void disableDeviceForAllUsers() {
+        IterableLogger.w(TAG, "disableDeviceForAllUsers is not supported on Android; use disableDeviceForCurrentUser. There is no public native equivalent.");
+    }
+
     public void registerDeviceToken(String token) {
         IterableLogger.v(TAG, "registerDeviceToken");
         IterableApi.getInstance().registerDeviceToken(token);
@@ -628,9 +649,8 @@ public boolean handleIterableCustomAction(@NonNull IterableAction action, @NonNu
     public IterableInAppHandler.InAppResponse onNewInApp(@NonNull IterableInAppMessage message) {
         IterableLogger.printInfo();
 
-        JSONObject messageJson = RNIterableInternal.getInAppMessageJson(message);
-
         try {
+            JSONObject messageJson = RNIterableInternal.getInAppMessageJson(message);
             WritableMap eventData = Serialization.convertJsonToMap(messageJson);
             jsCallBackLatch = new CountDownLatch(1);
             sendEvent(EventName.handleInAppCalled.name(), eventData);
@@ -677,6 +697,24 @@ public String onAuthTokenRequested() {
         }
     }
 
+    private static final String DECRYPTION_FAILURE_DEFAULT_MESSAGE = "Decryption failed";
+
+    @Override
+    public void onDecryptionFailed(Exception exception) {
+        JSONObject messageJson = new JSONObject();
+        try {
+            String message = exception != null ? exception.getMessage() : null;
+            if (message == null || message.isEmpty()) {
+                message = DECRYPTION_FAILURE_DEFAULT_MESSAGE;
+            }
+            messageJson.put("message", message);
+            WritableMap eventData = Serialization.convertJsonToMap(messageJson);
+            sendEvent(EventName.handleDecryptionFailureCalled.name(), eventData);
+        } catch (JSONException e) {
+            IterableLogger.e(TAG, "Failed to send decryption failure event");
+        }
+    }
+
     @Override
     public void onAuthFailure(AuthFailure authFailure) {
       // Create a JSON object for the authFailure object
@@ -744,21 +782,33 @@ public void onEmbeddedMessagingDisabled() {
     @Override
     public void onEmbeddedMessagingSyncSucceeded() {
         IterableLogger.d(TAG, "onEmbeddedMessagingSyncSucceeded");
+        sendEvent(EventName.handleEmbeddedMessagingSyncSucceededCalled.name(), null);
     }
 
     @Override
     public void onEmbeddedMessagingSyncFailed(@Nullable String reason) {
         IterableLogger.d(TAG, "onEmbeddedMessagingSyncFailed: " + reason);
+        sendEvent(EventName.handleEmbeddedMessagingSyncFailedCalled.name(), reason);
     }
     // ---------------------------------------------------------------------------------------
     // endregion
 
     // ---------------------------------------------------------------------------------------
     // region Embedded messaging
 
-    public void syncEmbeddedMessages() {
-        IterableLogger.d(TAG, "syncEmbeddedMessages");
-        IterableApi.getInstance().getEmbeddedManager().syncMessages();
+    public void syncEmbeddedMessages(@Nullable ReadableArray placementIds) {
+        IterableLogger.d(TAG, "syncEmbeddedMessages for placements: " + placementIds);
+
+        if (placementIds == null || placementIds.size() == 0) {
+            IterableApi.getInstance().getEmbeddedManager().syncMessages();
+        } else {
+            IterableLogger.w(TAG, "Scoped syncEmbeddedMessages may remove cached messages for placements not in the sync response (SDK-798). Prefer syncMessages() without placement IDs on Android until iterableapi is fixed.");
+            Long[] ids = new Long[placementIds.size()];
+            for (int i = 0; i < placementIds.size(); i++) {
+                ids[i] = (long) placementIds.getInt(i);
+            }
+            IterableApi.getInstance().getEmbeddedManager().syncMessages(ids);
+        }
     }
 
     public void startEmbeddedSession() {
@@ -839,8 +889,11 @@ enum EventName {
   handleAuthFailureCalled,
   handleAuthSuccessCalled,
   handleCustomActionCalled,
+  handleDecryptionFailureCalled,
   handleEmbeddedMessageUpdateCalled,
   handleEmbeddedMessagingDisabledCalled,
+  handleEmbeddedMessagingSyncSucceededCalled,
+  handleEmbeddedMessagingSyncFailedCalled,
   handleInAppCalled,
   handleUrlCalled,
   receivedIterableEmbeddedMessagesChanged,

android/src/main/java/com/iterable/reactnative/Serialization.java

@@ -129,7 +129,8 @@ static JSONObject messageContentToJsonObject(IterableInAppMessage.Content conten
         return messageContent;
     }
 
-    static JSONArray serializeInAppMessages(List<IterableInAppMessage> inAppMessages) {
+    static JSONArray serializeInAppMessages(List<IterableInAppMessage> inAppMessages)
+            throws JSONException {
         JSONArray inAppMessagesJson = new JSONArray();
         for (IterableInAppMessage message : inAppMessages) {
             JSONObject messageJson = RNIterableInternal.getInAppMessageJson(message);
@@ -250,6 +251,9 @@ static IterableConfig.Builder getConfigFromReadableMap(ReadableMap iterableConte
                 configBuilder.setEnableEmbeddedMessaging(iterableContextJSON.optBoolean("enableEmbeddedMessaging"));
             }
 
+            configBuilder.setKeychainEncryption(
+                    iterableContextJSON.optBoolean("keychainEncryption", true));
+
             if (iterableContextJSON.has("retryPolicy")) {
                 JSONObject retryPolicyJson = iterableContextJSON.getJSONObject("retryPolicy");
                 int maxRetry = retryPolicyJson.getInt("maxRetry");

android/src/newarch/java/com/RNIterableAPIModule.java

@@ -72,6 +72,11 @@ public void getUserId(Promise promise) {
     moduleImpl.getUserId(promise);
   }
 
+  @Override
+  public void getAuthToken(Promise promise) {
+    moduleImpl.getAuthToken(promise);
+  }
+
   @Override
   public void trackEvent(String name, @Nullable ReadableMap dataFields) {
     moduleImpl.trackEvent(name, dataFields);
@@ -137,6 +142,11 @@ public void disableDeviceForCurrentUser() {
     moduleImpl.disableDeviceForCurrentUser();
   }
 
+  @Override
+  public void disableDeviceForAllUsers() {
+    moduleImpl.disableDeviceForAllUsers();
+  }
+
   @Override
   public void registerDeviceToken(String token) {
     moduleImpl.registerDeviceToken(token);
@@ -230,8 +240,8 @@ public void pauseAuthRetries(boolean pauseRetry) {
   }
 
   @Override
-  public void syncEmbeddedMessages() {
-    moduleImpl.syncEmbeddedMessages();
+  public void syncEmbeddedMessages(@Nullable ReadableArray placementIds) {
+    moduleImpl.syncEmbeddedMessages(placementIds);
   }
 
   @Override

android/src/oldarch/java/com/RNIterableAPIModule.java

@@ -73,6 +73,11 @@ public void getUserId(Promise promise) {
       moduleImpl.getUserId(promise);
     }
 
+    @ReactMethod
+    public void getAuthToken(Promise promise) {
+      moduleImpl.getAuthToken(promise);
+    }
+
     @ReactMethod
     public void trackEvent(String name, @Nullable ReadableMap dataFields) {
       moduleImpl.trackEvent(name, dataFields);
@@ -138,6 +143,11 @@ public void disableDeviceForCurrentUser() {
       moduleImpl.disableDeviceForCurrentUser();
     }
 
+    @ReactMethod
+    public void disableDeviceForAllUsers() {
+      moduleImpl.disableDeviceForAllUsers();
+    }
+
     @ReactMethod
     public void registerDeviceToken(String token) {
       moduleImpl.registerDeviceToken(token);
@@ -234,8 +244,8 @@ public void pauseAuthRetries(boolean pauseRetry) {
     }
 
     @ReactMethod
-    public void syncEmbeddedMessages() {
-      moduleImpl.syncEmbeddedMessages();
+    public void syncEmbeddedMessages(@Nullable ReadableArray placementIds) {
+      moduleImpl.syncEmbeddedMessages(placementIds);
     }
 
     @ReactMethod