Merge branch 'evan/feature/embedded' into evan/MOB-11561-enableEmbeddedMessaging-flag-iOS

Author: evantk91

src/__tests__/IterableEmbeddedMessageMetadata.test.ts

@@ -0,0 +1,58 @@
+import { IterableEmbeddedMessageMetadata } from '../embedded/classes/IterableEmbeddedMessageMetadata';
+import { Iterable } from '../core';
+
+describe('IterableEmbeddedMessage', () => {
+  test('should create an instance of IterableEmbeddedMessageMetadata from a dictionary', () => {
+    Iterable.logger.log(
+      'iterableEmbeddedMessageMetadata_fromDict_valid_dictionary'
+    );
+
+    const dict = {
+      messageId: '123',
+      placementId: 456,
+      campaignId: 789,
+      isProof: false,
+    };
+
+    const result = IterableEmbeddedMessageMetadata.fromDict(dict);
+
+    expect(result).toBeInstanceOf(IterableEmbeddedMessageMetadata);
+    expect(result.messageId).toBe('123');
+    expect(result.placementId).toBe(456);
+    expect(result.campaignId).toBe(789);
+    expect(result.isProof).toBe(false);
+  });
+
+  test('should handle optional fields', () => {
+    Iterable.logger.log(
+      'iterableEmbeddedMessageMetadata_fromDict_optional_fields_omitted'
+    );
+
+    const dict = {
+      messageId: '123',
+      placementId: 456,
+    };
+
+    const result = IterableEmbeddedMessageMetadata.fromDict(dict);
+
+    expect(result).toBeInstanceOf(IterableEmbeddedMessageMetadata);
+    expect(result.messageId).toBe('123');
+    expect(result.placementId).toBe(456);
+    expect(result.campaignId).toBeUndefined();
+    expect(result.isProof).toBe(false);
+  });
+
+  test('should throw an error if messageId is not provided', () => {
+    Iterable.logger.log(
+      'iterableEmbeddedMessageMetadata_fromDict_missing_messageId'
+    );
+
+    const dict = {
+      placementId: 456,
+    };
+
+    expect(() => {
+      IterableEmbeddedMessageMetadata.fromDict(dict);
+    }).toThrow('messageId and placementId are required');
+  });
+});

src/embedded/classes/IterableEmbeddedMessageMetadata.ts

@@ -0,0 +1,65 @@
+/**
+ * Metadata for an embedded message.
+ */
+export class IterableEmbeddedMessageMetadata {
+  /** The ID for the embedded message */
+  readonly messageId: string;
+  /** The placement ID for the embedded message */
+  readonly placementId: number;
+  /** The campaign ID for the embedded message */
+  readonly campaignId?: number;
+  /** Whether the embedded message is a proof */
+  readonly isProof: boolean;
+
+  /**
+   * Constructs an instance of IterableEmbeddedMessageMetadata.
+   *
+   * @param messageId - The ID for the embedded message.
+   * @param placementId - The placement ID for the embedded message.
+   * @param campaignId - The campaign ID for the embedded message.
+   * @param isProof - Whether the embedded message is a proof.
+   */
+  constructor(
+    messageId: string,
+    placementId: number,
+    campaignId: number | undefined,
+    isProof: boolean = false
+  ) {
+    this.messageId = messageId;
+    this.placementId = placementId;
+    this.campaignId = campaignId;
+    this.isProof = isProof;
+  }
+
+  /**
+   * Creates an instance of `IterableEmbeddedMessageMetadata` from a dictionary object.
+   *
+   * @param dict - The dictionary objectcontaining the metadata properties.
+   * This corresponds to the properties in {@link IterableEmbeddedMessageMetadata}
+   *
+   * @returns A new instance of `IterableEmbeddedMessageMetadata` with the provided properties.
+   */
+  static fromDict(
+    dict: Partial<EmbeddedMessageMetadataDict>
+  ): IterableEmbeddedMessageMetadata {
+    if (!dict.messageId || !dict.placementId) {
+      throw new Error('messageId and placementId are required');
+    }
+    return new IterableEmbeddedMessageMetadata(
+      dict.messageId,
+      dict.placementId,
+      dict.campaignId,
+      dict.isProof
+    );
+  }
+}
+
+/**
+ * An interface defining the dictionary object containing the metadata properties for an embedded message.
+ */
+export interface EmbeddedMessageMetadataDict {
+  messageId: string;
+  placementId: number;
+  campaignId?: number;
+  isProof?: boolean;
+}