@botonic/plugin-hubtype-analytics 0.27.0-alpha.0 → 0.27.0-alpha.1

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

@@ -2,8 +2,9 @@ import { EventAction, EventFallback, EventType, RequestData } from '../types'
 import { HtEvent } from './ht-event'
 
 interface EventDataFallback {
-  action: EventAction.fallback
-  fallback_attempt: number
+  action: EventAction.Fallback
+  fallback_out: number
+  fallback_message_id: string
 }
 
 export class HtEventFallback extends HtEvent {
@@ -11,7 +12,8 @@ export class HtEventFallback extends HtEvent {
 
   constructor(event: EventFallback, requestData: RequestData) {
     super(event, requestData)
-    this.type = EventType.botevent
-    this.data.fallback_attempt = event.data.fallbackAttempt
+    this.type = EventType.Botevent
+    this.data.fallback_out = event.data.fallbackOut
+    this.data.fallback_message_id = event.data.fallbackMessageId
   }
 }

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

@@ -3,10 +3,10 @@ import { HtEvent } from './ht-event'
 
 interface EventDataFeedback {
   action:
-    | EventAction.feedbackCase
-    | EventAction.feedbackConversation
-    | EventAction.feedbackMessage
-    | EventAction.feedbackWebview
+    | EventAction.FeedbackCase
+    | EventAction.FeedbackConversation
+    | EventAction.FeedbackMessage
+    | EventAction.FeedbackWebview
   message_generated_by?: string
   feedback_target_id?: string
   feedback_group_id?: string
@@ -21,7 +21,7 @@ export class HtEventFeedback extends HtEvent {
 
   constructor(event: EventFeedback, requestData: RequestData) {
     super(event, requestData)
-    this.type = EventType.feedback
+    this.type = EventType.Feedback
     this.data.message_generated_by = event.data.messageGeneratedBy // ?? nomes te valor quan action es message. Si es message de knowledge base => sources y chunks. Quan es un node de flow builder => content_id
     this.data.feedback_target_id = event.data.feedbackTargetId // ?? case_id, message_id, conversation_id ???, webview_name
     this.data.feedback_group_id = event.data.feedbackGroupId // ??

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

@@ -2,13 +2,13 @@ import { EventAction, EventFlow, EventType, RequestData } from '../types'
 import { HtEvent } from './ht-event'
 
 interface EventDataFlow {
-  action: EventAction.flowNode
+  action: EventAction.FlowNode
   flow_thread_id: string
   flow_id: string
   flow_name: string
   flow_node_id: string
   flow_node_content_id: string
-  flow_node_is_meaningful?: boolean
+  flow_node_is_meaningful: boolean
 }
 
 export class HtEventFlow extends HtEvent {
@@ -16,7 +16,7 @@ export class HtEventFlow extends HtEvent {
 
   constructor(event: EventFlow, requestData: RequestData) {
     super(event, requestData)
-    this.type = EventType.botevent
+    this.type = EventType.Botevent
     this.data.flow_thread_id = event.data.flowThreadId // This value is managed by the flow builder plugin, stored in the session and updated every time the content connected to the conversation start is displayed
     this.data.flow_id = event.data.flowId
     this.data.flow_name = event.data.flowName

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

@@ -3,9 +3,9 @@ import { HtEvent } from './ht-event'
 
 interface EventDataHandoff {
   action:
-    | EventAction.handoffOption
-    | EventAction.handoffSuccess
-    | EventAction.handoffFail
+    | EventAction.HandoffOption
+    | EventAction.HandoffSuccess
+    | EventAction.HandoffFail
   handoff_queue_id: string
   handoff_queue_name: string
   handoff_case_id?: string
@@ -19,7 +19,7 @@ export class HtEventHandoff extends HtEvent {
 
   constructor(event: EventHandoff, requestData: RequestData) {
     super(event, requestData)
-    this.type = EventType.botevent
+    this.type = EventType.Botevent
     this.data.handoff_queue_id = event.data.queueId
     this.data.handoff_queue_name = event.data.queueName
     this.data.handoff_case_id = event.data.caseId

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

@@ -2,7 +2,7 @@ import { EventAction, EventIntentSmart, EventType, RequestData } from '../types'
 import { HtEvent } from './ht-event'
 
 interface EventDataIntentSmart {
-  action: EventAction.intentSmart
+  action: EventAction.IntentSmart
   nlu_intent_smart_title: string
   nlu_intent_smart_num_used: number
   nlu_intent_smart_message_id: string
@@ -13,7 +13,7 @@ export class HtEventIntentSmart extends HtEvent {
 
   constructor(event: EventIntentSmart, requestData: RequestData) {
     super(event, requestData)
-    this.type = EventType.botevent
+    this.type = EventType.Botevent
     this.data.nlu_intent_smart_title = event.data.nluIntentSmartTitle
     this.data.nlu_intent_smart_num_used = event.data.nluIntentSmartNumUsed
     this.data.nlu_intent_smart_message_id = event.data.nluIntentSmartMessageId

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

@@ -2,7 +2,7 @@ import { EventAction, EventIntent, EventType, RequestData } from '../types'
 import { HtEvent } from './ht-event'
 
 interface EventDataIntent {
-  action: EventAction.intent
+  action: EventAction.Intent
   nlu_intent_label: string
   nlu_intent_confidence: number
   nlu_intent_threshold: number
@@ -14,7 +14,7 @@ export class HtEventIntent extends HtEvent {
 
   constructor(event: EventIntent, requestData: RequestData) {
     super(event, requestData)
-    this.type = EventType.botevent
+    this.type = EventType.Botevent
     this.data.nlu_intent_label = event.data.nluIntentLabel
     this.data.nlu_intent_confidence = event.data.nluIntentConfidence
     this.data.nlu_intent_threshold = event.data.nluIntentThreshold

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

@@ -2,7 +2,7 @@ import { EventAction, EventKeyword, EventType, RequestData } from '../types'
 import { HtEvent } from './ht-event'
 
 interface EventDataKeyword {
-  action: EventAction.keyword
+  action: EventAction.Keyword
   nlu_keyword_id: string
   nlu_keyword_name: string
   nlu_keyword_is_regex: boolean
@@ -14,7 +14,7 @@ export class HtEventKeyword extends HtEvent {
 
   constructor(event: EventKeyword, requestData: RequestData) {
     super(event, requestData)
-    this.type = EventType.botevent
+    this.type = EventType.Botevent
     this.data.nlu_keyword_id = event.data.nluKeywordId
     this.data.nlu_keyword_name = event.data.nluKeywordName
     this.data.nlu_keyword_is_regex = event.data.nluKeywordIsRegex || false

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

@@ -7,10 +7,12 @@ import {
 import { HtEvent } from './ht-event'
 
 interface EventDataKnowledgeBase {
-  action: EventAction.knowledgebase
+  action: EventAction.Knowledgebase
+  knowledgebase_inference_id: string
   knowledgebase_fail_reason?: string
   knowledgebase_sources_ids: string[]
   knowledgebase_chunks_ids: string[]
+  knowledgebase_message_id: string
 }
 
 export class HtEventKnowledgeBase extends HtEvent {
@@ -18,9 +20,11 @@ export class HtEventKnowledgeBase extends HtEvent {
 
   constructor(event: EventKnowledgeBase, requestData: RequestData) {
     super(event, requestData)
-    this.type = EventType.botevent
+    this.type = EventType.Botevent
+    this.data.knowledgebase_inference_id = event.data.knowledgebaseInferenceId
     this.data.knowledgebase_fail_reason = event.data.knowledgebaseFailReason
     this.data.knowledgebase_sources_ids = event.data.knowledgebaseSourcesIds
     this.data.knowledgebase_chunks_ids = event.data.knowledgebaseChunksIds
+    this.data.knowledgebase_message_id = event.data.knowledgebaseMessageId
   }
 }

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

@@ -2,10 +2,10 @@ import { EventAction, EventType, EventWebview, RequestData } from '../types'
 import { HtEvent } from './ht-event'
 
 interface EventDataWebview {
-  action: EventAction.webviewStep | EventAction.webviewEnd
+  action: EventAction.WebviewStep | EventAction.WebviewEnd
   webview_thread_id: string
   webview_name: string
-  webview_step_name: string
+  webview_step_name?: string
   webview_end_fail_type?: string
   webview_end_fail_message?: string
 }
@@ -15,7 +15,7 @@ export class HtEventWebview extends HtEvent {
 
   constructor(event: EventWebview, requestData: RequestData) {
     super(event, requestData)
-    this.type = EventType.webevent
+    this.type = EventType.Webevent
     this.data.webview_thread_id = event.data.webviewThreadId
     this.data.webview_name = event.data.webviewName
     this.data.webview_step_name = event.data.webviewStepName

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

@@ -14,8 +14,6 @@ export class HtEvent {
 
   constructor(event: HtEventProps, requestData: RequestData) {
     this.chat_id = requestData.userId
-    this.channel = requestData.provider
-    this.created_at = new Date().toISOString()
     this.chat_language = requestData.language
     this.chat_country = requestData.country
     this.format_version = 2

package/src/index.ts

@@ -33,10 +33,10 @@ export default class BotonicPluginHubtypeAnalytics implements Plugin {
   }
 
   getUrl(request: BotRequest, eventType: EventType) {
-    if (eventType === EventType.webevent) {
-      return `${this.baseUrl}/external/v2/conversational_apps/${request.session.bot.id}/web_event/`
-    }
-    return `${this.baseUrl}/external/v2/conversational_apps/${request.session.bot.id}/bot_event/`
+    const endpoint =
+      eventType === EventType.Webevent ? 'web_event' : 'bot_event'
+    const botId = request.session.bot.id
+    return `${this.baseUrl}/external/v2/conversational_apps/${botId}/${endpoint}/`
   }
 
   getRequestData(request: BotRequest): RequestData {
@@ -58,7 +58,7 @@ export default class BotonicPluginHubtypeAnalytics implements Plugin {
   private sendEvent(request: BotRequest, event: HtEvent) {
     const url = this.getUrl(request, event.type)
     const headers = { Authorization: `Bearer ${request.session._access_token}` }
-    const config = event.type !== EventType.webevent ? { headers } : undefined
+    const config = event.type !== EventType.Webevent ? { headers } : undefined
     return axios.post(url, event, config)
   }
 }

package/src/types.ts

@@ -1,29 +1,28 @@
 import { PROVIDER } from '@botonic/core'
 
 export enum EventType {
-  feedback = 'feedback',
-  botevent = 'botevent',
-  webevent = 'webevent',
+  Feedback = 'feedback',
+  Botevent = 'botevent',
+  Webevent = 'webevent',
 }
 
 export enum EventAction {
-  feedbackCase = 'feedback_case',
-  feedbackMessage = 'feddback_message',
-  feedbackConversation = 'feddback_conversation',
-  feedbackWebview = 'feddback_webview',
-  flowNode = 'flow_node',
-  handoffOption = 'handoff_option',
-  handoffSuccess = 'handoff_success',
-  handoffFail = 'handoff_fail',
-  keyword = 'nlu_keyword',
-  intent = 'nlu_intent',
-  intentSmart = 'nlu_intent_smart',
-  knowledgebase = 'knowledgebase',
-  fallback = 'fallback',
-  webviewStep = 'webview_step',
-  webviewEnd = 'webview_end',
-  customBot = 'custom_bot', // Custom event for bot
-  customWeb = 'custom_web', // Custom event for web
+  FeedbackCase = 'feedback_case',
+  FeedbackMessage = 'feddback_message',
+  FeedbackConversation = 'feddback_conversation',
+  FeedbackWebview = 'feddback_webview',
+  FlowNode = 'flow_node',
+  HandoffOption = 'handoff_option',
+  HandoffSuccess = 'handoff_success',
+  HandoffFail = 'handoff_fail',
+  Keyword = 'nlu_keyword',
+  Intent = 'nlu_intent',
+  IntentSmart = 'nlu_intent_smart',
+  Knowledgebase = 'knowledgebase',
+  Fallback = 'fallback',
+  WebviewStep = 'webview_step',
+  WebviewEnd = 'webview_end',
+  Custom = 'custom',
 }
 
 export interface HtBaseEventProps {
@@ -32,10 +31,10 @@ export interface HtBaseEventProps {
 
 export interface EventFeedback extends HtBaseEventProps {
   action:
-    | EventAction.feedbackCase
-    | EventAction.feedbackConversation
-    | EventAction.feedbackMessage
-    | EventAction.feedbackWebview
+    | EventAction.FeedbackCase
+    | EventAction.FeedbackConversation
+    | EventAction.FeedbackMessage
+    | EventAction.FeedbackWebview
   data: EventPropsFeedback
 }
 
@@ -50,7 +49,7 @@ export interface EventPropsFeedback {
 }
 
 export interface EventFlow extends HtBaseEventProps {
-  action: EventAction.flowNode
+  action: EventAction.FlowNode
   data: EventPropsFlow
 }
 
@@ -65,9 +64,9 @@ export interface EventPropsFlow {
 
 export interface EventHandoff extends HtBaseEventProps {
   action:
-    | EventAction.handoffOption
-    | EventAction.handoffSuccess
-    | EventAction.handoffFail
+    | EventAction.HandoffOption
+    | EventAction.HandoffSuccess
+    | EventAction.HandoffFail
   data: EventPropsHandoff
 }
 
@@ -81,7 +80,7 @@ export interface EventPropsHandoff {
 }
 
 export interface EventIntent extends HtBaseEventProps {
-  action: EventAction.intent
+  action: EventAction.Intent
   data: EventPropsIntent
 }
 
@@ -93,7 +92,7 @@ export interface EventPropsIntent {
 }
 
 export interface EventKeyword extends HtBaseEventProps {
-  action: EventAction.keyword
+  action: EventAction.Keyword
   data: EventPropsKeyword
 }
 
@@ -105,7 +104,7 @@ export interface EventPropsKeyword {
 }
 
 export interface EventIntentSmart extends HtBaseEventProps {
-  action: EventAction.intentSmart
+  action: EventAction.IntentSmart
   data: EventPropsIntentSmart
 }
 
@@ -116,46 +115,54 @@ export interface EventPropsIntentSmart {
 }
 
 export interface EventKnowledgeBase extends HtBaseEventProps {
-  action: EventAction.knowledgebase
+  action: EventAction.Knowledgebase
   data: EventPropsKnowledgeBase
 }
 
 export interface EventPropsKnowledgeBase {
-  knowledgebaseFailReason?: string
+  knowledgebaseInferenceId: string
+  knowledgebaseFailReason?: KnowledgebaseFailReason
   knowledgebaseSourcesIds: string[]
   knowledgebaseChunksIds: string[]
+  knowledgebaseMessageId: string
+}
+
+export enum KnowledgebaseFailReason {
+  NoKnowledge = 'no_knowledge',
+  Hallucination = 'hallucination',
 }
 
 export interface EventFallback extends HtBaseEventProps {
-  action: EventAction.fallback
+  action: EventAction.Fallback
   data: EventPropsFallbackBase
 }
 
 export interface EventPropsFallbackBase {
-  fallbackAttempt: number
+  fallbackOut: number
+  fallbackMessageId: string
 }
 
 export interface EventWebview extends HtBaseEventProps {
-  action: EventAction.webviewStep | EventAction.webviewEnd
+  action: EventAction.WebviewStep | EventAction.WebviewEnd
   data: EventPropsWebview
 }
 
 export interface EventPropsWebview {
   webviewThreadId: string
   webviewName: string
-  webviewStepName: string
+  webviewStepName?: string
   webviewEndFailType?: string
   webviewEndFailMessage?: string
 }
 
 export interface EventCustom extends HtBaseEventProps {
-  action: EventAction.customBot | EventAction.customWeb
-  data: Record<CustomAttribute, string>
+  action: EventAction.Custom
+  data: EventPropsCustom
 }
 
-export const CUSTOM_PREFIX = 'custom_'
-// All attributs that start with 'custom_' are considered custom attributs
-export type CustomAttribute = `${typeof CUSTOM_PREFIX}${string}`
+export interface EventPropsCustom {
+  customFields: Record<string, any>
+}
 
 export type HtEventProps =
   | EventFeedback

package/src/utils.ts

@@ -18,40 +18,40 @@ export function createHtEvent(
   htEventProps: HtEventProps
 ): HtEvent {
   switch (htEventProps.action) {
-    case EventAction.feedbackCase:
-    case EventAction.feedbackConversation:
-    case EventAction.feedbackMessage:
-    case EventAction.feedbackWebview:
+    case EventAction.FeedbackCase:
+    case EventAction.FeedbackConversation:
+    case EventAction.FeedbackMessage:
+    case EventAction.FeedbackWebview:
       return new HtEventFeedback(htEventProps, requestData)
 
-    case EventAction.flowNode:
+    case EventAction.FlowNode:
       return new HtEventFlow(htEventProps, requestData)
 
-    case EventAction.handoffOption:
-    case EventAction.handoffSuccess:
-    case EventAction.handoffFail:
+    case EventAction.HandoffOption:
+    case EventAction.HandoffSuccess:
+    case EventAction.HandoffFail:
       return new HtEventHandoff(htEventProps, requestData)
 
-    case EventAction.intent:
+    case EventAction.Intent:
       return new HtEventIntent(htEventProps, requestData)
 
-    case EventAction.keyword:
+    case EventAction.Keyword:
       return new HtEventKeyword(htEventProps, requestData)
 
-    case EventAction.intentSmart:
+    case EventAction.IntentSmart:
       return new HtEventIntentSmart(htEventProps, requestData)
 
-    case EventAction.knowledgebase:
+    case EventAction.Knowledgebase:
       return new HtEventKnowledgeBase(htEventProps, requestData)
 
-    case EventAction.fallback:
+    case EventAction.Fallback:
       return new HtEventFallback(htEventProps, requestData)
 
-    case EventAction.webviewStep:
+    case EventAction.WebviewStep:
+    case EventAction.WebviewEnd:
       return new HtEventWebview(htEventProps, requestData)
 
-    case EventAction.customBot:
-    case EventAction.customWeb:
+    case EventAction.Custom:
       return new HtEventCustom(htEventProps, requestData)
 
     default: