@adobe/react-native-aepmessaging 5.0.0 → 5.1.0-beta.1

package/android/src/main/java/com/adobe/marketing/mobile/reactnative/messaging/RCTAEPMessagingModule.java

@@ -1,27 +1,27 @@
 /*
- Copyright 2022 Adobe. All rights reserved.
- This file is licensed to you under the Apache License, Version 2.0 (the "License");
- you may not use this file except in compliance with the License. You may obtain a copy
- of the License at http://www.apache.org/licenses/LICENSE-2.0
- Unless required by applicable law or agreed to in writing, software distributed under
- the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
- OF ANY KIND, either express or implied. See the License for the specific language
- governing permissions and limitations under the License.
+    Copyright 2023 Adobe. All rights reserved.
+    This file is licensed to you under the Apache License, Version 2.0 (the
+    "License"); you may not use this file except in compliance with the License.
+    You may obtain a copy of the License at
+    http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law
+    or agreed to in writing, software distributed under the License is
+    distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS OF
+    ANY KIND, either express or implied. See the License for the specific
+    language governing permissions and limitations under the License.
  */
 package com.adobe.marketing.mobile.reactnative.messaging;
 
+import android.app.Activity;
 import com.adobe.marketing.mobile.AdobeCallback;
+import com.adobe.marketing.mobile.AdobeCallbackWithError;
+import com.adobe.marketing.mobile.AdobeError;
 import com.adobe.marketing.mobile.LoggingMode;
-
-import static com.adobe.marketing.mobile.LoggingMode.DEBUG;
-import static com.adobe.marketing.mobile.LoggingMode.VERBOSE;
-
-import android.util.Log;
-
 import com.adobe.marketing.mobile.Message;
 import com.adobe.marketing.mobile.Messaging;
 import com.adobe.marketing.mobile.MessagingEdgeEventType;
 import com.adobe.marketing.mobile.MobileCore;
+import com.adobe.marketing.mobile.messaging.MessagingProposition;
+import com.adobe.marketing.mobile.messaging.Surface;
 import com.adobe.marketing.mobile.services.MessagingDelegate;
 import com.adobe.marketing.mobile.services.ui.FullscreenMessage;
 import com.facebook.react.bridge.Arguments;
@@ -29,225 +29,292 @@ import com.facebook.react.bridge.Promise;
 import com.facebook.react.bridge.ReactApplicationContext;
 import com.facebook.react.bridge.ReactContextBaseJavaModule;
 import com.facebook.react.bridge.ReactMethod;
+import com.facebook.react.bridge.ReadableArray;
 import com.facebook.react.bridge.WritableMap;
 import com.facebook.react.modules.core.DeviceEventManagerModule;
-
 import java.util.HashMap;
+import java.util.List;
 import java.util.Map;
 import java.util.concurrent.CountDownLatch;
 
-public final class RCTAEPMessagingModule extends ReactContextBaseJavaModule implements MessagingDelegate {
-
-    private static final String TAG = "RCTAEPMessagingModule";
-    private final Map<String, Message> messageCache;
-    private final ReactApplicationContext reactContext;
-    private boolean shouldSaveMessage;
-    private boolean shouldShowMessage;
-    private CountDownLatch latch = new CountDownLatch(1);
-
-    public RCTAEPMessagingModule(ReactApplicationContext reactContext) {
-        super(reactContext);
-        this.reactContext = reactContext;
-        this.messageCache = new HashMap<>();
-        this.shouldShowMessage = false;
-        this.shouldSaveMessage = false;
-    }
+public final class RCTAEPMessagingModule
+    extends ReactContextBaseJavaModule implements MessagingDelegate {
 
-    @Override
-    public String getName() {
-        return "AEPMessaging";
-    }
+  private static final String TAG = "RCTAEPMessagingModule";
+  private final Map<String, Message> messageCache = new HashMap<>();
+  private final ReactApplicationContext reactContext;
+  private boolean shouldSaveMessage = false;
+  private boolean shouldShowMessage = false;
+  private CountDownLatch latch = new CountDownLatch(1);
+  private Message latestMessage = null;
+
+  public RCTAEPMessagingModule(ReactApplicationContext reactContext) {
+    super(reactContext);
+    this.reactContext = reactContext;
+  }
+
+  @Override
+  public String getName() {
+    return "AEPMessaging";
+  }
+
+  // Required for rn built in EventEmitter Calls.
+  @ReactMethod
+  public void addListener(String eventName) {}
+
+  @ReactMethod
+  public void removeListeners(Integer count) {}
+
+  @ReactMethod
+  public void extensionVersion(final Promise promise) {
+    MobileCore.log(LoggingMode.VERBOSE, TAG, "extensionVersion is called");
+    promise.resolve(Messaging.extensionVersion());
+  }
 
-    // Required for rn built in EventEmitter Calls.
-    @ReactMethod
-    public void addListener(String eventName) {}
+  @ReactMethod
+  public void getCachedMessages(final Promise promise) {
+    promise.resolve(
+        RCTAEPMessagingUtil.convertMessagesToJS(this.messageCache.values()));
+  }
 
-    @ReactMethod
-    public void removeListeners(Integer count) {}
+  @ReactMethod
+  public void getLatestMessage(final Promise promise) {
+    promise.resolve(this.latestMessage);
+  }
 
-    @ReactMethod
-    public void extensionVersion(final Promise promise) {
-        MobileCore.log(VERBOSE, TAG, "extensionVersion is called");
-        promise.resolve(Messaging.extensionVersion());
+  @ReactMethod
+  public void getPropositionsForSurfaces(ReadableArray surfaces,
+                                         final Promise promise) {
+    String bundleId = this.reactContext.getPackageName();
+    Messaging.getPropositionsForSurfaces(
+        RCTAEPMessagingUtil.convertSurfaces(surfaces),
+        new AdobeCallbackWithError<Map<Surface, List<MessagingProposition>>>() {
+          @Override
+          public void fail(final AdobeError adobeError) {
+            promise.reject(adobeError.getErrorName(),
+                           "Unable to get Propositions");
+          }
+
+          @Override
+          public void call(
+              Map<Surface, List<MessagingProposition>> propositionsMap) {
+            promise.resolve(RCTAEPMessagingUtil.convertSurfacePropositions(
+                propositionsMap, bundleId));
+          }
+        });
+  }
+
+  @ReactMethod
+  public void refreshInAppMessages() {
+    MobileCore.log(LoggingMode.VERBOSE, TAG, "refreshInAppMessages is called");
+    Messaging.refreshInAppMessages();
+  }
+
+  @ReactMethod
+  public void setMessagingDelegate() {
+    MobileCore.log(LoggingMode.VERBOSE, TAG, "setMessagingDelegate is called");
+    MobileCore.setMessagingDelegate(this);
+  }
+
+  @ReactMethod
+  public void updatePropositionsForSurfaces(ReadableArray surfaces) {
+    Messaging.updatePropositionsForSurfaces(
+        RCTAEPMessagingUtil.convertSurfaces(surfaces));
+  }
+
+  // Message Methods
+
+  @ReactMethod
+  public void clear(final String messageId) {
+    if (messageId != null) {
+      MobileCore.log(
+          LoggingMode.VERBOSE, TAG,
+          String.format("clear is called with message id: %s", messageId));
+      messageCache.remove(messageId);
     }
+  }
 
-    @ReactMethod
-    public void refreshInAppMessages() {
-        MobileCore.log(VERBOSE, TAG, "refreshInAppMessages is called");
-        Messaging.refreshInAppMessages();
+  @ReactMethod
+  public void dismiss(final String messageId, final boolean suppressAutoTrack) {
+    if (messageId != null && messageCache.get(messageId) != null) {
+      MobileCore.log(
+          LoggingMode.VERBOSE, TAG,
+          String.format(
+              "dismiss is called with message id: %s and suppressAutoTrack: %b",
+              messageId, suppressAutoTrack));
+      messageCache.get(messageId).dismiss(suppressAutoTrack);
     }
+  }
 
-    @ReactMethod
-    public void setMessagingDelegate() {
-        MobileCore.log(VERBOSE, TAG, "setMessagingDelegate is called");
-        MobileCore.setMessagingDelegate(this);
+  @ReactMethod
+  public void handleJavascriptMessage(final String messageId,
+                                      final String messageName,
+                                      final Promise promise) {
+    if (messageId != null && messageCache.get(messageId) != null) {
+      MobileCore.log(
+          LoggingMode.VERBOSE, TAG,
+          String.format(
+              "handleJavascriptMessage is called with message id: %s and messageName: %s",
+              messageId, messageName));
+      messageCache.get(messageId).handleJavascriptMessage(
+          messageName, new AdobeCallback<String>() {
+            @Override
+            public void call(final String s) {
+              if (s != null) {
+                promise.resolve(s);
+              } else {
+                promise.reject("error", "error in handling javascriptMessage " +
+                                            messageName);
+              }
+            }
+          });
     }
+  }
 
-    @ReactMethod
-    public void show(final String messageId) {
-        if (messageId != null && messageCache.get(messageId) != null) {
-            MobileCore.log(VERBOSE, TAG, String.format("show is called with message id: %s", messageId));
-            messageCache.get(messageId).show();
-        }
+  @ReactMethod
+  public void setAutoTrack(final String messageId, final boolean autoTrack) {
+    if (messageId != null && messageCache.get(messageId) != null) {
+      MobileCore.log(
+          LoggingMode.VERBOSE, TAG,
+          String.format(
+              "setAutoTrack is called with message id: %s and autoTrack: %b",
+              messageId, autoTrack));
+      messageCache.get(messageId).setAutoTrack(autoTrack);
     }
+  }
 
-    @ReactMethod
-    public void dismiss(final String messageId, final boolean suppressAutoTrack) {
-        if (messageId != null && messageCache.get(messageId) != null) {
-            MobileCore.log(VERBOSE, TAG, String.format("dismiss is called with message id: %s and suppressAutoTrack: %b", messageId, suppressAutoTrack));
-            messageCache.get(messageId).dismiss(suppressAutoTrack);
-        }
+  @ReactMethod
+  public void show(final String messageId) {
+    if (messageId != null && messageCache.get(messageId) != null) {
+      MobileCore.log(
+          LoggingMode.VERBOSE, TAG,
+          String.format("show is called with message id: %s", messageId));
+      messageCache.get(messageId).show();
     }
+  }
 
-    @ReactMethod
-    public void track(final String messageId, final String interaction, final int eventType) {
-        if (messageId != null && messageCache.get(messageId) != null) {
-            MobileCore.log(VERBOSE, TAG, String.format("track is called with message id: %s, interaction: %s and eventType: %d", messageId, interaction, eventType));
-            MessagingEdgeEventType edgeEventType = null;
-            switch (eventType) {
-                case 0:
-                    edgeEventType = MessagingEdgeEventType.IN_APP_DISMISS;
-                    break;
-                case 1:
-                    edgeEventType = MessagingEdgeEventType.IN_APP_INTERACT;
-                    break;
-                case 2:
-                    edgeEventType = MessagingEdgeEventType.IN_APP_TRIGGER;
-                    break;
-                case 3:
-                    edgeEventType = MessagingEdgeEventType.IN_APP_DISPLAY;
-                    break;
-                case 4:
-                    edgeEventType = MessagingEdgeEventType.PUSH_APPLICATION_OPENED;
-                    break;
-                case 5:
-                    edgeEventType = MessagingEdgeEventType.PUSH_CUSTOM_ACTION;
-                    break;
-                default:
-                    break;
-            }
-            if (edgeEventType != null) {
-                messageCache.get(messageId).track(interaction, edgeEventType);
-            } else {
-                MobileCore.log(DEBUG, TAG, String.format("Unable to track interaction (%s) because edgeEventType (%d) is invalid ", interaction, eventType));
-            }
-        }
+  @ReactMethod
+  public void track(final String messageId, final String interaction,
+                    final int eventType) {
+    if (messageId != null && messageCache.get(messageId) != null) {
+      MobileCore.log(
+          LoggingMode.VERBOSE, TAG,
+          String.format(
+              "track is called with message id: %s, interaction: %s and eventType: %d",
+              messageId, interaction, eventType));
+      MessagingEdgeEventType edgeEventType =
+          RCTAEPMessagingUtil.getEventType(eventType);
+      if (edgeEventType != null) {
+        messageCache.get(messageId).track(interaction, edgeEventType);
+      } else {
+        MobileCore.log(
+            LoggingMode.DEBUG, TAG,
+            String.format(
+                "Unable to track interaction (%s) because edgeEventType (%d) is invalid ",
+                interaction, eventType));
+      }
     }
+  }
 
-    @ReactMethod
-    public void handleJavascriptMessage(final String messageId, final String messageName, final Promise promise) {
-        if (messageId != null && messageCache.get(messageId) != null) {
-            MobileCore.log(VERBOSE, TAG, String.format("handleJavascriptMessage is called with message id: %s and messageName: %s", messageId, messageName));
-            messageCache.get(messageId).handleJavascriptMessage(messageName, new AdobeCallback<String>() {
-                @Override
-                public void call(final String s) {
-                    if (s != null) {
-                        promise.resolve(s);
-                    } else {
-                        promise.reject("error", "error in handling javascriptMessage " + messageName);
-                    }
-                }
-            });
-        }
+  // Messaging Delegate functions
+  @Override
+  public void onShow(final FullscreenMessage fullscreenMessage) {
+    MobileCore.log(LoggingMode.VERBOSE, TAG, "onShow is called");
+    final Message message = (Message)fullscreenMessage.getParent();
+    if (message != null) {
+      Map<String, String> data =
+          RCTAEPMessagingUtil.convertMessageToMap(message);
+      emitEvent("onShow", data);
     }
+  }
 
-    @ReactMethod
-    public void clear(final String messageId) {
-        if (messageId != null) {
-            MobileCore.log(VERBOSE, TAG, String.format("clear is called with message id: %s", messageId));
-            messageCache.remove(messageId);
-        }
+  @Override
+  public void onDismiss(final FullscreenMessage fullscreenMessage) {
+    MobileCore.log(LoggingMode.VERBOSE, TAG, "onDismiss is called");
+    final Message message = (Message)fullscreenMessage.getParent();
+    if (message != null) {
+      Map<String, String> data =
+          RCTAEPMessagingUtil.convertMessageToMap(message);
+      emitEvent("onDismiss", data);
     }
+  }
 
-    @ReactMethod
-    public void setAutoTrack(final String messageId, final boolean autoTrack) {
-        if (messageId != null && messageCache.get(messageId) != null) {
-            MobileCore.log(VERBOSE, TAG, String.format("setAutoTrack is called with message id: %s and autoTrack: %b", messageId, autoTrack));
-            messageCache.get(messageId).setAutoTrack(autoTrack);
-        }
+  @Override
+  public boolean shouldShowMessage(final FullscreenMessage fullscreenMessage) {
+    MobileCore.log(LoggingMode.VERBOSE, TAG, "shouldShowMessage is called");
+    final Message message = (Message)fullscreenMessage.getParent();
+    if (message != null) {
+      Map<String, String> data =
+          RCTAEPMessagingUtil.convertMessageToMap(message);
+      emitEvent("shouldShowMessage", data);
+      // Latch stops the thread until the shouldShowMessage value is received
+      // from the JS side on thread dedicated to run JS code. The function
+      // called from JS that resumes the thread is "shouldShowMessage".
+      MobileCore.log(LoggingMode.VERBOSE, TAG,
+                     "shouldShowMessage: Thread is locked.");
+      try {
+        latch.await();
+      } catch (final InterruptedException e) {
+        MobileCore.log(LoggingMode.ERROR, TAG,
+                       String.format("CountDownLatch await Interrupted: (%s)",
+                                     e.getLocalizedMessage()));
+      }
+      MobileCore.log(LoggingMode.VERBOSE, TAG,
+                     "shouldShowMessage: Thread is resumed.");
     }
 
-    @ReactMethod(isBlockingSynchronousMethod = true)
-    public void shouldShowMessage(final boolean shouldShowMessage, final boolean shouldSaveMessage) {
-        MobileCore.log(VERBOSE, TAG, String.format("shouldShowMessage is called with message id: %b and shouldSaveMessage: %b", shouldShowMessage, shouldSaveMessage));
-        this.shouldShowMessage = shouldShowMessage;
-        this.shouldSaveMessage = shouldSaveMessage;
-        latch.countDown();
+    if (shouldShowMessage) {
+      this.latestMessage = message;
     }
 
-    //Messaging Delegate functions
-    @Override
-    public void onShow(final FullscreenMessage fullscreenMessage) {
-        MobileCore.log(VERBOSE, TAG, "onShow is called");
-        final Message message = (Message) fullscreenMessage.getParent();
-        if (message != null) {
-            Map<String, String> data = new HashMap<>();
-            data.put("id", message.getId());
-            data.put("autoTrack", String.valueOf(message.getAutoTrack()));
-            emitEvent("onShow", data);
-        }
+    if (shouldSaveMessage) {
+      messageCache.put(message.getId(), message);
     }
 
-    @Override
-    public void onDismiss(final FullscreenMessage fullscreenMessage) {
-        MobileCore.log(VERBOSE, TAG, "onDismiss is called");
-        final Message message = (Message) fullscreenMessage.getParent();
-        if (message != null) {
-            Map<String, String> data = new HashMap<>();
-            data.put("id", message.getId());
-            data.put("autoTrack", String.valueOf(message.getAutoTrack()));
-            emitEvent("onDismiss", data);
-        }
+    return shouldShowMessage;
+  }
+
+  @Override
+  public void urlLoaded(String url, FullscreenMessage fullscreenMessage) {
+    MobileCore.log(
+        LoggingMode.VERBOSE, TAG,
+        String.format("overrideUrlLoad is called with url: (%s)", url));
+    final Message message = (Message)fullscreenMessage.getParent();
+    if (message != null) {
+      Map data = new HashMap<>();
+      data.put("message", RCTAEPMessagingUtil.convertMessageToMap(message));
+      data.put("url", url);
+      emitEvent("urlLoaded", data);
     }
+  }
+
+  // Messaging Delegate Callback
+  @ReactMethod(isBlockingSynchronousMethod = true)
+  public void setMessageSettings(final boolean shouldShowMessage,
+                                 final boolean shouldSaveMessage) {
+    MobileCore.log(
+        LoggingMode.VERBOSE, TAG,
+        String.format(
+            "shouldShowMessage is called with message id: %b and shouldSaveMessage: %b",
+            shouldShowMessage, shouldSaveMessage));
+    this.shouldShowMessage = shouldShowMessage;
+    this.shouldSaveMessage = shouldSaveMessage;
+    latch.countDown();
+  }
 
-   @Override
-   public boolean shouldShowMessage(final FullscreenMessage fullscreenMessage) {
-       MobileCore.log(VERBOSE, TAG, "shouldShowMessage is called");
-       final Message message = (Message) fullscreenMessage.getParent();
-       if (message != null) {
-           Map<String, String> data = new HashMap<>();
-           data.put("id", message.getId());
-           data.put("autoTrack", String.valueOf(message.getAutoTrack()));
-           emitEvent("shouldShowMessage", data);
-           //Latch stops the thread until the shouldShowMessage value is received from the JS side on thread dedicated to run JS code. The function called from JS that resumes the thread is "shouldShowMessage".
-           MobileCore.log(VERBOSE, TAG, "shouldShowMessage: Thread is locked.");
-           try {
-               latch.await();
-           } catch (final InterruptedException e) {
-               MobileCore.log(LoggingMode.ERROR, TAG, String.format("CountDownLatch await Interrupted: (%s)", e.getLocalizedMessage()));
-           }
-           MobileCore.log(VERBOSE, TAG, "shouldShowMessage: Thread is resumed.");
-           if (shouldSaveMessage) {
-               messageCache.put(message.getId(), message);
-           }
-       }
-       return shouldShowMessage;
-     }
-     
-     @Override
-     public void urlLoaded(String url, FullscreenMessage fullscreenMessage) {
-        MobileCore.log(VERBOSE, TAG, String.format("overrideUrlLoad is called with url: (%s)", url));
-        final Message message = (Message) fullscreenMessage.getParent();
-        if (message != null) {
-            Map<String, String> data = new HashMap<>();
-            data.put("id", message.getId());
-            data.put("autoTrack", String.valueOf(message.getAutoTrack()));
-            data.put("url", url);
-            emitEvent("urlLoaded", data);
-        }
-     }
-
-    /**
-     * Emits an event along with data to be handled by the Javascript
-     *
-     * @param name event name
-     * @param data data sent along with event
-     */
-    private void emitEvent(final String name, final Map<String, String> data) {
-        WritableMap eventData = Arguments.createMap();
-        for (final Map.Entry<String, String> entry : data.entrySet()) {
-            eventData.putString(entry.getKey(), entry.getValue());
-        }
-        reactContext.getJSModule(DeviceEventManagerModule.RCTDeviceEventEmitter.class).emit(name, eventData);
+  /**
+   * Emits an event along with data to be handled by the Javascript
+   *
+   * @param name event name
+   * @param data data sent along with event
+   */
+  private void emitEvent(final String name, final Map<String, String> data) {
+    WritableMap eventData = Arguments.createMap();
+    for (final Map.Entry<String, String> entry : data.entrySet()) {
+      eventData.putString(entry.getKey(), entry.getValue());
     }
+    reactContext
+        .getJSModule(DeviceEventManagerModule.RCTDeviceEventEmitter.class)
+        .emit(name, eventData);
+  }
 }

package/android/src/main/java/com/adobe/marketing/mobile/reactnative/messaging/RCTAEPMessagingPackage.java

@@ -1,38 +1,40 @@
 /*
- Copyright 2022 Adobe. All rights reserved.
- This file is licensed to you under the Apache License, Version 2.0 (the "License");
- you may not use this file except in compliance with the License. You may obtain a copy
- of the License at http://www.apache.org/licenses/LICENSE-2.0
- Unless required by applicable law or agreed to in writing, software distributed under
- the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
- OF ANY KIND, either express or implied. See the License for the specific language
- governing permissions and limitations under the License.
+  Copyright 2023 Adobe. All rights reserved.
+  This file is licensed to you under the Apache License, Version 2.0 (the
+  "License"); you may not use this file except in compliance with the License.
+  You may obtain a copy of the License at
+  http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law
+  or agreed to in writing, software distributed under the License is distributed
+  on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, either
+  express or implied. See the License for the specific language governing
+  permissions and limitations under the License.
  */
 package com.adobe.marketing.mobile.reactnative.messaging;
 
-import java.util.Arrays;
-import java.util.Collections;
-import java.util.List;
-
 import com.facebook.react.ReactPackage;
+import com.facebook.react.bridge.JavaScriptModule;
 import com.facebook.react.bridge.NativeModule;
 import com.facebook.react.bridge.ReactApplicationContext;
 import com.facebook.react.uimanager.ViewManager;
-import com.facebook.react.bridge.JavaScriptModule;
+import java.util.Arrays;
+import java.util.Collections;
+import java.util.List;
 public class RCTAEPMessagingPackage implements ReactPackage {
 
-    @Override
-    public List<NativeModule> createNativeModules(ReactApplicationContext reactContext) {
-      return Arrays.<NativeModule>asList(new RCTAEPMessagingModule(reactContext));
-    }
+  @Override
+  public List<NativeModule>
+  createNativeModules(ReactApplicationContext reactContext) {
+    return Arrays.<NativeModule>asList(new RCTAEPMessagingModule(reactContext));
+  }
 
-    // Deprecated from RN 0.47
-    public List<Class<? extends JavaScriptModule>> createJSModules() {
-      return Collections.emptyList();
-    }
+  // Deprecated from RN 0.47
+  public List<Class<? extends JavaScriptModule>> createJSModules() {
+    return Collections.emptyList();
+  }
 
-    @Override
-    public List<ViewManager> createViewManagers(ReactApplicationContext reactContext) {
-      return Collections.emptyList();
-    }
+  @Override
+  public List<ViewManager>
+  createViewManagers(ReactApplicationContext reactContext) {
+    return Collections.emptyList();
+  }
 }