@botonic/plugin-flow-builder 0.46.1 → 2.23.0

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

@@ -1,31 +0,0 @@
-export enum HtNodeWithContentType {
-  CAROUSEL = 'carousel',
-  HANDOFF = 'handoff',
-  IMAGE = 'image',
-  TEXT = 'text',
-  KEYWORD = 'keyword',
-  SMART_INTENT = 'smart-intent',
-  FUNCTION = 'function',
-  FALLBACK = 'fallback',
-  VIDEO = 'video',
-  WHATSAPP_BUTTON_LIST = 'whatsapp-button-list',
-  WHATSAPP_CTA_URL_BUTTON = 'whatsapp-cta-url-button',
-  WHATSAPP_TEMPLATE = 'whatsapp-template',
-  KNOWLEDGE_BASE = 'knowledge-base',
-  BOT_ACTION = 'bot-action',
-  AI_AGENT = 'ai-agent',
-  RATING = 'rating',
-  WEBVIEW = 'webview',
-  GO_TO_FLOW = 'go-to-flow',
-  CAPTURE_USER_INPUT = 'capture-user-input',
-}
-
-export enum HtNodeWithoutContentType {
-  URL = 'url',
-  PAYLOAD = 'payload',
-}
-
-export enum HtButtonStyle {
-  BUTTON = 'button',
-  QUICK_REPLY = 'quick-reply',
-}

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

@@ -1,54 +0,0 @@
-import type { HtAiAgentNode } from './ai-agent'
-import type { HtBotActionNode } from './bot-action'
-import type { HtCaptureUserInputNode } from './capture-user-input'
-import type { HtCarouselNode } from './carousel'
-// import { HtChannelConditionalNode } from './channel-conditional'
-// import { HtCountryConditionalNode } from './country-conditional'
-// import { HtCustomConditionalNode } from './custom-conditional'
-import type { HtFallbackNode } from './fallback'
-import type { HtFunctionNode } from './function'
-import type { HtGoToFlow } from './go-to-flow'
-import type { HtHandoffNode } from './handoff'
-import type { HtImageNode } from './image'
-import type { HtKeywordNode } from './keyword'
-import type { HtKnowledgeBaseNode } from './knowledge-base'
-import type { HtPayloadNode } from './payload'
-// import { HtQueueStatusConditionalNode } from './queue-status-conditional'
-import type { HtRatingNode } from './rating'
-import type { HtSmartIntentNode } from './smart-intent'
-import type { HtTextNode } from './text'
-import type { HtUrlNode } from './url'
-import type { HtVideoNode } from './video'
-import type { HtWebviewNode } from './webview'
-import type { HtWhatsappButtonListNode } from './whatsapp-button-list'
-import type { HtWhatsappCTAUrlButtonNode } from './whatsapp-cta-url-button'
-import type { HtWhatsappTemplateNode } from './whatsapp-template'
-
-export type HtNodeWithContent =
-  | HtTextNode
-  | HtImageNode
-  | HtVideoNode
-  | HtCarouselNode
-  | HtHandoffNode
-  | HtKeywordNode
-  | HtFunctionNode
-  | HtFallbackNode
-  | HtWhatsappButtonListNode
-  | HtWhatsappCTAUrlButtonNode
-  | HtSmartIntentNode
-  | HtKnowledgeBaseNode
-  | HtBotActionNode
-  | HtAiAgentNode
-  | HtRatingNode
-  | HtWebviewNode
-  | HtGoToFlow
-  | HtWhatsappTemplateNode
-  | HtCaptureUserInputNode
-// | HtChannelConditionalNode
-// | HtCountryConditionalNode
-// | HtCustomConditionalNode
-// | HtQueueStatusConditionalNode
-
-export type HtNodeWithoutContent = HtUrlNode | HtPayloadNode
-
-export type HtNodeComponent = HtNodeWithContent | HtNodeWithoutContent

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

@@ -1,9 +0,0 @@
-import type { HtNodeWithoutContentType } from './node-types'
-
-export interface HtPayloadNode {
-  id: string
-  type: HtNodeWithoutContentType.PAYLOAD
-  content: {
-    payload: string
-  }
-}

package/src/content-fields/hubtype-fields/queue-status-conditional.ts

@@ -1,55 +0,0 @@
-import type { HtBaseNode, HtNodeLink } from './common'
-import type { HtFunctionArguments, HtFunctionResult } from './function'
-import type { HtNodeWithContentType } from './node-types'
-
-/*  TODO: In the future, refactor the conditional nodes so they are not of type FUNCTION and can use type-hints for all exact arguments and results. */
-
-// interface HtQueueArgument {
-//   locale: string
-//   values: [
-//     {
-//       type: 'string'
-//       name: 'queue_id'
-//       value: string
-//     },
-//     {
-//       type: 'string'
-//       name: 'queue_name'
-//       value: string
-//     },
-//   ]
-// }
-
-// interface HtCheckAvailableAgentsArgument {
-//   type: 'boolean'
-//   name: 'check_available_agents'
-//   value: boolean
-// }
-
-// export interface HtQueueStatusConditionalArguments {
-//   values: HtQueueArgument[] | HtCheckAvailableAgentsArgument[]
-// }
-
-export type HtQueueStatusConditionalResultMapping = [
-  {
-    result: 'open'
-    target: HtNodeLink
-  },
-  {
-    result: 'closed'
-    target: HtNodeLink
-  },
-  {
-    result: 'open-without-agents'
-    target: HtNodeLink
-  },
-]
-
-export interface HtQueueStatusConditionalNode extends HtBaseNode {
-  type: HtNodeWithContentType.FUNCTION
-  content: {
-    action: string //'get-channel-type'
-    arguments: HtFunctionArguments[]
-    result_mapping: HtFunctionResult[]
-  }
-}

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

@@ -1,26 +0,0 @@
-import type { HtBaseNode, HtNodeLink, HtTextLocale } from './common'
-import type { HtNodeWithContentType } from './node-types'
-
-export enum RatingType {
-  Stars = 'stars',
-  Smileys = 'smileys',
-}
-
-export interface HtRatingButton {
-  id: string
-  text: string
-  payload: string
-  value: number
-  target?: HtNodeLink
-}
-
-export interface HtRatingNode extends HtBaseNode {
-  type: HtNodeWithContentType.RATING
-  content: {
-    text: HtTextLocale[]
-    buttons: HtRatingButton[]
-    rating_type: RatingType
-    send_button_text: HtTextLocale[]
-    open_list_button_text: HtTextLocale[]
-  }
-}

package/src/content-fields/hubtype-fields/smart-intent.ts

@@ -1,12 +0,0 @@
-import type { HtBaseNode } from './common'
-import type { HtNodeWithContentType } from './node-types'
-
-interface SmartIntent {
-  title: string
-  description: string
-}
-
-export interface HtSmartIntentNode extends HtBaseNode {
-  type: HtNodeWithContentType.SMART_INTENT
-  content: SmartIntent
-}

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

@@ -1,12 +0,0 @@
-import type { HtButton } from './button'
-import type { HtBaseNode, HtTextLocale } from './common'
-import type { HtButtonStyle, HtNodeWithContentType } from './node-types'
-
-export interface HtTextNode extends HtBaseNode {
-  type: HtNodeWithContentType.TEXT
-  content: {
-    text: HtTextLocale[]
-    buttons_style?: HtButtonStyle
-    buttons: HtButton[]
-  }
-}

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

@@ -1,9 +0,0 @@
-import type { HtNodeWithoutContentType } from './node-types'
-
-export interface HtUrlNode {
-  id: string
-  type: HtNodeWithoutContentType.URL
-  content: {
-    url: string
-  }
-}

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

@@ -1,9 +0,0 @@
-import type { HtBaseNode, HtVideoLocale } from './common'
-import type { HtNodeWithContentType } from './node-types'
-
-export interface HtVideoNode extends HtBaseNode {
-  type: HtNodeWithContentType.VIDEO
-  content: {
-    video: HtVideoLocale[]
-  }
-}

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

@@ -1,18 +0,0 @@
-import type { HtBaseNode, HtNodeLink } from './common'
-import type { HtNodeWithContentType } from './node-types'
-
-export interface HtWebviewExits {
-  id: string
-  name: string
-  target?: HtNodeLink
-}
-
-export interface HtWebviewNode extends HtBaseNode {
-  type: HtNodeWithContentType.WEBVIEW
-  content: {
-    webview_target_id: string
-    webview_name: string
-    webview_component_name: string
-    exits: HtWebviewExits[]
-  }
-}

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

@@ -1,25 +0,0 @@
-/* eslint-disable @typescript-eslint/naming-convention */
-import type { HtBaseNode, HtNodeLink, HtTextLocale } from './common'
-import type { HtNodeWithContentType } from './node-types'
-
-export interface HtWhatsappButtonListRow {
-  id: string
-  text: HtTextLocale[]
-  description: HtTextLocale[]
-  target?: HtNodeLink
-}
-
-export interface HtWhatsappButtonListSection {
-  id: string
-  title: HtTextLocale[]
-  rows: HtWhatsappButtonListRow[]
-}
-
-export interface HtWhatsappButtonListNode extends HtBaseNode {
-  type: HtNodeWithContentType.WHATSAPP_BUTTON_LIST
-  content: {
-    text: HtTextLocale[]
-    button_text: HtTextLocale[]
-    sections: HtWhatsappButtonListSection[]
-  }
-}

package/src/content-fields/hubtype-fields/whatsapp-cta-url-button.ts

@@ -1,19 +0,0 @@
-import type { WhatsappCTAUrlHeaderType } from '@botonic/react'
-
-import type { HtButton } from './button'
-import type { HtBaseNode, HtMediaFileLocale, HtTextLocale } from './common'
-import type { HtNodeWithContentType } from './node-types'
-
-export interface HtWhatsappCTAUrlButtonNode extends HtBaseNode {
-  type: HtNodeWithContentType.WHATSAPP_CTA_URL_BUTTON
-  content: {
-    text: HtTextLocale[]
-    header: HtTextLocale[]
-    header_type?: WhatsappCTAUrlHeaderType
-    header_image?: HtMediaFileLocale[]
-    header_video?: HtMediaFileLocale[]
-    header_document?: HtMediaFileLocale[]
-    footer: HtTextLocale[]
-    button: HtButton
-  }
-}

package/src/content-fields/hubtype-fields/whatsapp-template.ts

@@ -1,90 +0,0 @@
-import type {
-  WhatsAppTemplateButtonSubType,
-  WhatsAppTemplateComponentType,
-  WhatsAppTemplateParameterType,
-} from '@botonic/react'
-
-import type { HtButton } from './button'
-import type { HtBaseNode, HtMediaFileLocale } from './common'
-import type { HtNodeWithContentType } from './node-types'
-
-type HtWhatsAppTemplateButton =
-  | {
-      type: WhatsAppTemplateButtonSubType.URL
-      text: string
-      url?: string
-      index: number
-    }
-  | {
-      type: WhatsAppTemplateButtonSubType.QUICK_REPLY
-      text: string
-      id: string
-      index: number
-    }
-  | {
-      type: WhatsAppTemplateButtonSubType.PHONE_NUMBER
-      text: string
-      phone_number: string
-      index: number
-    }
-
-export interface HtWhatsAppTemplateHeaderComponent {
-  type: WhatsAppTemplateComponentType.HEADER
-  format:
-    | WhatsAppTemplateParameterType.TEXT
-    | WhatsAppTemplateParameterType.IMAGE
-    | WhatsAppTemplateParameterType.VIDEO
-  text?: string
-  image?: { link: string }
-  video?: { link: string }
-}
-
-export interface HtWhatsAppTemplateBodyComponent {
-  type: WhatsAppTemplateComponentType.BODY
-  text: string
-}
-
-export interface HtWhatsAppTemplateFooterComponent {
-  type: WhatsAppTemplateComponentType.FOOTER
-  text: string
-}
-
-export interface HtWhatsAppTemplateButtonsComponent {
-  type: WhatsAppTemplateComponentType.BUTTONS
-  buttons: HtWhatsAppTemplateButton[]
-}
-export type HtWhatsAppTemplateComponent =
-  | HtWhatsAppTemplateHeaderComponent
-  | HtWhatsAppTemplateBodyComponent
-  | HtWhatsAppTemplateFooterComponent
-  | HtWhatsAppTemplateButtonsComponent
-
-export interface HtWhatsAppTemplate {
-  id: string
-  name: string
-  language: string
-  status: string
-  category: string
-  components: HtWhatsAppTemplateComponent[]
-  namespace: string
-  parameter_format: string
-}
-
-export interface HtWhatsappTemplateContentByLocale {
-  template: HtWhatsAppTemplate
-  header_variables?: {
-    type: WhatsAppTemplateParameterType
-    text?: Record<string, string>
-    media?: HtMediaFileLocale[]
-  }
-  variable_values: Record<string, string>
-  url_variable_values?: Record<string, string>
-}
-
-export interface HtWhatsappTemplateNode extends HtBaseNode {
-  type: HtNodeWithContentType.WHATSAPP_TEMPLATE
-  content: {
-    by_locale: Record<string, HtWhatsappTemplateContentByLocale>
-    buttons: HtButton[]
-  }
-}

package/src/content-fields/index.ts

@@ -1,67 +0,0 @@
-import { FlowAiAgent } from './flow-ai-agent'
-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 { FlowCountryConditional } from './flow-country-conditional'
-import { FlowCustomConditional } from './flow-custom-conditional'
-import { FlowGoToFlow } from './flow-go-to-flow'
-import { FlowHandoff } from './flow-handoff'
-import { FlowImage } from './flow-image'
-import {
-  DISABLED_MEMORY_LENGTH,
-  FlowKnowledgeBase,
-} from './flow-knowledge-base'
-import { FlowQueueStatusConditional } from './flow-queue-status-conditional'
-import { FlowRating } from './flow-rating'
-import { FlowText } from './flow-text'
-import { FlowVideo } from './flow-video'
-import { FlowWhatsappCtaUrlButtonNode } from './flow-whatsapp-cta-url-button'
-import { FlowWhatsappTemplate } from './flow-whatsapp-template'
-import { FlowWhatsappButtonList } from './whatsapp-button-list/flow-whatsapp-button-list'
-
-export { ContentFieldsBase } from './content-fields-base'
-export { FlowButton } from './flow-button'
-export { FlowElement } from './flow-element'
-export {
-  FlowAiAgent,
-  FlowBotAction,
-  FlowCaptureUserInput,
-  FlowCarousel,
-  FlowChannelConditional,
-  FlowCountryConditional,
-  FlowCustomConditional,
-  FlowGoToFlow,
-  FlowHandoff,
-  FlowImage,
-  FlowKnowledgeBase,
-  FlowQueueStatusConditional,
-  FlowRating,
-  FlowText,
-  FlowVideo,
-  FlowWhatsappButtonList,
-  FlowWhatsappCtaUrlButtonNode,
-  FlowWhatsappTemplate,
-}
-
-export type FlowContent =
-  | FlowCarousel
-  | FlowImage
-  | FlowText
-  | FlowVideo
-  | FlowWhatsappButtonList
-  | FlowWhatsappCtaUrlButtonNode
-  | FlowWhatsappTemplate
-  | FlowHandoff
-  | FlowKnowledgeBase
-  | FlowBotAction
-  | FlowAiAgent
-  | FlowRating
-  | FlowCountryConditional
-  | FlowChannelConditional
-  | FlowQueueStatusConditional
-  | FlowCustomConditional
-  | FlowGoToFlow
-  | FlowCaptureUserInput
-
-export { DISABLED_MEMORY_LENGTH }

package/src/content-fields/whatsapp-button-list/flow-whatsapp-button-list-row.tsx

@@ -1,55 +0,0 @@
-import type { ActionRequest, WhatsappButtonListRowProps } from '@botonic/react'
-
-import type { FlowBuilderApi } from '../../api'
-import { SOURCE_INFO_SEPARATOR } from '../../constants'
-import { ContentFieldsBase } from '../content-fields-base'
-import type { HtWhatsappButtonListRow } from '../hubtype-fields'
-
-export class FlowWhatsappButtonListRow extends ContentFieldsBase {
-  public title = ''
-  public description = ''
-  public targetId?: string
-
-  static fromHubtypeCMS(
-    component: HtWhatsappButtonListRow,
-    locale: string,
-    cmsApi: FlowBuilderApi
-  ): FlowWhatsappButtonListRow {
-    const newRow = new FlowWhatsappButtonListRow(component.id)
-    newRow.title = FlowWhatsappButtonListRow.getTextByLocale(
-      locale,
-      component.text
-    )
-    newRow.description = FlowWhatsappButtonListRow.getTextByLocale(
-      locale,
-      component.description
-    )
-    newRow.targetId = cmsApi.getPayload(component.target)
-
-    return newRow
-  }
-
-  // eslint-disable-next-line @typescript-eslint/no-unused-vars
-  async trackFlow(_request: ActionRequest): Promise<void> {
-    // Not apply for this content, because it is a child of the FlowWhatsappButtonList content
-  }
-
-  toBotonic(
-    rowIndex: number,
-    sectionIndex: number
-  ): WhatsappButtonListRowProps | undefined {
-    if (!this.targetId) {
-      console.error(`Row with title: '${this.title}' has no target`)
-      return undefined
-    }
-    return {
-      id: this.getRowId(rowIndex, sectionIndex),
-      title: this.title,
-      description: this.description,
-    }
-  }
-
-  private getRowId(rowIndex: number, sectionIndex: number): string {
-    return `${this.targetId}${SOURCE_INFO_SEPARATOR}${sectionIndex}.${rowIndex}`
-  }
-}

package/src/content-fields/whatsapp-button-list/flow-whatsapp-button-list-section.tsx

@@ -1,51 +0,0 @@
-import type {
-  ActionRequest,
-  WhatsappButtonListRowProps,
-  WhatsappButtonListSectionProps,
-} from '@botonic/react'
-
-import type { FlowBuilderApi } from '../../api'
-import { ContentFieldsBase } from '../content-fields-base'
-import type { HtWhatsappButtonListSection } from '../hubtype-fields'
-import { FlowWhatsappButtonListRow } from './flow-whatsapp-button-list-row'
-
-export class FlowWhatsappButtonListSection extends ContentFieldsBase {
-  public title = ''
-  public rows: FlowWhatsappButtonListRow[] = []
-
-  static fromHubtypeCMS(
-    component: HtWhatsappButtonListSection,
-    locale: string,
-    cmsApi: FlowBuilderApi
-  ): FlowWhatsappButtonListSection {
-    const newButton = new FlowWhatsappButtonListSection(component.id)
-    newButton.title = FlowWhatsappButtonListSection.getTextByLocale(
-      locale,
-      component.title
-    )
-    newButton.rows = component.rows.map(row =>
-      FlowWhatsappButtonListRow.fromHubtypeCMS(row, locale, cmsApi)
-    )
-    return newButton
-  }
-
-  // eslint-disable-next-line @typescript-eslint/no-unused-vars
-  async trackFlow(_request: ActionRequest): Promise<void> {
-    // Not apply for this content, because it is a child of the FlowWhatsappButtonList content
-  }
-
-  toBotonic(sectionIndex: number): WhatsappButtonListSectionProps {
-    const rows = this.rows.reduce(
-      (acc: WhatsappButtonListRowProps[], row, rowIndex) => {
-        const botonicRow = row.toBotonic(rowIndex, sectionIndex)
-        if (botonicRow) {
-          acc.push(botonicRow)
-        }
-        return acc
-      },
-      []
-    )
-
-    return { title: this.title, rows }
-  }
-}

package/src/content-fields/whatsapp-button-list/flow-whatsapp-button-list.tsx

@@ -1,78 +0,0 @@
-import { isWhatsapp } from '@botonic/core'
-import {
-  type ActionRequest,
-  Button,
-  Text,
-  WhatsappButtonList,
-} from '@botonic/react'
-
-import type { FlowBuilderApi } from '../../api'
-import { trackOneContent } from '../../tracking'
-import { ContentFieldsBase } from '../content-fields-base'
-import type { HtWhatsappButtonListNode } from '../hubtype-fields'
-import { FlowWhatsappButtonListSection } from './flow-whatsapp-button-list-section'
-
-export class FlowWhatsappButtonList extends ContentFieldsBase {
-  public text = ''
-  public listButtonText = ''
-  public sections: FlowWhatsappButtonListSection[] = []
-
-  static fromHubtypeCMS(
-    component: HtWhatsappButtonListNode,
-    locale: string,
-    cmsApi: FlowBuilderApi
-  ): FlowWhatsappButtonList {
-    const newWhatsappButtonList = new FlowWhatsappButtonList(component.id)
-    newWhatsappButtonList.code = component.code
-    newWhatsappButtonList.text = FlowWhatsappButtonList.getTextByLocale(
-      locale,
-      component.content.text
-    )
-    newWhatsappButtonList.listButtonText =
-      FlowWhatsappButtonList.getTextByLocale(
-        locale,
-        component.content.button_text
-      )
-    newWhatsappButtonList.sections = component.content.sections.map(section =>
-      FlowWhatsappButtonListSection.fromHubtypeCMS(section, locale, cmsApi)
-    )
-    newWhatsappButtonList.followUp = component.follow_up
-
-    return newWhatsappButtonList
-  }
-
-  async trackFlow(request: ActionRequest): Promise<void> {
-    await trackOneContent(request, this)
-  }
-
-  toBotonic(id: string, request: ActionRequest): JSX.Element {
-    const replacedText = this.replaceVariables(this.text, request)
-
-    if (!isWhatsapp(request.session)) {
-      const rows = this.sections.flatMap(section => section.rows)
-      const buttons = rows.map(row => (
-        <Button key={row.id} payload={row.targetId}>
-          {row.title}
-        </Button>
-      ))
-
-      return (
-        <Text>
-          {replacedText}
-          {buttons}
-        </Text>
-      )
-    }
-
-    return (
-      <WhatsappButtonList
-        key={id}
-        body={replacedText}
-        button={this.listButtonText}
-        sections={this.sections.map((section, sectionIndex) =>
-          section.toBotonic(sectionIndex)
-        )}
-      ></WhatsappButtonList>
-    )
-  }
-}

package/src/filters/index.ts

@@ -1,27 +0,0 @@
-import type { BotContext } from '@botonic/core'
-
-import type { FlowContent } from '../content-fields'
-import type { ContentFilter } from '../types'
-
-interface ContentFilterExecutorOptions {
-  filters: ContentFilter[]
-}
-
-export class ContentFilterExecutor {
-  private filters: ContentFilter[] = []
-
-  constructor(options: ContentFilterExecutorOptions) {
-    this.filters = options.filters
-  }
-
-  async filter(
-    request: BotContext,
-    content: FlowContent
-  ): Promise<FlowContent> {
-    for (const filter of this.filters) {
-      content = await filter(request, content)
-    }
-
-    return content
-  }
-}