plugin-hubtype-analytics: change events to use new endpoint v2

[Iru89]

Description

@botonic/plugin-hubtype-analytics

• Add Jest config
• Add github action workflow to launch tests

Accumulation of all PRs of new hubtype-analytics events with endpoint v2
Apply events within the botonic-plugin-flow-builder
Update Session and Input types within botonic-core
Add the withBotEvent option to the botonic-core HandoffBuilder to tell the backend to track the handoff-success

Context

There are two types of events: botevent and webevent

• botevent: these are events that are always done in the bot's lambda and use an authenticated endpoint with token.
• webevent: these events that can be sent from the bot's frontend (webchat, webviews) or from the bot's lambda, it uses an unauthenticated endpoint.

Approach taken / Explain the design

Different actions of the bot can be tracked, for now we have the following ones:

• with botevent type: FlowNode, HandoffOption, HandoffSuccess, HandoffFail, Keyword, Intent, IntentSmart, Knowledgebase, and Fallback
• with webevent type: FeedbackCase, FeedbackMessage, FeedbackConversation, FeedbackWebview, WebviewStep, WebviewEnd and Custom

The plugin-flow-builder takes care of flow tracking and exports the function, trackFlowContent to facilitate the tracking of content displayed in the bot. Apart from tracking the content displayed by the bot, it tracks Keywords, IntentSmart, IntentKnowledge base and Fallback. It also uses the HandoffBuilder with the parameter with BotEvent for the backend to track the handoff-success.

To document / Usage example

In the bot code we can declare a function like this and then pass it through the flow builder constructor to make it work

type EventArgs = { [key: string]: any }

export async function trackEvent(
  request: BotRequest,
  eventName: string,
  args?: EventArgs
): Promise<void> {
  if (Object.values(EventAction).includes(eventName as EventAction)) {
    const htEventProps = {
      action: eventName as EventAction,
      ...args,
    } as HtEventProps
    const hubtypeAnalyticsPlugin = request.plugins.hubtypeAnalytics
    await hubtypeAnalyticsPlugin.trackEvent(request, htEventProps)
  }
  return
}

Testing

• Add tests to check how each event is created