feat: converts IterableEmbeddedMessage constructor

Author: Evan Greer

src/__tests__/IterableEmbeddedMessage.test.ts

@@ -47,12 +47,12 @@ describe('IterableEmbeddedMessage', () => {
       },
     };
 
-    const message = IterableEmbeddedMessage.fromDict(dict);
+    const message = new IterableEmbeddedMessage(dict);
 
     expect(message).toBeInstanceOf(IterableEmbeddedMessage);
 
     // Check metadata
-    expect(message.metadata).toBeInstanceOf(IterableEmbeddedMessageMetadata);
+    expect(message.metadata).toBeInstanceOf(Object);
     expect(message.metadata.messageId).toBe('msg-123');
     expect(message.metadata.placementId).toBe(1);
     expect(message.metadata.campaignId).toBe(456);
@@ -85,7 +85,7 @@ describe('IterableEmbeddedMessage', () => {
       },
     };
 
-    const message = IterableEmbeddedMessage.fromDict(dict);
+    const message = new IterableEmbeddedMessage(dict);
 
     expect(message).toBeInstanceOf(IterableEmbeddedMessage);
     expect(message.metadata).toBeInstanceOf(IterableEmbeddedMessageMetadata);
@@ -107,7 +107,8 @@ describe('IterableEmbeddedMessage', () => {
       },
     };
 
-    expect(() => IterableEmbeddedMessage.fromDict(dict)).toThrow(
+    // @ts-expect-error - metadata is purposely missing
+    expect(() => new IterableEmbeddedMessage(dict)).toThrow(
       'metadata is required'
     );
   });
@@ -127,7 +128,7 @@ describe('IterableEmbeddedMessage', () => {
       },
     };
 
-    const message = IterableEmbeddedMessage.fromDict(dict);
+    const message = new IterableEmbeddedMessage(dict);
 
     expect(message).toBeInstanceOf(IterableEmbeddedMessage);
     expect(message.metadata).toBeInstanceOf(IterableEmbeddedMessageMetadata);
@@ -151,7 +152,7 @@ describe('IterableEmbeddedMessage', () => {
       },
     };
 
-    const message = IterableEmbeddedMessage.fromDict(dict);
+    const message = new IterableEmbeddedMessage(dict);
 
     expect(message).toBeInstanceOf(IterableEmbeddedMessage);
     expect(message.metadata).toBeInstanceOf(IterableEmbeddedMessageMetadata);

src/__tests__/IterableEmbeddedMessageMetadata.test.ts

@@ -14,7 +14,7 @@ describe('IterableEmbeddedMessage', () => {
       isProof: false,
     };
 
-    const result = IterableEmbeddedMessageMetadata.fromDict(dict);
+    const result = new IterableEmbeddedMessageMetadata(dict);
 
     expect(result).toBeInstanceOf(IterableEmbeddedMessageMetadata);
     expect(result.messageId).toBe('123');
@@ -33,7 +33,7 @@ describe('IterableEmbeddedMessage', () => {
       placementId: 456,
     };
 
-    const result = IterableEmbeddedMessageMetadata.fromDict(dict);
+    const result = new IterableEmbeddedMessageMetadata(dict);
 
     expect(result).toBeInstanceOf(IterableEmbeddedMessageMetadata);
     expect(result.messageId).toBe('123');
@@ -52,7 +52,8 @@ describe('IterableEmbeddedMessage', () => {
     };
 
     expect(() => {
-      IterableEmbeddedMessageMetadata.fromDict(dict);
+      // @ts-expect-error - messageId is purposely missing
+      new IterableEmbeddedMessageMetadata(dict);
     }).toThrow('messageId and placementId are required');
   });
 });

src/embedded/classes/IterableEmbeddedMessage.ts

@@ -1,61 +1,57 @@
-import { IterableEmbeddedMessageMetadata } from './IterableEmbeddedMessageMetadata';
 import { IterableEmbeddedMessageElements } from './IterableEmbeddedMessageElements';
+import type { EmbeddedMessageElementsDict } from './IterableEmbeddedMessageElements';
 
 /**
  * IterableEmbeddedMessage represents an embedded message.
  */
 export class IterableEmbeddedMessage {
   /** The metadata of the embedded message */
-  metadata: IterableEmbeddedMessageMetadata;
+  readonly metadata: {
+    messageId: string;
+    placementId: number;
+    campaignId?: number;
+    isProof: boolean;
+  };
   /** The elements of the embedded message */
-  elements?: IterableEmbeddedMessageElements;
+  readonly elements?: IterableEmbeddedMessageElements;
   /** The custom payload of the embedded message */
-  payload?: Record<string, unknown>;
+  readonly payload?: Record<string, unknown>;
 
   /**
    * Creates an instance of `IterableEmbeddedMessage`.
    *
-   * @param metadata - The metadata of the embedded message.
-   * @param elements - The elements of the embedded message.
-   * @param payload - The custom payload of the embedded message.
-   */
-  constructor(
-    metadata: IterableEmbeddedMessageMetadata,
-    elements?: IterableEmbeddedMessageElements,
-    payload?: Record<string, unknown>
-  ) {
-    this.metadata = metadata;
-    this.elements = elements;
-    this.payload = payload;
-  }
-
-  /**
-   * Creates an instance of `IterableEmbeddedMessage` from a dictionary object.
-   *
    * @param dict - The dictionary object containing the properties to initialize the `IterableEmbeddedMessage` instance.
-   * @returns A new instance of `IterableEmbeddedMessage` initialized with the provided dictionary properties.
    */
-  static fromDict(dict: Partial<EmbeddedMessageDict>): IterableEmbeddedMessage {
+  constructor(dict: EmbeddedMessageDict) {
     if (!dict.metadata) {
       throw new Error('metadata is required');
     }
-    const metadata = IterableEmbeddedMessageMetadata.fromDict(dict.metadata);
-    const elements = dict.elements
+    this.metadata = {
+      messageId: dict.metadata.messageId,
+      placementId: dict.metadata.placementId,
+      campaignId: dict.metadata.campaignId,
+      isProof: dict.metadata.isProof,
+    };
+    this.elements = dict.elements
       ? new IterableEmbeddedMessageElements(dict.elements)
       : undefined;
-    const payload = dict.payload;
-    return new IterableEmbeddedMessage(metadata, elements, payload);
+    this.payload = dict.payload;
   }
 }
 
 /**
  * An interface defining the dictionary object containing the properties for the embedded message.
  */
-interface EmbeddedMessageDict {
+export interface EmbeddedMessageDict {
   /** The metadata of the embedded message */
-  metadata: IterableEmbeddedMessageMetadata;
+  metadata: {
+    messageId: string;
+    placementId: number;
+    campaignId?: number;
+    isProof: boolean;
+  };
   /** The elements of the embedded message */
-  elements: IterableEmbeddedMessageElements;
+  elements?: EmbeddedMessageElementsDict;
   /** The custom payload of the embedded message */
-  payload: Record<string, unknown>;
+  payload?: Record<string, unknown>;
 }

src/embedded/classes/IterableEmbeddedMessageMetadata.ts

@@ -14,43 +14,16 @@ export class IterableEmbeddedMessageMetadata {
   /**
    * 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.
+   * @param dict - The dictionary object containing the metadata properties.
    */
-  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 {
+  constructor(dict: EmbeddedMessageMetadataDict) {
     if (!dict.messageId || !dict.placementId) {
       throw new Error('messageId and placementId are required');
     }
-    return new IterableEmbeddedMessageMetadata(
-      dict.messageId,
-      dict.placementId,
-      dict.campaignId,
-      dict.isProof
-    );
+    this.messageId = dict.messageId;
+    this.placementId = dict.placementId;
+    this.campaignId = dict.campaignId;
+    this.isProof = dict.isProof ?? false;
   }
 }