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

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

@@ -0,0 +1,10 @@
+import { HtEvent } from './ht-event';
+export class HtEventBotRating extends HtEvent {
+    constructor(event, requestData) {
+        super(event, requestData);
+        this.rating = event.event_data.rating;
+        this.free_comment = event.event_data.free_comment;
+        this.selected_options = event.event_data.selected_options;
+    }
+}
+//# sourceMappingURL=ht-event-bot-rating.js.map

package/lib/esm/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":"AACA,OAAO,EAAE,OAAO,EAAE,MAAM,YAAY,CAAA;AAEpC,MAAM,OAAO,gBAAiB,SAAQ,OAAO;IAK3C,YAAY,KAAqB,EAAE,WAAwB;QACzD,KAAK,CAAC,KAAK,EAAE,WAAW,CAAC,CAAA;QACzB,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC,UAAU,CAAC,MAAM,CAAA;QACrC,IAAI,CAAC,YAAY,GAAG,KAAK,CAAC,UAAU,CAAC,YAAY,CAAA;QACjD,IAAI,CAAC,gBAAgB,GAAG,KAAK,CAAC,UAAU,CAAC,gBAAgB,CAAA;IAC3D,CAAC;CACF"}

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

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

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

@@ -0,0 +1,8 @@
+import { HtEvent } from './ht-event';
+export class HtEventChannelRating extends HtEvent {
+    constructor(event, requestData) {
+        super(event, requestData);
+        this.rating = event.event_data.rating;
+    }
+}
+//# sourceMappingURL=ht-event-channel-rating.js.map

package/lib/esm/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":"AACA,OAAO,EAAE,OAAO,EAAE,MAAM,YAAY,CAAA;AAEpC,MAAM,OAAO,oBAAqB,SAAQ,OAAO;IAG/C,YAAY,KAAyB,EAAE,WAAwB;QAC7D,KAAK,CAAC,KAAK,EAAE,WAAW,CAAC,CAAA;QACzB,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC,UAAU,CAAC,MAAM,CAAA;IACvC,CAAC;CACF"}

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

@@ -0,0 +1,7 @@
+import { EventFaqUseful, RequestData } from '../types';
+import { HtEvent } from './ht-event';
+export declare class HtEventFaqUseful extends HtEvent {
+    faq_name: string;
+    useful: boolean;
+    constructor(event: EventFaqUseful, requestData: RequestData);
+}

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

@@ -0,0 +1,9 @@
+import { HtEvent } from './ht-event';
+export class HtEventFaqUseful extends HtEvent {
+    constructor(event, requestData) {
+        super(event, requestData);
+        this.faq_name = event.event_data.faq_name;
+        this.useful = event.event_data.useful;
+    }
+}
+//# sourceMappingURL=ht-event-faq-useful.js.map

package/lib/esm/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":"AACA,OAAO,EAAE,OAAO,EAAE,MAAM,YAAY,CAAA;AAEpC,MAAM,OAAO,gBAAiB,SAAQ,OAAO;IAI3C,YAAY,KAAqB,EAAE,WAAwB;QACzD,KAAK,CAAC,KAAK,EAAE,WAAW,CAAC,CAAA;QACzB,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC,UAAU,CAAC,QAAQ,CAAA;QACzC,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC,UAAU,CAAC,MAAM,CAAA;IACvC,CAAC;CACF"}

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

@@ -0,0 +1,8 @@
+import { EventHandoffFail, RequestData } from '../types';
+import { HtEvent } from './ht-event';
+export declare class HtEventHandoffFail extends HtEvent {
+    queue_open: boolean;
+    available_agents: boolean;
+    threshold_reached: boolean;
+    constructor(event: EventHandoffFail, requestData: RequestData);
+}

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

@@ -0,0 +1,10 @@
+import { HtEvent } from './ht-event';
+export class HtEventHandoffFail extends HtEvent {
+    constructor(event, requestData) {
+        super(event, requestData);
+        this.queue_open = event.event_data.queue_open;
+        this.available_agents = event.event_data.available_agents;
+        this.threshold_reached = event.event_data.threshold_reached;
+    }
+}
+//# sourceMappingURL=ht-event-handoff-fail.js.map

package/lib/esm/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":"AACA,OAAO,EAAE,OAAO,EAAE,MAAM,YAAY,CAAA;AAEpC,MAAM,OAAO,kBAAmB,SAAQ,OAAO;IAK7C,YAAY,KAAuB,EAAE,WAAwB;QAC3D,KAAK,CAAC,KAAK,EAAE,WAAW,CAAC,CAAA;QACzB,IAAI,CAAC,UAAU,GAAG,KAAK,CAAC,UAAU,CAAC,UAAU,CAAA;QAC7C,IAAI,CAAC,gBAAgB,GAAG,KAAK,CAAC,UAAU,CAAC,gBAAgB,CAAA;QACzD,IAAI,CAAC,iBAAiB,GAAG,KAAK,CAAC,UAAU,CAAC,iBAAiB,CAAA;IAC7D,CAAC;CACF"}

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

@@ -0,0 +1,8 @@
+import { EventHandoffSuccess, RequestData } from '../types';
+import { HtEvent } from './ht-event';
+export declare class HtEventHandoffSuccess extends HtEvent {
+    queue_open: boolean;
+    available_agents: boolean;
+    threshold_reached: boolean;
+    constructor(event: EventHandoffSuccess, requestData: RequestData);
+}

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

@@ -0,0 +1,10 @@
+import { HtEvent } from './ht-event';
+export class HtEventHandoffSuccess extends HtEvent {
+    constructor(event, requestData) {
+        super(event, requestData);
+        this.queue_open = event.event_data.queue_open;
+        this.available_agents = event.event_data.available_agents;
+        this.threshold_reached = event.event_data.threshold_reached;
+    }
+}
+//# sourceMappingURL=ht-event-handoff-success.js.map

package/lib/esm/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":"AACA,OAAO,EAAE,OAAO,EAAE,MAAM,YAAY,CAAA;AAEpC,MAAM,OAAO,qBAAsB,SAAQ,OAAO;IAKhD,YAAY,KAA0B,EAAE,WAAwB;QAC9D,KAAK,CAAC,KAAK,EAAE,WAAW,CAAC,CAAA;QACzB,IAAI,CAAC,UAAU,GAAG,KAAK,CAAC,UAAU,CAAC,UAAU,CAAA;QAC7C,IAAI,CAAC,gBAAgB,GAAG,KAAK,CAAC,UAAU,CAAC,gBAAgB,CAAA;QACzD,IAAI,CAAC,iBAAiB,GAAG,KAAK,CAAC,UAAU,CAAC,iBAAiB,CAAA;IAC7D,CAAC;CACF"}

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

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

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

@@ -0,0 +1,55 @@
+import { EventName } from '../types';
+import { HtEventAgentRating } from './ht-event-agent-rating';
+import { HtEventBotAiModel } from './ht-event-bot-ai-model';
+import { HtEventBotFaq } from './ht-event-bot-faq';
+import { HtEventBotKeywordModel } from './ht-event-bot-keyword-model';
+import { HtEventBotRating } from './ht-event-bot-rating';
+import { HtEventChannelRating } from './ht-event-channel-rating';
+import { HtEventFaqUseful } from './ht-event-faq-useful';
+import { HtEventHandoffFail } from './ht-event-handoff-fail';
+import { HtEventHandoffSuccess } from './ht-event-handoff-success';
+export 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
+        };
+    }
+    static create(requestData, htEventProps) {
+        if (htEventProps.event_type === EventName.botAgentRating) {
+            return new HtEventAgentRating(htEventProps, requestData);
+        }
+        if (htEventProps.event_type === EventName.botChannelRating) {
+            return new HtEventChannelRating(htEventProps, requestData);
+        }
+        if (htEventProps.event_type === EventName.botFaqUseful) {
+            return new HtEventFaqUseful(htEventProps, requestData);
+        }
+        if (htEventProps.event_type === EventName.botRating) {
+            return new HtEventBotRating(htEventProps, requestData);
+        }
+        if (htEventProps.event_type === EventName.botFaq) {
+            return new HtEventBotFaq(htEventProps, requestData);
+        }
+        if (htEventProps.event_type === EventName.botAiModel) {
+            return new HtEventBotAiModel(htEventProps, requestData);
+        }
+        if (htEventProps.event_type === EventName.botKeywordsModel) {
+            return new HtEventBotKeywordModel(htEventProps, requestData);
+        }
+        if (htEventProps.event_type === EventName.handoffSuccess) {
+            return new HtEventHandoffSuccess(htEventProps, requestData);
+        }
+        if (htEventProps.event_type === EventName.handoffFail) {
+            return new HtEventHandoffFail(htEventProps, requestData);
+        }
+        return new HtEvent(htEventProps, requestData);
+    }
+}
+//# sourceMappingURL=ht-event.js.map

package/lib/esm/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":"AAAA,OAAO,EAAiB,SAAS,EAA6B,MAAM,UAAU,CAAA;AAC9E,OAAO,EAAE,kBAAkB,EAAE,MAAM,yBAAyB,CAAA;AAC5D,OAAO,EAAE,iBAAiB,EAAE,MAAM,yBAAyB,CAAA;AAC3D,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAA;AAClD,OAAO,EAAE,sBAAsB,EAAE,MAAM,8BAA8B,CAAA;AACrE,OAAO,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAA;AACxD,OAAO,EAAE,oBAAoB,EAAE,MAAM,2BAA2B,CAAA;AAChE,OAAO,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAA;AACxD,OAAO,EAAE,kBAAkB,EAAE,MAAM,yBAAyB,CAAA;AAC5D,OAAO,EAAE,qBAAqB,EAAE,MAAM,4BAA4B,CAAA;AAElE,MAAM,OAAO,OAAO;IAKlB,YAAsB,KAAmB,EAAE,WAAwB;QACjE,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;IAED,MAAM,CAAC,MAAM,CAAC,WAAwB,EAAE,YAA0B;QAChE,IAAI,YAAY,CAAC,UAAU,KAAK,SAAS,CAAC,cAAc,EAAE;YACxD,OAAO,IAAI,kBAAkB,CAAC,YAAY,EAAE,WAAW,CAAC,CAAA;SACzD;QACD,IAAI,YAAY,CAAC,UAAU,KAAK,SAAS,CAAC,gBAAgB,EAAE;YAC1D,OAAO,IAAI,oBAAoB,CAAC,YAAY,EAAE,WAAW,CAAC,CAAA;SAC3D;QACD,IAAI,YAAY,CAAC,UAAU,KAAK,SAAS,CAAC,YAAY,EAAE;YACtD,OAAO,IAAI,gBAAgB,CAAC,YAAY,EAAE,WAAW,CAAC,CAAA;SACvD;QACD,IAAI,YAAY,CAAC,UAAU,KAAK,SAAS,CAAC,SAAS,EAAE;YACnD,OAAO,IAAI,gBAAgB,CAAC,YAAY,EAAE,WAAW,CAAC,CAAA;SACvD;QACD,IAAI,YAAY,CAAC,UAAU,KAAK,SAAS,CAAC,MAAM,EAAE;YAChD,OAAO,IAAI,aAAa,CAAC,YAAY,EAAE,WAAW,CAAC,CAAA;SACpD;QACD,IAAI,YAAY,CAAC,UAAU,KAAK,SAAS,CAAC,UAAU,EAAE;YACpD,OAAO,IAAI,iBAAiB,CAAC,YAAY,EAAE,WAAW,CAAC,CAAA;SACxD;QACD,IAAI,YAAY,CAAC,UAAU,KAAK,SAAS,CAAC,gBAAgB,EAAE;YAC1D,OAAO,IAAI,sBAAsB,CAAC,YAAY,EAAE,WAAW,CAAC,CAAA;SAC7D;QACD,IAAI,YAAY,CAAC,UAAU,KAAK,SAAS,CAAC,cAAc,EAAE;YACxD,OAAO,IAAI,qBAAqB,CAAC,YAAY,EAAE,WAAW,CAAC,CAAA;SAC5D;QACD,IAAI,YAAY,CAAC,UAAU,KAAK,SAAS,CAAC,WAAW,EAAE;YACrD,OAAO,IAAI,kBAAkB,CAAC,YAAY,EAAE,WAAW,CAAC,CAAA;SACzD;QAED,OAAO,IAAI,OAAO,CAAC,YAAY,EAAE,WAAW,CAAC,CAAA;IAC/C,CAAC;CACF"}

package/lib/esm/index.d.ts

@@ -0,0 +1,16 @@
+import { BotRequest, Plugin } from '@botonic/core';
+import { HtEventProps, RequestData } from './types';
+export interface HubtypeAnalyticsOptions {
+    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);
+    post(): void;
+    getUrl(request: BotRequest): string;
+    getRequestData(request: BotRequest): RequestData;
+    trackEvent(request: BotRequest, htEventProps: HtEventProps): Promise<import("axios").AxiosResponse<any, any>>;
+}

package/lib/esm/index.js

@@ -0,0 +1,38 @@
+import axios from 'axios';
+import { HtEvent } from './event-models/ht-event';
+function getDefaultLanguage(request) {
+    return request.session.user.extra_data.language;
+}
+function getDefaultCountry(request) {
+    return request.session.user.extra_data.country;
+}
+export default class BotonicPluginHubtypeAnalytics {
+    constructor(options) {
+        this.baseUrl = process.env.HUBTYPE_API_URL || 'https://api.hubtype.com';
+        this.getLaguange = options.getLaguange || getDefaultLanguage;
+        this.getCountry = options.getCountry || getDefaultCountry;
+    }
+    post() {
+        return;
+    }
+    getUrl(request) {
+        return `${this.baseUrl}/external/v1/conversational_apps/${request.session.bot.id}/bot_event/`;
+    }
+    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 = HtEvent.create(requestData, htEventProps);
+        const headers = { Authorization: `Bearer ${request.session._access_token}` };
+        const config = { headers };
+        return axios.post(url, event, 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;AAEzB,OAAO,EAAE,OAAO,EAAE,MAAM,yBAAyB,CAAA;AAQjD,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,MAAM,CAAC,OAAO,OAAO,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,OAAO,CAAC,MAAM,CAAC,WAAW,EAAE,YAAY,CAAC,CAAA;QACvD,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,KAAK,EAAE,MAAM,CAAC,CAAA;IACvC,CAAC;CACF"}

package/lib/esm/types.d.ts

@@ -0,0 +1,117 @@
+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",
+    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"
+}
+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 HtBaseEventProps {
+    event_type: EventName;
+}
+export interface EventAgentRating extends HtBaseEventProps {
+    event_type: EventName.botAgentRating;
+    event_data: EventDataRating;
+}
+export interface EventChannelRating extends HtBaseEventProps {
+    event_type: EventName.botChannelRating;
+    event_data: EventDataRating;
+}
+export interface EventDataRating {
+    rating: number;
+}
+export interface EventFaqUseful extends HtBaseEventProps {
+    event_type: EventName.botFaqUseful;
+    event_data: EventDataUseful;
+}
+export interface EventDataUseful {
+    faq_name: string;
+    useful: boolean;
+}
+export interface EventBotRating extends HtBaseEventProps {
+    event_type: EventName.botRating;
+    event_data: EventDataBotRating;
+}
+interface EventDataBotRating {
+    rating: number;
+    free_comment?: string;
+    selected_options?: string[];
+}
+export interface EventBotFaq extends HtBaseEventProps {
+    event_type: EventName.botFaq;
+    event_data: EventDataBotFaq;
+}
+interface EventDataBotFaq {
+    faq_name: string;
+}
+export interface EventBotStart extends HtBaseEventProps {
+    event_type: EventName.botStart;
+}
+export interface EventBotOpen {
+    event_type: EventName.botOpen;
+}
+export interface EventBotAiModel {
+    event_type: EventName.botAiModel;
+    event_data: EventDataBotAiModel;
+}
+interface EventDataBotAiModel {
+    intent: string;
+    confidence: number;
+    confidence_successful: boolean;
+}
+export interface EventBotKeywordModel extends HtBaseEventProps {
+    event_type: EventName.botKeywordsModel;
+    event_data: EventDataBotKeywordModel;
+}
+interface EventDataBotKeywordModel {
+    confidence_successful: boolean;
+}
+export interface EventFallback extends HtBaseEventProps {
+    event_type: EventName.fallback;
+}
+export interface EventHandoffOption extends HtBaseEventProps {
+    event_type: EventName.handoffOption;
+}
+export interface EventHandoffSuccess extends HtBaseEventProps {
+    event_type: EventName.handoffSuccess;
+    event_data: EventDataHandoff;
+}
+export interface EventHandoffFail extends HtBaseEventProps {
+    event_type: EventName.handoffFail;
+    event_data: EventDataHandoff;
+}
+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;
+}
+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":"AAQA,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.4",
   "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": "",
+  "license": "MIT",
+  "keywords": [
+    "analytics",
+    "bot-framework",
+    "chatbot",
+    "conversational-app",
+    "conversational-ui",
+    "javascript",
+    "typescript"
+  ]
 }

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

@@ -0,0 +1,11 @@
+import { EventAgentRating, RequestData } from '../types'
+import { HtEvent } from './ht-event'
+
+export class HtEventAgentRating extends HtEvent {
+  rating: number
+
+  constructor(event: EventAgentRating, requestData: RequestData) {
+    super(event, requestData)
+    this.rating = event.event_data.rating
+  }
+}

package/src/event-models/ht-event-bot-ai-model.ts

@@ -0,0 +1,15 @@
+import { EventBotAiModel, RequestData } from '../types'
+import { HtEvent } from './ht-event'
+
+export class HtEventBotAiModel extends HtEvent {
+  intent: string
+  confidence: number
+  confidence_successful: boolean
+
+  constructor(event: EventBotAiModel, requestData: RequestData) {
+    super(event, requestData)
+    this.intent = event.event_data.intent
+    this.confidence = event.event_data.confidence
+    this.confidence_successful = event.event_data.confidence_successful
+  }
+}

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

@@ -0,0 +1,11 @@
+import { EventBotFaq, RequestData } from '../types'
+import { HtEvent } from './ht-event'
+
+export class HtEventBotFaq extends HtEvent {
+  faq_name: string
+
+  constructor(event: EventBotFaq, requestData: RequestData) {
+    super(event, requestData)
+    this.faq_name = event.event_data.faq_name
+  }
+}

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

@@ -0,0 +1,12 @@
+import { EventBotKeywordModel, RequestData } from '../types'
+import { HtEvent } from './ht-event'
+
+export class HtEventBotKeywordModel extends HtEvent {
+  confidence_successful: boolean
+
+  constructor(event: EventBotKeywordModel, requestData: RequestData) {
+    super(event, requestData)
+
+    this.confidence_successful = event.event_data.confidence_successful
+  }
+}

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

@@ -0,0 +1,15 @@
+import { EventBotRating, RequestData } from '../types'
+import { HtEvent } from './ht-event'
+
+export class HtEventBotRating extends HtEvent {
+  rating: number
+  free_comment?: string
+  selected_options?: string[]
+
+  constructor(event: EventBotRating, requestData: RequestData) {
+    super(event, requestData)
+    this.rating = event.event_data.rating
+    this.free_comment = event.event_data.free_comment
+    this.selected_options = event.event_data.selected_options
+  }
+}

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

@@ -0,0 +1,11 @@
+import { EventChannelRating, RequestData } from '../types'
+import { HtEvent } from './ht-event'
+
+export class HtEventChannelRating extends HtEvent {
+  rating: number
+
+  constructor(event: EventChannelRating, requestData: RequestData) {
+    super(event, requestData)
+    this.rating = event.event_data.rating
+  }
+}

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

@@ -0,0 +1,13 @@
+import { EventFaqUseful, RequestData } from '../types'
+import { HtEvent } from './ht-event'
+
+export class HtEventFaqUseful extends HtEvent {
+  faq_name: string
+  useful: boolean
+
+  constructor(event: EventFaqUseful, requestData: RequestData) {
+    super(event, requestData)
+    this.faq_name = event.event_data.faq_name
+    this.useful = event.event_data.useful
+  }
+}

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

@@ -0,0 +1,15 @@
+import { EventHandoffFail, RequestData } from '../types'
+import { HtEvent } from './ht-event'
+
+export class HtEventHandoffFail extends HtEvent {
+  queue_open: boolean
+  available_agents: boolean
+  threshold_reached: boolean
+
+  constructor(event: EventHandoffFail, requestData: RequestData) {
+    super(event, requestData)
+    this.queue_open = event.event_data.queue_open
+    this.available_agents = event.event_data.available_agents
+    this.threshold_reached = event.event_data.threshold_reached
+  }
+}

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

@@ -0,0 +1,15 @@
+import { EventHandoffSuccess, RequestData } from '../types'
+import { HtEvent } from './ht-event'
+
+export class HtEventHandoffSuccess extends HtEvent {
+  queue_open: boolean
+  available_agents: boolean
+  threshold_reached: boolean
+
+  constructor(event: EventHandoffSuccess, requestData: RequestData) {
+    super(event, requestData)
+    this.queue_open = event.event_data.queue_open
+    this.available_agents = event.event_data.available_agents
+    this.threshold_reached = event.event_data.threshold_reached
+  }
+}

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

@@ -0,0 +1,61 @@
+import { BaseEventData, EventName, HtEventProps, RequestData } from '../types'
+import { HtEventAgentRating } from './ht-event-agent-rating'
+import { HtEventBotAiModel } from './ht-event-bot-ai-model'
+import { HtEventBotFaq } from './ht-event-bot-faq'
+import { HtEventBotKeywordModel } from './ht-event-bot-keyword-model'
+import { HtEventBotRating } from './ht-event-bot-rating'
+import { HtEventChannelRating } from './ht-event-channel-rating'
+import { HtEventFaqUseful } from './ht-event-faq-useful'
+import { HtEventHandoffFail } from './ht-event-handoff-fail'
+import { HtEventHandoffSuccess } from './ht-event-handoff-success'
+
+export class HtEvent {
+  chat: string
+  event_type: EventName
+  event_data: BaseEventData
+
+  protected constructor(event: HtEventProps, requestData: 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
+    }
+  }
+
+  static create(requestData: RequestData, htEventProps: HtEventProps): HtEvent {
+    if (htEventProps.event_type === EventName.botAgentRating) {
+      return new HtEventAgentRating(htEventProps, requestData)
+    }
+    if (htEventProps.event_type === EventName.botChannelRating) {
+      return new HtEventChannelRating(htEventProps, requestData)
+    }
+    if (htEventProps.event_type === EventName.botFaqUseful) {
+      return new HtEventFaqUseful(htEventProps, requestData)
+    }
+    if (htEventProps.event_type === EventName.botRating) {
+      return new HtEventBotRating(htEventProps, requestData)
+    }
+    if (htEventProps.event_type === EventName.botFaq) {
+      return new HtEventBotFaq(htEventProps, requestData)
+    }
+    if (htEventProps.event_type === EventName.botAiModel) {
+      return new HtEventBotAiModel(htEventProps, requestData)
+    }
+    if (htEventProps.event_type === EventName.botKeywordsModel) {
+      return new HtEventBotKeywordModel(htEventProps, requestData)
+    }
+    if (htEventProps.event_type === EventName.handoffSuccess) {
+      return new HtEventHandoffSuccess(htEventProps, requestData)
+    }
+    if (htEventProps.event_type === EventName.handoffFail) {
+      return new HtEventHandoffFail(htEventProps, requestData)
+    }
+
+    return new HtEvent(htEventProps, requestData)
+  }
+}