@botonic/plugin-hubtype-analytics 0.22.0-alpha.4 → 0.22.0-alpha.6

package/src/event-models/ht-event-handoff-success.ts

@@ -1,15 +1,19 @@
-import { EventHandoffSuccess, RequestData } from '../types'
+import {
+  BaseEventData,
+  EventDataHandoff,
+  EventHandoffSuccess,
+  RequestData,
+} from '../types'
 import { HtEvent } from './ht-event'
 
 export class HtEventHandoffSuccess extends HtEvent {
-  queue_open: boolean
-  available_agents: boolean
-  threshold_reached: boolean
+  event_data: BaseEventData & EventDataHandoff
 
   constructor(event: EventHandoffSuccess, requestData: RequestData) {
     super(event, requestData)
-    this.queue_open = event.event_data.queue_open
-    this.available_agents = event.event_data.available_agents
-    this.threshold_reached = event.event_data.threshold_reached
+    this.event_data.queue_open = event.event_data.queue_open
+    this.event_data.queue_id = event.event_data.queue_id
+    this.event_data.available_agents = event.event_data.available_agents
+    this.event_data.threshold_reached = event.event_data.threshold_reached
   }
 }

package/src/event-models/ht-event.ts

@@ -1,20 +1,11 @@
 import { BaseEventData, EventName, HtEventProps, RequestData } from '../types'
-import { HtEventAgentRating } from './ht-event-agent-rating'
-import { HtEventBotAiModel } from './ht-event-bot-ai-model'
-import { HtEventBotFaq } from './ht-event-bot-faq'
-import { HtEventBotKeywordModel } from './ht-event-bot-keyword-model'
-import { HtEventBotRating } from './ht-event-bot-rating'
-import { HtEventChannelRating } from './ht-event-channel-rating'
-import { HtEventFaqUseful } from './ht-event-faq-useful'
-import { HtEventHandoffFail } from './ht-event-handoff-fail'
-import { HtEventHandoffSuccess } from './ht-event-handoff-success'
 
 export class HtEvent {
   chat: string
   event_type: EventName
   event_data: BaseEventData
 
-  protected constructor(event: HtEventProps, requestData: RequestData) {
+  constructor(event: HtEventProps, requestData: RequestData) {
     this.chat = requestData.userId
     this.event_type = event.event_type
     this.event_data = {
@@ -26,36 +17,4 @@ export class HtEvent {
       // flow_version?: string
     }
   }
-
-  static create(requestData: RequestData, htEventProps: HtEventProps): HtEvent {
-    if (htEventProps.event_type === EventName.botAgentRating) {
-      return new HtEventAgentRating(htEventProps, requestData)
-    }
-    if (htEventProps.event_type === EventName.botChannelRating) {
-      return new HtEventChannelRating(htEventProps, requestData)
-    }
-    if (htEventProps.event_type === EventName.botFaqUseful) {
-      return new HtEventFaqUseful(htEventProps, requestData)
-    }
-    if (htEventProps.event_type === EventName.botRating) {
-      return new HtEventBotRating(htEventProps, requestData)
-    }
-    if (htEventProps.event_type === EventName.botFaq) {
-      return new HtEventBotFaq(htEventProps, requestData)
-    }
-    if (htEventProps.event_type === EventName.botAiModel) {
-      return new HtEventBotAiModel(htEventProps, requestData)
-    }
-    if (htEventProps.event_type === EventName.botKeywordsModel) {
-      return new HtEventBotKeywordModel(htEventProps, requestData)
-    }
-    if (htEventProps.event_type === EventName.handoffSuccess) {
-      return new HtEventHandoffSuccess(htEventProps, requestData)
-    }
-    if (htEventProps.event_type === EventName.handoffFail) {
-      return new HtEventHandoffFail(htEventProps, requestData)
-    }
-
-    return new HtEvent(htEventProps, requestData)
-  }
 }

package/src/index.ts

@@ -1,8 +1,8 @@
 import { BotRequest, Plugin } from '@botonic/core'
 import axios from 'axios'
 
-import { HtEvent } from './event-models/ht-event'
 import { HtEventProps, RequestData } from './types'
+import { createHtEvent } from './utils'
 
 export interface HubtypeAnalyticsOptions {
   getLaguange?: (request: BotRequest) => string
@@ -21,10 +21,10 @@ export default class BotonicPluginHubtypeAnalytics implements Plugin {
   baseUrl: string
   getLaguange: (request: BotRequest) => string
   getCountry: (request: BotRequest) => string
-  constructor(options: HubtypeAnalyticsOptions) {
+  constructor(options?: HubtypeAnalyticsOptions) {
     this.baseUrl = process.env.HUBTYPE_API_URL || 'https://api.hubtype.com'
-    this.getLaguange = options.getLaguange || getDefaultLanguage
-    this.getCountry = options.getCountry || getDefaultCountry
+    this.getLaguange = options?.getLaguange || getDefaultLanguage
+    this.getCountry = options?.getCountry || getDefaultCountry
   }
 
   post(): void {
@@ -47,9 +47,12 @@ export default class BotonicPluginHubtypeAnalytics implements Plugin {
   async trackEvent(request: BotRequest, htEventProps: HtEventProps) {
     const url = this.getUrl(request)
     const requestData = this.getRequestData(request)
-    const event = HtEvent.create(requestData, htEventProps)
+    const event = createHtEvent(requestData, htEventProps)
     const headers = { Authorization: `Bearer ${request.session._access_token}` }
     const config = { headers }
     return axios.post(url, event, config)
   }
 }
+
+export * from './types'
+export * from './utils'

package/src/types.ts

@@ -62,7 +62,7 @@ export interface EventBotRating extends HtBaseEventProps {
   event_data: EventDataBotRating
 }
 
-interface EventDataBotRating {
+export interface EventDataBotRating {
   rating: number
   free_comment?: string
   selected_options?: string[]
@@ -73,7 +73,7 @@ export interface EventBotFaq extends HtBaseEventProps {
   event_data: EventDataBotFaq
 }
 
-interface EventDataBotFaq {
+export interface EventDataBotFaq {
   faq_name: string
 }
 export interface EventBotStart extends HtBaseEventProps {
@@ -89,7 +89,7 @@ export interface EventBotAiModel {
   event_data: EventDataBotAiModel
 }
 
-interface EventDataBotAiModel {
+export interface EventDataBotAiModel {
   intent: string
   confidence: number
   confidence_successful: boolean
@@ -100,7 +100,7 @@ export interface EventBotKeywordModel extends HtBaseEventProps {
   event_data: EventDataBotKeywordModel
 }
 
-interface EventDataBotKeywordModel {
+export interface EventDataBotKeywordModel {
   confidence_successful: boolean
 }
 export interface EventFallback extends HtBaseEventProps {
@@ -121,8 +121,9 @@ export interface EventHandoffFail extends HtBaseEventProps {
   event_data: EventDataHandoff
 }
 
-interface EventDataHandoff {
+export interface EventDataHandoff {
   queue_open: boolean
+  queue_id: string
   available_agents: boolean
   threshold_reached: boolean
 }

package/src/utils.ts

@@ -0,0 +1,48 @@
+import { HtEvent } from './event-models/ht-event'
+import { HtEventAgentRating } from './event-models/ht-event-agent-rating'
+import { HtEventBotAiModel } from './event-models/ht-event-bot-ai-model'
+import { HtEventBotFaq } from './event-models/ht-event-bot-faq'
+import { HtEventBotKeywordModel } from './event-models/ht-event-bot-keyword-model'
+import { HtEventBotRating } from './event-models/ht-event-bot-rating'
+import { HtEventChannelRating } from './event-models/ht-event-channel-rating'
+import { HtEventFaqUseful } from './event-models/ht-event-faq-useful'
+import { HtEventHandoffFail } from './event-models/ht-event-handoff-fail'
+import { HtEventHandoffSuccess } from './event-models/ht-event-handoff-success'
+import { EventName, HtEventProps, RequestData } from './types'
+
+export function createHtEvent(
+  requestData: RequestData,
+  htEventProps: HtEventProps
+): HtEvent {
+  switch (htEventProps.event_type) {
+    case EventName.botAgentRating:
+      return new HtEventAgentRating(htEventProps, requestData)
+
+    case EventName.botChannelRating:
+      return new HtEventChannelRating(htEventProps, requestData)
+
+    case EventName.botFaqUseful:
+      return new HtEventFaqUseful(htEventProps, requestData)
+
+    case EventName.botRating:
+      return new HtEventBotRating(htEventProps, requestData)
+
+    case EventName.botFaq:
+      return new HtEventBotFaq(htEventProps, requestData)
+
+    case EventName.botAiModel:
+      return new HtEventBotAiModel(htEventProps, requestData)
+
+    case EventName.botKeywordsModel:
+      return new HtEventBotKeywordModel(htEventProps, requestData)
+
+    case EventName.handoffSuccess:
+      return new HtEventHandoffSuccess(htEventProps, requestData)
+
+    case EventName.handoffFail:
+      return new HtEventHandoffFail(htEventProps, requestData)
+
+    default:
+      return new HtEvent(htEventProps, requestData)
+  }
+}