@botonic/plugin-flow-builder 0.46.2 → 2.23.0

package/src/content-fields/flow-whatsapp-template.tsx

@@ -1,319 +0,0 @@
-import { isWhatsapp } from '@botonic/core'
-import {
-  type ActionRequest,
-  Text,
-  WhatsAppTemplateButtonSubType,
-  WhatsAppTemplateComponentType,
-  WhatsAppTemplateParameterType,
-  WhatsappTemplate,
-  type WhatsappTemplateButton,
-  type WhatsappTemplateComponentBody,
-  type WhatsappTemplateComponentButtons,
-  type WhatsappTemplateComponentHeader,
-  type WhatsappTemplateQuickReplyButton,
-  type WhatsappTemplateUrlButton,
-  type WhatsappTemplateVoiceCallButton,
-} from '@botonic/react'
-
-import { getFlowBuilderPlugin } from '../helpers'
-import { trackOneContent } from '../tracking'
-import { ContentFieldsBase } from './content-fields-base'
-import type {
-  HtButton,
-  HtMediaFileLocale,
-  HtWhatsAppTemplate,
-  HtWhatsAppTemplateButtonsComponent,
-  HtWhatsAppTemplateHeaderComponent,
-  HtWhatsappTemplateContentByLocale,
-  HtWhatsappTemplateNode,
-} from './hubtype-fields'
-
-interface HeaderVariables {
-  type: WhatsAppTemplateParameterType
-  text?: Record<string, string>
-  media?: HtMediaFileLocale[]
-}
-
-export class FlowWhatsappTemplate extends ContentFieldsBase {
-  public htWhatsappTemplate: HtWhatsAppTemplate
-  public variableValues: Record<string, string> = {}
-  public headerVariables?: HeaderVariables
-  public buttons?: HtButton[]
-  public urlVariableValues?: Record<string, string>
-
-  static fromHubtypeCMS(
-    component: HtWhatsappTemplateNode,
-    currentLocale: string
-  ): FlowWhatsappTemplate {
-    const whatsappTemplate = new FlowWhatsappTemplate(component.id)
-    whatsappTemplate.code = component.code
-    whatsappTemplate.buttons = component.content.buttons
-    const contentByLocale = FlowWhatsappTemplate.getContentByLocale(
-      component,
-      currentLocale
-    )
-
-    whatsappTemplate.htWhatsappTemplate = contentByLocale.template
-    whatsappTemplate.headerVariables = contentByLocale.header_variables
-    whatsappTemplate.variableValues = contentByLocale.variable_values
-    whatsappTemplate.urlVariableValues = contentByLocale.url_variable_values
-
-    whatsappTemplate.followUp = component.follow_up
-
-    return whatsappTemplate
-  }
-
-  private static getContentByLocale(
-    component: HtWhatsappTemplateNode,
-    currentLocale: string
-  ) {
-    const content: HtWhatsappTemplateContentByLocale | undefined =
-      component.content.by_locale[currentLocale]
-    if (!content) {
-      throw new Error(
-        `Whatsapp template content not found for locale: ${currentLocale}`
-      )
-    }
-    return content
-  }
-
-  private getHeaderComponent(
-    whatsappTemplate: HtWhatsAppTemplate,
-    headerVariables: HeaderVariables,
-    locale: string,
-    request: ActionRequest
-  ): WhatsappTemplateComponentHeader | undefined {
-    const headerComponent = whatsappTemplate.components.find(
-      component => component.type === WhatsAppTemplateComponentType.HEADER
-    ) as HtWhatsAppTemplateHeaderComponent | undefined
-
-    if (
-      headerComponent &&
-      headerComponent.format === WhatsAppTemplateParameterType.TEXT
-    ) {
-      return this.createHeaderTextComponent(headerVariables, request)
-    }
-
-    if (
-      headerComponent &&
-      headerComponent.format === WhatsAppTemplateParameterType.IMAGE
-    ) {
-      return this.createHeaderImageComponent(headerVariables, locale)
-    }
-
-    if (
-      headerComponent &&
-      headerComponent.format === WhatsAppTemplateParameterType.VIDEO
-    ) {
-      return this.createHeaderVideoComponent(headerVariables, locale)
-    }
-
-    return undefined
-  }
-
-  private createHeaderTextComponent(
-    headerVariables: HeaderVariables,
-    request: ActionRequest
-  ): WhatsappTemplateComponentHeader {
-    return {
-      type: WhatsAppTemplateComponentType.HEADER,
-      parameters: Object.values(headerVariables.text || {}).map(value => {
-        const valueVariable = this.replaceVariables(value, request)
-        return {
-          type: WhatsAppTemplateParameterType.TEXT,
-          text: valueVariable,
-        }
-      }),
-    }
-  }
-
-  private createHeaderImageComponent(
-    headerVariables: HeaderVariables,
-    locale: string
-  ): WhatsappTemplateComponentHeader {
-    return {
-      type: WhatsAppTemplateComponentType.HEADER,
-      parameters: [
-        {
-          type: WhatsAppTemplateParameterType.IMAGE,
-          image: {
-            link:
-              headerVariables.media?.find(m => m.locale === locale)?.file || '',
-          },
-        },
-      ],
-    }
-  }
-
-  private createHeaderVideoComponent(
-    headerVariables: HeaderVariables,
-    locale: string
-  ): WhatsappTemplateComponentHeader {
-    return {
-      type: WhatsAppTemplateComponentType.HEADER,
-      parameters: [
-        {
-          type: WhatsAppTemplateParameterType.VIDEO,
-          video: {
-            link:
-              headerVariables.media?.find(m => m.locale === locale)?.file || '',
-          },
-        },
-      ],
-    }
-  }
-
-  // TODO: To use named variables (contact_info_fields) we need to take it from request.session.user.contact_info, this only be able in toBotonic method
-  private getBodyComponent(
-    variableValues: Record<string, string>,
-    request: ActionRequest
-  ): WhatsappTemplateComponentBody {
-    return {
-      type: WhatsAppTemplateComponentType.BODY,
-      parameters: Object.entries(variableValues).map(([key, value]) => {
-        const valueVariable = this.replaceVariables(value, request)
-        return {
-          type: WhatsAppTemplateParameterType.TEXT,
-          parameter_name: key,
-          text: valueVariable,
-        }
-      }),
-    }
-  }
-
-  private getButtons(
-    whatsappTemplate: HtWhatsAppTemplate,
-    buttonNodes: HtButton[],
-    urlVariableValues: Record<string, string>,
-    request: ActionRequest
-  ): WhatsappTemplateComponentButtons | undefined {
-    const htWhatsappTemplateButtons = whatsappTemplate.components.find(
-      component => component.type === WhatsAppTemplateComponentType.BUTTONS
-    ) as HtWhatsAppTemplateButtonsComponent | undefined
-
-    if (htWhatsappTemplateButtons) {
-      const buttons = htWhatsappTemplateButtons.buttons
-        .map((button, index) => {
-          if (button.type === WhatsAppTemplateButtonSubType.URL) {
-            const urlParam: string | undefined =
-              urlVariableValues?.[String(index)]
-            if (!urlParam) {
-              return null
-            }
-            return this.createUrlButtonComponent(index, urlParam, request)
-          }
-
-          if (button.type === WhatsAppTemplateButtonSubType.QUICK_REPLY) {
-            const payload = buttonNodes[index].target?.id || ''
-            return this.createQuickReplyButtonComponent(index, payload)
-          }
-
-          return this.createVoiceCallButtonComponent(index)
-        })
-        .filter(button => button !== null)
-
-      return {
-        type: WhatsAppTemplateComponentType.BUTTONS,
-        buttons: buttons as WhatsappTemplateButton[],
-      }
-    }
-
-    return undefined
-  }
-
-  private createUrlButtonComponent(
-    index: number,
-    urlParam: string,
-    request: ActionRequest
-  ): WhatsappTemplateUrlButton {
-    const variableUrlParam = this.replaceVariables(urlParam, request)
-    return {
-      type: WhatsAppTemplateComponentType.BUTTON,
-      sub_type: WhatsAppTemplateButtonSubType.URL,
-      index: index,
-      parameters: urlParam
-        ? [
-            {
-              type: WhatsAppTemplateParameterType.TEXT,
-              text: variableUrlParam,
-            },
-          ]
-        : [],
-    }
-  }
-
-  private createQuickReplyButtonComponent(
-    index: number,
-    payload: string
-  ): WhatsappTemplateQuickReplyButton {
-    return {
-      type: WhatsAppTemplateComponentType.BUTTON,
-      sub_type: WhatsAppTemplateButtonSubType.QUICK_REPLY,
-      index: index,
-      parameters: [
-        {
-          type: WhatsAppTemplateParameterType.PAYLOAD,
-          payload: payload,
-        },
-      ],
-    }
-  }
-
-  private createVoiceCallButtonComponent(
-    index: number
-  ): WhatsappTemplateVoiceCallButton {
-    return {
-      type: WhatsAppTemplateComponentType.BUTTON,
-      sub_type: WhatsAppTemplateButtonSubType.VOICE_CALL,
-      index: index,
-      parameters: [],
-    }
-  }
-
-  async trackFlow(request: ActionRequest): Promise<void> {
-    await trackOneContent(request, this)
-  }
-
-  toBotonic(id: string, request: ActionRequest): JSX.Element {
-    const templateName = this.htWhatsappTemplate.name
-    const templateLanguage = this.htWhatsappTemplate.language
-    const body = this.getBodyComponent(this.variableValues, request)
-    const pluginFlowBuilder = getFlowBuilderPlugin(request.plugins)
-    const resolvedLocale = pluginFlowBuilder.cmsApi.getResolvedLocale()
-
-    const header = this.getHeaderComponent(
-      this.htWhatsappTemplate,
-      this.headerVariables || ({} as HeaderVariables),
-      resolvedLocale,
-      request
-    )
-    const buttons = this.getButtons(
-      this.htWhatsappTemplate,
-      this.buttons || [],
-      this.urlVariableValues || {},
-      request
-    )
-
-    if (isWhatsapp(request.session)) {
-      return (
-        <WhatsappTemplate
-          key={id}
-          name={templateName}
-          language={templateLanguage}
-          header={header}
-          body={body}
-          buttons={buttons}
-        />
-      )
-    }
-
-    return (
-      <Text key={id}>
-        {`WhatsApp Template: ${templateName} (${templateLanguage})`}
-        {header && `${JSON.stringify(header, null, 2)}`}
-        {body && `${JSON.stringify(body, null, 2)}`}
-        {buttons && `${JSON.stringify(buttons, null, 2)}`}
-      </Text>
-    )
-  }
-}

package/src/content-fields/hubtype-fields/ai-agent.ts

@@ -1,22 +0,0 @@
-import type { VerbosityLevel } from '@botonic/core'
-import type { HtBaseNode } from './common'
-import type { HtNodeWithContentType } from './node-types'
-
-export interface HtInputGuardrailRule {
-  name: string
-  description: string
-  is_active: boolean
-}
-
-export interface HtAiAgentNode extends HtBaseNode {
-  type: HtNodeWithContentType.AI_AGENT
-  content: {
-    name: string
-    instructions: string
-    model: string
-    verbosity: VerbosityLevel
-    active_tools?: { name: string }[]
-    input_guardrail_rules?: HtInputGuardrailRule[]
-    sources?: { id: string; name: string }[]
-  }
-}

package/src/content-fields/hubtype-fields/bot-action.ts

@@ -1,11 +0,0 @@
-import type { HtBaseNode } from './common'
-import type { HtNodeWithContentType } from './node-types'
-
-export interface HtBotActionNode extends HtBaseNode {
-  id: string
-  type: HtNodeWithContentType.BOT_ACTION
-  content: {
-    payload_id: string
-    payload_params?: string
-  }
-}

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

@@ -1,9 +0,0 @@
-import type { HtNodeLink, HtTextLocale, HtUrlLocale } from './common'
-
-export interface HtButton {
-  id: string
-  text: HtTextLocale[]
-  url: HtUrlLocale[]
-  target?: HtNodeLink
-  hidden: string[]
-}

package/src/content-fields/hubtype-fields/capture-user-input.ts

@@ -1,21 +0,0 @@
-import type { HtBaseNode, HtNodeLink } from './common'
-import type { HtNodeWithContentType } from './node-types'
-
-export enum HtAiValidationType {
-  NONE = 'none',
-  NAME = 'name',
-  EMAIL = 'email',
-  PHONE = 'phone',
-  CUSTOM = 'custom',
-}
-
-export interface HtCaptureUserInputNode extends HtBaseNode {
-  type: HtNodeWithContentType.CAPTURE_USER_INPUT
-  content: {
-    field_name: string
-    ai_validation_type?: HtAiValidationType
-    ai_validation_instructions?: string
-    capture_success: HtNodeLink
-    capture_fail: HtNodeLink
-  }
-}

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

@@ -1,19 +0,0 @@
-import type { HtButton } from './button'
-import type { HtBaseNode, HtMediaFileLocale, HtTextLocale } from './common'
-import type { HtNodeWithContentType } from './node-types'
-
-export interface HtCarouselElement {
-  id: string
-  title: HtTextLocale[]
-  subtitle: HtTextLocale[]
-  image: HtMediaFileLocale[]
-  button: HtButton
-}
-
-export interface HtCarouselNode extends HtBaseNode {
-  type: HtNodeWithContentType.CAROUSEL
-  content: {
-    whatsapp_text: HtTextLocale[]
-    elements: HtCarouselElement[]
-  }
-}

package/src/content-fields/hubtype-fields/channel-conditional.ts

@@ -1,11 +0,0 @@
-import type { HtBaseNode } from './common'
-import type { HtFunctionResult } from './function'
-import type { HtNodeWithContentType } from './node-types'
-
-export interface HtChannelConditionalNode extends HtBaseNode {
-  type: HtNodeWithContentType.FUNCTION
-  content: {
-    action: string //'get-channel-type'
-    result_mapping: HtFunctionResult[]
-  }
-}

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

@@ -1,94 +0,0 @@
-import type {
-  HtNodeWithContentType,
-  HtNodeWithoutContentType,
-} from './node-types'
-import type { HtNodeComponent } from './nodes'
-
-export interface HtFlowBuilderData {
-  version: string
-  name: string
-  locales: string[]
-  default_locale_code: string
-  start_node_id?: string
-  ai_model_id?: string
-  is_knowledge_base_active?: boolean
-  is_ai_agent_active?: boolean
-  nodes: HtNodeComponent[]
-  flows: HtFlows[]
-  webviews: HtFlowWebview[]
-  campaigns: HtCampaign[]
-}
-
-export interface HtFlows {
-  id: string
-  name: string
-  start_node_id: string
-}
-
-export interface HtFlowWebview {
-  id: string
-  name: string
-  component_name: string
-}
-
-export interface HtCampaign {
-  id: string
-  name: string
-  start_node_id: string
-}
-
-export interface HtNodeLink {
-  id: string
-  type: HtNodeWithContentType | HtNodeWithoutContentType
-}
-
-export interface HtBaseNode {
-  id: string
-  code: string
-  meta: {
-    x: number
-    y: number
-  }
-  follow_up?: HtNodeLink
-  target?: HtNodeLink
-  flow_id: string // TODO: Review if this field is necessary in all HtBaseNode
-  is_meaningful?: boolean
-}
-
-export interface HtTextLocale {
-  message: string
-  locale: string
-}
-
-export interface HtMediaFileLocale {
-  id: string
-  file: string
-  locale: string
-}
-
-export interface HtVideoLocale {
-  url: string
-  is_embedded: boolean
-  locale: string
-}
-
-export interface HtQueueLocale {
-  id: string
-  name: string
-  locale: string
-}
-
-export interface HtInputLocale {
-  values: string[]
-  locale: string
-}
-
-export interface HtUrlLocale {
-  id: string
-  locale: string
-}
-
-export interface HtPayloadLocale {
-  id: string
-  locale: string
-}

package/src/content-fields/hubtype-fields/country-conditional.ts

@@ -1,11 +0,0 @@
-import type { HtBaseNode } from './common'
-import type { HtFunctionResult } from './function'
-import type { HtNodeWithContentType } from './node-types'
-
-export interface HtCountryConditionalNode extends HtBaseNode {
-  type: HtNodeWithContentType.FUNCTION
-  content: {
-    action: string //'check-country'
-    result_mapping: HtFunctionResult[]
-  }
-}

package/src/content-fields/hubtype-fields/custom-conditional.ts

@@ -1,12 +0,0 @@
-import type { HtBaseNode } from './common'
-import type { HtFunctionArguments, HtFunctionResult } from './function'
-import type { HtNodeWithContentType } from './node-types'
-
-export interface HtCustomConditionalNode extends HtBaseNode {
-  type: HtNodeWithContentType.FUNCTION
-  content: {
-    action: string //'check-bot-variable'
-    arguments: HtFunctionArguments[]
-    result_mapping: HtFunctionResult[]
-  }
-}

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

@@ -1,12 +0,0 @@
-import type { HtBaseNode, HtNodeLink } from './common'
-import type { HtNodeWithContentType } from './node-types'
-
-export interface HtFallbackNode extends HtBaseNode {
-  type: HtNodeWithContentType.FALLBACK
-  content: {
-    first_message?: HtNodeLink
-    second_message?: HtNodeLink
-    knowledge_base_followup?: HtNodeLink
-    is_knowledge_base_active?: boolean
-  }
-}

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

@@ -1,36 +0,0 @@
-import type { HtBaseNode, HtNodeLink } from './common'
-import type { HtNodeWithContentType } from './node-types'
-
-export enum HtArgumentType {
-  BOOLEAN = 'boolean',
-  NUMBER = 'number',
-  STRING = 'string',
-  JSON = 'json',
-}
-
-export interface HtFunctionArgument {
-  type: HtArgumentType
-  name: string
-  value: string
-}
-
-export interface HtFunctionArgumentLocale {
-  locale: string
-  values: HtFunctionArgument[]
-}
-
-export interface HtFunctionResult {
-  result: string | boolean | number
-  target?: HtNodeLink
-}
-
-export type HtFunctionArguments = HtFunctionArgumentLocale | HtFunctionArgument
-
-export interface HtFunctionNode extends HtBaseNode {
-  type: HtNodeWithContentType.FUNCTION
-  content: {
-    action: string
-    arguments: HtFunctionArguments[]
-    result_mapping: HtFunctionResult[]
-  }
-}

package/src/content-fields/hubtype-fields/go-to-flow.ts

@@ -1,10 +0,0 @@
-import type { HtBaseNode } from './common'
-import type { HtNodeWithContentType } from './node-types'
-
-export interface HtGoToFlow extends HtBaseNode {
-  id: string
-  type: HtNodeWithContentType.GO_TO_FLOW
-  content: {
-    flow_id: string
-  }
-}

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

@@ -1,12 +0,0 @@
-import type { HtBaseNode, HtPayloadLocale, HtQueueLocale } from './common'
-import type { HtNodeWithContentType } from './node-types'
-
-export interface HtHandoffNode extends HtBaseNode {
-  type: HtNodeWithContentType.HANDOFF
-  content: {
-    queue: HtQueueLocale[]
-    payload: HtPayloadLocale[]
-    has_auto_assign: boolean
-    has_queue_position_changed_notifications_enabled: boolean
-  }
-}

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

@@ -1,9 +0,0 @@
-import type { HtBaseNode, HtMediaFileLocale } from './common'
-import type { HtNodeWithContentType } from './node-types'
-
-export interface HtImageNode extends HtBaseNode {
-  type: HtNodeWithContentType.IMAGE
-  content: {
-    image: HtMediaFileLocale[]
-  }
-}

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

@@ -1,24 +0,0 @@
-export * from './bot-action'
-export * from './button'
-export * from './capture-user-input'
-export * from './carousel'
-export * from './common'
-export * from './fallback'
-export * from './function'
-export * from './go-to-flow'
-export * from './handoff'
-export * from './image'
-export * from './keyword'
-export * from './knowledge-base'
-export * from './node-types'
-export * from './nodes'
-export * from './payload'
-export * from './rating'
-export * from './smart-intent'
-export * from './text'
-export * from './url'
-export * from './video'
-export * from './webview'
-export * from './whatsapp-button-list'
-export * from './whatsapp-cta-url-button'
-export * from './whatsapp-template'

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

@@ -1,10 +0,0 @@
-import type { HtBaseNode, HtInputLocale, HtTextLocale } from './common'
-import type { HtNodeWithContentType } from './node-types'
-
-export interface HtKeywordNode extends HtBaseNode {
-  type: HtNodeWithContentType.KEYWORD
-  content: {
-    title: HtTextLocale[]
-    keywords: HtInputLocale[]
-  }
-}

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

@@ -1,18 +0,0 @@
-import type { HtBaseNode } from './common'
-import type { HtNodeWithContentType } from './node-types'
-
-interface SourceData {
-  id: string
-  name: string
-}
-
-export interface HtKnowledgeBaseNode extends HtBaseNode {
-  type: HtNodeWithContentType.KNOWLEDGE_BASE
-  content: {
-    feedback_enabled: boolean
-    sources_data: SourceData[]
-    instructions: string
-    has_memory: boolean
-    memory_length?: number
-  }
-}