@botonic/plugin-flow-builder 0.27.0-alpha.4 → 0.27.0

package/src/action/knowledge-bases.ts

@@ -1,79 +1,108 @@
-/* eslint-disable @typescript-eslint/naming-convention */
+import { INPUT } from '@botonic/core'
 import { ActionRequest } from '@botonic/react'
-import { v4 as uuid } from 'uuid'
-
-import { FlowBuilderApi } from '../api'
-import {
-  HtNodeWithContent,
-  HtNodeWithContentType,
-  HtTextNode,
-} from '../content-fields/hubtype-fields'
-import { getFlowBuilderPlugin } from '../helpers'
+
+import { FlowContent, FlowKnowledgeBase } from '../content-fields'
 import { EventAction, KnowledgebaseFailReason, trackEvent } from '../tracking'
-import { KnowledgeBaseResponse } from '../types'
+import { KnowledgeBaseFunction, KnowledgeBaseResponse } from '../types'
+import { getContentsByFallback } from './fallback'
+import { FlowBuilderContext } from './index'
 
-export async function createNodeFromKnowledgeBase(
-  cmsApi: FlowBuilderApi,
-  request: ActionRequest
-): Promise<HtNodeWithContent | undefined> {
-  const flowBuilderPlugin = getFlowBuilderPlugin(request.plugins)
-  const locale = flowBuilderPlugin.getLocale(request.session)
-  const resolvedLocale = cmsApi.getResolvedLocale(locale)
-  const knowledgeBaseConfig = cmsApi.getKnowledgeBaseConfig()
+export async function getContentsByKnowledgeBase({
+  cmsApi,
+  flowBuilderPlugin,
+  request,
+  resolvedLocale,
+}: FlowBuilderContext): Promise<FlowContent[]> {
+  const startNodeKnowledeBaseFlow = cmsApi.getStartNodeKnowledeBaseFlow()
+
+  if (!startNodeKnowledeBaseFlow) {
+    return await getContentsByFallback({
+      cmsApi,
+      flowBuilderPlugin,
+      request,
+      resolvedLocale,
+    })
+  }
+
+  const contents = await flowBuilderPlugin.getContentsByNode(
+    startNodeKnowledeBaseFlow,
+    resolvedLocale
+  )
+
+  const knowledgeBaseContent = contents.find(
+    content => content instanceof FlowKnowledgeBase
+  ) as FlowKnowledgeBase
+
+  if (!knowledgeBaseContent) {
+    return contents
+  }
 
   if (
     flowBuilderPlugin.getKnowledgeBaseResponse &&
-    knowledgeBaseConfig?.isActive
+    request.input.data &&
+    request.input.type === INPUT.TEXT
   ) {
-    try {
-      const knowledgeBaseResponse =
-        await flowBuilderPlugin.getKnowledgeBaseResponse(request)
-      await trackKnowledgeBase(knowledgeBaseResponse, request)
-
-      if (
-        knowledgeBaseResponse.hasKnowledge &&
-        knowledgeBaseResponse.isFaithuful
-      ) {
-        const knowledgeBaseNode: HtTextNode = {
-          type: HtNodeWithContentType.TEXT,
-          content: {
-            text: [
-              {
-                message: knowledgeBaseResponse.answer,
-                locale: resolvedLocale,
-              },
-            ],
-            buttons_style: undefined,
-            buttons: [],
-          },
-          flow_id: 'randomUUID', // TODO: Add flow_id consequentially with HtBaseNode changes
-          id: uuid(),
-          code: 'knowledge-response',
-          meta: {
-            x: 0,
-            y: 0,
-          },
-          follow_up: knowledgeBaseConfig.followup,
-        }
-        return knowledgeBaseNode
-      }
-    } catch (e) {
-      console.error('Hubtype knowledge base api error: ', { e })
+    const contentsWithKnowledgeResponse =
+      await getContentsWithKnowledgeResponse(
+        flowBuilderPlugin.getKnowledgeBaseResponse,
+        request,
+        knowledgeBaseContent,
+        contents
+      )
+
+    if (contentsWithKnowledgeResponse) {
+      return contentsWithKnowledgeResponse
     }
   }
-  return undefined
+
+  return await getContentsByFallback({
+    cmsApi,
+    flowBuilderPlugin,
+    request,
+    resolvedLocale,
+  })
+}
+
+async function getContentsWithKnowledgeResponse(
+  getKnowledgeBaseResponse: KnowledgeBaseFunction,
+  request: ActionRequest,
+  knowledgeBaseContent: FlowKnowledgeBase,
+  contents: FlowContent[]
+): Promise<FlowContent[] | undefined> {
+  const knowledgeBaseResponse = await getKnowledgeBaseResponse(
+    request,
+    request.input.data!,
+    knowledgeBaseContent.sources
+  )
+  await trackKnowledgeBase(knowledgeBaseResponse, request)
+
+  if (
+    !knowledgeBaseResponse.hasKnowledge ||
+    !knowledgeBaseResponse.isFaithuful
+  ) {
+    return undefined
+  }
+
+  return updateContentsWithAnswer(contents, knowledgeBaseResponse.answer)
+}
+
+function updateContentsWithAnswer(
+  contents: FlowContent[],
+  answer: string
+): FlowContent[] {
+  return contents.map(content => {
+    if (content instanceof FlowKnowledgeBase) {
+      content.text = answer
+    }
+
+    return content
+  })
 }
 
 async function trackKnowledgeBase(
   response: KnowledgeBaseResponse,
   request: ActionRequest
 ) {
-  /*  TODO:
-      In order to have all these parameters in the base knowlege response 
-      it is necessary to use the new endpoint to which the knowledge sources 
-      have to be indicated. For now this will not work, we need to finish 
-      the knowldege base node in the flow builder frontend.
-  */
   const knowledgebaseInferenceId = response.inferenceId
   const knowledgebaseSourcesIds = response.sources.map(
     source => source.knowledgeSourceId
@@ -97,5 +126,6 @@ async function trackKnowledgeBase(
     knowledgebaseSourcesIds,
     knowledgebaseChunksIds,
     knowledgebaseMessageId,
+    userInput: request.input.data,
   })
 }

package/src/api.ts

@@ -1,7 +1,11 @@
 import { Input, PluginPreRequest } from '@botonic/core'
 import axios from 'axios'
 
-import { BOT_ACTION_PAYLOAD_PREFIX, SEPARATOR } from './constants'
+import {
+  BOT_ACTION_PAYLOAD_PREFIX,
+  KNOWLEDGE_BASE_FLOW_NAME,
+  SEPARATOR,
+} from './constants'
 import {
   HtBotActionNode,
   HtFallbackNode,
@@ -204,6 +208,20 @@ export class FlowBuilderApi {
     return flow ? flow.name : ''
   }
 
+  getStartNodeKnowledeBaseFlow(): HtNodeWithContent | undefined {
+    const knowledgeBaseFlow = this.flow.flows.find(
+      flow => flow.name === KNOWLEDGE_BASE_FLOW_NAME
+    )
+    if (!knowledgeBaseFlow) {
+      return undefined
+    }
+    return this.getNodeById<HtNodeWithContent>(knowledgeBaseFlow.start_node_id)
+  }
+
+  isKnowledgeBaseEnabled(): boolean {
+    return this.flow.is_knowledge_base_active || false
+  }
+
   getResolvedLocale(locale: string): string {
     if (this.flow.locales.find(flowLocale => flowLocale === locale)) {
       return locale

package/src/constants.ts

@@ -6,3 +6,7 @@ export const BOT_ACTION_PAYLOAD_PREFIX = `ba${SEPARATOR}`
 export const VARIABLE_PATTERN = /{([^}]+)}/g
 export const ACCESS_TOKEN_VARIABLE_KEY = '_access_token'
 export const REG_EXP_PATTERN = /^\/(.*)\/([gimyus]*)$/
+
+export const MAIN_FLOW_NAME = 'Main'
+export const KNOWLEDGE_BASE_FLOW_NAME = 'Knowledge base'
+export const FALLBACK_FLOW_NAME = 'Fallback'

package/src/content-fields/flow-knowledge-base.tsx

@@ -0,0 +1,23 @@
+import { Text } from '@botonic/react'
+import React from 'react'
+
+import { ContentFieldsBase } from './content-fields-base'
+import { HtKnowledgeBaseNode } from './hubtype-fields'
+
+export class FlowKnowledgeBase extends ContentFieldsBase {
+  public code = ''
+  public sources: string[] = []
+  public text = ''
+
+  static fromHubtypeCMS(component: HtKnowledgeBaseNode): FlowKnowledgeBase {
+    const newKnowledgeBase = new FlowKnowledgeBase(component.id)
+    newKnowledgeBase.code = component.code
+    newKnowledgeBase.sources = component.content.sources
+
+    return newKnowledgeBase
+  }
+
+  toBotonic(id: string): JSX.Element {
+    return <Text key={id}>{this.text}</Text>
+  }
+}

package/src/content-fields/flow-whatsapp-cta-url-button.tsx

@@ -4,8 +4,7 @@ import React from 'react'
 import { FlowBuilderApi } from '../api'
 import { ContentFieldsBase } from './content-fields-base'
 import { FlowButton } from './flow-button'
-import { HtUrlNode } from './hubtype-fields'
-import { HtWhatsappCTAUrlButtonNode } from './hubtype-fields/whatsapp-cta-url-button'
+import { HtUrlNode, HtWhatsappCTAUrlButtonNode } from './hubtype-fields'
 
 export class FlowWhatsappCtaUrlButtonNode extends ContentFieldsBase {
   public code = ''

package/src/content-fields/hubtype-fields/common.ts

@@ -7,6 +7,7 @@ export interface HtFlowBuilderData {
   locales: string[]
   start_node_id?: string
   ai_model_id?: string
+  is_knowledge_base_active?: boolean
   nodes: HtNodeComponent[]
   flows: HtFlows[]
 }

package/src/content-fields/hubtype-fields/index.ts

@@ -9,6 +9,7 @@ export * from './handoff'
 export * from './image'
 export * from './intent'
 export * from './keyword'
+export * from './knowledge-base'
 export * from './node-types'
 export * from './nodes'
 export * from './payload'
@@ -17,3 +18,4 @@ export * from './text'
 export * from './url'
 export * from './video'
 export * from './whatsapp-button-list'
+export * from './whatsapp-cta-url-button'

package/src/content-fields/hubtype-fields/knowledge-base.ts

@@ -0,0 +1,9 @@
+import { HtBaseNode } from './common'
+import { HtNodeWithContentType } from './node-types'
+
+export interface HtKnowledgeBaseNode extends HtBaseNode {
+  type: HtNodeWithContentType.KNOWLEDGE_BASE
+  content: {
+    sources: string[]
+  }
+}

package/src/content-fields/hubtype-fields/node-types.ts

@@ -11,6 +11,7 @@ export enum HtNodeWithContentType {
   VIDEO = 'video',
   WHATSAPP_BUTTON_LIST = 'whatsapp-button-list',
   WHATSAPP_CTA_URL_BUTTON = 'whatsapp-cta-url-button',
+  KNOWLEDGE_BASE = 'knowledge-base',
 }
 
 export enum HtNodeWithoutContentType {

package/src/content-fields/hubtype-fields/nodes.ts

@@ -7,6 +7,7 @@ import { HtHandoffNode } from './handoff'
 import { HtImageNode } from './image'
 import { HtIntentNode } from './intent'
 import { HtKeywordNode } from './keyword'
+import { HtKnowledgeBaseNode } from './knowledge-base'
 import { HtPayloadNode } from './payload'
 import { HtSmartIntentNode } from './smart-intent'
 import { HtTextNode } from './text'
@@ -28,6 +29,7 @@ export type HtNodeWithContent =
   | HtWhatsappButtonListNode
   | HtWhatsappCTAUrlButtonNode
   | HtSmartIntentNode
+  | HtKnowledgeBaseNode
 
 export type HtNodeWithoutContent =
   | HtUrlNode

package/src/content-fields/index.ts

@@ -1,6 +1,7 @@
 import { FlowCarousel } from './flow-carousel'
 import { FlowHandoff } from './flow-handoff'
 import { FlowImage } from './flow-image'
+import { FlowKnowledgeBase } from './flow-knowledge-base'
 import { FlowText } from './flow-text'
 import { FlowVideo } from './flow-video'
 import { FlowWhatsappCtaUrlButtonNode } from './flow-whatsapp-cta-url-button'
@@ -9,7 +10,14 @@ import { FlowWhatsappButtonList } from './whatsapp-button-list/flow-whatsapp-but
 export { ContentFieldsBase } from './content-fields-base'
 export { FlowButton } from './flow-button'
 export { FlowElement } from './flow-element'
-export { FlowCarousel, FlowImage, FlowText, FlowVideo, FlowWhatsappButtonList }
+export {
+  FlowCarousel,
+  FlowImage,
+  FlowKnowledgeBase,
+  FlowText,
+  FlowVideo,
+  FlowWhatsappButtonList,
+}
 export { FlowHandoff } from './flow-handoff'
 export { FlowWhatsappCtaUrlButtonNode } from './flow-whatsapp-cta-url-button'
 
@@ -21,3 +29,4 @@ export type FlowContent =
   | FlowWhatsappButtonList
   | FlowWhatsappCtaUrlButtonNode
   | FlowHandoff
+  | FlowKnowledgeBase

package/src/index.ts

@@ -14,11 +14,12 @@ import {
   FlowContent,
   FlowHandoff,
   FlowImage,
+  FlowKnowledgeBase,
   FlowText,
   FlowVideo,
   FlowWhatsappButtonList,
+  FlowWhatsappCtaUrlButtonNode,
 } from './content-fields'
-import { FlowWhatsappCtaUrlButtonNode } from './content-fields/flow-whatsapp-cta-url-button'
 import {
   HtBotActionNode,
   HtFlowBuilderData,
@@ -30,12 +31,12 @@ import {
   HtNodeWithContentType,
 } from './content-fields/hubtype-fields'
 import { DEFAULT_FUNCTIONS } from './functions'
-import { trackFlowContent } from './tracking'
 import {
   BotonicPluginFlowBuilderOptions,
   FlowBuilderJSONVersion,
-  KnowledgeBaseResponse,
+  KnowledgeBaseFunction,
   PayloadParamsBase,
+  TrackEventFunction,
 } from './types'
 import { getNodeByUserInput } from './user-input'
 import { SmartIntentsInferenceConfig } from './user-input/smart-intent'
@@ -48,14 +49,8 @@ export default class BotonicPluginFlowBuilder implements Plugin {
   private currentRequest: PluginPreRequest
   private getAccessToken: (session: Session) => string
   public getLocale: (session: Session) => string
-  public trackEvent?: (
-    request: ActionRequest,
-    eventAction: string,
-    args?: Record<string, any>
-  ) => Promise<void>
-  public getKnowledgeBaseResponse?: (
-    request: ActionRequest
-  ) => Promise<KnowledgeBaseResponse>
+  public trackEvent?: TrackEventFunction
+  public getKnowledgeBaseResponse?: KnowledgeBaseFunction
   public smartIntentsConfig: SmartIntentsInferenceConfig
 
   constructor(readonly options: BotonicPluginFlowBuilderOptions) {
@@ -154,13 +149,7 @@ export default class BotonicPluginFlowBuilder implements Plugin {
     const resolvedLocale = this.cmsApi.getResolvedLocale(locale)
     const startNode = this.cmsApi.getStartNode()
     this.currentRequest.session.flow_thread_id = uuid()
-    const contents = await this.getContentsByNode(startNode, resolvedLocale)
-
-    await trackFlowContent(
-      this.currentRequest as unknown as ActionRequest,
-      contents
-    )
-    return contents
+    return await this.getContentsByNode(startNode, resolvedLocale)
   }
 
   async getContentsByNode(
@@ -216,6 +205,9 @@ export default class BotonicPluginFlowBuilder implements Plugin {
         )
       case HtNodeWithContentType.HANDOFF:
         return FlowHandoff.fromHubtypeCMS(hubtypeContent, locale, this.cmsApi)
+
+      case HtNodeWithContentType.KNOWLEDGE_BASE:
+        return FlowKnowledgeBase.fromHubtypeCMS(hubtypeContent)
       default:
         return undefined
     }

package/src/types.ts

@@ -10,17 +10,23 @@ export interface BotonicPluginFlowBuilderOptions {
   customFunctions?: Record<any, any>
   getLocale: (session: Session) => string
   getAccessToken: () => string
-  trackEvent?: (
-    request: ActionRequest,
-    eventAction: string,
-    args?: Record<string, any>
-  ) => Promise<void>
-  getKnowledgeBaseResponse?: (
-    request: ActionRequest
-  ) => Promise<KnowledgeBaseResponse>
+  trackEvent?: TrackEventFunction
+  getKnowledgeBaseResponse?: KnowledgeBaseFunction
   smartIntentsConfig?: { numSmartIntentsToUse: number }
 }
 
+export type TrackEventFunction = (
+  request: ActionRequest,
+  eventAction: string,
+  args?: Record<string, any>
+) => Promise<void>
+
+export type KnowledgeBaseFunction = (
+  request: ActionRequest,
+  userInput: string,
+  sources: string[]
+) => Promise<KnowledgeBaseResponse>
+
 export interface FlowBuilderApiOptions {
   url: string
   flow?: HtFlowBuilderData

package/src/user-input/intent.ts

@@ -31,6 +31,7 @@ async function trackIntentEvent(
     nluIntentConfidence: request.input.confidence,
     nluIntentThreshold: intentNode?.content.confidence,
     nluIntentMessageId: request.input.message_id,
+    userInput: request.input.data,
   }
   await trackEvent(request, EventAction.Intent, eventArgs)
 }

package/src/user-input/keyword.ts

@@ -91,6 +91,7 @@ export class KeywordMatcher {
       nluKeywordName: this.matchedKeyword,
       nluKeywordIsRegex: this.isRegExp,
       nluKeywordMessageId: this.request.input.message_id,
+      userInput: this.request.input.data,
     }
     await trackEvent(this.request, EventAction.Keyword, eventArgs)
   }

package/src/user-input/smart-intent.ts

@@ -48,6 +48,7 @@ export class SmartIntentsApi {
           nluIntentSmartTitle: response.data.smart_intent_title,
           nluIntentSmartNumUsed: response.data.smart_intents_used.length,
           nluIntentSmartMessageId: this.currentRequest.input.message_id,
+          userInput: this.currentRequest.input.data,
         })
         return smartIntentNode
       }