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

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
+  }
 }

package/lib/action/ai-agent-from-user-input.d.ts

@@ -1,3 +0,0 @@
-import type { FlowContent } from '../content-fields/index.js';
-import type { FlowBuilderContext } from './context.js';
-export declare function getContentsByAiAgentFromUserInput({ cmsApi, flowBuilderPlugin, request, }: FlowBuilderContext): Promise<FlowContent[]>;

package/lib/action/ai-agent-from-user-input.js

@@ -1,35 +0,0 @@
-import { splitAiAgentContents } from "../utils/ai-agent.js";
-
-
-
-async function getContentsByAiAgentFromUserInput({ cmsApi, flowBuilderPlugin, request }) {
-    const startNodeAiAgentFlow = cmsApi.getStartNodeAiAgentFlow();
-    const isAiAgentEnabled = cmsApi.isAiAgentEnabled();
-    if (!startNodeAiAgentFlow || !isAiAgentEnabled) {
-        return [];
-    }
-    const contents = await flowBuilderPlugin.getContentsByNode(startNodeAiAgentFlow);
-    const splitContents = splitAiAgentContents(contents);
-    if (!splitContents) {
-        return [];
-    }
-    if ('aiAgentRouterContent' in splitContents) {
-        const { aiAgentRouterContent, contentsBeforeAiAgentRouter } = splitContents;
-        const aiAgentResponse = await aiAgentRouterContent.resolveAIAgentResponse(request, contentsBeforeAiAgentRouter);
-        if (!aiAgentResponse || aiAgentResponse.exit) {
-            return [];
-        }
-    }
-    if ('aiAgentWorkerContent' in splitContents) {
-        const { aiAgentWorkerContent, contentsBeforeAiAgentWorker } = splitContents;
-        const aiAgentResponse = await aiAgentWorkerContent.resolveAIAgentResponse(request, contentsBeforeAiAgentWorker);
-        if (!aiAgentResponse || aiAgentResponse.exit) {
-            return [];
-        }
-    }
-    return contents;
-}
-
-export { getContentsByAiAgentFromUserInput };
-
-//# sourceMappingURL=ai-agent-from-user-input.js.map

package/lib/action/ai-agent-from-user-input.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"action/ai-agent-from-user-input.js","sources":["../../src/action/ai-agent-from-user-input.ts"],"sourcesContent":["import type { FlowContent } from '../content-fields/index'\nimport { splitAiAgentContents } from '../utils/ai-agent'\nimport type { FlowBuilderContext } from './context'\n\nexport async function getContentsByAiAgentFromUserInput({\n  cmsApi,\n  flowBuilderPlugin,\n  request,\n}: FlowBuilderContext): Promise<FlowContent[]> {\n  const startNodeAiAgentFlow = cmsApi.getStartNodeAiAgentFlow()\n  const isAiAgentEnabled = cmsApi.isAiAgentEnabled()\n  if (!startNodeAiAgentFlow || !isAiAgentEnabled) {\n    return []\n  }\n\n  const contents =\n    await flowBuilderPlugin.getContentsByNode(startNodeAiAgentFlow)\n\n  const splitContents = splitAiAgentContents(contents)\n\n  if (!splitContents) {\n    return []\n  }\n\n  if ('aiAgentRouterContent' in splitContents) {\n    const { aiAgentRouterContent, contentsBeforeAiAgentRouter } = splitContents\n    const aiAgentResponse = await aiAgentRouterContent.resolveAIAgentResponse(\n      request,\n      contentsBeforeAiAgentRouter\n    )\n\n    if (!aiAgentResponse || aiAgentResponse.exit) {\n      return []\n    }\n  }\n\n  if ('aiAgentWorkerContent' in splitContents) {\n    const { aiAgentWorkerContent, contentsBeforeAiAgentWorker } = splitContents\n    const aiAgentResponse = await aiAgentWorkerContent.resolveAIAgentResponse(\n      request,\n      contentsBeforeAiAgentWorker\n    )\n\n    if (!aiAgentResponse || aiAgentResponse.exit) {\n      return []\n    }\n  }\n\n  return contents\n}\n"],"names":["splitAiAgentContents","getContentsByAiAgentFromUserInput","cmsApi","flowBuilderPlugin","request","startNodeAiAgentFlow","isAiAgentEnabled","contents","splitContents","aiAgentRouterContent","contentsBeforeAiAgentRouter","aiAgentResponse","aiAgentWorkerContent","contentsBeforeAiAgentWorker"],"mappings":";;;AACwD;AAGjD,eAAeC,iCAAiCA,CAAC,EACtDC,MAAM,EACNC,iBAAiB,EACjBC,OAAO,EACY;IACnB,MAAMC,uBAAuBH,OAAO,uBAAuB;IAC3D,MAAMI,mBAAmBJ,OAAO,gBAAgB;IAChD,IAAI,CAACG,wBAAwB,CAACC,kBAAkB;QAC9C,OAAO,EAAE;IACX;IAEA,MAAMC,WACJ,MAAMJ,kBAAkB,iBAAiB,CAACE;IAE5C,MAAMG,gBAAgBR,oBAAoBA,CAACO;IAE3C,IAAI,CAACC,eAAe;QAClB,OAAO,EAAE;IACX;IAEA,IAAI,0BAA0BA,eAAe;QAC3C,MAAM,EAAEC,oBAAoB,EAAEC,2BAA2B,EAAE,GAAGF;QAC9D,MAAMG,kBAAkB,MAAMF,qBAAqB,sBAAsB,CACvEL,SACAM;QAGF,IAAI,CAACC,mBAAmBA,gBAAgB,IAAI,EAAE;YAC5C,OAAO,EAAE;QACX;IACF;IAEA,IAAI,0BAA0BH,eAAe;QAC3C,MAAM,EAAEI,oBAAoB,EAAEC,2BAA2B,EAAE,GAAGL;QAC9D,MAAMG,kBAAkB,MAAMC,qBAAqB,sBAAsB,CACvER,SACAS;QAGF,IAAI,CAACF,mBAAmBA,gBAAgB,IAAI,EAAE;YAC5C,OAAO,EAAE;QACX;IACF;IAEA,OAAOJ;AACT"}

package/lib/action/context.d.ts

@@ -1,11 +0,0 @@
-import type { BotContext } from '@botonic/core';
-import type { FlowBuilderApi } from '../api.js';
-import type BotonicPluginFlowBuilder from '../index.js';
-export interface FlowBuilderContext {
-    cmsApi: FlowBuilderApi;
-    flowBuilderPlugin: BotonicPluginFlowBuilder;
-    request: BotContext;
-    resolvedLocale: string;
-    contentID?: string;
-}
-export declare function getFlowBuilderActionContext(request: BotContext, contentID?: string): FlowBuilderContext;

package/lib/action/context.js

@@ -1,20 +0,0 @@
-import { getFlowBuilderPlugin } from "../utils/get-flow-builder-plugin.js";
-
-
-
-function getFlowBuilderActionContext(request, contentID) {
-    const flowBuilderPlugin = getFlowBuilderPlugin(request.plugins);
-    const cmsApi = flowBuilderPlugin.cmsApi;
-    const resolvedLocale = flowBuilderPlugin.cmsApi.getResolvedLocale();
-    return {
-        cmsApi,
-        flowBuilderPlugin,
-        request,
-        resolvedLocale,
-        contentID
-    };
-}
-
-export { getFlowBuilderActionContext };
-
-//# sourceMappingURL=context.js.map

package/lib/action/context.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"action/context.js","sources":["../../src/action/context.ts"],"sourcesContent":["import type { BotContext } from '@botonic/core'\n\nimport type { FlowBuilderApi } from '../api'\nimport type BotonicPluginFlowBuilder from '../index'\nimport { getFlowBuilderPlugin } from '../utils/get-flow-builder-plugin'\n\nexport interface FlowBuilderContext {\n  cmsApi: FlowBuilderApi\n  flowBuilderPlugin: BotonicPluginFlowBuilder\n  request: BotContext\n  resolvedLocale: string\n  contentID?: string\n}\n\nexport function getFlowBuilderActionContext(\n  request: BotContext,\n  contentID?: string\n): FlowBuilderContext {\n  const flowBuilderPlugin = getFlowBuilderPlugin(request.plugins)\n  const cmsApi = flowBuilderPlugin.cmsApi\n  const resolvedLocale = flowBuilderPlugin.cmsApi.getResolvedLocale()\n  return {\n    cmsApi,\n    flowBuilderPlugin,\n    request,\n    resolvedLocale,\n    contentID,\n  }\n}\n"],"names":["getFlowBuilderPlugin","getFlowBuilderActionContext","request","contentID","flowBuilderPlugin","cmsApi","resolvedLocale"],"mappings":";;;AAIuE;AAUhE,SAASC,2BAA2BA,CACzCC,OAAmB,EACnBC,SAAkB;IAElB,MAAMC,oBAAoBJ,oBAAoBA,CAACE,QAAQ,OAAO;IAC9D,MAAMG,SAASD,kBAAkB,MAAM;IACvC,MAAME,iBAAiBF,kBAAkB,MAAM,CAAC,iBAAiB;IACjE,OAAO;QACLC;QACAD;QACAF;QACAI;QACAH;IACF;AACF"}

package/lib/action/fallback.d.ts

@@ -1,3 +0,0 @@
-import type { FlowContent } from '../content-fields/index.js';
-import type { FlowBuilderContext } from './context.js';
-export declare function getContentsByFallback({ cmsApi, flowBuilderPlugin, request, }: FlowBuilderContext): Promise<FlowContent[]>;

package/lib/action/fallback.js

@@ -1,41 +0,0 @@
-import { EventAction } from "@botonic/core";
-import { getCommonFlowContentEventArgsForContentId, trackEvent } from "../tracking.js";
-
-
-
-
-
-async function getContentsByFallback({ cmsApi, flowBuilderPlugin, request }) {
-    const fallbackNode = await getFallbackNode(cmsApi, request);
-    const fallbackContents = await flowBuilderPlugin.getContentsByNode(fallbackNode);
-    return fallbackContents;
-}
-async function getFallbackNode(cmsApi, request) {
-    if (request.session.user.extra_data?.isFirstFallbackOption === undefined) {
-        request.session.user.extra_data = {
-            ...request.session.user.extra_data,
-            isFirstFallbackOption: true
-        };
-    }
-    const isFirstFallbackOption = !!request.session.user.extra_data.isFirstFallbackOption;
-    const fallbackNode = cmsApi.getFallbackNode(isFirstFallbackOption);
-    request.session.user.extra_data.isFirstFallbackOption = !isFirstFallbackOption;
-    const { flowId, flowName, flowNodeId, flowNodeContentId } = getCommonFlowContentEventArgsForContentId(request, fallbackNode.id);
-    const event = {
-        action: EventAction.Fallback,
-        flowId,
-        flowName,
-        flowNodeId,
-        flowNodeContentId,
-        userInput: request.input.data,
-        fallbackOut: isFirstFallbackOption ? 1 : 2,
-        fallbackMessageId: request.input.message_id
-    };
-    const { action, ...eventArgs } = event;
-    await trackEvent(request, action, eventArgs);
-    return fallbackNode;
-}
-
-export { getContentsByFallback };
-
-//# sourceMappingURL=fallback.js.map

package/lib/action/fallback.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"action/fallback.js","sources":["../../src/action/fallback.ts"],"sourcesContent":["import { EventAction, type EventFallback } from '@botonic/core'\nimport type { ActionRequest } from '@botonic/react'\n\nimport type { FlowBuilderApi } from '../api'\nimport type { FlowContent } from '../content-fields'\nimport {\n  getCommonFlowContentEventArgsForContentId,\n  trackEvent,\n} from '../tracking'\nimport type { FlowBuilderContext } from './context'\n\nexport async function getContentsByFallback({\n  cmsApi,\n  flowBuilderPlugin,\n  request,\n}: FlowBuilderContext): Promise<FlowContent[]> {\n  const fallbackNode = await getFallbackNode(cmsApi, request)\n  const fallbackContents =\n    await flowBuilderPlugin.getContentsByNode(fallbackNode)\n\n  return fallbackContents\n}\n\nasync function getFallbackNode(cmsApi: FlowBuilderApi, request: ActionRequest) {\n  if (request.session.user.extra_data?.isFirstFallbackOption === undefined) {\n    request.session.user.extra_data = {\n      ...request.session.user.extra_data,\n      isFirstFallbackOption: true,\n    }\n  }\n\n  const isFirstFallbackOption =\n    !!request.session.user.extra_data.isFirstFallbackOption\n  const fallbackNode = cmsApi.getFallbackNode(isFirstFallbackOption)\n  request.session.user.extra_data.isFirstFallbackOption = !isFirstFallbackOption\n\n  const { flowId, flowName, flowNodeId, flowNodeContentId } =\n    getCommonFlowContentEventArgsForContentId(request, fallbackNode.id)\n\n  const event: EventFallback = {\n    action: EventAction.Fallback,\n    flowId,\n    flowName,\n    flowNodeId,\n    flowNodeContentId,\n    userInput: request.input.data as string,\n    fallbackOut: isFirstFallbackOption ? 1 : 2,\n    fallbackMessageId: request.input.message_id,\n  }\n  const { action, ...eventArgs } = event\n\n  await trackEvent(request, action, eventArgs)\n\n  return fallbackNode\n}\n"],"names":["EventAction","getCommonFlowContentEventArgsForContentId","trackEvent","getContentsByFallback","cmsApi","flowBuilderPlugin","request","fallbackNode","getFallbackNode","fallbackContents","undefined","isFirstFallbackOption","flowId","flowName","flowNodeId","flowNodeContentId","event","action","eventArgs"],"mappings":";;;;;AAA+D;AAQ3C;AAGb,eAAeG,qBAAqBA,CAAC,EAC1CC,MAAM,EACNC,iBAAiB,EACjBC,OAAO,EACY;IACnB,MAAMC,eAAe,MAAMC,eAAeA,CAACJ,QAAQE;IACnD,MAAMG,mBACJ,MAAMJ,kBAAkB,iBAAiB,CAACE;IAE5C,OAAOE;AACT;AAEA,eAAeD,eAAeA,CAACJ,MAAsB,EAAEE,OAAsB;IAC3E,IAAIA,QAAQ,OAAO,CAAC,IAAI,CAAC,UAAU,EAAE,0BAA0BI,WAAW;QACxEJ,QAAQ,OAAO,CAAC,IAAI,CAAC,UAAU,GAAG;YAChC,GAAGA,QAAQ,OAAO,CAAC,IAAI,CAAC,UAAU;YAClC,uBAAuB;QACzB;IACF;IAEA,MAAMK,wBACJ,CAAC,CAACL,QAAQ,OAAO,CAAC,IAAI,CAAC,UAAU,CAAC,qBAAqB;IACzD,MAAMC,eAAeH,OAAO,eAAe,CAACO;IAC5CL,QAAQ,OAAO,CAAC,IAAI,CAAC,UAAU,CAAC,qBAAqB,GAAG,CAACK;IAEzD,MAAM,EAAEC,MAAM,EAAEC,QAAQ,EAAEC,UAAU,EAAEC,iBAAiB,EAAE,GACvDd,yCAAyCA,CAACK,SAASC,aAAa,EAAE;IAEpE,MAAMS,QAAuB;QAC3B,QAAQhB,oBAAoB;QAC5BY;QACAC;QACAC;QACAC;QACA,WAAWT,QAAQ,KAAK,CAAC,IAAI;QAC7B,aAAaK,wBAAwB,IAAI;QACzC,mBAAmBL,QAAQ,KAAK,CAAC,UAAU;IAC7C;IACA,MAAM,EAAEW,MAAM,EAAE,GAAGC,WAAW,GAAGF;IAEjC,MAAMd,UAAUA,CAACI,SAASW,QAAQC;IAElC,OAAOX;AACT"}

package/lib/action/first-interaction.d.ts

@@ -1,3 +0,0 @@
-import { type FlowContent } from '../content-fields/index.js';
-import type { FlowBuilderContext } from './context.js';
-export declare function getContentsByFirstInteraction(context: FlowBuilderContext): Promise<FlowContent[]>;

package/lib/action/first-interaction.js

@@ -1,100 +0,0 @@
-import { MAIN_FLOW_NAME } from "../constants.js";
-import { FlowAiAgent, FlowAiAgentRouter, FlowBotAction } from "../content-fields/index.js";
-import { inputHasTextOrTranscript } from "../utils/input.js";
-import { getContentsByAiAgentFromUserInput } from "./ai-agent-from-user-input.js";
-import { getContentsByPayload } from "./payload.js";
-
-
-
-
-
-
-
-
-
-
-
-async function getContentsByFirstInteraction(context) {
-    const { contentID, flowBuilderPlugin, request } = context;
-    /*
-   * If the contentID is provided, the firstInteractionContents are obtained even if they are not used
-   * because when obtain this firstInteractionContents is when the session.flow_thread_id is updated.
-   * This is needed for example when send a WhatsApp campaign is sent,
-   * the bot not receives the message because this message is sent directly by the backend
-   * we expect the bot to respond only with the contents of the contentID and not with the firstInteractionContents.
-   */ const firstInteractionContents = await flowBuilderPlugin.getStartContents();
-    if (contentID) {
-        try {
-            const contentsByContentID = await flowBuilderPlugin.getContentsByContentID(contentID);
-            if (contentsByContentID.length > 0) {
-                return contentsByContentID;
-            }
-        } catch (_error) {
-            console.warn(`The contentID ${contentID} is not found. Returning the firstInteractionContents`);
-        }
-    }
-    // Bot actions and AI agents already consume the user input. Matching
-    // keywords/intents/KB/AI-agent-from-user-input on top would duplicate replies
-    // (e.g. Main start → Go to flow → AI Agents).
-    if (startContentsAlreadyHandleUserInput(firstInteractionContents)) {
-        return firstInteractionContents;
-    }
-    if (request.input.nluResolution || inputHasTextOrTranscript(request.input)) {
-        const contentsByUserInput = await getContentsByUserInput(context);
-        return [
-            ...firstInteractionContents,
-            ...contentsByUserInput
-        ];
-    }
-    return firstInteractionContents;
-}
-function startContentsAlreadyHandleUserInput(contents) {
-    if (contents.at(-1) instanceof FlowBotAction) {
-        return true;
-    }
-    // To avoid duplicated ai agent response, we check if there is an ai agent or ai agent router in the first interaction contents.
-    return contents.some((content)=>content instanceof FlowAiAgent || content instanceof FlowAiAgentRouter);
-}
-async function getContentsByUserInput(context) {
-    const { cmsApi, flowBuilderPlugin, request, resolvedLocale } = context;
-    const payloadByNlu = request.input.nluResolution?.payload;
-    if (payloadByNlu) {
-        request.input.payload = payloadByNlu;
-        const conversationStartId = getConversationStartId(cmsApi);
-        if (request.input.payload === conversationStartId) {
-            return [];
-        }
-        const contentsByKeywordsOrIntents = await getContentsByPayload({
-            cmsApi,
-            flowBuilderPlugin,
-            request,
-            resolvedLocale
-        });
-        const hasRepeatedContent = await checkRepeatedContents(flowBuilderPlugin, contentsByKeywordsOrIntents);
-        if (hasRepeatedContent) {
-            return [];
-        }
-        if (contentsByKeywordsOrIntents.length > 0) {
-            return contentsByKeywordsOrIntents;
-        }
-    }
-    if (!flowBuilderPlugin.disableAIAgentInFirstInteraction) {
-        const contentsByAiAgent = await getContentsByAiAgentFromUserInput(context);
-        return contentsByAiAgent;
-    }
-    return [];
-}
-function getConversationStartId(cmsApi) {
-    const conversationStartId = cmsApi.flow.flows.find((flow)=>flow.name === MAIN_FLOW_NAME)?.start_node_id;
-    return conversationStartId;
-}
-async function checkRepeatedContents(flowBuilderPlugin, contentsByKeywordsOrIntents) {
-    const startContents = await flowBuilderPlugin.getStartContents();
-    const contentIds = new Set(contentsByKeywordsOrIntents.map((content)=>content.id));
-    const hasRepeatedContent = startContents.some((content)=>contentIds.has(content.id));
-    return hasRepeatedContent;
-}
-
-export { getContentsByFirstInteraction };
-
-//# sourceMappingURL=first-interaction.js.map

package/lib/action/first-interaction.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"action/first-interaction.js","sources":["../../src/action/first-interaction.ts"],"sourcesContent":["import type { FlowBuilderApi } from '../api'\nimport { MAIN_FLOW_NAME } from '../constants'\nimport {\n  FlowAiAgent,\n  FlowAiAgentRouter,\n  FlowBotAction,\n  type FlowContent,\n} from '../content-fields'\nimport type BotonicPluginFlowBuilder from '../index'\nimport { inputHasTextOrTranscript } from '../utils/input'\nimport { getContentsByAiAgentFromUserInput } from './ai-agent-from-user-input'\nimport type { FlowBuilderContext } from './context'\nimport { getContentsByPayload } from './payload'\n\nexport async function getContentsByFirstInteraction(\n  context: FlowBuilderContext\n): Promise<FlowContent[]> {\n  const { contentID, flowBuilderPlugin, request } = context\n\n  /*\n   * If the contentID is provided, the firstInteractionContents are obtained even if they are not used\n   * because when obtain this firstInteractionContents is when the session.flow_thread_id is updated.\n   * This is needed for example when send a WhatsApp campaign is sent,\n   * the bot not receives the message because this message is sent directly by the backend\n   * we expect the bot to respond only with the contents of the contentID and not with the firstInteractionContents.\n   */\n  const firstInteractionContents = await flowBuilderPlugin.getStartContents()\n\n  if (contentID) {\n    try {\n      const contentsByContentID =\n        await flowBuilderPlugin.getContentsByContentID(contentID)\n\n      if (contentsByContentID.length > 0) {\n        return contentsByContentID\n      }\n    } catch (_error) {\n      console.warn(\n        `The contentID ${contentID} is not found. Returning the firstInteractionContents`\n      )\n    }\n  }\n\n  // Bot actions and AI agents already consume the user input. Matching\n  // keywords/intents/KB/AI-agent-from-user-input on top would duplicate replies\n  // (e.g. Main start → Go to flow → AI Agents).\n  if (startContentsAlreadyHandleUserInput(firstInteractionContents)) {\n    return firstInteractionContents\n  }\n\n  if (request.input.nluResolution || inputHasTextOrTranscript(request.input)) {\n    const contentsByUserInput = await getContentsByUserInput(context)\n\n    return [...firstInteractionContents, ...contentsByUserInput]\n  }\n\n  return firstInteractionContents\n}\n\nfunction startContentsAlreadyHandleUserInput(contents: FlowContent[]): boolean {\n  if (contents.at(-1) instanceof FlowBotAction) {\n    return true\n  }\n\n  // To avoid duplicated ai agent response, we check if there is an ai agent or ai agent router in the first interaction contents.\n  return contents.some(\n    content =>\n      content instanceof FlowAiAgent || content instanceof FlowAiAgentRouter\n  )\n}\n\nasync function getContentsByUserInput(\n  context: FlowBuilderContext\n): Promise<FlowContent[]> {\n  const { cmsApi, flowBuilderPlugin, request, resolvedLocale } = context\n  const payloadByNlu = request.input.nluResolution?.payload\n\n  if (payloadByNlu) {\n    request.input.payload = payloadByNlu\n    const conversationStartId = getConversationStartId(cmsApi)\n\n    if (request.input.payload === conversationStartId) {\n      return []\n    }\n\n    const contentsByKeywordsOrIntents = await getContentsByPayload({\n      cmsApi,\n      flowBuilderPlugin,\n      request,\n      resolvedLocale,\n    })\n\n    const hasRepeatedContent = await checkRepeatedContents(\n      flowBuilderPlugin,\n      contentsByKeywordsOrIntents\n    )\n\n    if (hasRepeatedContent) {\n      return []\n    }\n\n    if (contentsByKeywordsOrIntents.length > 0) {\n      return contentsByKeywordsOrIntents\n    }\n  }\n\n  if (!flowBuilderPlugin.disableAIAgentInFirstInteraction) {\n    const contentsByAiAgent = await getContentsByAiAgentFromUserInput(context)\n    return contentsByAiAgent\n  }\n\n  return []\n}\n\nfunction getConversationStartId(cmsApi: FlowBuilderApi) {\n  const conversationStartId = cmsApi.flow.flows.find(\n    flow => flow.name === MAIN_FLOW_NAME\n  )?.start_node_id\n\n  return conversationStartId\n}\n\nasync function checkRepeatedContents(\n  flowBuilderPlugin: BotonicPluginFlowBuilder,\n  contentsByKeywordsOrIntents: FlowContent[]\n) {\n  const startContents = await flowBuilderPlugin.getStartContents()\n  const contentIds = new Set(\n    contentsByKeywordsOrIntents.map(content => content.id)\n  )\n  const hasRepeatedContent = startContents.some(content =>\n    contentIds.has(content.id)\n  )\n\n  return hasRepeatedContent\n}\n"],"names":["MAIN_FLOW_NAME","FlowAiAgent","FlowAiAgentRouter","FlowBotAction","inputHasTextOrTranscript","getContentsByAiAgentFromUserInput","getContentsByPayload","getContentsByFirstInteraction","context","contentID","flowBuilderPlugin","request","firstInteractionContents","contentsByContentID","_error","console","startContentsAlreadyHandleUserInput","contentsByUserInput","getContentsByUserInput","contents","content","cmsApi","resolvedLocale","payloadByNlu","conversationStartId","getConversationStartId","contentsByKeywordsOrIntents","hasRepeatedContent","checkRepeatedContents","contentsByAiAgent","flow","startContents","contentIds","Set"],"mappings":";;;;;;;;;;;AAC6C;AAMnB;AAE+B;AACqB;AAE9B;AAEzC,eAAeO,6BAA6BA,CACjDC,OAA2B;IAE3B,MAAM,EAAEC,SAAS,EAAEC,iBAAiB,EAAEC,OAAO,EAAE,GAAGH;IAElD;;;;;;GAMC,GACD,MAAMI,2BAA2B,MAAMF,kBAAkB,gBAAgB;IAEzE,IAAID,WAAW;QACb,IAAI;YACF,MAAMI,sBACJ,MAAMH,kBAAkB,sBAAsB,CAACD;YAEjD,IAAII,oBAAoB,MAAM,GAAG,GAAG;gBAClC,OAAOA;YACT;QACF,EAAE,OAAOC,QAAQ;YACfC,QAAQ,IAAI,CACV,CAAC,cAAc,EAAEN,UAAU,qDAAqD,CAAC;QAErF;IACF;IAEA,qEAAqE;IACrE,8EAA8E;IAC9E,8CAA8C;IAC9C,IAAIO,mCAAmCA,CAACJ,2BAA2B;QACjE,OAAOA;IACT;IAEA,IAAID,QAAQ,KAAK,CAAC,aAAa,IAAIP,wBAAwBA,CAACO,QAAQ,KAAK,GAAG;QAC1E,MAAMM,sBAAsB,MAAMC,sBAAsBA,CAACV;QAEzD,OAAO;eAAII;eAA6BK;SAAoB;IAC9D;IAEA,OAAOL;AACT;AAEA,SAASI,mCAAmCA,CAACG,QAAuB;IAClE,IAAIA,SAAS,EAAE,CAAC,CAAC,cAAchB,aAAaA,EAAE;QAC5C,OAAO;IACT;IAEA,gIAAgI;IAChI,OAAOgB,SAAS,IAAI,CAClBC,CAAAA,UACEA,mBAAmBnB,WAAWA,IAAImB,mBAAmBlB,iBAAiBA;AAE5E;AAEA,eAAegB,sBAAsBA,CACnCV,OAA2B;IAE3B,MAAM,EAAEa,MAAM,EAAEX,iBAAiB,EAAEC,OAAO,EAAEW,cAAc,EAAE,GAAGd;IAC/D,MAAMe,eAAeZ,QAAQ,KAAK,CAAC,aAAa,EAAE;IAElD,IAAIY,cAAc;QAChBZ,QAAQ,KAAK,CAAC,OAAO,GAAGY;QACxB,MAAMC,sBAAsBC,sBAAsBA,CAACJ;QAEnD,IAAIV,QAAQ,KAAK,CAAC,OAAO,KAAKa,qBAAqB;YACjD,OAAO,EAAE;QACX;QAEA,MAAME,8BAA8B,MAAMpB,oBAAoBA,CAAC;YAC7De;YACAX;YACAC;YACAW;QACF;QAEA,MAAMK,qBAAqB,MAAMC,qBAAqBA,CACpDlB,mBACAgB;QAGF,IAAIC,oBAAoB;YACtB,OAAO,EAAE;QACX;QAEA,IAAID,4BAA4B,MAAM,GAAG,GAAG;YAC1C,OAAOA;QACT;IACF;IAEA,IAAI,CAAChB,kBAAkB,gCAAgC,EAAE;QACvD,MAAMmB,oBAAoB,MAAMxB,iCAAiCA,CAACG;QAClE,OAAOqB;IACT;IAEA,OAAO,EAAE;AACX;AAEA,SAASJ,sBAAsBA,CAACJ,MAAsB;IACpD,MAAMG,sBAAsBH,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAChDS,CAAAA,OAAQA,KAAK,IAAI,KAAK9B,cAAcA,GACnC;IAEH,OAAOwB;AACT;AAEA,eAAeI,qBAAqBA,CAClClB,iBAA2C,EAC3CgB,2BAA0C;IAE1C,MAAMK,gBAAgB,MAAMrB,kBAAkB,gBAAgB;IAC9D,MAAMsB,aAAa,IAAIC,IACrBP,4BAA4B,GAAG,CAACN,CAAAA,UAAWA,QAAQ,EAAE;IAEvD,MAAMO,qBAAqBI,cAAc,IAAI,CAACX,CAAAA,UAC5CY,WAAW,GAAG,CAACZ,QAAQ,EAAE;IAG3B,OAAOO;AACT"}

package/lib/action/get-contents.d.ts

@@ -1,3 +0,0 @@
-import { type BotContext } from '@botonic/core';
-import type { FlowContent } from '../content-fields/index.js';
-export declare function getContents(botContext: BotContext, contentID?: string): Promise<FlowContent[]>;

package/lib/action/get-contents.js

@@ -1,56 +0,0 @@
-import { INPUT } from "@botonic/core";
-import { EMPTY_PAYLOAD } from "../constants.js";
-import { inputHasTextOrTranscript } from "../utils/input.js";
-import { getContentsByAiAgentFromUserInput } from "./ai-agent-from-user-input.js";
-import { getFlowBuilderActionContext } from "./context.js";
-import { getContentsByFallback } from "./fallback.js";
-import { getContentsByFirstInteraction } from "./first-interaction.js";
-import { getContentsByPayload } from "./payload.js";
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-async function getContents(botContext, contentID) {
-    const context = getFlowBuilderActionContext(botContext, contentID);
-    if (botContext.session.is_first_interaction) {
-        return await getContentsByFirstInteraction(context);
-    }
-    // TODO: Add needed logic when we can define contents for multi locale queue position message
-    if (botContext.input.type === INPUT.EVENT_QUEUE_POSITION_CHANGED) {
-        return [];
-    }
-    if (botContext.input.payload?.startsWith(EMPTY_PAYLOAD)) {
-        botContext.input.payload = undefined;
-    }
-    if (botContext.input.payload || contentID) {
-        const contentsByPayload = await getContentsByPayload(context);
-        if (contentsByPayload.length > 0) {
-            return contentsByPayload;
-        }
-        return await getContentsByFallback(context);
-    }
-    if (inputHasTextOrTranscript(botContext.input)) {
-        const aiAgentContents = await getContentsByAiAgentFromUserInput(context);
-        if (aiAgentContents.length > 0) {
-            return aiAgentContents;
-        }
-    }
-    return await getContentsByFallback(context);
-}
-
-export { getContents };
-
-//# sourceMappingURL=get-contents.js.map

package/lib/action/get-contents.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"action/get-contents.js","sources":["../../src/action/get-contents.ts"],"sourcesContent":["import { type BotContext, INPUT } from '@botonic/core'\nimport { EMPTY_PAYLOAD } from '../constants'\nimport type { FlowContent } from '../content-fields'\nimport { inputHasTextOrTranscript } from '../utils/input'\nimport { getContentsByAiAgentFromUserInput } from './ai-agent-from-user-input'\nimport { getFlowBuilderActionContext } from './context'\nimport { getContentsByFallback } from './fallback'\nimport { getContentsByFirstInteraction } from './first-interaction'\nimport { getContentsByPayload } from './payload'\n\nexport async function getContents(\n  botContext: BotContext,\n  contentID?: string\n): Promise<FlowContent[]> {\n  const context = getFlowBuilderActionContext(botContext, contentID)\n\n  if (botContext.session.is_first_interaction) {\n    return await getContentsByFirstInteraction(context)\n  }\n  // TODO: Add needed logic when we can define contents for multi locale queue position message\n  if (botContext.input.type === INPUT.EVENT_QUEUE_POSITION_CHANGED) {\n    return []\n  }\n\n  if (botContext.input.payload?.startsWith(EMPTY_PAYLOAD)) {\n    botContext.input.payload = undefined\n  }\n\n  if (botContext.input.payload || contentID) {\n    const contentsByPayload = await getContentsByPayload(context)\n    if (contentsByPayload.length > 0) {\n      return contentsByPayload\n    }\n\n    return await getContentsByFallback(context)\n  }\n\n  if (inputHasTextOrTranscript(botContext.input)) {\n    const aiAgentContents = await getContentsByAiAgentFromUserInput(context)\n    if (aiAgentContents.length > 0) {\n      return aiAgentContents\n    }\n  }\n\n  return await getContentsByFallback(context)\n}\n"],"names":["INPUT","EMPTY_PAYLOAD","inputHasTextOrTranscript","getContentsByAiAgentFromUserInput","getFlowBuilderActionContext","getContentsByFallback","getContentsByFirstInteraction","getContentsByPayload","getContents","botContext","contentID","context","undefined","contentsByPayload","aiAgentContents"],"mappings":";;;;;;;;;;;;;;;;;AAAsD;AACV;AAEa;AACqB;AACvB;AACL;AACiB;AACnB;AAEzC,eAAeQ,WAAWA,CAC/BC,UAAsB,EACtBC,SAAkB;IAElB,MAAMC,UAAUP,2BAA2BA,CAACK,YAAYC;IAExD,IAAID,WAAW,OAAO,CAAC,oBAAoB,EAAE;QAC3C,OAAO,MAAMH,6BAA6BA,CAACK;IAC7C;IACA,6FAA6F;IAC7F,IAAIF,WAAW,KAAK,CAAC,IAAI,KAAKT,kCAAkC,EAAE;QAChE,OAAO,EAAE;IACX;IAEA,IAAIS,WAAW,KAAK,CAAC,OAAO,EAAE,WAAWR,aAAaA,GAAG;QACvDQ,WAAW,KAAK,CAAC,OAAO,GAAGG;IAC7B;IAEA,IAAIH,WAAW,KAAK,CAAC,OAAO,IAAIC,WAAW;QACzC,MAAMG,oBAAoB,MAAMN,oBAAoBA,CAACI;QACrD,IAAIE,kBAAkB,MAAM,GAAG,GAAG;YAChC,OAAOA;QACT;QAEA,OAAO,MAAMR,qBAAqBA,CAACM;IACrC;IAEA,IAAIT,wBAAwBA,CAACO,WAAW,KAAK,GAAG;QAC9C,MAAMK,kBAAkB,MAAMX,iCAAiCA,CAACQ;QAChE,IAAIG,gBAAgB,MAAM,GAAG,GAAG;YAC9B,OAAOA;QACT;IACF;IAEA,OAAO,MAAMT,qBAAqBA,CAACM;AACrC"}

package/lib/action/index.d.ts

@@ -1,25 +0,0 @@
-import { type BotContext } from '@botonic/core';
-import { RequestContext, type WebchatSettingsProps } from '@botonic/react';
-import React from 'react';
-import { type FlowContent } from '../content-fields/index.js';
-export type FlowBuilderActionProps = {
-    contents: FlowContent[];
-    webchatSettingsParams?: WebchatSettingsProps;
-};
-export declare class FlowBuilderAction extends React.Component<FlowBuilderActionProps> {
-    static contextType: React.Context<import("@botonic/react").ActionRequest>;
-    context: React.ContextType<typeof RequestContext>;
-    static executeConversationStart(botContext: BotContext): Promise<FlowBuilderActionProps>;
-    static botonicInit(botContext: BotContext, contentID?: string): Promise<FlowBuilderActionProps>;
-    static prepareContentsToRender(botContext: BotContext, contents: FlowContent[]): Promise<FlowContent[]>;
-    private static isAiAgentContent;
-    private static processAiAgentContent;
-    protected getWebchatSettingsParams(botContext: BotContext): {
-        shouldSendWebchatSettings: boolean;
-        webchatSettingsParams?: WebchatSettingsProps;
-    };
-    render(): JSX.Element | JSX.Element[];
-}
-export declare class FlowBuilderMultichannelAction extends FlowBuilderAction {
-    render(): JSX.Element | JSX.Element[];
-}