@botonic/plugin-hubtype-analytics 0.46.0 → 2.23.1

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

@@ -1,32 +0,0 @@
-import {
-  EventAction,
-  type EventConditionalCustom,
-  EventType,
-  type RequestData,
-} from '../types'
-import { HtEvent } from './ht-event'
-
-export class HtEventConditionalCustom extends HtEvent {
-  flow_thread_id: string
-  flow_id: string
-  flow_name: string
-  flow_node_id: string
-  flow_node_content_id: string
-  flow_node_is_meaningful: boolean
-  conditional_variable: string
-  variable_format: string
-
-  constructor(event: EventConditionalCustom, requestData: RequestData) {
-    super(event, requestData)
-    this.type = EventType.BotEvent
-    this.action = EventAction.ConditionalCustom
-    this.flow_thread_id = event.flowThreadId
-    this.flow_id = event.flowId
-    this.flow_name = event.flowName
-    this.flow_node_id = event.flowNodeId
-    this.flow_node_content_id = event.flowNodeContentId
-    this.conditional_variable = event.conditionalVariable
-    this.flow_node_is_meaningful = event.flowNodeIsMeaningful
-    this.variable_format = event.variableFormat
-  }
-}

package/src/event-models/ht-event-conditional-queue-status.ts

@@ -1,36 +0,0 @@
-import {
-  EventAction,
-  type EventConditionalQueueStatus,
-  EventType,
-  type RequestData,
-} from '../types'
-import { HtEvent } from './ht-event'
-
-export class HtEventConditionalQueueStatus extends HtEvent {
-  flow_thread_id: string
-  flow_id: string
-  flow_name: string
-  flow_node_id: string
-  flow_node_content_id: string
-  flow_node_is_meaningful: boolean
-  queue_id: string
-  queue_name: string
-  is_queue_open: boolean
-  is_available_agent: boolean
-
-  constructor(event: EventConditionalQueueStatus, requestData: RequestData) {
-    super(event, requestData)
-    this.type = EventType.BotEvent
-    this.action = EventAction.ConditionalQueueStatus
-    this.flow_thread_id = event.flowThreadId
-    this.flow_id = event.flowId
-    this.flow_name = event.flowName
-    this.flow_node_id = event.flowNodeId
-    this.flow_node_content_id = event.flowNodeContentId
-    this.flow_node_is_meaningful = event.flowNodeIsMeaningful
-    this.queue_id = event.queueId
-    this.queue_name = event.queueName
-    this.is_queue_open = event.isQueueOpen
-    this.is_available_agent = event.isAvailableAgent
-  }
-}

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

@@ -1,20 +0,0 @@
-import {
-  EventAction,
-  type EventCustom,
-  EventType,
-  type RequestData,
-} from '../types'
-import { HtEvent } from './ht-event'
-
-export class HtEventCustom extends HtEvent {
-  custom_fields: Record<string, unknown>
-  custom_sensitive_fields: Record<string, unknown>
-
-  constructor(event: EventCustom, requestData: RequestData) {
-    super(event, requestData)
-    this.type = EventType.WebEvent
-    this.action = EventAction.Custom
-    this.custom_fields = event.customFields || {}
-    this.custom_sensitive_fields = event.customSensitiveFields || {}
-  }
-}

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

@@ -1,30 +0,0 @@
-import {
-  EventAction,
-  type EventFallback,
-  EventType,
-  type RequestData,
-} from '../types'
-import { HtEvent } from './ht-event'
-
-export class HtEventFallback extends HtEvent {
-  flow_id: string
-  flow_name: string
-  flow_node_id: string
-  flow_node_content_id: string
-  fallback_out: number
-  fallback_message_id: string
-  user_input: string
-
-  constructor(event: EventFallback, requestData: RequestData) {
-    super(event, requestData)
-    this.type = EventType.BotEvent
-    this.action = EventAction.Fallback
-    this.flow_id = event.flowId
-    this.flow_name = event.flowName
-    this.flow_node_id = event.flowNodeId
-    this.flow_node_content_id = event.flowNodeContentId
-    this.user_input = event.userInput
-    this.fallback_out = event.fallbackOut
-    this.fallback_message_id = event.fallbackMessageId
-  }
-}

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

@@ -1,35 +0,0 @@
-import {
-  type EventAction,
-  type EventFeedbackKnowledgebase,
-  EventType,
-  type RequestData,
-} from '../types'
-import { HtEvent } from './ht-event'
-
-export class HtEventFeedbackKnowledgebase extends HtEvent {
-  action: EventAction.FeedbackKnowledgebase
-  knowledge_base_inference_id: string
-  feedback_target_bot_interaction_id: string
-  feedback_target_id: string
-  feedback_group_id: string
-  possible_options: string[]
-  possible_values?: number[]
-  option: string
-  value?: number
-  comment?: string
-
-  constructor(event: EventFeedbackKnowledgebase, requestData: RequestData) {
-    super(event, requestData)
-    this.type = EventType.WebEvent
-    this.action = event.action
-    this.knowledge_base_inference_id = event.knowledgebaseInferenceId
-    this.feedback_target_bot_interaction_id = event.feedbackBotInteractionId
-    this.feedback_target_id = event.feedbackTargetId
-    this.feedback_group_id = event.feedbackGroupId
-    this.possible_options = event.possibleOptions
-    this.possible_values = event.possibleValues
-    this.option = event.option
-    this.value = event.value
-    this.comment = event.comment
-  }
-}

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

@@ -1,35 +0,0 @@
-import {
-  type EventAction,
-  type EventFeedback,
-  EventType,
-  type RequestData,
-} from '../types'
-import { HtEvent } from './ht-event'
-
-export class HtEventFeedback extends HtEvent {
-  action:
-    | EventAction.FeedbackCase
-    | EventAction.FeedbackConversation
-    | EventAction.FeedbackMessage
-    | EventAction.FeedbackWebview
-  feedback_target_id: string
-  feedback_group_id: string
-  possible_options: string[]
-  possible_values?: number[]
-  option: string
-  value?: number
-  comment?: string
-
-  constructor(event: EventFeedback, requestData: RequestData) {
-    super(event, requestData)
-    this.type = EventType.WebEvent
-    this.action = event.action
-    this.feedback_target_id = event.feedbackTargetId
-    this.feedback_group_id = event.feedbackGroupId
-    this.possible_options = event.possibleOptions
-    this.possible_values = event.possibleValues
-    this.option = event.option
-    this.value = event.value
-    this.comment = event.comment
-  }
-}

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

@@ -1,28 +0,0 @@
-import {
-  EventAction,
-  type EventFlow,
-  EventType,
-  type RequestData,
-} from '../types'
-import { HtEvent } from './ht-event'
-
-export class HtEventFlow extends HtEvent {
-  flow_thread_id: string
-  flow_id: string
-  flow_name: string
-  flow_node_id: string
-  flow_node_content_id: string
-  flow_node_is_meaningful: boolean
-
-  constructor(event: EventFlow, requestData: RequestData) {
-    super(event, requestData)
-    this.type = EventType.BotEvent
-    this.action = EventAction.FlowNode
-    this.flow_thread_id = event.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.flow_id = event.flowId
-    this.flow_name = event.flowName
-    this.flow_node_id = event.flowNodeId
-    this.flow_node_content_id = event.flowNodeContentId
-    this.flow_node_is_meaningful = event.flowNodeIsMeaningful || false
-  }
-}

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

@@ -1,30 +0,0 @@
-import {
-  type EventAction,
-  type EventHandoffOption,
-  EventType,
-  type RequestData,
-} from '../types'
-import { HtEvent } from './ht-event'
-
-export class HtEventHandoffOption extends HtEvent {
-  action: EventAction.HandoffOption
-  flow_thread_id?: string
-  flow_id: string
-  flow_name: string
-  flow_node_id: string
-  flow_node_content_id: string
-  handoff_queue_id?: string
-  handoff_queue_name?: string
-
-  constructor(event: EventHandoffOption, requestData: RequestData) {
-    super(event, requestData)
-    this.type = EventType.BotEvent
-    this.flow_thread_id = event.flowThreadId
-    this.flow_id = event.flowId
-    this.flow_name = event.flowName
-    this.flow_node_id = event.flowNodeId
-    this.flow_node_content_id = event.flowNodeContentId
-    this.handoff_queue_id = event.queueId
-    this.handoff_queue_name = event.queueName
-  }
-}

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

@@ -1,39 +0,0 @@
-import {
-  type EventAction,
-  type EventHandoff,
-  EventType,
-  type RequestData,
-} from '../types'
-import { HtEvent } from './ht-event'
-
-export class HtEventHandoff extends HtEvent {
-  action: EventAction.HandoffSuccess | EventAction.HandoffFail
-  flow_thread_id?: string
-  flow_id: string
-  flow_name: string
-  flow_node_id: string
-  flow_node_content_id: string
-  handoff_queue_id: string
-  handoff_queue_name: string
-  handoff_case_id?: string
-  handoff_is_queue_open: boolean
-  handoff_is_available_agent: boolean
-  handoff_is_threshold_reached: boolean
-
-  constructor(event: EventHandoff, requestData: RequestData) {
-    super(event, requestData)
-    this.type = EventType.BotEvent
-    this.action = event.action
-    this.flow_thread_id = event.flowThreadId
-    this.flow_id = event.flowId
-    this.flow_name = event.flowName
-    this.flow_node_id = event.flowNodeId
-    this.flow_node_content_id = event.flowNodeContentId
-    this.handoff_queue_id = event.queueId
-    this.handoff_queue_name = event.queueName
-    this.handoff_case_id = event.caseId
-    this.handoff_is_queue_open = event.isQueueOpen || false
-    this.handoff_is_available_agent = event.isAvailableAgent || false
-    this.handoff_is_threshold_reached = event.isThresholdReached || false
-  }
-}

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

@@ -1,34 +0,0 @@
-import {
-  EventAction,
-  type EventIntentSmart,
-  EventType,
-  type RequestData,
-} from '../types'
-import { HtEvent } from './ht-event'
-
-export class HtEventIntentSmart extends HtEvent {
-  nlu_intent_smart_title: string
-  nlu_intent_smart_num_used: number
-  nlu_intent_smart_message_id: string
-  user_input: string
-  flow_thread_id: string
-  flow_id: string
-  flow_name: string
-  flow_node_id: string
-  flow_node_content_id: string
-
-  constructor(event: EventIntentSmart, requestData: RequestData) {
-    super(event, requestData)
-    this.type = EventType.BotEvent
-    this.action = EventAction.IntentSmart
-    this.nlu_intent_smart_title = event.nluIntentSmartTitle
-    this.nlu_intent_smart_num_used = event.nluIntentSmartNumUsed
-    this.nlu_intent_smart_message_id = event.nluIntentSmartMessageId
-    this.user_input = event.userInput
-    this.flow_thread_id = event.flowThreadId
-    this.flow_id = event.flowId
-    this.flow_name = event.flowName
-    this.flow_node_id = event.flowNodeId
-    this.flow_node_content_id = event.flowNodeContentId
-  }
-}

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

@@ -1,34 +0,0 @@
-import {
-  EventAction,
-  type EventKeyword,
-  EventType,
-  type RequestData,
-} from '../types'
-import { HtEvent } from './ht-event'
-
-export class HtEventKeyword extends HtEvent {
-  nlu_keyword_name: string
-  nlu_keyword_is_regex: boolean
-  nlu_keyword_message_id: string
-  user_input: string
-  flow_thread_id: string
-  flow_id: string
-  flow_name: string
-  flow_node_id: string
-  flow_node_content_id: string
-
-  constructor(event: EventKeyword, requestData: RequestData) {
-    super(event, requestData)
-    this.type = EventType.BotEvent
-    this.action = EventAction.Keyword
-    this.nlu_keyword_name = event.nluKeywordName
-    this.nlu_keyword_is_regex = event.nluKeywordIsRegex || false
-    this.nlu_keyword_message_id = event.nluKeywordMessageId
-    this.user_input = event.userInput
-    this.flow_thread_id = event.flowThreadId
-    this.flow_id = event.flowId
-    this.flow_name = event.flowName
-    this.flow_node_id = event.flowNodeId
-    this.flow_node_content_id = event.flowNodeContentId
-  }
-}

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

@@ -1,38 +0,0 @@
-import {
-  EventAction,
-  type EventKnowledgeBase,
-  EventType,
-  type RequestData,
-} from '../types'
-import { HtEvent } from './ht-event'
-
-export class HtEventKnowledgeBase extends HtEvent {
-  knowledgebase_inference_id: string
-  knowledgebase_fail_reason?: string
-  knowledgebase_sources_ids: string[]
-  knowledgebase_chunks_ids: string[]
-  knowledgebase_message_id: string
-  user_input: string
-  flow_thread_id: string
-  flow_id: string
-  flow_name: string
-  flow_node_id: string
-  flow_node_content_id: string
-
-  constructor(event: EventKnowledgeBase, requestData: RequestData) {
-    super(event, requestData)
-    this.type = EventType.BotEvent
-    this.action = EventAction.Knowledgebase
-    this.knowledgebase_inference_id = event.knowledgebaseInferenceId
-    this.knowledgebase_fail_reason = event.knowledgebaseFailReason
-    this.knowledgebase_sources_ids = event.knowledgebaseSourcesIds
-    this.knowledgebase_chunks_ids = event.knowledgebaseChunksIds
-    this.knowledgebase_message_id = event.knowledgebaseMessageId
-    this.user_input = event.userInput
-    this.flow_thread_id = event.flowThreadId
-    this.flow_id = event.flowId
-    this.flow_name = event.flowName
-    this.flow_node_id = event.flowNodeId
-    this.flow_node_content_id = event.flowNodeContentId
-  }
-}

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

@@ -1,29 +0,0 @@
-import type { EventRedirectFlow } from '@botonic/core'
-
-import { EventAction, EventType, type RequestData } from '../types'
-import { HtEvent } from './ht-event'
-
-export class HtEventRedirectFlow extends HtEvent {
-  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_target_id: string
-  flow_target_name: string
-
-  constructor(event: EventRedirectFlow, requestData: RequestData) {
-    super(event, requestData)
-    this.type = EventType.BotEvent
-    this.action = EventAction.RedirectFlow
-    this.flow_thread_id = event.flowThreadId
-    this.flow_id = event.flowId
-    this.flow_name = event.flowName
-    this.flow_node_id = event.flowNodeId
-    this.flow_node_content_id = event.flowNodeContentId
-    this.flow_node_is_meaningful = event.flowNodeIsMeaningful
-    this.flow_target_id = event.flowTargetId
-    this.flow_target_name = event.flowTargetName
-  }
-}

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

@@ -1,32 +0,0 @@
-import {
-  EventAction,
-  EventType,
-  type EventWebviewActionTriggered,
-  type RequestData,
-} from '../types'
-import { HtEvent } from './ht-event'
-
-export class HtEventWebviewActionTriggered extends HtEvent {
-  flow_thread_id: string
-  flow_id: string
-  flow_name: string
-  flow_node_id: string
-  flow_node_content_id: string
-  flow_node_is_meaningful: boolean
-  webview_name: string
-  webview_target_id: string
-
-  constructor(event: EventWebviewActionTriggered, requestData: RequestData) {
-    super(event, requestData)
-    this.type = EventType.BotEvent
-    this.action = EventAction.WebviewActionTriggered
-    this.flow_thread_id = event.flowThreadId
-    this.flow_id = event.flowId
-    this.flow_name = event.flowName
-    this.flow_node_id = event.flowNodeId
-    this.flow_node_content_id = event.flowNodeContentId
-    this.flow_node_is_meaningful = event.flowNodeIsMeaningful
-    this.webview_name = event.webviewName
-    this.webview_target_id = event.webviewTargetId
-  }
-}

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

@@ -1,31 +0,0 @@
-import {
-  type EventAction,
-  EventType,
-  type EventWebviewEnd,
-  type RequestData,
-} from '../types'
-import { HtEvent } from './ht-event'
-
-export class HtEventWebviewEnd extends HtEvent {
-  action: EventAction.WebviewEnd
-  flow_thread_id?: string
-  webview_thread_id: string
-  webview_name: string
-  webview_end_step_name?: string
-  webview_end_step_n?: number
-  webview_end_fail_type?: string
-  webview_end_fail_message?: string
-
-  constructor(event: EventWebviewEnd, requestData: RequestData) {
-    super(event, requestData)
-    this.type = EventType.WebEvent
-    this.action = event.action
-    this.flow_thread_id = event.flowThreadId
-    this.webview_thread_id = event.webviewThreadId
-    this.webview_name = event.webviewName
-    this.webview_end_step_name = event.webviewStepName
-    this.webview_end_step_n = event.webviewStepNumber
-    this.webview_end_fail_type = event.webviewEndFailType
-    this.webview_end_fail_message = event.webviewEndFailMessage
-  }
-}

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

@@ -1,27 +0,0 @@
-import {
-  type EventAction,
-  EventType,
-  type EventWebviewStep,
-  type RequestData,
-} from '../types'
-import { HtEvent } from './ht-event'
-
-export class HtEventWebviewStep extends HtEvent {
-  action: EventAction.WebviewStep
-  flow_thread_id?: string
-  webview_thread_id: string
-  webview_name: string
-  webview_step_name: string
-  webview_step_n: number
-
-  constructor(event: EventWebviewStep, requestData: RequestData) {
-    super(event, requestData)
-    this.type = EventType.WebEvent
-    this.action = event.action
-    this.flow_thread_id = event.flowThreadId
-    this.webview_thread_id = event.webviewThreadId
-    this.webview_name = event.webviewName
-    this.webview_step_name = event.webviewStepName
-    this.webview_step_n = event.webviewStepNumber
-  }
-}

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

@@ -1,31 +0,0 @@
-/* eslint-disable @typescript-eslint/naming-convention */
-import { EVENT_FORMAT_VERSION } from '@botonic/core'
-
-import type {
-  EventAction,
-  EventType,
-  HtEventProps,
-  RequestData,
-} from '../types'
-export class HtEvent {
-  chat_id?: string
-  type: EventType
-  format_version?: number
-  bot_version?: string
-  flow_version?: string
-  action: EventAction
-  bot_interaction_id?: string
-  user_locale: string
-  user_country: string
-  system_locale: string
-
-  constructor(event: HtEventProps, requestData: RequestData) {
-    this.chat_id = requestData.userId
-    this.format_version = EVENT_FORMAT_VERSION
-    this.action = event.action
-    this.bot_interaction_id = requestData.botInteractionId
-    this.user_locale = requestData.userLocale
-    this.user_country = requestData.userCountry
-    this.system_locale = requestData.systemLocale
-  }
-}

package/src/event-models/index.ts

@@ -1,21 +0,0 @@
-export { HtEvent } from './ht-event'
-export { HtEventAiAgent } from './ht-event-ai-agent'
-export { HtEventBotAction } from './ht-event-bot-action'
-export { HtEventConditionalChannel } from './ht-event-conditional-channel'
-export { HtEventConditionalCountry } from './ht-event-conditional-country'
-export { HtEventConditionalCustom } from './ht-event-conditional-custom'
-export { HtEventConditionalQueueStatus } from './ht-event-conditional-queue-status'
-export { HtEventCustom } from './ht-event-custom'
-export { HtEventFallback } from './ht-event-fallback'
-export { HtEventFeedback } from './ht-event-feedback'
-export { HtEventFeedbackKnowledgebase } from './ht-event-feedback-knowledgebase'
-export { HtEventFlow } from './ht-event-flow'
-export { HtEventHandoff } from './ht-event-handoff'
-export { HtEventHandoffOption } from './ht-event-handoff-option'
-export { HtEventIntentSmart } from './ht-event-intent-smart'
-export { HtEventKeyword } from './ht-event-keyword'
-export { HtEventKnowledgeBase } from './ht-event-knowledge-base'
-export { HtEventRedirectFlow } from './ht-event-redirect-flow'
-export { HtEventWebviewActionTriggered } from './ht-event-webview-action-triggered'
-export { HtEventWebviewEnd } from './ht-event-webview-end'
-export { HtEventWebviewStep } from './ht-event-webview-step'

package/src/index.ts

@@ -1,82 +0,0 @@
-import type { BotContext, Plugin } from '@botonic/core'
-import axios from 'axios'
-
-import type { HtEvent } from './event-models'
-import { EventType, type HtEventProps, type RequestData } from './types'
-import { createHtEvent } from './utils'
-
-export default class BotonicPluginHubtypeAnalytics implements Plugin {
-  eventsBaseUrl: string
-  constructor() {
-    const hubtypeUrl = process.env.HUBTYPE_API_URL || 'https://api.hubtype.com'
-    this.eventsBaseUrl = `${hubtypeUrl}/external/v2/conversational_apps`
-  }
-
-  post(): void {
-    return
-  }
-
-  async trackEvent(request: BotContext, htEventProps: HtEventProps) {
-    const requestData = this.getRequestData(request)
-    const event = createHtEvent(requestData, htEventProps)
-    return this.sendEvent(request, event)
-  }
-
-  getRequestData(request: BotContext): RequestData {
-    return {
-      userId: this.isLambdaEvent(request) ? request.session.user.id : undefined,
-      botInteractionId: request.input?.bot_interaction_id,
-      userLocale: request.getUserLocale(),
-      userCountry: request.getUserCountry(),
-      systemLocale: request.getSystemLocale(),
-    }
-  }
-
-  private isLambdaEvent(request: BotContext): boolean {
-    return request.session?.bot?.id !== undefined
-  }
-
-  private sendEvent(request: BotContext, event: HtEvent) {
-    if (event.type === EventType.BotEvent) {
-      return this.sendBotEvent(request, event)
-    }
-
-    return this.sendWebEvent(request, event)
-  }
-
-  private sendBotEvent(request: BotContext, event: HtEvent) {
-    const botId = request.session.bot.id
-    const url = `${this.eventsBaseUrl}/${botId}/bot_event/`
-    const config = {
-      headers: { Authorization: `Bearer ${request.session._access_token}` },
-    }
-    return axios.post(url, event, config)
-  }
-
-  private sendWebEvent(request: BotContext, event: HtEvent) {
-    if (this.isLambdaEvent(request)) {
-      return this.sendWebEventByBotId(request, event)
-    }
-
-    return this.sendWebEventByProviderId(request, event)
-  }
-
-  private sendWebEventByBotId(request: BotContext, event: HtEvent) {
-    const botId = request.session.bot.id
-    const url = `${this.eventsBaseUrl}/${botId}/web_event/`
-    return axios.post(url, event)
-  }
-
-  private sendWebEventByProviderId(request: BotContext, event: HtEvent) {
-    const url = `${this.eventsBaseUrl}/web_event/`
-    const config = {
-      params: {
-        provider_id: request.session.user.id,
-      },
-    }
-    return axios.post(url, event, config)
-  }
-}
-
-export * from './types'
-export * from './utils'