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

package/lib/cjs/index.d.ts

@@ -0,0 +1,13 @@
+import { BotRequest, Plugin } from '@botonic/core';
+import { HtEvent } from './types';
+export interface HubtypeAnalyticsOptions {
+    baseUrl: string;
+}
+export default class BotonicPluginHubtypeAnalytics implements Plugin {
+    baseUrl: string;
+    constructor(options: HubtypeAnalyticsOptions);
+    pre(): void;
+    post(): void;
+    getUrl(request: BotRequest): string;
+    trackEvent(request: BotRequest, event: HtEvent): Promise<import("axios").AxiosResponse<any, any>>;
+}

package/lib/cjs/index.js

@@ -0,0 +1,31 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+const axios_1 = tslib_1.__importDefault(require("axios"));
+class BotonicPluginHubtypeAnalytics {
+    constructor(options) {
+        this.baseUrl = options.baseUrl;
+    }
+    pre() {
+        return;
+    }
+    post() {
+        return;
+    }
+    getUrl(request) {
+        return `${this.baseUrl}/external/v1/conversational_apps/${request.session.bot.id}/bot_event/`;
+    }
+    async trackEvent(request, event) {
+        const url = this.getUrl(request);
+        const data = {
+            chat: request.session.user.id,
+            event_type: event.event_type,
+            event_data: Object.assign(Object.assign({}, 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_1.default.post(url, data, config);
+    }
+}
+exports.default = BotonicPluginHubtypeAnalytics;
+//# sourceMappingURL=index.js.map

package/lib/cjs/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;AACA,0DAAyB;AAQzB,MAAqB,6BAA6B;IAEhD,YAAY,OAAgC;QAC1C,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC,OAAO,CAAA;IAChC,CAAC;IAED,GAAG;QACD,OAAM;IACR,CAAC;IAED,IAAI;QACF,OAAM;IACR,CAAC;IAED,MAAM,CAAC,OAAmB;QACxB,OAAO,GAAG,IAAI,CAAC,OAAO,oCAAoC,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,aAAa,CAAA;IAC/F,CAAC;IAED,KAAK,CAAC,UAAU,CAAC,OAAmB,EAAE,KAAc;QAClD,MAAM,GAAG,GAAG,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,CAAA;QAChC,MAAM,IAAI,GAAG;YACX,IAAI,EAAE,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE;YAC7B,UAAU,EAAE,KAAK,CAAC,UAAU;YAC5B,UAAU,kCACL,KAAK,CAAC,UAAU,KACnB,cAAc,EAAE,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE,EACxC,OAAO,EAAE,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,GACvC;SACF,CAAA;QACD,MAAM,OAAO,GAAG,EAAE,aAAa,EAAE,UAAU,OAAO,CAAC,OAAO,CAAC,aAAa,EAAE,EAAE,CAAA;QAC5E,MAAM,MAAM,GAAG,EAAE,OAAO,EAAE,CAAA;QAC1B,OAAO,eAAK,CAAC,IAAI,CAAC,GAAG,EAAE,IAAI,EAAE,MAAM,CAAC,CAAA;IACtC,CAAC;CACF;AAjCD,gDAiCC"}

package/lib/cjs/types.d.ts

@@ -0,0 +1,105 @@
+export declare 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;
+export {};

package/lib/cjs/types.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EventName = void 0;
+var EventName;
+(function (EventName) {
+    EventName["botAgentRating"] = "bot_agent_rating";
+    EventName["botChannelRating"] = "bot_channel_rating";
+    EventName["botFaqUseful"] = "bot_faq_useful";
+    EventName["botRating"] = "bot_rating";
+    EventName["botFaq"] = "bot_faq";
+    EventName["botStart"] = "bot_start";
+    EventName["botOpen"] = "bot_open";
+    EventName["botAiModel"] = "bot_ai_model";
+    EventName["botKeywordsModel"] = "bot_keywords_model";
+    EventName["fallback"] = "fallback";
+    EventName["handoffOption"] = "handoff_option";
+    EventName["handoffSuccess"] = "handoff_success";
+    EventName["handoffFail"] = "handoff_fail";
+})(EventName = exports.EventName || (exports.EventName = {}));
+//# sourceMappingURL=types.js.map

package/lib/cjs/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":";;;AAAA,IAAY,SAcX;AAdD,WAAY,SAAS;IACnB,gDAAmC,CAAA;IACnC,oDAAuC,CAAA;IACvC,4CAA+B,CAAA;IAC/B,qCAAwB,CAAA;IACxB,+BAAkB,CAAA;IAClB,mCAAsB,CAAA;IACtB,iCAAoB,CAAA;IACpB,wCAA2B,CAAA;IAC3B,oDAAuC,CAAA;IACvC,kCAAqB,CAAA;IACrB,6CAAgC,CAAA;IAChC,+CAAkC,CAAA;IAClC,yCAA4B,CAAA;AAC9B,CAAC,EAdW,SAAS,GAAT,iBAAS,KAAT,iBAAS,QAcpB"}

package/lib/esm/index.d.ts

@@ -0,0 +1,13 @@
+import { BotRequest, Plugin } from '@botonic/core';
+import { HtEvent } from './types';
+export interface HubtypeAnalyticsOptions {
+    baseUrl: string;
+}
+export default class BotonicPluginHubtypeAnalytics implements Plugin {
+    baseUrl: string;
+    constructor(options: HubtypeAnalyticsOptions);
+    pre(): void;
+    post(): void;
+    getUrl(request: BotRequest): string;
+    trackEvent(request: BotRequest, event: HtEvent): Promise<import("axios").AxiosResponse<any, any>>;
+}

package/lib/esm/index.js

@@ -0,0 +1,27 @@
+import axios from 'axios';
+export default class BotonicPluginHubtypeAnalytics {
+    constructor(options) {
+        this.baseUrl = options.baseUrl;
+    }
+    pre() {
+        return;
+    }
+    post() {
+        return;
+    }
+    getUrl(request) {
+        return `${this.baseUrl}/external/v1/conversational_apps/${request.session.bot.id}/bot_event/`;
+    }
+    async trackEvent(request, event) {
+        const url = this.getUrl(request);
+        const data = {
+            chat: request.session.user.id,
+            event_type: event.event_type,
+            event_data: Object.assign(Object.assign({}, 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);
+    }
+}
+//# sourceMappingURL=index.js.map

package/lib/esm/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,MAAM,OAAO,CAAA;AAQzB,MAAM,CAAC,OAAO,OAAO,6BAA6B;IAEhD,YAAY,OAAgC;QAC1C,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC,OAAO,CAAA;IAChC,CAAC;IAED,GAAG;QACD,OAAM;IACR,CAAC;IAED,IAAI;QACF,OAAM;IACR,CAAC;IAED,MAAM,CAAC,OAAmB;QACxB,OAAO,GAAG,IAAI,CAAC,OAAO,oCAAoC,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,aAAa,CAAA;IAC/F,CAAC;IAED,KAAK,CAAC,UAAU,CAAC,OAAmB,EAAE,KAAc;QAClD,MAAM,GAAG,GAAG,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,CAAA;QAChC,MAAM,IAAI,GAAG;YACX,IAAI,EAAE,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE;YAC7B,UAAU,EAAE,KAAK,CAAC,UAAU;YAC5B,UAAU,kCACL,KAAK,CAAC,UAAU,KACnB,cAAc,EAAE,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE,EACxC,OAAO,EAAE,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,GACvC;SACF,CAAA;QACD,MAAM,OAAO,GAAG,EAAE,aAAa,EAAE,UAAU,OAAO,CAAC,OAAO,CAAC,aAAa,EAAE,EAAE,CAAA;QAC5E,MAAM,MAAM,GAAG,EAAE,OAAO,EAAE,CAAA;QAC1B,OAAO,KAAK,CAAC,IAAI,CAAC,GAAG,EAAE,IAAI,EAAE,MAAM,CAAC,CAAA;IACtC,CAAC;CACF"}

package/lib/esm/types.d.ts

@@ -0,0 +1,105 @@
+export declare 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;
+export {};

package/lib/esm/types.js

@@ -0,0 +1,17 @@
+export var EventName;
+(function (EventName) {
+    EventName["botAgentRating"] = "bot_agent_rating";
+    EventName["botChannelRating"] = "bot_channel_rating";
+    EventName["botFaqUseful"] = "bot_faq_useful";
+    EventName["botRating"] = "bot_rating";
+    EventName["botFaq"] = "bot_faq";
+    EventName["botStart"] = "bot_start";
+    EventName["botOpen"] = "bot_open";
+    EventName["botAiModel"] = "bot_ai_model";
+    EventName["botKeywordsModel"] = "bot_keywords_model";
+    EventName["fallback"] = "fallback";
+    EventName["handoffOption"] = "handoff_option";
+    EventName["handoffSuccess"] = "handoff_success";
+    EventName["handoffFail"] = "handoff_fail";
+})(EventName || (EventName = {}));
+//# sourceMappingURL=types.js.map

package/lib/esm/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":"AAAA,MAAM,CAAN,IAAY,SAcX;AAdD,WAAY,SAAS;IACnB,gDAAmC,CAAA;IACnC,oDAAuC,CAAA;IACvC,4CAA+B,CAAA;IAC/B,qCAAwB,CAAA;IACxB,+BAAkB,CAAA;IAClB,mCAAsB,CAAA;IACtB,iCAAoB,CAAA;IACpB,wCAA2B,CAAA;IAC3B,oDAAuC,CAAA;IACvC,kCAAqB,CAAA;IACrB,6CAAgC,CAAA;IAChC,+CAAkC,CAAA;IAClC,yCAA4B,CAAA;AAC9B,CAAC,EAdW,SAAS,KAAT,SAAS,QAcpB"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@botonic/plugin-hubtype-analytics",
-  "version": "0.22.0-alpha.2",
+  "version": "0.22.0-alpha.3",
   "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",
@@ -13,30 +13,35 @@
     "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"
-  }
+  },
+  "files": [
+    "lib/**",
+    "src/**",
+    "README.md"
+  ],
+  "eslintConfig": {
+    "extends": "../.eslintrc.js",
+    "root": true
+  },
+  "author": "Hubtype",
+  "license": "MIT",
+  "keywords": [
+    "analytics",
+    "bot-framework",
+    "chatbot",
+    "conversational-app",
+    "conversational-ui",
+    "javascript",
+    "typescript"
+  ]
 }

package/tsconfig.esm.json

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

package/tsconfig.json

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