@customerio/cdp-analytics-browser 0.3.9 → 0.3.11

package/src/plugins/in-app-plugin/inbox_messages.ts

@@ -1,8 +1,12 @@
+import { Analytics } from '../../core/analytics'
+import { JourneysEvents } from './events'
+
 export interface GistInboxMessage {
   messageType: string
   expiry: string
   priority: number
   topics?: string[]
+  type: string
   properties: { [key: string]: any }
   queueId: string
   userToken: string
@@ -24,6 +28,18 @@ export interface InboxMessage {
   // When the message was sent
   readonly sentAt: string
 
+  // Optional message type
+  readonly type: string
+
+  // Optional list of topics this message belongs to
+  readonly topics: string[]
+
+  /**
+   * Tracks a click metric for the message with an optional tracked response value.
+   * @returns void
+   */
+  trackClick(trackedResponse?: string): void
+
   /**
    * Marks this message as opened
    * @returns Promise that resolves when the message is marked as opened
@@ -71,6 +87,7 @@ export interface InboxAPI {
 }
 
 function createInboxMessage(
+  analyticsInstance: Analytics,
   gist: any,
   gistMessage: GistInboxMessage
 ): InboxMessage {
@@ -79,6 +96,18 @@ function createInboxMessage(
     messageId: gistMessage.queueId,
     opened: gistMessage?.opened === true,
     properties: gistMessage.properties,
+    type: gistMessage.type || "",
+    topics: gistMessage.topics || [],
+    trackClick: (trackedResponse?: string) => {
+      if(typeof gistMessage.deliveryId === 'undefined' || gistMessage.deliveryId === '') {
+        return
+      }
+      void analyticsInstance.track(JourneysEvents.Metric, {
+        deliveryId: gistMessage.deliveryId,
+        metric: JourneysEvents.Clicked,
+        actionName: trackedResponse,
+      })
+    },
     markOpened: async () => {
       await gist.updateInboxMessageOpenState(gistMessage.queueId, true)
     },
@@ -118,7 +147,7 @@ async function getFilteredMessages(
   })
 }
 
-export function createInboxAPI(gist: any, topics: string[]): InboxAPI {
+export function createInboxAPI(analyticsInstance: Analytics, gist: any, topics: string[]): InboxAPI {
   return {
     total: async () => {
       const messages = await getFilteredMessages(gist, topics, null)
@@ -132,7 +161,7 @@ export function createInboxAPI(gist: any, topics: string[]): InboxAPI {
     },
     messages: async (): Promise<InboxMessage[]> => {
       const messages = await getFilteredMessages(gist, topics, null)
-      return messages.map((msg) => createInboxMessage(gist, msg))
+      return messages.map((msg) => createInboxMessage(analyticsInstance, gist, msg))
     },
     onUpdates: (callback: (messages: InboxMessage[]) => void): (() => void) => {
       const handler = async (gistMessages: GistInboxMessage[]) => {
@@ -143,7 +172,7 @@ export function createInboxAPI(gist: any, topics: string[]): InboxAPI {
             gistMessages
           )
           const inboxMessages = filteredMessages.map((msg) =>
-            createInboxMessage(gist, msg)
+            createInboxMessage(analyticsInstance, gist, msg)
           )
 
           callback(inboxMessages)

package/src/plugins/in-app-plugin/index.ts

@@ -86,8 +86,11 @@ export function InAppPlugin(settings: InAppPluginSettings): Plugin {
         })
         return
       }
-      const broadcastId: Number =
+      let broadcastId: Number =
         message?.properties?.gist?.broadcast?.broadcastIdInt
+      if (!broadcastId) {
+        broadcastId = message?.properties?.gist?.broadcast?.broadcastId
+      }
       if (broadcastId) {
         const templateId = message?.properties?.gist?.broadcast?.templateId
         void _analytics.track(JourneysEvents.Content, {
@@ -136,8 +139,11 @@ export function InAppPlugin(settings: InAppPluginSettings): Plugin {
         })
         return
       }
-      const broadcastId: Number =
+      let broadcastId: Number =
         params?.message?.properties?.gist?.broadcast?.broadcastIdInt
+      if (!broadcastId) {
+        broadcastId = params?.message?.properties?.gist?.broadcast?.broadcastId
+      }
       if (broadcastId) {
         const templateId: Number =
           params?.message?.properties?.gist?.broadcast?.templateId
@@ -229,7 +235,7 @@ export function InAppPlugin(settings: InAppPluginSettings): Plugin {
             'Customer.io In-App Plugin is not loaded yet. Ensure the plugin is initialized before calling inbox().'
           )
         }
-        return createInboxAPI(Gist, topics)
+        return createInboxAPI(instance, Gist, topics)
       }
 
       _pluginLoaded = true