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

package/README.md

@@ -2,25 +2,29 @@
 
 ## What Does This Plugin Do?
 
-This plugin allows you to integrate Hubtype Analytics in your Botonic project.
+This plugin is used to integrate Hubtype Analytics Service in your Botonic project.
 
 ## Setup
 
 1. Install the plugin from npm (or yarn):
 
 ```
-npm i --save @botonic/plugin-hubtype-analytics
+npm i @botonic/plugin-hubtype-analytics
 ```
 
 2. Add it to the `src/plugins.js` file defining the projectId of the Project you want to use:
 
+You can define two optional functions to obtain the language and the country.
+By default if you do not define these functions it will use the language defined in request.session.user.extra_data.language and country defined in request.session.user.extra_data.country
+
 ```
   export const plugins = [
     {
       id: 'hubtype-analytics',
       resolve: require('@botonic/plugin-hubtype-analytics'),
       options: {
-        baseUrl: https://api.hubtype.com,
+        getLaguange?: (request: BotRequest) => request.session.user.extra_data.lang
+        getCountry?: (request: BotRequest) => request.session.user.extra_data.store
       },
     },
   ]
@@ -47,4 +51,5 @@ You can use it in your actions for example an event to check that a faq has been
 
 ## Plugin Options
 
-- **`baseUrl`**: baseUrl to the envirment https://api.hubtype.com for production
+- **`getLaguange`**: getLaguange(request) function to define the language when it is not in request.session.user.extra_data.language
+- **`getCountry`**: getCountry(request) function to define the country when it is not in request.session.user.extra_data.country

package/lib/cjs/event-models/ht-event-agent-rating.d.ts

@@ -0,0 +1,6 @@
+import { BaseEventData, EventAgentRating, EventDataRating, RequestData } from '../types';
+import { HtEvent } from './ht-event';
+export declare class HtEventAgentRating extends HtEvent {
+    event_data: BaseEventData & EventDataRating;
+    constructor(event: EventAgentRating, requestData: RequestData);
+}

package/lib/cjs/event-models/ht-event-agent-rating.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HtEventAgentRating = void 0;
+const ht_event_1 = require("./ht-event");
+class HtEventAgentRating extends ht_event_1.HtEvent {
+    constructor(event, requestData) {
+        super(event, requestData);
+        this.event_data.rating = event.event_data.rating;
+    }
+}
+exports.HtEventAgentRating = HtEventAgentRating;
+//# sourceMappingURL=ht-event-agent-rating.js.map

package/lib/cjs/event-models/ht-event-agent-rating.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ht-event-agent-rating.js","sourceRoot":"","sources":["../../../src/event-models/ht-event-agent-rating.ts"],"names":[],"mappings":";;;AAMA,yCAAoC;AAEpC,MAAa,kBAAmB,SAAQ,kBAAO;IAG7C,YAAY,KAAuB,EAAE,WAAwB;QAC3D,KAAK,CAAC,KAAK,EAAE,WAAW,CAAC,CAAA;QACzB,IAAI,CAAC,UAAU,CAAC,MAAM,GAAG,KAAK,CAAC,UAAU,CAAC,MAAM,CAAA;IAClD,CAAC;CACF;AAPD,gDAOC"}

package/lib/cjs/event-models/ht-event-bot-ai-model.d.ts

@@ -0,0 +1,6 @@
+import { BaseEventData, EventBotAiModel, EventDataBotAiModel, RequestData } from '../types';
+import { HtEvent } from './ht-event';
+export declare class HtEventBotAiModel extends HtEvent {
+    event_data: BaseEventData & EventDataBotAiModel;
+    constructor(event: EventBotAiModel, requestData: RequestData);
+}

package/lib/cjs/event-models/ht-event-bot-ai-model.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HtEventBotAiModel = void 0;
+const ht_event_1 = require("./ht-event");
+class HtEventBotAiModel extends ht_event_1.HtEvent {
+    constructor(event, requestData) {
+        super(event, requestData);
+        this.event_data.intent = event.event_data.intent;
+        this.event_data.confidence = event.event_data.confidence;
+        this.event_data.confidence_successful =
+            event.event_data.confidence_successful;
+    }
+}
+exports.HtEventBotAiModel = HtEventBotAiModel;
+//# sourceMappingURL=ht-event-bot-ai-model.js.map

package/lib/cjs/event-models/ht-event-bot-ai-model.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ht-event-bot-ai-model.js","sourceRoot":"","sources":["../../../src/event-models/ht-event-bot-ai-model.ts"],"names":[],"mappings":";;;AAMA,yCAAoC;AAEpC,MAAa,iBAAkB,SAAQ,kBAAO;IAG5C,YAAY,KAAsB,EAAE,WAAwB;QAC1D,KAAK,CAAC,KAAK,EAAE,WAAW,CAAC,CAAA;QACzB,IAAI,CAAC,UAAU,CAAC,MAAM,GAAG,KAAK,CAAC,UAAU,CAAC,MAAM,CAAA;QAChD,IAAI,CAAC,UAAU,CAAC,UAAU,GAAG,KAAK,CAAC,UAAU,CAAC,UAAU,CAAA;QACxD,IAAI,CAAC,UAAU,CAAC,qBAAqB;YACnC,KAAK,CAAC,UAAU,CAAC,qBAAqB,CAAA;IAC1C,CAAC;CACF;AAVD,8CAUC"}

package/lib/cjs/event-models/ht-event-bot-faq.d.ts

@@ -0,0 +1,6 @@
+import { BaseEventData, EventBotFaq, EventDataBotFaq, RequestData } from '../types';
+import { HtEvent } from './ht-event';
+export declare class HtEventBotFaq extends HtEvent {
+    event_data: BaseEventData & EventDataBotFaq;
+    constructor(event: EventBotFaq, requestData: RequestData);
+}

package/lib/cjs/event-models/ht-event-bot-faq.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HtEventBotFaq = void 0;
+const ht_event_1 = require("./ht-event");
+class HtEventBotFaq extends ht_event_1.HtEvent {
+    constructor(event, requestData) {
+        super(event, requestData);
+        this.event_data.faq_name = event.event_data.faq_name;
+    }
+}
+exports.HtEventBotFaq = HtEventBotFaq;
+//# sourceMappingURL=ht-event-bot-faq.js.map

package/lib/cjs/event-models/ht-event-bot-faq.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ht-event-bot-faq.js","sourceRoot":"","sources":["../../../src/event-models/ht-event-bot-faq.ts"],"names":[],"mappings":";;;AAMA,yCAAoC;AAEpC,MAAa,aAAc,SAAQ,kBAAO;IAGxC,YAAY,KAAkB,EAAE,WAAwB;QACtD,KAAK,CAAC,KAAK,EAAE,WAAW,CAAC,CAAA;QACzB,IAAI,CAAC,UAAU,CAAC,QAAQ,GAAG,KAAK,CAAC,UAAU,CAAC,QAAQ,CAAA;IACtD,CAAC;CACF;AAPD,sCAOC"}

package/lib/cjs/event-models/ht-event-bot-keyword-model.d.ts

@@ -0,0 +1,6 @@
+import { BaseEventData, EventBotKeywordModel, EventDataBotKeywordModel, RequestData } from '../types';
+import { HtEvent } from './ht-event';
+export declare class HtEventBotKeywordModel extends HtEvent {
+    event_data: BaseEventData & EventDataBotKeywordModel;
+    constructor(event: EventBotKeywordModel, requestData: RequestData);
+}

package/lib/cjs/event-models/ht-event-bot-keyword-model.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HtEventBotKeywordModel = void 0;
+const ht_event_1 = require("./ht-event");
+class HtEventBotKeywordModel extends ht_event_1.HtEvent {
+    constructor(event, requestData) {
+        super(event, requestData);
+        this.event_data.confidence_successful =
+            event.event_data.confidence_successful;
+    }
+}
+exports.HtEventBotKeywordModel = HtEventBotKeywordModel;
+//# sourceMappingURL=ht-event-bot-keyword-model.js.map

package/lib/cjs/event-models/ht-event-bot-keyword-model.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ht-event-bot-keyword-model.js","sourceRoot":"","sources":["../../../src/event-models/ht-event-bot-keyword-model.ts"],"names":[],"mappings":";;;AAMA,yCAAoC;AAEpC,MAAa,sBAAuB,SAAQ,kBAAO;IAGjD,YAAY,KAA2B,EAAE,WAAwB;QAC/D,KAAK,CAAC,KAAK,EAAE,WAAW,CAAC,CAAA;QACzB,IAAI,CAAC,UAAU,CAAC,qBAAqB;YACnC,KAAK,CAAC,UAAU,CAAC,qBAAqB,CAAA;IAC1C,CAAC;CACF;AARD,wDAQC"}

package/lib/cjs/event-models/ht-event-bot-rating.d.ts

@@ -0,0 +1,6 @@
+import { BaseEventData, EventBotRating, EventDataBotRating, RequestData } from '../types';
+import { HtEvent } from './ht-event';
+export declare class HtEventBotRating extends HtEvent {
+    event_data: BaseEventData & EventDataBotRating;
+    constructor(event: EventBotRating, requestData: RequestData);
+}

package/lib/cjs/event-models/ht-event-bot-rating.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HtEventBotRating = void 0;
+const ht_event_1 = require("./ht-event");
+class HtEventBotRating extends ht_event_1.HtEvent {
+    constructor(event, requestData) {
+        super(event, requestData);
+        this.event_data.rating = event.event_data.rating;
+        this.event_data.free_comment = event.event_data.free_comment;
+        this.event_data.selected_options = event.event_data.selected_options;
+    }
+}
+exports.HtEventBotRating = HtEventBotRating;
+//# sourceMappingURL=ht-event-bot-rating.js.map

package/lib/cjs/event-models/ht-event-bot-rating.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ht-event-bot-rating.js","sourceRoot":"","sources":["../../../src/event-models/ht-event-bot-rating.ts"],"names":[],"mappings":";;;AAMA,yCAAoC;AAEpC,MAAa,gBAAiB,SAAQ,kBAAO;IAG3C,YAAY,KAAqB,EAAE,WAAwB;QACzD,KAAK,CAAC,KAAK,EAAE,WAAW,CAAC,CAAA;QACzB,IAAI,CAAC,UAAU,CAAC,MAAM,GAAG,KAAK,CAAC,UAAU,CAAC,MAAM,CAAA;QAChD,IAAI,CAAC,UAAU,CAAC,YAAY,GAAG,KAAK,CAAC,UAAU,CAAC,YAAY,CAAA;QAC5D,IAAI,CAAC,UAAU,CAAC,gBAAgB,GAAG,KAAK,CAAC,UAAU,CAAC,gBAAgB,CAAA;IACtE,CAAC;CACF;AATD,4CASC"}

package/lib/cjs/event-models/ht-event-channel-rating.d.ts

@@ -0,0 +1,6 @@
+import { BaseEventData, EventChannelRating, EventDataRating, RequestData } from '../types';
+import { HtEvent } from './ht-event';
+export declare class HtEventChannelRating extends HtEvent {
+    event_data: BaseEventData & EventDataRating;
+    constructor(event: EventChannelRating, requestData: RequestData);
+}

package/lib/cjs/event-models/ht-event-channel-rating.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HtEventChannelRating = void 0;
+const ht_event_1 = require("./ht-event");
+class HtEventChannelRating extends ht_event_1.HtEvent {
+    constructor(event, requestData) {
+        super(event, requestData);
+        this.event_data.rating = event.event_data.rating;
+    }
+}
+exports.HtEventChannelRating = HtEventChannelRating;
+//# sourceMappingURL=ht-event-channel-rating.js.map

package/lib/cjs/event-models/ht-event-channel-rating.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ht-event-channel-rating.js","sourceRoot":"","sources":["../../../src/event-models/ht-event-channel-rating.ts"],"names":[],"mappings":";;;AAMA,yCAAoC;AAEpC,MAAa,oBAAqB,SAAQ,kBAAO;IAG/C,YAAY,KAAyB,EAAE,WAAwB;QAC7D,KAAK,CAAC,KAAK,EAAE,WAAW,CAAC,CAAA;QACzB,IAAI,CAAC,UAAU,CAAC,MAAM,GAAG,KAAK,CAAC,UAAU,CAAC,MAAM,CAAA;IAClD,CAAC;CACF;AAPD,oDAOC"}

package/lib/cjs/event-models/ht-event-faq-useful.d.ts

@@ -0,0 +1,6 @@
+import { BaseEventData, EventDataUseful, EventFaqUseful, RequestData } from '../types';
+import { HtEvent } from './ht-event';
+export declare class HtEventFaqUseful extends HtEvent {
+    event_data: BaseEventData & EventDataUseful;
+    constructor(event: EventFaqUseful, requestData: RequestData);
+}

package/lib/cjs/event-models/ht-event-faq-useful.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HtEventFaqUseful = void 0;
+const ht_event_1 = require("./ht-event");
+class HtEventFaqUseful extends ht_event_1.HtEvent {
+    constructor(event, requestData) {
+        super(event, requestData);
+        this.event_data.faq_name = event.event_data.faq_name;
+        this.event_data.useful = event.event_data.useful;
+    }
+}
+exports.HtEventFaqUseful = HtEventFaqUseful;
+//# sourceMappingURL=ht-event-faq-useful.js.map

package/lib/cjs/event-models/ht-event-faq-useful.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ht-event-faq-useful.js","sourceRoot":"","sources":["../../../src/event-models/ht-event-faq-useful.ts"],"names":[],"mappings":";;;AAMA,yCAAoC;AAEpC,MAAa,gBAAiB,SAAQ,kBAAO;IAG3C,YAAY,KAAqB,EAAE,WAAwB;QACzD,KAAK,CAAC,KAAK,EAAE,WAAW,CAAC,CAAA;QACzB,IAAI,CAAC,UAAU,CAAC,QAAQ,GAAG,KAAK,CAAC,UAAU,CAAC,QAAQ,CAAA;QACpD,IAAI,CAAC,UAAU,CAAC,MAAM,GAAG,KAAK,CAAC,UAAU,CAAC,MAAM,CAAA;IAClD,CAAC;CACF;AARD,4CAQC"}

package/lib/cjs/event-models/ht-event-handoff-fail.d.ts

@@ -0,0 +1,6 @@
+import { BaseEventData, EventDataHandoff, EventHandoffFail, RequestData } from '../types';
+import { HtEvent } from './ht-event';
+export declare class HtEventHandoffFail extends HtEvent {
+    event_data: BaseEventData & EventDataHandoff;
+    constructor(event: EventHandoffFail, requestData: RequestData);
+}

package/lib/cjs/event-models/ht-event-handoff-fail.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HtEventHandoffFail = void 0;
+const ht_event_1 = require("./ht-event");
+class HtEventHandoffFail extends ht_event_1.HtEvent {
+    constructor(event, requestData) {
+        super(event, requestData);
+        this.event_data.queue_open = event.event_data.queue_open;
+        this.event_data.available_agents = event.event_data.available_agents;
+        this.event_data.threshold_reached = event.event_data.threshold_reached;
+    }
+}
+exports.HtEventHandoffFail = HtEventHandoffFail;
+//# sourceMappingURL=ht-event-handoff-fail.js.map

package/lib/cjs/event-models/ht-event-handoff-fail.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ht-event-handoff-fail.js","sourceRoot":"","sources":["../../../src/event-models/ht-event-handoff-fail.ts"],"names":[],"mappings":";;;AAMA,yCAAoC;AAEpC,MAAa,kBAAmB,SAAQ,kBAAO;IAG7C,YAAY,KAAuB,EAAE,WAAwB;QAC3D,KAAK,CAAC,KAAK,EAAE,WAAW,CAAC,CAAA;QACzB,IAAI,CAAC,UAAU,CAAC,UAAU,GAAG,KAAK,CAAC,UAAU,CAAC,UAAU,CAAA;QACxD,IAAI,CAAC,UAAU,CAAC,gBAAgB,GAAG,KAAK,CAAC,UAAU,CAAC,gBAAgB,CAAA;QACpE,IAAI,CAAC,UAAU,CAAC,iBAAiB,GAAG,KAAK,CAAC,UAAU,CAAC,iBAAiB,CAAA;IACxE,CAAC;CACF;AATD,gDASC"}

package/lib/cjs/event-models/ht-event-handoff-success.d.ts

@@ -0,0 +1,6 @@
+import { BaseEventData, EventDataHandoff, EventHandoffSuccess, RequestData } from '../types';
+import { HtEvent } from './ht-event';
+export declare class HtEventHandoffSuccess extends HtEvent {
+    event_data: BaseEventData & EventDataHandoff;
+    constructor(event: EventHandoffSuccess, requestData: RequestData);
+}

package/lib/cjs/event-models/ht-event-handoff-success.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HtEventHandoffSuccess = void 0;
+const ht_event_1 = require("./ht-event");
+class HtEventHandoffSuccess extends ht_event_1.HtEvent {
+    constructor(event, requestData) {
+        super(event, requestData);
+        this.event_data.queue_open = event.event_data.queue_open;
+        this.event_data.available_agents = event.event_data.available_agents;
+        this.event_data.threshold_reached = event.event_data.threshold_reached;
+    }
+}
+exports.HtEventHandoffSuccess = HtEventHandoffSuccess;
+//# sourceMappingURL=ht-event-handoff-success.js.map

package/lib/cjs/event-models/ht-event-handoff-success.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ht-event-handoff-success.js","sourceRoot":"","sources":["../../../src/event-models/ht-event-handoff-success.ts"],"names":[],"mappings":";;;AAMA,yCAAoC;AAEpC,MAAa,qBAAsB,SAAQ,kBAAO;IAGhD,YAAY,KAA0B,EAAE,WAAwB;QAC9D,KAAK,CAAC,KAAK,EAAE,WAAW,CAAC,CAAA;QACzB,IAAI,CAAC,UAAU,CAAC,UAAU,GAAG,KAAK,CAAC,UAAU,CAAC,UAAU,CAAA;QACxD,IAAI,CAAC,UAAU,CAAC,gBAAgB,GAAG,KAAK,CAAC,UAAU,CAAC,gBAAgB,CAAA;QACpE,IAAI,CAAC,UAAU,CAAC,iBAAiB,GAAG,KAAK,CAAC,UAAU,CAAC,iBAAiB,CAAA;IACxE,CAAC;CACF;AATD,sDASC"}

package/lib/cjs/event-models/ht-event.d.ts

@@ -0,0 +1,7 @@
+import { BaseEventData, EventName, HtEventProps, RequestData } from '../types';
+export declare class HtEvent {
+    chat: string;
+    event_type: EventName;
+    event_data: BaseEventData;
+    constructor(event: HtEventProps, requestData: RequestData);
+}

package/lib/cjs/event-models/ht-event.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HtEvent = void 0;
+class HtEvent {
+    constructor(event, requestData) {
+        this.chat = requestData.userId;
+        this.event_type = event.event_type;
+        this.event_data = {
+            channel: requestData.provider,
+            event_datetime: new Date().toISOString(),
+            enduser_language: requestData.language,
+            enduser_country: requestData.country,
+            format_version: 1,
+            // flow_version?: string
+        };
+    }
+}
+exports.HtEvent = HtEvent;
+//# sourceMappingURL=ht-event.js.map

package/lib/cjs/event-models/ht-event.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ht-event.js","sourceRoot":"","sources":["../../../src/event-models/ht-event.ts"],"names":[],"mappings":";;;AAEA,MAAa,OAAO;IAKlB,YAAY,KAAmB,EAAE,WAAwB;QACvD,IAAI,CAAC,IAAI,GAAG,WAAW,CAAC,MAAM,CAAA;QAC9B,IAAI,CAAC,UAAU,GAAG,KAAK,CAAC,UAAU,CAAA;QAClC,IAAI,CAAC,UAAU,GAAG;YAChB,OAAO,EAAE,WAAW,CAAC,QAAQ;YAC7B,cAAc,EAAE,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE;YACxC,gBAAgB,EAAE,WAAW,CAAC,QAAQ;YACtC,eAAe,EAAE,WAAW,CAAC,OAAO;YACpC,cAAc,EAAE,CAAC;YACjB,wBAAwB;SACzB,CAAA;IACH,CAAC;CACF;AAjBD,0BAiBC"}

package/lib/cjs/index.d.ts

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

package/lib/cjs/index.js

@@ -2,12 +2,18 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
 const axios_1 = tslib_1.__importDefault(require("axios"));
+const utils_1 = require("./utils");
+function getDefaultLanguage(request) {
+    return request.session.user.extra_data.language;
+}
+function getDefaultCountry(request) {
+    return request.session.user.extra_data.country;
+}
 class BotonicPluginHubtypeAnalytics {
     constructor(options) {
-        this.baseUrl = options.baseUrl;
-    }
-    pre() {
-        return;
+        this.baseUrl = process.env.HUBTYPE_API_URL || 'https://api.hubtype.com';
+        this.getLaguange = options.getLaguange || getDefaultLanguage;
+        this.getCountry = options.getCountry || getDefaultCountry;
     }
     post() {
         return;
@@ -15,16 +21,21 @@ class BotonicPluginHubtypeAnalytics {
     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 }),
+    getRequestData(request) {
+        return {
+            language: this.getLaguange(request),
+            country: this.getCountry(request),
+            provider: request.session.user.provider,
+            userId: request.session.user.id,
         };
+    }
+    async trackEvent(request, htEventProps) {
+        const url = this.getUrl(request);
+        const requestData = this.getRequestData(request);
+        const event = (0, utils_1.createHtEvent)(requestData, htEventProps);
         const headers = { Authorization: `Bearer ${request.session._access_token}` };
         const config = { headers };
-        return axios_1.default.post(url, data, config);
+        return axios_1.default.post(url, event, config);
     }
 }
 exports.default = BotonicPluginHubtypeAnalytics;

package/lib/cjs/index.js.map

@@ -1 +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"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;AACA,0DAAyB;AAGzB,mCAAuC;AAOvC,SAAS,kBAAkB,CAAC,OAAmB;IAC7C,OAAO,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAA;AACjD,CAAC;AAED,SAAS,iBAAiB,CAAC,OAAmB;IAC5C,OAAO,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,UAAU,CAAC,OAAO,CAAA;AAChD,CAAC;AAED,MAAqB,6BAA6B;IAIhD,YAAY,OAAgC;QAC1C,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC,GAAG,CAAC,eAAe,IAAI,yBAAyB,CAAA;QACvE,IAAI,CAAC,WAAW,GAAG,OAAO,CAAC,WAAW,IAAI,kBAAkB,CAAA;QAC5D,IAAI,CAAC,UAAU,GAAG,OAAO,CAAC,UAAU,IAAI,iBAAiB,CAAA;IAC3D,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,cAAc,CAAC,OAAmB;QAChC,OAAO;YACL,QAAQ,EAAE,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC;YACnC,OAAO,EAAE,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC;YACjC,QAAQ,EAAE,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ;YACvC,MAAM,EAAE,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE;SAChC,CAAA;IACH,CAAC;IAED,KAAK,CAAC,UAAU,CAAC,OAAmB,EAAE,YAA0B;QAC9D,MAAM,GAAG,GAAG,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,CAAA;QAChC,MAAM,WAAW,GAAG,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC,CAAA;QAChD,MAAM,KAAK,GAAG,IAAA,qBAAa,EAAC,WAAW,EAAE,YAAY,CAAC,CAAA;QACtD,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,KAAK,EAAE,MAAM,CAAC,CAAA;IACvC,CAAC;CACF;AAnCD,gDAmCC"}

package/lib/cjs/types.d.ts

@@ -1,3 +1,9 @@
+import { PROVIDER } from '@botonic/core';
+export interface Event {
+    chat: string;
+    event_type: EventName;
+    event_data: BaseEventData;
+}
 export declare enum EventName {
     botAgentRating = "bot_agent_rating",
     botChannelRating = "bot_channel_rating",
@@ -13,93 +19,98 @@ export declare enum EventName {
     handoffSuccess = "handoff_success",
     handoffFail = "handoff_fail"
 }
-interface EventData {
-    enduser_country?: string;
+export interface BaseEventData {
+    channel: string;
+    event_datetime: string;
     enduser_language: string;
+    enduser_country?: string;
     format_version?: number;
     bot_version?: string;
     flow_version?: string;
 }
-export interface EventAgentRating {
+export interface HtBaseEventProps {
+    event_type: EventName;
+}
+export interface EventAgentRating extends HtBaseEventProps {
     event_type: EventName.botAgentRating;
-    event_data: EventData & {
-        rating: number;
-    };
+    event_data: EventDataRating;
 }
-export interface EventChannelRating {
+export interface EventChannelRating extends HtBaseEventProps {
     event_type: EventName.botChannelRating;
-    event_data: EventData & {
-        rating: number;
-    };
+    event_data: EventDataRating;
 }
-export interface EventFaqUseful {
+export interface EventDataRating {
+    rating: number;
+}
+export interface EventFaqUseful extends HtBaseEventProps {
     event_type: EventName.botFaqUseful;
-    event_data: EventData & {
-        faq_name: string;
-        useful: boolean;
-    };
+    event_data: EventDataUseful;
+}
+export interface EventDataUseful {
+    faq_name: string;
+    useful: boolean;
 }
-export interface EventBotRating {
+export interface EventBotRating extends HtBaseEventProps {
     event_type: EventName.botRating;
-    event_data: EventData & {
-        faq_name: string;
-        useful: boolean;
-        rating: number;
-        free_comment: string;
-        selected_options: string[];
-    };
-}
-export interface EventBotFaq {
+    event_data: EventDataBotRating;
+}
+export interface EventDataBotRating {
+    rating: number;
+    free_comment?: string;
+    selected_options?: string[];
+}
+export interface EventBotFaq extends HtBaseEventProps {
     event_type: EventName.botFaq;
-    event_data: EventData & {
-        faq_name: string;
-    };
+    event_data: EventDataBotFaq;
+}
+export interface EventDataBotFaq {
+    faq_name: string;
 }
-export interface EventBotStart {
+export interface EventBotStart extends HtBaseEventProps {
     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;
-    };
+    event_data: EventDataBotAiModel;
 }
-export interface EventBotKeywordModel {
+export interface EventDataBotAiModel {
+    intent: string;
+    confidence: number;
+    confidence_successful: boolean;
+}
+export interface EventBotKeywordModel extends HtBaseEventProps {
     event_type: EventName.botKeywordsModel;
-    event_data: EventData & {
-        confidence_successful: boolean;
-    };
+    event_data: EventDataBotKeywordModel;
+}
+export interface EventDataBotKeywordModel {
+    confidence_successful: boolean;
 }
-export interface EventFallback {
+export interface EventFallback extends HtBaseEventProps {
     event_type: EventName.fallback;
-    event_data: EventData;
 }
-export interface EventHandoffOption {
+export interface EventHandoffOption extends HtBaseEventProps {
     event_type: EventName.handoffOption;
-    event_data: EventData;
 }
-export interface EventHandoffSuccess {
+export interface EventHandoffSuccess extends HtBaseEventProps {
     event_type: EventName.handoffSuccess;
-    event_data: EventData & {
-        queue_open: boolean;
-        available_agents: boolean;
-        threshold_reached: boolean;
-    };
+    event_data: EventDataHandoff;
 }
-export interface EventHandoffFail {
+export interface EventHandoffFail extends HtBaseEventProps {
     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 {};
+    event_data: EventDataHandoff;
+}
+export interface EventDataHandoff {
+    queue_open: boolean;
+    available_agents: boolean;
+    threshold_reached: boolean;
+}
+export type HtEventProps = EventAgentRating | EventChannelRating | EventFaqUseful | EventBotRating | EventBotFaq | EventBotStart | EventBotOpen | EventBotAiModel | EventBotKeywordModel | EventFallback | EventHandoffOption | EventHandoffSuccess | EventHandoffFail;
+export interface RequestData {
+    language: string;
+    country: string;
+    provider: PROVIDER;
+    userId: string;
+}

package/lib/cjs/types.js.map

@@ -1 +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"}
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":";;;AAQA,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/cjs/utils.d.ts

@@ -0,0 +1,3 @@
+import { HtEvent } from './event-models/ht-event';
+import { HtEventProps, RequestData } from './types';
+export declare function createHtEvent(requestData: RequestData, htEventProps: HtEventProps): HtEvent;

package/lib/cjs/utils.js

@@ -0,0 +1,46 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createHtEvent = void 0;
+const ht_event_1 = require("./event-models/ht-event");
+const ht_event_agent_rating_1 = require("./event-models/ht-event-agent-rating");
+const ht_event_bot_ai_model_1 = require("./event-models/ht-event-bot-ai-model");
+const ht_event_bot_faq_1 = require("./event-models/ht-event-bot-faq");
+const ht_event_bot_keyword_model_1 = require("./event-models/ht-event-bot-keyword-model");
+const ht_event_bot_rating_1 = require("./event-models/ht-event-bot-rating");
+const ht_event_channel_rating_1 = require("./event-models/ht-event-channel-rating");
+const ht_event_faq_useful_1 = require("./event-models/ht-event-faq-useful");
+const ht_event_handoff_fail_1 = require("./event-models/ht-event-handoff-fail");
+const ht_event_handoff_success_1 = require("./event-models/ht-event-handoff-success");
+const types_1 = require("./types");
+function createHtEvent(requestData, htEventProps) {
+    if (htEventProps.event_type === types_1.EventName.botAgentRating) {
+        return new ht_event_agent_rating_1.HtEventAgentRating(htEventProps, requestData);
+    }
+    if (htEventProps.event_type === types_1.EventName.botChannelRating) {
+        return new ht_event_channel_rating_1.HtEventChannelRating(htEventProps, requestData);
+    }
+    if (htEventProps.event_type === types_1.EventName.botFaqUseful) {
+        return new ht_event_faq_useful_1.HtEventFaqUseful(htEventProps, requestData);
+    }
+    if (htEventProps.event_type === types_1.EventName.botRating) {
+        return new ht_event_bot_rating_1.HtEventBotRating(htEventProps, requestData);
+    }
+    if (htEventProps.event_type === types_1.EventName.botFaq) {
+        return new ht_event_bot_faq_1.HtEventBotFaq(htEventProps, requestData);
+    }
+    if (htEventProps.event_type === types_1.EventName.botAiModel) {
+        return new ht_event_bot_ai_model_1.HtEventBotAiModel(htEventProps, requestData);
+    }
+    if (htEventProps.event_type === types_1.EventName.botKeywordsModel) {
+        return new ht_event_bot_keyword_model_1.HtEventBotKeywordModel(htEventProps, requestData);
+    }
+    if (htEventProps.event_type === types_1.EventName.handoffSuccess) {
+        return new ht_event_handoff_success_1.HtEventHandoffSuccess(htEventProps, requestData);
+    }
+    if (htEventProps.event_type === types_1.EventName.handoffFail) {
+        return new ht_event_handoff_fail_1.HtEventHandoffFail(htEventProps, requestData);
+    }
+    return new ht_event_1.HtEvent(htEventProps, requestData);
+}
+exports.createHtEvent = createHtEvent;
+//# sourceMappingURL=utils.js.map

package/lib/cjs/utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../src/utils.ts"],"names":[],"mappings":";;;AAAA,sDAAiD;AACjD,gFAAyE;AACzE,gFAAwE;AACxE,sEAA+D;AAC/D,0FAAkF;AAClF,4EAAqE;AACrE,oFAA6E;AAC7E,4EAAqE;AACrE,gFAAyE;AACzE,sFAA+E;AAC/E,mCAA8D;AAE9D,SAAgB,aAAa,CAC3B,WAAwB,EACxB,YAA0B;IAE1B,IAAI,YAAY,CAAC,UAAU,KAAK,iBAAS,CAAC,cAAc,EAAE;QACxD,OAAO,IAAI,0CAAkB,CAAC,YAAY,EAAE,WAAW,CAAC,CAAA;KACzD;IACD,IAAI,YAAY,CAAC,UAAU,KAAK,iBAAS,CAAC,gBAAgB,EAAE;QAC1D,OAAO,IAAI,8CAAoB,CAAC,YAAY,EAAE,WAAW,CAAC,CAAA;KAC3D;IACD,IAAI,YAAY,CAAC,UAAU,KAAK,iBAAS,CAAC,YAAY,EAAE;QACtD,OAAO,IAAI,sCAAgB,CAAC,YAAY,EAAE,WAAW,CAAC,CAAA;KACvD;IACD,IAAI,YAAY,CAAC,UAAU,KAAK,iBAAS,CAAC,SAAS,EAAE;QACnD,OAAO,IAAI,sCAAgB,CAAC,YAAY,EAAE,WAAW,CAAC,CAAA;KACvD;IACD,IAAI,YAAY,CAAC,UAAU,KAAK,iBAAS,CAAC,MAAM,EAAE;QAChD,OAAO,IAAI,gCAAa,CAAC,YAAY,EAAE,WAAW,CAAC,CAAA;KACpD;IACD,IAAI,YAAY,CAAC,UAAU,KAAK,iBAAS,CAAC,UAAU,EAAE;QACpD,OAAO,IAAI,yCAAiB,CAAC,YAAY,EAAE,WAAW,CAAC,CAAA;KACxD;IACD,IAAI,YAAY,CAAC,UAAU,KAAK,iBAAS,CAAC,gBAAgB,EAAE;QAC1D,OAAO,IAAI,mDAAsB,CAAC,YAAY,EAAE,WAAW,CAAC,CAAA;KAC7D;IACD,IAAI,YAAY,CAAC,UAAU,KAAK,iBAAS,CAAC,cAAc,EAAE;QACxD,OAAO,IAAI,gDAAqB,CAAC,YAAY,EAAE,WAAW,CAAC,CAAA;KAC5D;IACD,IAAI,YAAY,CAAC,UAAU,KAAK,iBAAS,CAAC,WAAW,EAAE;QACrD,OAAO,IAAI,0CAAkB,CAAC,YAAY,EAAE,WAAW,CAAC,CAAA;KACzD;IAED,OAAO,IAAI,kBAAO,CAAC,YAAY,EAAE,WAAW,CAAC,CAAA;AAC/C,CAAC;AAjCD,sCAiCC"}