@botonic/plugin-flow-builder 0.57.0-rslib-esm.1 → 0.57.0

package/src/constants.ts

@@ -2,7 +2,6 @@ export const FLOW_BUILDER_API_URL_PROD =
   process.env.HUBTYPE_API_URL || 'https://api.hubtype.com'
 export const SEPARATOR = '|'
 export const SOURCE_INFO_SEPARATOR = `${SEPARATOR}source_`
-export const EMPTY_PAYLOAD = 'fb-empty-payload'
 export const VARIABLE_PATTERN_GLOBAL = /{([^{}]+)}/g
 export const ACCESS_TOKEN_VARIABLE_KEY = '_access_token'
 export const REG_EXP_PATTERN = /^\/(.*)\/([gimyus]*)$/
@@ -10,6 +9,8 @@ export const UUID_REGEXP =
   /^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/i
 
 /* ********** PAYLOADS ********** */
+export const EMPTY_PAYLOAD = 'fb-empty-payload'
+export const ON_CLOSE_HANDOFF_PAYLOAD = 'fb-on-close-handoff'
 export const AGENT_RATING_PAYLOAD = 'agent-rating'
 export const PUSH_FLOW_PAYLOAD = 'push-flow'
 

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

@@ -0,0 +1,24 @@
+import type { HubtypeCaseContactReason } from '@botonic/core'
+
+import type { HtContactReasonBranch } from './hubtype-fields/contact-reasons-conditional'
+
+export function contactReasonMatchesBranch(
+  sessionContactReason: HubtypeCaseContactReason,
+  branch: HtContactReasonBranch
+): boolean {
+  return (
+    sessionContactReason.project_id === branch.project_id &&
+    sessionContactReason.name === branch.name
+  )
+}
+
+export function findMatchingContactReasonBranch(
+  sessionContactReasons: HubtypeCaseContactReason[],
+  contactReasonBranches: HtContactReasonBranch[]
+): HtContactReasonBranch | undefined {
+  return contactReasonBranches.find(branch =>
+    sessionContactReasons.some(sessionContactReason =>
+      contactReasonMatchesBranch(sessionContactReason, branch)
+    )
+  )
+}

package/src/content-fields/flow-ai-agent-base.tsx

@@ -16,6 +16,7 @@ import { HubtypeAssistantContent } from '../utils/hubtype-assistant-content'
 import { ContentFieldsBase } from './content-fields-base'
 import { FlowCarousel } from './flow-carousel'
 import { FlowText } from './flow-text'
+import { FlowWhatsappRequestContactInfoNode } from './flow-whatsapp-request-contact-info'
 import type { HtInputGuardrailRule, HtNodeWithContent } from './hubtype-fields'
 import type { FlowContent } from './index'
 
@@ -89,6 +90,16 @@ export abstract class FlowAiAgentBase extends ContentFieldsBase {
         )
       }
 
+      if (message.type === OutputMessageType.RequestContactInfo) {
+        this.jsxElements.push(
+          FlowWhatsappRequestContactInfoNode.fromAIAgent(
+            this.id,
+            message,
+            botContext
+          )
+        )
+      }
+
       if (message.type === FlowBuilderOutputMessageType.FlowBuilderContent) {
         const flowContents = await this.getFlowContentsByContentId(
           botContext,
@@ -107,7 +118,7 @@ export abstract class FlowAiAgentBase extends ContentFieldsBase {
     botContext: BotContext,
     previousContents?: FlowContent[]
   ): Promise<void> {
-    if (this.messages.length === 0) {
+    if (!this.aiAgentResponse) {
       await this.resolveAIAgentResponse(botContext, previousContents)
     }
     if (this.jsxElements.length === 0) {

package/src/content-fields/flow-ai-agent-router.tsx

@@ -194,6 +194,7 @@ export class FlowAiAgentRouter extends FlowAiAgentBase {
       inputGuardrailsTriggered: [],
       outputGuardrailsTriggered:
         this.aiAgentResponse?.outputGuardrailsTriggered ?? [],
+      doNothing: this.aiAgentResponse?.doNothing ?? false,
     }
     const { action, ...specialistEventArgs } = specialistEvent
     await trackEvent(botContext, action, specialistEventArgs)

package/src/content-fields/flow-ai-agent.tsx

@@ -94,6 +94,7 @@ export class FlowAiAgent extends FlowAiAgentBase {
         this.aiAgentResponse?.inputGuardrailsTriggered ?? [],
       outputGuardrailsTriggered: [], //aiAgentResponse.outputGuardrailsTriggered,
       error: this.aiAgentResponse?.error ?? false,
+      doNothing: this.aiAgentResponse?.doNothing ?? false,
     }
     const { action, ...eventArgs } = event
 

package/src/content-fields/flow-contact-reasons-conditional.tsx

@@ -0,0 +1,90 @@
+import {
+  type BotContext,
+  EventAction,
+  type EventConditionalContactReasons,
+} from '@botonic/core'
+
+import {
+  getCommonFlowContentEventArgsForContentId,
+  trackEvent,
+} from '../tracking'
+import { findMatchingContactReasonBranch } from './contact-reasons-conditional-matcher'
+import { ContentFieldsBase } from './content-fields-base'
+import type { HtNodeLink } from './hubtype-fields/common'
+import type {
+  HtContactReasonBranch,
+  HtContactReasonsNode,
+} from './hubtype-fields/contact-reasons-conditional'
+
+export class FlowContactReasonsConditional extends ContentFieldsBase {
+  public contactReasons: HtContactReasonBranch[] = []
+  public conditionalResult: string = ''
+  public defaultTarget: HtNodeLink
+
+  static fromHubtypeCMS(
+    component: HtContactReasonsNode,
+    botContext: BotContext
+  ): FlowContactReasonsConditional {
+    const newContactReasonsConditional = new FlowContactReasonsConditional(
+      component.id
+    )
+    newContactReasonsConditional.contactReasons =
+      component.content.contact_reasons
+    newContactReasonsConditional.defaultTarget =
+      component.content.default_target
+    newContactReasonsConditional.setFollowUp(botContext)
+    return newContactReasonsConditional
+  }
+
+  private setFollowUp(botContext: BotContext): void {
+    const sessionContactReasons =
+      botContext.session._hubtype_case_contact_reasons
+
+    const matchingBranch = sessionContactReasons
+      ? findMatchingContactReasonBranch(
+          sessionContactReasons,
+          this.contactReasons
+        )
+      : undefined
+
+    if (matchingBranch) {
+      this.conditionalResult = matchingBranch.name
+      this.followUp = matchingBranch.target
+    } else {
+      this.conditionalResult = 'default'
+      this.followUp = this.defaultTarget
+    }
+  }
+
+  async trackFlow(botContext: BotContext): Promise<void> {
+    const { flowThreadId, flowId, flowName, flowNodeId, flowNodeContentId } =
+      getCommonFlowContentEventArgsForContentId(botContext, this.id)
+    const eventContactReasonsConditional: EventConditionalContactReasons = {
+      action: EventAction.ConditionalContactReasons,
+      flowThreadId,
+      flowId,
+      flowName,
+      flowNodeId,
+      flowNodeContentId,
+      flowNodeIsMeaningful: false,
+      contactReasons:
+        botContext.session._hubtype_case_contact_reasons?.map(
+          contactReason => contactReason.name
+        ) || [],
+      result: this.conditionalResult,
+    }
+    const { action, ...eventArgs } = eventContactReasonsConditional
+    await trackEvent(botContext, action, eventArgs)
+    return
+  }
+
+  async processContent(botContext: BotContext): Promise<void> {
+    await this.filterContent(botContext, this)
+    await this.trackFlow(botContext)
+    return
+  }
+
+  toBotonic() {
+    return <></>
+  }
+}

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
     }