Merge branch 'loren/embedded/MOB-12264-android-sync-and-get-messages' into loren/embedded/MOB-12267-android-add-start-impression-and-pause-impressio

Author: lposen

src/__mocks__/MockRNIterableAPI.ts

@@ -137,9 +137,34 @@ export class MockRNIterableAPI {
     .fn()
     .mockResolvedValue([1, 2, 3] as number[]);
 
-  static syncEmbeddedMessages = jest.fn();
-
-  static getEmbeddedMessages = jest.fn().mockResolvedValue([]);
+  static syncEmbeddedMessages = jest.fn().mockResolvedValue(undefined);
+
+  static getEmbeddedMessages = jest.fn().mockResolvedValue([
+    {
+      metadata: {
+        messageId: 'msg-1',
+        campaignId: 123,
+        placementId: 1,
+      },
+      elements: {
+        title: 'Test Message 1',
+        body: 'Test body 1',
+      },
+      payload: { customKey: 'customValue' },
+    },
+    {
+      metadata: {
+        messageId: 'msg-2',
+        campaignId: 456,
+        placementId: 2,
+      },
+      elements: {
+        title: 'Test Message 2',
+        body: 'Test body 2',
+      },
+      payload: null,
+    },
+  ]);
 
   static startEmbeddedImpression = jest.fn();
 

src/embedded/classes/IterableEmbeddedManager.test.ts

@@ -65,12 +65,15 @@ describe('IterableEmbeddedManager', () => {
   });
 
   describe('syncMessages', () => {
-    it('should call IterableApi.syncEmbeddedMessages', () => {
+    it('should call IterableApi.syncEmbeddedMessages', async () => {
       // WHEN syncMessages is called
-      embeddedManager.syncMessages();
+      const result = await embeddedManager.syncMessages();
 
       // THEN IterableApi.syncEmbeddedMessages is called
       expect(MockRNIterableAPI.syncEmbeddedMessages).toHaveBeenCalledTimes(1);
+
+      // AND the result is returned
+      expect(result).toBeUndefined();
     });
   });
 
@@ -91,23 +94,47 @@ describe('IterableEmbeddedManager', () => {
 
   describe('getMessages', () => {
     it('should call IterableApi.getEmbeddedMessages with placement IDs', async () => {
-      // GIVEN some placement IDs
-      const placementIds = [1, 2, 3];
+      // GIVEN placement IDs
+      const placementIds = [1, 2];
 
       // WHEN getMessages is called
       const result = await embeddedManager.getMessages(placementIds);
 
-      // THEN IterableApi.getEmbeddedMessages is called with the placement IDs
+      // THEN IterableApi.getEmbeddedMessages is called with placement IDs
       expect(MockRNIterableAPI.getEmbeddedMessages).toHaveBeenCalledTimes(1);
       expect(MockRNIterableAPI.getEmbeddedMessages).toHaveBeenCalledWith(
         placementIds
       );
 
-      // AND the result is returned
-      expect(result).toEqual([]);
+      // AND the result contains embedded messages
+      expect(result).toHaveLength(2);
+      expect(result[0]).toEqual({
+        metadata: {
+          messageId: 'msg-1',
+          campaignId: 123,
+          placementId: 1,
+        },
+        elements: {
+          title: 'Test Message 1',
+          body: 'Test body 1',
+        },
+        payload: { customKey: 'customValue' },
+      });
+      expect(result[1]).toEqual({
+        metadata: {
+          messageId: 'msg-2',
+          campaignId: 456,
+          placementId: 2,
+        },
+        elements: {
+          title: 'Test Message 2',
+          body: 'Test body 2',
+        },
+        payload: null,
+      });
     });
 
-    it('should call IterableApi.getEmbeddedMessages with null', async () => {
+    it('should call IterableApi.getEmbeddedMessages with null placement IDs', async () => {
       // WHEN getMessages is called with null
       const result = await embeddedManager.getMessages(null);
 
@@ -116,7 +143,7 @@ describe('IterableEmbeddedManager', () => {
       expect(MockRNIterableAPI.getEmbeddedMessages).toHaveBeenCalledWith(null);
 
       // AND the result is returned
-      expect(result).toEqual([]);
+      expect(result).toBeDefined();
     });
   });
 

src/embedded/classes/IterableEmbeddedManager.ts

@@ -64,6 +64,13 @@ export class IterableEmbeddedManager {
    * Retrieves a list of placement IDs for the embedded manager.
    *
    * [Placement Documentation](https://support.iterable.com/hc/en-us/articles/23060529977364-Embedded-Messaging-Overview#placements-and-prioritization)
+   *
+   * @example
+   * ```typescript
+   * Iterable.embeddedManager.getPlacementIds().then(placementIds => {
+   *   console.log('Placement IDs:', placementIds);
+   * });
+   * ```
    */
   getPlacementIds() {
     return IterableApi.getEmbeddedPlacementIds();
@@ -74,6 +81,13 @@ export class IterableEmbeddedManager {
    *
    * @param placementIds - The placement IDs to retrieve messages for.
    * @returns A Promise that resolves to an array of embedded messages.
+   *
+   * @example
+   * ```typescript
+   * Iterable.embeddedManager.getMessages([1, 2, 3]).then(messages => {
+   *   console.log('Messages:', messages);
+   * });
+   * ```
    */
   getMessages(
     placementIds: number[] | null
@@ -133,7 +147,7 @@ export class IterableEmbeddedManager {
    *
    * @example
    * ```typescript
-   * IterableEmbeddedManager.startImpression(messageId, placementId);
+   * Iterable.embeddedManager.startImpression(messageId, placementId);
    * ```
    */
   startImpression(messageId: string, placementId: number) {
@@ -151,7 +165,7 @@ export class IterableEmbeddedManager {
    *
    * @example
    * ```typescript
-   * IterableEmbeddedManager.pauseImpression(messageId);
+   * Iterable.embeddedManager.pauseImpression(messageId);
    * ```
    */
   pauseImpression(messageId: string) {