feat: add embedded message update listener and callback support in Iterable API

Author: lposen

ios/RNIterableAPI/ReactIterableAPI.swift

@@ -33,6 +33,7 @@ import React
     case receivedIterableInboxChanged
     case handleAuthSuccessCalled
     case handleAuthFailureCalled
+    case handleEmbeddedMessageUpdateCalled
   }
 
   @objc public static var supportedEvents: [String] {
@@ -650,6 +651,13 @@ import React
       }
 
       IterableAPI.setDeviceAttribute(name: "reactNativeSDKVersion", value: version)
+
+      // Add embedded update listener if callback is present
+      if let onEmbeddedMessageUpdatePresent = configDict["onEmbeddedMessageUpdatePresent"] as? Bool,
+        onEmbeddedMessageUpdatePresent == true
+      {
+        IterableAPI.embeddedManager.addUpdateListener(self)
+      }
     }
   }
 
@@ -807,3 +815,20 @@ extension ReactIterableAPI: IterableAuthDelegate {
   public func onTokenRegistrationFailed(_ reason: String?) {
   }
 }
+
+extension ReactIterableAPI: IterableEmbeddedUpdateDelegate {
+  public func onMessagesUpdated() {
+    ITBInfo()
+    guard shouldEmit else {
+      return
+    }
+    delegate?.sendEvent(
+      withName: EventName.handleEmbeddedMessageUpdateCalled.rawValue,
+      body: nil as Any?)
+  }
+
+  public func onEmbeddedMessagingDisabled() {
+    ITBInfo()
+    // This is called when embedded messaging is disabled, we don't need to do anything here for now
+  }
+}

src/core/classes/Iterable.ts

@@ -950,6 +950,9 @@ export class Iterable {
     RNEventEmitter.removeAllListeners(
       IterableEventName.handleAuthFailureCalled
     );
+    RNEventEmitter.removeAllListeners(
+      IterableEventName.handleEmbeddedMessageUpdateCalled
+    );
   }
 
   /**
@@ -1083,6 +1086,15 @@ export class Iterable {
         }
       );
     }
+
+    if (Iterable.savedConfig.onEmbeddedMessageUpdate) {
+      RNEventEmitter.addListener(
+        IterableEventName.handleEmbeddedMessageUpdateCalled,
+        () => {
+          Iterable.savedConfig.onEmbeddedMessageUpdate?.();
+        }
+      );
+    }
   }
 
   /**

src/core/classes/IterableConfig.ts

@@ -339,6 +339,24 @@ export class IterableConfig {
    */
   enableEmbeddedMessaging = false;
 
+  /**
+   * A callback function that is called when embedded messages are updated.
+   *
+   * This callback is triggered when the local cache of embedded messages changes,
+   * such as when new messages arrive or existing messages are removed.
+   *
+   * @example
+   * ```typescript
+   * const config = new IterableConfig();
+   * config.onEmbeddedMessageUpdate = () => {
+   *   console.log('Embedded messages updated!');
+   *   // Refresh your UI to display the latest messages
+   * };
+   * Iterable.initialize('<YOUR_API_KEY>', config);
+   * ```
+   */
+  onEmbeddedMessageUpdate?: () => void;
+
   /**
    * Converts the IterableConfig instance to a dictionary object.
    *
@@ -377,6 +395,13 @@ export class IterableConfig {
        */
       // eslint-disable-next-line eqeqeq
       authHandlerPresent: this.authHandler != undefined,
+      /**
+       * A boolean indicating if an embedded message update callback is present.
+       *
+       * TODO: Figure out if this is purposeful
+       */
+      // eslint-disable-next-line eqeqeq
+      onEmbeddedMessageUpdatePresent: this.onEmbeddedMessageUpdate != undefined,
       /** The log level for the SDK. */
       logLevel: this.logLevel,
       expiringAuthTokenRefreshPeriod: this.expiringAuthTokenRefreshPeriod,

src/core/enums/IterableEventName.ts

@@ -19,4 +19,6 @@ export enum IterableEventName {
   handleAuthSuccessCalled = 'handleAuthSuccessCalled',
   /** Event that fires when authentication with Iterable fails */
   handleAuthFailureCalled = 'handleAuthFailureCalled',
+  /** Event that fires when embedded messages are updated */
+  handleEmbeddedMessageUpdateCalled = 'handleEmbeddedMessageUpdateCalled',
 }