@botonic/plugin-hubtype-analytics 0.27.0-alpha.5 → 0.27.0

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

@@ -1,4 +1,4 @@
-import { EventType, HtEventProps, RequestData } from '../types'
+import { EventAction, EventType, HtEventProps, RequestData } from '../types'
 
 export class HtEvent {
   chat_id: string
@@ -8,14 +8,13 @@ export class HtEvent {
   format_version?: number
   bot_version?: string
   flow_version?: string
-  data: any
+  action: EventAction
 
   constructor(event: HtEventProps, requestData: RequestData) {
     this.chat_id = requestData.userId
     this.chat_language = requestData.language
     this.chat_country = requestData.country
     this.format_version = 2
-    this.data = {}
-    this.data.action = event.action
+    this.action = event.action
   }
 }

package/src/event-models/index.ts

@@ -4,6 +4,7 @@ export { HtEventFallback } from './ht-event-fallback'
 export { HtEventFeedback } from './ht-event-feedback'
 export { HtEventFlow } from './ht-event-flow'
 export { HtEventHandoff } from './ht-event-handoff'
+export { HtEventHandoffOption } from './ht-event-handoff-option'
 export { HtEventIntent } from './ht-event-intent'
 export { HtEventIntentSmart } from './ht-event-intent-smart'
 export { HtEventKeyword } from './ht-event-keyword'

package/src/types.ts

@@ -1,5 +1,4 @@
 export enum EventType {
-  Feedback = 'feedback',
   BotEvent = 'botevent',
   WebEvent = 'webevent',
 }
@@ -33,10 +32,6 @@ export interface EventFeedback extends HtBaseEventProps {
     | EventAction.FeedbackConversation
     | EventAction.FeedbackMessage
     | EventAction.FeedbackWebview
-  data: EventPropsFeedback
-}
-
-export interface EventPropsFeedback {
   messageGeneratedBy?: string
   feedbackTargetId?: string
   feedbackGroupId?: string
@@ -44,14 +39,11 @@ export interface EventPropsFeedback {
   possibleValues: number[]
   option: string
   value: number
+  comment?: string
 }
 
 export interface EventFlow extends HtBaseEventProps {
   action: EventAction.FlowNode
-  data: EventPropsFlow
-}
-
-export interface EventPropsFlow {
   flowThreadId: string
   flowId: string
   flowName: string
@@ -61,14 +53,7 @@ export interface EventPropsFlow {
 }
 
 export interface EventHandoff extends HtBaseEventProps {
-  action:
-    | EventAction.HandoffOption
-    | EventAction.HandoffSuccess
-    | EventAction.HandoffFail
-  data: EventPropsHandoff
-}
-
-export interface EventPropsHandoff {
+  action: EventAction.HandoffSuccess | EventAction.HandoffFail
   queueId: string
   queueName: string
   caseId?: string
@@ -77,52 +62,46 @@ export interface EventPropsHandoff {
   isThresholdReached?: boolean
 }
 
-export interface EventIntent extends HtBaseEventProps {
-  action: EventAction.Intent
-  data: EventPropsIntent
+export interface EventHandoffOption extends HtBaseEventProps {
+  action: EventAction.HandoffOption
+  queueId: string
+  queueName: string
 }
 
-export interface EventPropsIntent {
+export interface EventIntent extends HtBaseEventProps {
+  action: EventAction.Intent
   nluIntentLabel: string
   nluIntentConfidence: number
   nluIntentThreshold: number
   nluIntentMessageId: string
+  userInput: string
 }
 
 export interface EventKeyword extends HtBaseEventProps {
   action: EventAction.Keyword
-  data: EventPropsKeyword
-}
-
-export interface EventPropsKeyword {
   nluKeywordId: string
   nluKeywordName: string
   nluKeywordIsRegex?: boolean
   nluKeywordMessageId: string
+  userInput: string
 }
 
 export interface EventIntentSmart extends HtBaseEventProps {
   action: EventAction.IntentSmart
-  data: EventPropsIntentSmart
-}
-
-export interface EventPropsIntentSmart {
   nluIntentSmartTitle: string
   nluIntentSmartNumUsed: number
   nluIntentSmartMessageId: string
+  userInput: string
 }
 
 export interface EventKnowledgeBase extends HtBaseEventProps {
   action: EventAction.Knowledgebase
-  data: EventPropsKnowledgeBase
-}
-
-export interface EventPropsKnowledgeBase {
   knowledgebaseInferenceId: string
   knowledgebaseFailReason?: KnowledgebaseFailReason
   knowledgebaseSourcesIds: string[]
   knowledgebaseChunksIds: string[]
   knowledgebaseMessageId: string
+  userInput: string
 }
 
 export enum KnowledgebaseFailReason {
@@ -132,17 +111,17 @@ export enum KnowledgebaseFailReason {
 
 export interface EventFallback extends HtBaseEventProps {
   action: EventAction.Fallback
-  data: EventPropsFallbackBase
-}
-
-export interface EventPropsFallbackBase {
   fallbackOut: number
   fallbackMessageId: string
 }
 
 export interface EventWebview extends HtBaseEventProps {
   action: EventAction.WebviewStep | EventAction.WebviewEnd
-  data: EventPropsWebview
+  webviewThreadId: string
+  webviewName: string
+  webviewStepName?: string
+  webviewEndFailType?: string
+  webviewEndFailMessage?: string
 }
 
 export interface EventPropsWebview {
@@ -155,10 +134,6 @@ export interface EventPropsWebview {
 
 export interface EventCustom extends HtBaseEventProps {
   action: EventAction.Custom
-  data: EventPropsCustom
-}
-
-export interface EventPropsCustom {
   customFields: Record<string, any>
 }
 
@@ -166,6 +141,7 @@ export type HtEventProps =
   | EventFeedback
   | EventFlow
   | EventHandoff
+  | EventHandoffOption
   | EventIntent
   | EventKeyword
   | EventIntentSmart

package/src/utils.ts

@@ -5,6 +5,7 @@ import {
   HtEventFeedback,
   HtEventFlow,
   HtEventHandoff,
+  HtEventHandoffOption,
   HtEventIntent,
   HtEventIntentSmart,
   HtEventKeyword,
@@ -28,6 +29,8 @@ export function createHtEvent(
       return new HtEventFlow(htEventProps, requestData)
 
     case EventAction.HandoffOption:
+      return new HtEventHandoffOption(htEventProps, requestData)
+
     case EventAction.HandoffSuccess:
     case EventAction.HandoffFail:
       return new HtEventHandoff(htEventProps, requestData)