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

package/src/content-fields/flow-do-nothing.tsx

@@ -0,0 +1,29 @@
+import type { BotContext } from '@botonic/core'
+
+import { trackOneContent } from '../tracking'
+import { ContentFieldsBase } from './content-fields-base'
+import type { HtDoNothingNode } from './hubtype-fields'
+
+export class FlowDoNothing extends ContentFieldsBase {
+  static fromHubtypeCMS(cmsDoNothing: HtDoNothingNode): FlowDoNothing {
+    const newDoNothing = new FlowDoNothing(cmsDoNothing.id)
+    newDoNothing.code = cmsDoNothing.code
+    newDoNothing.followUp = cmsDoNothing.follow_up
+
+    return newDoNothing
+  }
+
+  async trackFlow(botContext: BotContext): Promise<void> {
+    await trackOneContent(botContext, this)
+  }
+
+  async processContent(botContext: BotContext): Promise<void> {
+    await this.filterContent(botContext, this)
+    await this.trackFlow(botContext)
+    return
+  }
+
+  toBotonic(): JSX.Element {
+    return <></>
+  }
+}

package/src/content-fields/flow-handoff.tsx

@@ -6,17 +6,27 @@ import {
   isWebchat,
 } from '@botonic/core'
 import { WebchatSettings } from '@botonic/react'
-
 import type { FlowBuilderApi } from '../api'
+import { ON_CLOSE_HANDOFF_PAYLOAD, SEPARATOR } from '../constants'
 import { getCommonFlowContentEventArgsForContentId } from '../tracking'
 import { ContentFieldsBase } from './content-fields-base'
-import type { HtHandoffNode, HtQueueLocale } from './hubtype-fields'
+import {
+  DiscardType,
+  type HtHandoffNode,
+  type HtNodeLink,
+  type HtQueueLocale,
+} from './hubtype-fields'
 
 export class FlowHandoff extends ContentFieldsBase {
   public queue?: HtQueueLocale
   public onFinishPayload?: string
   public handoffAutoAssign: boolean
   public hasQueuePositionChangedNotificationsEnabled: boolean
+  public hasDifferentiatedCloseTypes: boolean
+  public resolvedByAgent?: HtNodeLink
+  public discardedByAgent?: HtNodeLink
+  public discardedByUser?: HtNodeLink
+  public discardedBySystem?: HtNodeLink
   public isTestIntegration: boolean
 
   static fromHubtypeCMS(
@@ -30,14 +40,21 @@ export class FlowHandoff extends ContentFieldsBase {
       locale,
       cmsHandoff.content.queue
     )
+    newHandoff.hasDifferentiatedCloseTypes =
+      cmsHandoff.content.has_differentiated_close_types
+    newHandoff.resolvedByAgent = cmsHandoff.content.resolved_by_agent
+    newHandoff.discardedByAgent = cmsHandoff.content.discarded_by_agent
+    newHandoff.discardedByUser = cmsHandoff.content.discarded_by_user
+    newHandoff.discardedBySystem = cmsHandoff.content.discarded_by_system
+    newHandoff.handoffAutoAssign = cmsHandoff.content.has_auto_assign
+    newHandoff.hasQueuePositionChangedNotificationsEnabled =
+      cmsHandoff.content.has_queue_position_changed_notifications_enabled
+
     newHandoff.onFinishPayload = FlowHandoff.getOnFinishPayload(
       cmsHandoff,
       cmsApi
     )
-    newHandoff.handoffAutoAssign = cmsHandoff.content.has_auto_assign
-    newHandoff.hasQueuePositionChangedNotificationsEnabled =
-      cmsHandoff.content.has_queue_position_changed_notifications_enabled
-    newHandoff.followUp = cmsHandoff.follow_up
+    newHandoff.followUp = undefined
 
     return newHandoff
   }
@@ -46,13 +63,43 @@ export class FlowHandoff extends ContentFieldsBase {
     cmsHandoff: HtHandoffNode,
     cmsApi: FlowBuilderApi
   ): string | undefined {
-    if (cmsHandoff.target?.id) {
+    if (cmsHandoff.content.has_differentiated_close_types) {
+      return `${ON_CLOSE_HANDOFF_PAYLOAD}${SEPARATOR}${cmsHandoff.id}`
+    } else if (cmsHandoff.target?.id) {
       return cmsApi.getPayload(cmsHandoff.target)
     }
 
     return undefined
   }
 
+  resolveOnClosePayload(botContext: BotContext): string {
+    const contactReasons =
+      botContext.session._hubtype_case_contact_reasons || []
+
+    if (contactReasons.some(reason => reason.name === DiscardType.ByAgent)) {
+      if (this.discardedByAgent?.id) {
+        return this.discardedByAgent.id
+      }
+      console.error('No discarded by agent target found')
+    }
+    if (contactReasons.some(reason => reason.name === DiscardType.ByUser)) {
+      if (this.discardedByUser?.id) {
+        return this.discardedByUser.id
+      }
+      console.error('No discarded by user target found')
+    }
+    if (contactReasons.some(reason => reason.name === DiscardType.BySystem)) {
+      if (this.discardedBySystem?.id) {
+        return this.discardedBySystem.id
+      }
+      console.error('No discarded by system target found')
+    }
+    if (this.resolvedByAgent?.id) {
+      return this.resolvedByAgent.id
+    }
+    throw new Error('No resolved by agent target found')
+  }
+
   async doHandoff(botContext: BotContext): Promise<void> {
     const handOffBuilder = new HandOffBuilder(botContext.session)
     handOffBuilder.withAutoAssignOnWaiting(this.handoffAutoAssign)

package/src/content-fields/flow-whatsapp-request-contact-info.tsx

@@ -1,4 +1,8 @@
-import { type BotContext, isWhatsapp } from '@botonic/core'
+import {
+  type BotContext,
+  isWhatsapp,
+  type RequestContactInfoMessage,
+} from '@botonic/core'
 import { Text, WhatsappRequestContactInfo } from '@botonic/react'
 
 import { trackOneContent } from '../tracking'
@@ -26,6 +30,20 @@ export class FlowWhatsappRequestContactInfoNode extends ContentFieldsBase {
     return requestContactInfo
   }
 
+  static fromAIAgent(
+    id: string,
+    message: RequestContactInfoMessage,
+    botContext: BotContext
+  ): JSX.Element {
+    botContext.session.whatsapp_request_contact = undefined
+
+    if (!isWhatsapp(botContext.session)) {
+      return <Text key={id}>{message.content.text}</Text>
+    }
+
+    return <WhatsappRequestContactInfo key={id} body={message.content.text} />
+  }
+
   async trackFlow(botContext: BotContext): Promise<void> {
     await trackOneContent(botContext, this)
   }

package/src/content-fields/hubtype-fields/contact-reasons-conditional.ts

@@ -0,0 +1,18 @@
+import type { HtBaseNode, HtNodeLink } from './common'
+import type { HtNodeWithContentType } from './node-types'
+
+export interface HtContactReasonBranch {
+  id: string
+  name: string
+  project_id: string
+  project_name: string
+  target: HtNodeLink
+}
+
+export interface HtContactReasonsNode extends HtBaseNode {
+  type: HtNodeWithContentType.CONTACT_REASONS_CONDITION
+  content: {
+    contact_reasons: HtContactReasonBranch[]
+    default_target: HtNodeLink
+  }
+}

package/src/content-fields/hubtype-fields/do-nothing.ts

@@ -0,0 +1,7 @@
+import type { HtBaseNode } from './common'
+import type { HtNodeWithContentType } from './node-types'
+
+export interface HtDoNothingNode extends HtBaseNode {
+  id: string
+  type: HtNodeWithContentType.DO_NOTHING
+}

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

@@ -1,6 +1,17 @@
-import type { HtBaseNode, HtPayloadLocale, HtQueueLocale } from './common'
+import type {
+  HtBaseNode,
+  HtNodeLink,
+  HtPayloadLocale,
+  HtQueueLocale,
+} from './common'
 import type { HtNodeWithContentType } from './node-types'
 
+export enum DiscardType {
+  ByAgent = 'discarded',
+  ByUser = 'discarded_by_user',
+  BySystem = 'discarded_by_system',
+}
+
 export interface HtHandoffNode extends HtBaseNode {
   type: HtNodeWithContentType.HANDOFF
   content: {
@@ -8,5 +19,10 @@ export interface HtHandoffNode extends HtBaseNode {
     payload: HtPayloadLocale[]
     has_auto_assign: boolean
     has_queue_position_changed_notifications_enabled: boolean
+    has_differentiated_close_types: boolean
+    resolved_by_agent?: HtNodeLink
+    discarded_by_agent?: HtNodeLink
+    discarded_by_user?: HtNodeLink
+    discarded_by_system?: HtNodeLink
   }
 }

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

@@ -6,6 +6,7 @@ export * from './capture-user-input'
 export * from './carousel'
 export * from './common'
 export * from './custom-conditional-v2'
+export * from './do-nothing'
 export * from './fallback'
 export * from './function'
 export * from './go-to-flow'

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

@@ -20,6 +20,8 @@ export enum HtNodeWithContentType {
   GO_TO_FLOW = 'go-to-flow',
   CAPTURE_USER_INPUT = 'capture-user-input',
   CUSTOM_CONDITION = 'custom-condition',
+  DO_NOTHING = 'do-nothing',
+  CONTACT_REASONS_CONDITION = 'contact-reasons-condition',
 }
 
 export enum HtNodeWithoutContentType {

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

@@ -3,7 +3,9 @@ import type { HtAiAgentRouterNode } from './ai-agent-router'
 import type { HtBotActionNode } from './bot-action'
 import type { HtCaptureUserInputNode } from './capture-user-input'
 import type { HtCarouselNode } from './carousel'
+import type { HtContactReasonsNode } from './contact-reasons-conditional'
 import type { HtCustomConditionalV2Node } from './custom-conditional-v2'
+import type { HtDoNothingNode } from './do-nothing'
 // import { HtChannelConditionalNode } from './channel-conditional'
 // import { HtCountryConditionalNode } from './country-conditional'
 // import { HtCustomConditionalNode } from './custom-conditional'
@@ -48,6 +50,8 @@ export type HtNodeWithContent =
   | HtWhatsappTemplateNode
   | HtCaptureUserInputNode
   | HtCustomConditionalV2Node
+  | HtDoNothingNode
+  | HtContactReasonsNode
 // | HtChannelConditionalNode
 // | HtCountryConditionalNode
 // | HtCustomConditionalNode

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 {

package/src/utils/hubtype-assistant-content.ts

@@ -6,6 +6,7 @@ import { FlowImage } from '../content-fields/flow-image'
 import { FlowText } from '../content-fields/flow-text'
 import { FlowVideo } from '../content-fields/flow-video'
 import { FlowWhatsappCtaUrlButtonNode } from '../content-fields/flow-whatsapp-cta-url-button'
+import { FlowWhatsappRequestContactInfoNode } from '../content-fields/flow-whatsapp-request-contact-info'
 import { FlowWhatsappTemplate } from '../content-fields/flow-whatsapp-template'
 import { HtButtonStyle } from '../content-fields/hubtype-fields'
 import { FlowWhatsappButtonList } from '../content-fields/whatsapp-button-list/flow-whatsapp-button-list'
@@ -34,6 +35,9 @@ export class HubtypeAssistantContent {
     if (content instanceof FlowWhatsappTemplate) {
       return HubtypeAssistantContent.formatWhatsappTemplateContent(content)
     }
+    if (content instanceof FlowWhatsappRequestContactInfoNode) {
+      return HubtypeAssistantContent.formatRequestContactInfoContent(content)
+    }
     return ''
   }
 
@@ -205,4 +209,14 @@ export class HubtypeAssistantContent {
     const { name, language } = template.htWhatsappTemplate
     return `WhatsApp Template: ${name} (${language})`
   }
+
+  private static formatRequestContactInfoContent(
+    requestContactInfo: FlowWhatsappRequestContactInfoNode
+  ): string {
+    const body = requestContactInfo.text?.trim() ?? ''
+    if (!body) {
+      return '[WhatsApp Request Contact Info]'
+    }
+    return requestContactInfo.text
+  }
 }