@botonic/plugin-hubtype-analytics/src/index.ts

Plugin for tracking in the Hubtype backend to see the results in the Hubtype Dashbord

import { BotContext, Plugin } from '@botonic/core'
import axios from 'axios'

import { HtEvent } from './event-models'
import { EventType, HtEventProps, 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.getSystemLocale(),
      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'