@botonic/plugin-flow-builder 0.57.0-rslib-esm.2 → 0.58.0-alpha-new-stack.0

package/src/content-fields/hubtype-fields/whatsapp-request-contact-info.ts

@@ -1,3 +1,4 @@
+import type { HtButton } from './button'
 import type { HtBaseNode, HtTextLocale } from './common'
 import type { HtNodeWithContentType } from './node-types'
 
@@ -5,5 +6,6 @@ export interface HtWhatsappRequestContactInfoNode extends HtBaseNode {
   type: HtNodeWithContentType.WHATSAPP_REQUEST_CONTACT_INFO
   content: {
     text: HtTextLocale[]
+    button: HtButton
   }
 }

package/src/content-fields/index.ts

@@ -5,8 +5,10 @@ import { FlowBotAction } from './flow-bot-action'
 import { FlowCaptureUserInput } from './flow-capture-user-input'
 import { FlowCarousel } from './flow-carousel'
 import { FlowChannelConditional } from './flow-channel-conditional'
+import { FlowContactReasonsConditional } from './flow-contact-reasons-conditional'
 import { FlowCountryConditional } from './flow-country-conditional'
 import { FlowCustomConditional } from './flow-custom-conditional'
+import { FlowDoNothing } from './flow-do-nothing'
 import { FlowGoToFlow } from './flow-go-to-flow'
 import { FlowHandoff } from './flow-handoff'
 import { FlowImage } from './flow-image'
@@ -33,9 +35,11 @@ export {
   FlowCaptureUserInput,
   FlowCarousel,
   FlowChannelConditional,
+  FlowContactReasonsConditional,
   FlowCountryConditional,
   FlowCustomConditional,
   FlowCustomConditionalV2,
+  FlowDoNothing,
   FlowGoToFlow,
   FlowHandoff,
   FlowImage,
@@ -72,3 +76,5 @@ export type FlowContent =
   | FlowCaptureUserInput
   | FlowAiAgentRouter
   | FlowCustomConditionalV2
+  | FlowDoNothing
+  | FlowContactReasonsConditional

package/src/flow-factory.ts

@@ -7,10 +7,12 @@ import {
   FlowBotAction,
   FlowCarousel,
   FlowChannelConditional,
+  FlowContactReasonsConditional,
   type FlowContent,
   FlowCountryConditional,
   FlowCustomConditional,
   FlowCustomConditionalV2,
+  FlowDoNothing,
   FlowGoToFlow,
   FlowHandoff,
   FlowImage,
@@ -118,6 +120,15 @@ export class FlowFactory {
           this.botContext
         )
 
+      case HtNodeWithContentType.DO_NOTHING:
+        return FlowDoNothing.fromHubtypeCMS(hubtypeContent)
+
+      case HtNodeWithContentType.CONTACT_REASONS_CONDITION:
+        return FlowContactReasonsConditional.fromHubtypeCMS(
+          hubtypeContent,
+          this.botContext
+        )
+
       default:
         return undefined
     }

package/src/index.ts

@@ -1,24 +1,16 @@
-import {
-  INPUT,
-  type Plugin,
-  type PluginPreRequest,
-  PROVIDER,
-  type ResolvedPlugins,
-  type Session,
+import type {
+  BotContext,
+  Plugin,
+  ResolvedPlugins,
+  Session,
 } from '@botonic/core'
-import type { ActionRequest } from '@botonic/react'
 import { v7 as uuidv7 } from 'uuid'
 
 import { FlowBuilderApi } from './api'
-import {
-  EMPTY_PAYLOAD,
-  FLOW_BUILDER_API_URL_PROD,
-  SEPARATOR,
-  SOURCE_INFO_SEPARATOR,
-} from './constants'
+import { BotContextManager } from './bot-context-manager'
+import { FLOW_BUILDER_API_URL_PROD, SEPARATOR } from './constants'
 import type { FlowContent } from './content-fields'
 import {
-  type HtBotActionNode,
   type HtFlowBuilderData,
   type HtNodeWithContent,
   HtNodeWithContentType,
@@ -35,10 +27,8 @@ import {
   type RatingSubmittedInfo,
   type TrackEventFunction,
 } from './types'
-import { getNextPayloadByUserInput } from './user-input'
 import type { SmartIntentsInferenceConfig } from './user-input/smart-intent'
 import { resolveGetAccessToken } from './utils/authentication'
-import { inputHasTextOrTranscript } from './utils/input'
 
 // TODO: Create a proper service to wrap all calls and allow api versioning
 
@@ -46,7 +36,7 @@ export default class BotonicPluginFlowBuilder implements Plugin {
   public cmsApi: FlowBuilderApi
   private flow?: HtFlowBuilderData
   private functions: Record<any, any>
-  private currentRequest: PluginPreRequest
+  private botContext: BotContext
   public getAccessToken: (session: Session) => string
   public trackEvent?: TrackEventFunction
   public getAiAgentResponse?: AiAgentFunction
@@ -85,85 +75,33 @@ export default class BotonicPluginFlowBuilder implements Plugin {
       options.disableAIAgentInFirstInteraction || false
   }
 
-  resolveFlowUrl(request: PluginPreRequest): string {
-    if (request.session.is_test_integration) {
+  resolveFlowUrl(botContext: BotContext): string {
+    if (botContext.session.is_test_integration) {
       return `${this.apiUrl}/v1/bot_flows/{bot_id}/versions/${FlowBuilderJSONVersion.DRAFT}/`
     }
     return `${this.apiUrl}/v1/bot_flows/{bot_id}/versions/${this.jsonVersion}/`
   }
 
-  async pre(request: PluginPreRequest): Promise<void> {
-    // When AI Agent is executed in Whatsapp, button payloads come as referral and must be converted to text being processed by the agent.
-    this.convertWhatsappAiAgentEmptyPayloads(request)
-
-    this.currentRequest = request
+  async pre(botContext: BotContext): Promise<void> {
+    this.botContext = botContext
     this.cmsApi = await FlowBuilderApi.create({
-      flowUrl: this.resolveFlowUrl(request),
+      flowUrl: this.resolveFlowUrl(botContext),
       url: this.apiUrl,
       flow: this.flow,
-      accessToken: this.getAccessToken(request.session),
-      request: this.currentRequest,
+      accessToken: this.getAccessToken(botContext.session),
+      botContext: this.botContext,
     })
 
-    const checkUserTextInput =
-      inputHasTextOrTranscript(request.input) && !request.input.payload
-
-    if (checkUserTextInput) {
-      const resolvedLocale = this.cmsApi.getResolvedLocale()
-      const nextPayload = await getNextPayloadByUserInput(
-        this.cmsApi,
-        resolvedLocale,
-        request as unknown as ActionRequest,
-        this.smartIntentsConfig
-      )
-      request.input.payload = nextPayload
-    }
-
-    await this.updateRequestBeforeRoutes(request)
-  }
-
-  private convertWhatsappAiAgentEmptyPayloads(request: PluginPreRequest): void {
-    if (request.session.user.provider === PROVIDER.WHATSAPP) {
-      const shouldUseReferral =
-        request.input.referral &&
-        request.input.payload?.startsWith(EMPTY_PAYLOAD)
-
-      if (shouldUseReferral) {
-        request.input.type = INPUT.TEXT
-        request.input.data = request.input.referral
-      }
-    }
-  }
-
-  private async updateRequestBeforeRoutes(
-    request: PluginPreRequest
-  ): Promise<void> {
-    this.cmsApi.removeCaptureUserInputId()
-    if (request.input.payload) {
-      request.input.payload = this.removeSourceSuffix(request.input.payload)
-
-      if (this.cmsApi.isBotAction(request.input.payload)) {
-        const cmsBotAction = this.cmsApi.getNodeById<HtBotActionNode>(
-          request.input.payload
-        )
-
-        request.input.payload =
-          this.cmsApi.createPayloadWithParams(cmsBotAction)
-
-        // Re-execute convertWhatsappAiAgentEmptyPayloads function to handle
-        // the case that a BotAction has a payload equals to EMPTY_PAYLOAD
-        this.convertWhatsappAiAgentEmptyPayloads(request)
-      }
-    }
-  }
-
-  private removeSourceSuffix(payload: string): string {
-    return payload.split(SOURCE_INFO_SEPARATOR)[0]
+    const botContextManager = new BotContextManager(
+      this.cmsApi,
+      this.smartIntentsConfig
+    )
+    await botContextManager.prepareInputForRoutes(botContext)
   }
 
-  post(request: PluginPreRequest): void {
-    request.input.nluResolution = undefined
-    delete request.session.user.system_locale_updated
+  post(botContext: BotContext): void {
+    botContext.input.nluResolution = undefined
+    delete botContext.session.user.system_locale_updated
   }
 
   async getContentsByContentID(
@@ -189,7 +127,7 @@ export default class BotonicPluginFlowBuilder implements Plugin {
 
   async getStartContents(): Promise<FlowContent[]> {
     const startNode = this.cmsApi.getStartNode()
-    this.currentRequest.session.flow_thread_id = uuidv7()
+    this.botContext.session.flow_thread_id = uuidv7()
     return await this.getContentsByNode(startNode)
   }
 
@@ -206,7 +144,7 @@ export default class BotonicPluginFlowBuilder implements Plugin {
     ) {
       const customFunctionResolver = new CustomFunction(
         this.functions,
-        this.currentRequest,
+        this.botContext,
         resolvedLocale
       )
       const targetId = await customFunctionResolver.call(node)
@@ -214,7 +152,7 @@ export default class BotonicPluginFlowBuilder implements Plugin {
     }
 
     const flowFactory = new FlowFactory(
-      this.currentRequest,
+      this.botContext,
       this.cmsApi,
       resolvedLocale
     )

package/src/types.ts

@@ -3,7 +3,6 @@ import type {
   BotContext,
   GuardrailRule,
   InferenceResponse,
-  PluginPreRequest,
   ResolvedPlugins,
 } from '@botonic/core'
 import type { FlowContent } from './content-fields'
@@ -67,7 +66,7 @@ export interface FlowBuilderApiOptions {
   flowUrl: string
   flow?: HtFlowBuilderData
   accessToken: string
-  request: PluginPreRequest
+  botContext: BotContext
 }
 
 export enum ProcessEnvNodeEnvs {