@botonic/plugin-hubtype-analytics 0.22.0-alpha.2

package/README.md

@@ -0,0 +1,50 @@
+# Botonic Plugin Hubtype Analytics
+
+## What Does This Plugin Do?
+
+This plugin allows you to integrate Hubtype Analytics in your Botonic project.
+
+## Setup
+
+1. Install the plugin from npm (or yarn):
+
+```
+npm i --save @botonic/plugin-hubtype-analytics
+```
+
+2. Add it to the `src/plugins.js` file defining the projectId of the Project you want to use:
+
+```
+  export const plugins = [
+    {
+      id: 'hubtype-analytics',
+      resolve: require('@botonic/plugin-hubtype-analytics'),
+      options: {
+        baseUrl: https://api.hubtype.com,
+      },
+    },
+  ]
+```
+
+## Use
+
+You can use it in your actions for example an event to check that a faq has been displayed in the bot:
+
+```
+  const hubtypeAnalyticsPlugin = request.plugins.hubtypeAnalytics
+  const eventBotFaq = {
+    event_type: EventName.botFaq
+    event_data: { enduser_language: 'en', faq_name: 'orders_and_deliveries' }
+  }
+  try {
+    const response = await hubtypeAnalyticsPlugin.trackEvent(request, event)
+    console.log(response)
+  } catch(error) {
+    console.log(error)
+  }
+
+```
+
+## Plugin Options
+
+- **`baseUrl`**: baseUrl to the envirment https://api.hubtype.com for production

package/package.json

@@ -0,0 +1,42 @@
+{
+  "name": "@botonic/plugin-hubtype-analytics",
+  "version": "0.22.0-alpha.2",
+  "description": "Plugin for tracking in the Hubtype backend to see the results in the Hubtype Dashbord",
+  "main": "./lib/cjs/index.js",
+  "module": "./lib/esm/index.js",
+  "scripts": {
+    "build": "rm -rf lib && ../../node_modules/.bin/tsc -p tsconfig.json && ../../node_modules/.bin/tsc -p tsconfig.esm.json",
+    "build:watch": "npm run build -- --watch",
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "prepublishOnly": "rm -rf lib && npm run build",
+    "lint": "npm run lint_core -- --fix",
+    "lint_ci": "npm run lint_core -- -c ../.eslintrc_slow.js",
+    "lint_core": "../../node_modules/.bin/eslint_d --cache --quiet 'src/**/*.ts*'"
+  },
+  "keywords": [
+    "analytics",
+    "bot-framework",
+    "chatbot",
+    "conversational-app",
+    "conversational-ui",
+    "javascript",
+    "typescript"
+  ],
+  "author": "Hubtype",
+  "license": "MIT",
+  "dependencies": {
+    "@babel/runtime": "^7.21.0",
+    "@botonic/core": "^0.22.0",
+    "@types/axios": "^0.14.0",
+    "axios": "^1.4.0"
+  },
+  "eslintConfig": {
+    "extends": "../.eslintrc.js",
+    "root": true
+  },
+  "devDependencies": {
+    "@types/node": "^16.11.7",
+    "@types/react": "^16.14.0",
+    "typescript": "^4.8.4"
+  }
+}

package/src/index.ts

@@ -0,0 +1,43 @@
+import { BotRequest, Plugin } from '@botonic/core'
+import axios from 'axios'
+
+import { HtEvent } from './types'
+
+export interface HubtypeAnalyticsOptions {
+  baseUrl: string
+}
+
+export default class BotonicPluginHubtypeAnalytics implements Plugin {
+  baseUrl: string
+  constructor(options: HubtypeAnalyticsOptions) {
+    this.baseUrl = options.baseUrl
+  }
+
+  pre(): void {
+    return
+  }
+
+  post(): void {
+    return
+  }
+
+  getUrl(request: BotRequest) {
+    return `${this.baseUrl}/external/v1/conversational_apps/${request.session.bot.id}/bot_event/`
+  }
+
+  async trackEvent(request: BotRequest, event: HtEvent) {
+    const url = this.getUrl(request)
+    const data = {
+      chat: request.session.user.id,
+      event_type: event.event_type,
+      event_data: {
+        ...event.event_data,
+        event_datetime: new Date().toISOString(),
+        channel: request.session.user.provider,
+      },
+    }
+    const headers = { Authorization: `Bearer ${request.session._access_token}` }
+    const config = { headers }
+    return axios.post(url, data, config)
+  }
+}

package/src/types.ts

@@ -0,0 +1,123 @@
+export enum EventName {
+  botAgentRating = 'bot_agent_rating',
+  botChannelRating = 'bot_channel_rating',
+  botFaqUseful = 'bot_faq_useful',
+  botRating = 'bot_rating',
+  botFaq = 'bot_faq',
+  botStart = 'bot_start',
+  botOpen = 'bot_open',
+  botAiModel = 'bot_ai_model',
+  botKeywordsModel = 'bot_keywords_model',
+  fallback = 'fallback',
+  handoffOption = 'handoff_option',
+  handoffSuccess = 'handoff_success',
+  handoffFail = 'handoff_fail',
+}
+
+interface EventData {
+  enduser_country?: string
+  enduser_language: string
+  format_version?: number
+  bot_version?: string
+  flow_version?: string
+}
+
+export interface EventAgentRating {
+  event_type: EventName.botAgentRating
+  event_data: EventData & { rating: number }
+}
+
+export interface EventChannelRating {
+  event_type: EventName.botChannelRating
+  event_data: EventData & { rating: number }
+}
+
+export interface EventFaqUseful {
+  event_type: EventName.botFaqUseful
+  event_data: EventData & { faq_name: string; useful: boolean }
+}
+
+export interface EventBotRating {
+  event_type: EventName.botRating
+  event_data: EventData & {
+    faq_name: string
+    useful: boolean
+    rating: number
+    free_comment: string
+    selected_options: string[]
+  }
+}
+
+export interface EventBotFaq {
+  event_type: EventName.botFaq
+  event_data: EventData & { faq_name: string }
+}
+
+export interface EventBotStart {
+  event_type: EventName.botStart
+  event_data: EventData
+}
+
+export interface EventBotOpen {
+  event_type: EventName.botOpen
+  event_data: EventData
+}
+
+export interface EventBotAiModel {
+  event_type: EventName.botAiModel
+  event_data: EventData & {
+    intent: string
+    confidence: number
+    confidence_successful: boolean
+  }
+}
+
+export interface EventBotKeywordModel {
+  event_type: EventName.botKeywordsModel
+  event_data: EventData & {
+    confidence_successful: boolean
+  }
+}
+
+export interface EventFallback {
+  event_type: EventName.fallback
+  event_data: EventData
+}
+
+export interface EventHandoffOption {
+  event_type: EventName.handoffOption
+  event_data: EventData
+}
+
+export interface EventHandoffSuccess {
+  event_type: EventName.handoffSuccess
+  event_data: EventData & {
+    queue_open: boolean
+    available_agents: boolean
+    threshold_reached: boolean
+  }
+}
+
+export interface EventHandoffFail {
+  event_type: EventName.handoffFail
+  event_data: EventData & {
+    queue_open: boolean
+    available_agents: boolean
+    threshold_reached: boolean
+  }
+}
+
+export type HtEvent =
+  | EventAgentRating
+  | EventChannelRating
+  | EventFaqUseful
+  | EventBotRating
+  | EventBotFaq
+  | EventBotStart
+  | EventBotOpen
+  | EventBotAiModel
+  | EventBotKeywordModel
+  | EventFallback
+  | EventHandoffOption
+  | EventHandoffSuccess
+  | EventHandoffFail

package/tsconfig.esm.json

@@ -0,0 +1,11 @@
+{
+  "extends": "./tsconfig.json",
+  "include": ["src/"],
+  "compilerOptions": {
+    "baseUrl": ".",
+    "outDir": "./lib/esm",
+    "target": "ES2017",
+    "module": "ES2020",
+    "moduleResolution": "node"
+  }
+}

package/tsconfig.json

@@ -0,0 +1,13 @@
+{
+  "extends": "../../tsconfig.base.json",
+  "include": ["src/"],
+  "compilerOptions": {
+    "jsx": "react",
+    "experimentalDecorators": true,
+    "baseUrl": ".",
+    "outDir": "./lib/cjs",
+    "esModuleInterop": true,
+    "lib": ["es2015"],
+    "skipLibCheck": true
+  }
+}