[MOB-11649] updated embedded message class

src/__tests__/IterableEmbeddedMessage.test.ts

@@ -0,0 +1,162 @@
+import { IterableEmbeddedMessage } from '../embedded/classes/IterableEmbeddedMessage';
+import { Iterable } from '../core/classes/Iterable';
+
+describe('IterableEmbeddedMessage', () => {
+  it('should create an instance with all properties', () => {
+    Iterable.logger.log('iterableEmbeddedMessage_fromDict_all_properties');
+
+    const dict = {
+      metadata: {
+        messageId: 'msg-123',
+        placementId: 1,
+        campaignId: 456,
+        isProof: false,
+      },
+      elements: {
+        title: 'Awesome Title',
+        body: 'Radical Body Text',
+        mediaUrl: 'https://example.com/image.jpg',
+        mediaUrlCaption: 'Check out this sick image!',
+        defaultAction: {
+          type: 'openUrl',
+          data: 'https://example.com',
+        },
+        buttons: [
+          {
+            id: 'button-1',
+            title: 'Click Me!',
+            action: {
+              type: 'openUrl',
+              data: 'https://example.com/button1',
+            },
+          },
+        ],
+        text: [
+          {
+            id: 'text-1',
+            text: 'Some cool text',
+            type: 'body',
+          },
+        ],
+      },
+      payload: {
+        customKey: 'customValue',
+        anotherKey: 123,
+      },
+    };
+
+    const message = new IterableEmbeddedMessage(dict);
+
+    expect(message).toBeInstanceOf(IterableEmbeddedMessage);
+
+    // Check metadata
+    expect(message.metadata).toBeInstanceOf(Object);
+    expect(message.metadata.messageId).toBe('msg-123');
+    expect(message.metadata.placementId).toBe(1);
+    expect(message.metadata.campaignId).toBe(456);
+    expect(message.metadata.isProof).toBe(false);
+
+    // Check elements
+    expect(message.elements).toBeInstanceOf(Object);
+    expect(message.elements?.title).toBe('Awesome Title');
+    expect(message.elements?.body).toBe('Radical Body Text');
+    expect(message.elements?.mediaUrl).toBe('https://example.com/image.jpg');
+    expect(message.elements?.mediaUrlCaption).toBe(
+      'Check out this sick image!'
+    );
+
+    // Check payload
+    expect(message.payload).toEqual({
+      customKey: 'customValue',
+      anotherKey: 123,
+    });
+  });
+
+  it('should create an instance with only required metadata', () => {
+    Iterable.logger.log('iterableEmbeddedMessage_fromDict_required_only');
+
+    const dict = {
+      metadata: {
+        messageId: 'msg-123',
+        placementId: 1,
+        isProof: false,
+      },
+    };
+
+    const message = new IterableEmbeddedMessage(dict);
+
+    expect(message).toBeInstanceOf(IterableEmbeddedMessage);
+    expect(message.metadata).toBeInstanceOf(Object);
+    expect(message.metadata.messageId).toBe('msg-123');
+    expect(message.metadata.placementId).toBe(1);
+    expect(message.metadata.campaignId).toBeUndefined();
+    expect(message.metadata.isProof).toBe(false);
+    expect(message.elements).toBeUndefined();
+    expect(message.payload).toBeUndefined();
+  });
+
+  it('should throw an error if metadata is missing', () => {
+    Iterable.logger.log('iterableEmbeddedMessage_fromDict_missing_metadata');
+
+    const dict = {
+      elements: {
+        title: 'Some Title',
+        body: 'Some Body',
+      },
+    };
+
+    // @ts-expect-error - metadata is purposely missing
+    expect(() => new IterableEmbeddedMessage(dict)).toThrow(
+      'metadata is required'
+    );
+  });
+
+  it('should create an instance with elements but no payload', () => {
+    Iterable.logger.log('iterableEmbeddedMessage_fromDict_elements_only');
+
+    const dict = {
+      metadata: {
+        messageId: 'msg-123',
+        placementId: 1,
+        isProof: false,
+      },
+      elements: {
+        title: 'Elements Only',
+        body: 'No payload here',
+      },
+    };
+
+    const message = new IterableEmbeddedMessage(dict);
+
+    expect(message).toBeInstanceOf(IterableEmbeddedMessage);
+    expect(message.metadata).toBeInstanceOf(Object);
+    expect(message.elements).toBeInstanceOf(Object);
+    expect(message.elements?.title).toBe('Elements Only');
+    expect(message.elements?.body).toBe('No payload here');
+    expect(message.payload).toBeUndefined();
+  });
+
+  it('should create an instance with payload but no elements', () => {
+    Iterable.logger.log('iterableEmbeddedMessage_fromDict_payload_only');
+
+    const dict = {
+      metadata: {
+        messageId: 'msg-123',
+        placementId: 1,
+        isProof: false,
+      },
+      payload: {
+        someData: 'someValue',
+      },
+    };
+
+    const message = new IterableEmbeddedMessage(dict);
+
+    expect(message).toBeInstanceOf(IterableEmbeddedMessage);
+    expect(message.metadata).toBeInstanceOf(Object);
+    expect(message.elements).toBeUndefined();
+    expect(message.payload).toEqual({
+      someData: 'someValue',
+    });
+  });
+});

src/__tests__/IterableEmbeddedMessageButton.test.ts

@@ -0,0 +1,86 @@
+import { IterableEmbeddedMessageButton } from '../embedded/classes/IterableEmbeddedMessageButton';
+import { Iterable } from '../core/classes/Iterable';
+
+describe('IterableEmbeddedMessageButton', () => {
+  it('should create an instance with all properties including button action', () => {
+    Iterable.logger.log(
+      'iterableEmbeddedMessageButton_fromDict_all_properties'
+    );
+
+    const dict = {
+      id: 'button-123',
+      title: 'Click Me!',
+      action: { type: 'openUrl', data: 'https://example.com' },
+    };
+
+    const button = new IterableEmbeddedMessageButton(dict);
+
+    expect(button).toBeInstanceOf(IterableEmbeddedMessageButton);
+    expect(button.id).toBe('button-123');
+    expect(button.title).toBe('Click Me!');
+    expect(button.action).toBeInstanceOf(Object);
+    expect(button.action?.type).toBe('openUrl');
+    expect(button.action?.data).toBe('https://example.com');
+  });
+
+  it('should create an instance with only required properties', () => {
+    Iterable.logger.log('iterableEmbeddedMessageButton_fromDict_required_only');
+
+    const dict = { id: 'button-123' };
+
+    const button = new IterableEmbeddedMessageButton(dict);
+
+    expect(button).toBeInstanceOf(IterableEmbeddedMessageButton);
+    expect(button.id).toBe('button-123');
+    expect(button.title).toBeUndefined();
+    expect(button.action).toBeUndefined();
+  });
+
+  it('should create an instance with title but no action', () => {
+    Iterable.logger.log('iterableEmbeddedMessageButton_fromDict_title_only');
+
+    const dict = {
+      id: 'button-123',
+      title: 'Click Me!',
+    };
+
+    const button = new IterableEmbeddedMessageButton(dict);
+
+    expect(button).toBeInstanceOf(IterableEmbeddedMessageButton);
+    expect(button.id).toBe('button-123');
+    expect(button.title).toBe('Click Me!');
+    expect(button.action).toBeUndefined();
+  });
+
+  it('should throw an error if id is missing', () => {
+    Iterable.logger.log('iterableEmbeddedMessageButton_fromDict_missing_id');
+
+    const dict = {
+      title: 'Click Me!',
+      action: { type: 'openUrl', data: 'https://example.com' },
+    };
+    // @ts-expect-error - id is purposely missing
+    expect(() => new IterableEmbeddedMessageButton(dict)).toThrow(
+      'id is required'
+    );
+  });
+
+  it('should handle button action with only type', () => {
+    Iterable.logger.log(
+      'iterableEmbeddedMessageButton_fromDict_action_type_only'
+    );
+
+    const dict = {
+      id: 'button-123',
+      action: { type: 'close' },
+    };
+
+    const button = new IterableEmbeddedMessageButton(dict);
+
+    expect(button).toBeInstanceOf(IterableEmbeddedMessageButton);
+    expect(button.id).toBe('button-123');
+    expect(button.action).toBeInstanceOf(Object);
+    expect(button.action?.type).toBe('close');
+    expect(button.action?.data).toBeUndefined();
+  });
+});

src/__tests__/IterableEmbeddedMessageText.test.ts

@@ -0,0 +1,39 @@
+import { IterableEmbeddedMessageText } from '../embedded/classes/IterableEmbeddedMessageText';
+import { Iterable } from '../core/classes/Iterable';
+
+describe('IterableEmbeddedMessageText', () => {
+  it('should create an instance from a dictionary with all properties', () => {
+    Iterable.logger.log('iterableEmbeddedMessageText_fromDict_all_properties');
+
+    const dict = { id: 'text-123', text: 'Hello World!', type: 'heading' };
+    const text = new IterableEmbeddedMessageText(dict);
+
+    expect(text).toBeInstanceOf(IterableEmbeddedMessageText);
+    expect(text.id).toBe('text-123');
+    expect(text.text).toBe('Hello World!');
+    expect(text.type).toBe('heading');
+  });
+
+  it('should create an instance from a dictionary with only required properties', () => {
+    Iterable.logger.log('iterableEmbeddedMessageText_fromDict_required_only');
+
+    const dict = { id: 'text-123' };
+    const text = new IterableEmbeddedMessageText(dict);
+
+    expect(text).toBeInstanceOf(IterableEmbeddedMessageText);
+    expect(text.id).toBe('text-123');
+    expect(text.text).toBeUndefined();
+    expect(text.type).toBeUndefined();
+  });
+
+  it('should throw an error if id is missing in fromDict', () => {
+    Iterable.logger.log('iterableEmbeddedMessageText_fromDict_missing_id');
+
+    const dict = { text: 'Hello World!', type: 'heading' };
+
+    // @ts-expect-error - id is purposely missing
+    expect(() => new IterableEmbeddedMessageText(dict)).toThrow(
+      'id is required'
+    );
+  });
+});