feat: enhance IterableApi with new tracking methods for embedded sessions and clicks

Author: lposen

src/core/classes/IterableApi.ts

@@ -1,21 +1,20 @@
 import { Platform } from 'react-native';
 
 import RNIterableAPI from '../../api';
-import { IterableConfig } from './IterableConfig';
-import type { IterableLogger } from './IterableLogger';
-import { defaultLogger } from '../constants/defaults';
-import { IterableAttributionInfo } from './IterableAttributionInfo';
-import type { IterableCommerceItem } from './IterableCommerceItem';
+import type { IterableEmbeddedMessage } from '../../embedded/classes/IterableEmbeddedMessage';
+import type { IterableEmbeddedSession } from '../../embedded/classes/IterableEmbeddedSession';
+import type { IterableHtmlInAppContent } from '../../inApp/classes/IterableHtmlInAppContent';
 import type { IterableInAppMessage } from '../../inApp/classes/IterableInAppMessage';
-import type { IterableInAppLocation } from '../../inApp/enums/IterableInAppLocation';
 import type { IterableInAppCloseSource } from '../../inApp/enums/IterableInAppCloseSource';
 import type { IterableInAppDeleteSource } from '../../inApp/enums/IterableInAppDeleteSource';
-import type { IterableHtmlInAppContent } from '../../inApp/classes/IterableHtmlInAppContent';
+import type { IterableInAppLocation } from '../../inApp/enums/IterableInAppLocation';
 import type { IterableInAppShowResponse } from '../../inApp/enums/IterableInAppShowResponse';
 import type { IterableInboxImpressionRowInfo } from '../../inbox/types/IterableInboxImpressionRowInfo';
-import type { IterableEmbeddedSession } from '../../embedded/classes/IterableEmbeddedSession';
-import type { IterableEmbeddedMessage } from '../../embedded/classes/IterableEmbeddedMessage';
-import type { IterableEmbeddedPlacement } from '../../embedded/classes/IterableEmbeddedPlacement';
+import { defaultLogger } from '../constants/defaults';
+import { IterableAttributionInfo } from './IterableAttributionInfo';
+import type { IterableCommerceItem } from './IterableCommerceItem';
+import { IterableConfig } from './IterableConfig';
+import type { IterableLogger } from './IterableLogger';
 
 export class IterableApi {
   static logger: IterableLogger = defaultLogger;
@@ -308,9 +307,48 @@ export class IterableApi {
    */
   static trackEmbeddedSession(session: IterableEmbeddedSession) {
     IterableApi.logger.log('trackEmbeddedSession: ', session);
+
+    if (session == null) {
+      IterableApi.logger.log('trackEmbeddedSession: session is null');
+      return;
+    }
+
+    if (!session.start || !session.end) {
+      IterableApi.logger.log(
+        'trackEmbeddedSession: sessionStartTime and sessionEndTime must be set',
+        session
+      );
+      return;
+    }
+
     return RNIterableAPI.trackEmbeddedSession(session);
   }
 
+  static trackEmbeddedClick(
+    message: IterableEmbeddedMessage,
+    buttonId: string | null | undefined,
+    clickedUrl: string | null | undefined
+  ) {
+    IterableApi.logger.log(
+      'trackEmbeddedClick: ',
+      message,
+      buttonId,
+      clickedUrl
+    );
+    return RNIterableAPI.trackEmbeddedClick(message, buttonId, clickedUrl);
+  }
+
+  static trackEmbeddedMessageReceived(message: IterableEmbeddedMessage) {
+    IterableApi.logger.log('trackEmbeddedMessageReceived: ', message);
+
+    if (message == null) {
+      IterableApi.logger.log('trackEmbeddedMessageReceived: message is null');
+      return;
+    }
+
+    return RNIterableAPI.trackEmbeddedMessageReceived(message);
+  }
+
   // ---- End TRACKING ---- //
 
   // ====================================================== //
@@ -501,22 +539,9 @@ export class IterableApi {
    *
    * @returns A Promise that resolves to an array of embedded messages.
    */
-  static getEmbeddedMessages(): Promise<IterableEmbeddedPlacement[]> {
-    IterableApi.logger.log('getEmbeddedMessages');
-    return RNIterableAPI.getEmbeddedMessages() as unknown as Promise<
-      IterableEmbeddedPlacement[]
-    >;
-  }
-
-  static trackEmbeddedMessageReceived(message: IterableEmbeddedMessage) {
-    IterableApi.logger.log('trackEmbeddedMessageReceived: ', message);
-
-    if (message == null) {
-      IterableApi.logger.log('trackEmbeddedMessageReceived: message is null');
-      return;
-    }
-
-    return RNIterableAPI.trackEmbeddedMessageReceived(message);
+  static getEmbeddedMessages(placementIds: number[] | null) {
+    IterableApi.logger.log('getEmbeddedMessages: ', placementIds);
+    return RNIterableAPI.getEmbeddedMessages(placementIds);
   }
 
   // ---- End EMBEDDED ---- //

src/embedded/classes/IterableEmbeddedSessionManager.ts

@@ -11,7 +11,11 @@ import { IterableEmbeddedSession } from './IterableEmbeddedSession';
 export class IterableEmbeddedSessionManager {
   private logger: IterableLogger = new IterableLogger(new IterableConfig());
   private impressions: Record<string, IterableEmbeddedImpressionData> = {};
-  public session?: IterableEmbeddedSession;
+  public session: IterableEmbeddedSession = new IterableEmbeddedSession({
+    start: null,
+    end: null,
+    impressions: [],
+  });
 
   constructor(logger: IterableLogger) {
     this.logger = logger;
@@ -31,6 +35,8 @@ export class IterableEmbeddedSessionManager {
     // TODO: figure out how to get a unique ID for the session
     this.session = new IterableEmbeddedSession({
       start: new Date(),
+      end: null,
+      impressions: [],
     });
   }
 
@@ -40,7 +46,7 @@ export class IterableEmbeddedSessionManager {
       return;
     }
 
-    if (this.session?.impressions?.length) {
+    if (Object.keys(this.impressions).length > 0) {
       this.endAllImpressions();
 
       const sessionToTrack = new IterableEmbeddedSession({
@@ -64,53 +70,61 @@ export class IterableEmbeddedSessionManager {
 
   public startImpression(messageId: string, placementId: number) {
     let impressionData = this.impressions[messageId];
+
     if (!impressionData) {
       impressionData = new IterableEmbeddedImpressionData(
         messageId,
         placementId
       );
       this.impressions[messageId] = impressionData;
     }
+
     impressionData.start = new Date();
   }
 
   public pauseImpression(messageId: string) {
     const impressionData = this.impressions[messageId];
+
     if (!impressionData) {
       this.logger.log('onMessageImpressionEnded: impressionData not found');
       return;
     }
 
-    if (impressionData.start == null) {
+    if (!impressionData.start) {
       this.logger.log('onMessageImpressionEnded: impressionStarted is null');
       return;
     }
 
     this.updateDisplayCountAndDuration(impressionData);
   }
 
+  private endAllImpressions() {
+    Object.values(this.impressions).forEach((impressionData) => {
+      this.updateDisplayCountAndDuration(impressionData);
+    });
+  }
+
+  private getImpressionList(): IterableEmbeddedImpression[] {
+    return Object.values(this.impressions).map((impression) => {
+      return new IterableEmbeddedImpression({
+        messageId: impression.messageId || '',
+        placementId: impression.placementId || 0,
+        displayCount: impression.displayCount || 0,
+        duration: impression.duration || 0,
+      });
+    });
+  }
+
   private updateDisplayCountAndDuration(
     impressionData: IterableEmbeddedImpressionData
   ): IterableEmbeddedImpressionData {
     if (impressionData.start) {
       impressionData.displayCount = (impressionData.displayCount || 0) + 1;
       impressionData.duration =
         (impressionData.duration || 0) +
-        (new Date().getTime() - impressionData.start.getTime()) / 1000;
+        (new Date().getTime() - impressionData.start.getTime()) / 1000.0;
       impressionData.start = null;
     }
     return impressionData;
   }
-
-  private endAllImpressions() {
-    Object.values(this.impressions).forEach((impression) => {
-      this.updateDisplayCountAndDuration(impression);
-    });
-  }
-
-  private getImpressionList(): IterableEmbeddedImpressionData[] {
-    return Object.values(this.impressions).map((impression) => {
-      return new IterableEmbeddedImpression(impression);
-    });
-  }
 }