@botonic/plugin-flow-builder 0.34.0 → 0.34.2-alpha.0

package/src/action/knowledge-bases.ts

@@ -8,7 +8,7 @@ import {
 import { HtNodeWithContent } from '../content-fields/hubtype-fields/nodes'
 import { EventAction, KnowledgebaseFailReason, trackEvent } from '../tracking'
 import { KnowledgeBaseFunction, KnowledgeBaseResponse } from '../types'
-import { inputHasTextData } from '../utils'
+import { inputHasTextData, isKnowledgeBasesAllowed } from '../utils'
 import { FlowBuilderContext } from './index'
 
 export async function getContentsByKnowledgeBase({
@@ -17,46 +17,48 @@ export async function getContentsByKnowledgeBase({
   request,
   resolvedLocale,
 }: FlowBuilderContext): Promise<FlowContent[]> {
-  const startNodeKnowledgeBaseFlow = cmsApi.getStartNodeKnowledgeBaseFlow()
+  if (isKnowledgeBasesAllowed(request)) {
+    const startNodeKnowledgeBaseFlow = cmsApi.getStartNodeKnowledgeBaseFlow()
 
-  if (!startNodeKnowledgeBaseFlow) {
-    return []
-  }
-
-  const contents = await flowBuilderPlugin.getContentsByNode(
-    startNodeKnowledgeBaseFlow,
-    resolvedLocale
-  )
+    if (!startNodeKnowledgeBaseFlow) {
+      return []
+    }
 
-  const knowledgeBaseContent = contents.find(
-    content => content instanceof FlowKnowledgeBase
-  ) as FlowKnowledgeBase
+    const contents = await flowBuilderPlugin.getContentsByNode(
+      startNodeKnowledgeBaseFlow,
+      resolvedLocale
+    )
 
-  if (!knowledgeBaseContent) {
-    return contents
-  }
+    const knowledgeBaseContent = contents.find(
+      content => content instanceof FlowKnowledgeBase
+    ) as FlowKnowledgeBase
 
-  const sourceIds = knowledgeBaseContent.sourcesData.map(source => source.id)
-  const flowId = cmsApi.getNodeById<HtNodeWithContent>(
-    knowledgeBaseContent.id
-  ).flow_id
+    if (!knowledgeBaseContent) {
+      return contents
+    }
 
-  if (
-    flowBuilderPlugin.getKnowledgeBaseResponse &&
-    inputHasTextData(request.input) &&
-    sourceIds.length > 0
-  ) {
-    const contentsWithKnowledgeResponse =
-      await getContentsWithKnowledgeResponse(
-        flowBuilderPlugin.getKnowledgeBaseResponse,
-        request,
-        contents,
-        knowledgeBaseContent,
-        flowId
-      )
-
-    if (contentsWithKnowledgeResponse) {
-      return contentsWithKnowledgeResponse
+    const sourceIds = knowledgeBaseContent.sourcesData.map(source => source.id)
+    const flowId = cmsApi.getNodeById<HtNodeWithContent>(
+      knowledgeBaseContent.id
+    ).flow_id
+
+    if (
+      flowBuilderPlugin.getKnowledgeBaseResponse &&
+      inputHasTextData(request.input) &&
+      sourceIds.length > 0
+    ) {
+      const contentsWithKnowledgeResponse =
+        await getContentsWithKnowledgeResponse(
+          flowBuilderPlugin.getKnowledgeBaseResponse,
+          request,
+          contents,
+          knowledgeBaseContent,
+          flowId
+        )
+
+      if (contentsWithKnowledgeResponse) {
+        return contentsWithKnowledgeResponse
+      }
     }
   }
 

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

@@ -1,6 +1,7 @@
 import { HtBaseNode, HtInputLocale, HtTextLocale } from './common'
 import { HtNodeWithContentType } from './node-types'
 
+// TODO: Remove this because frontend no allow create intents babel
 export interface HtIntentNode extends HtBaseNode {
   type: HtNodeWithContentType.INTENT
   content: {

package/src/index.ts

@@ -34,6 +34,7 @@ import { DEFAULT_FUNCTIONS } from './functions'
 import {
   BotonicPluginFlowBuilderOptions,
   FlowBuilderJSONVersion,
+  InShadowingConfig,
   KnowledgeBaseFunction,
   PayloadParamsBase,
   TrackEventFunction,
@@ -54,12 +55,13 @@ export default class BotonicPluginFlowBuilder implements Plugin {
   public trackEvent?: TrackEventFunction
   public getKnowledgeBaseResponse?: KnowledgeBaseFunction
   public smartIntentsConfig: SmartIntentsInferenceConfig
+  public inShadowing: InShadowingConfig
 
   // TODO: Rethink how we construct FlowBuilderApi to be simpler
   public jsonVersion: FlowBuilderJSONVersion
   public apiUrl: string
 
-  constructor(readonly options: BotonicPluginFlowBuilderOptions) {
+  constructor(options: BotonicPluginFlowBuilderOptions) {
     this.apiUrl = options.apiUrl || FLOW_BUILDER_API_URL_PROD
     this.jsonVersion = options.jsonVersion || FlowBuilderJSONVersion.LATEST
     this.flow = options.flow
@@ -73,6 +75,11 @@ export default class BotonicPluginFlowBuilder implements Plugin {
     }
     const customFunctions = options.customFunctions || {}
     this.functions = { ...DEFAULT_FUNCTIONS, ...customFunctions }
+    this.inShadowing = {
+      allowKeywords: options.inShadowing?.allowKeywords || false,
+      allowSmartIntents: options.inShadowing?.allowSmartIntents || false,
+      allowKnowledgeBases: options.inShadowing?.allowKnowledgeBases || false,
+    }
   }
 
   resolveFlowUrl(request: PluginPreRequest): string {
@@ -93,9 +100,7 @@ export default class BotonicPluginFlowBuilder implements Plugin {
     })
 
     const checkUserTextInput =
-      inputHasTextData(request.input) &&
-      !request.input.payload &&
-      !request.session.is_first_interaction
+      inputHasTextData(request.input) && !request.input.payload
 
     if (checkUserTextInput) {
       const locale = this.getLocale(request.session)

package/src/tracking.ts

@@ -5,7 +5,6 @@ import { FlowContent } from './content-fields'
 import {
   HtNodeWithContent,
   HtNodeWithContentType,
-  HtNodeWithoutContentType,
 } from './content-fields/hubtype-fields'
 import { getFlowBuilderPlugin } from './helpers'
 

package/src/types.ts

@@ -3,6 +3,12 @@ import { ActionRequest } from '@botonic/react'
 
 import { HtFlowBuilderData } from './content-fields/hubtype-fields'
 
+export interface InShadowingConfig {
+  allowKeywords: boolean
+  allowSmartIntents: boolean
+  allowKnowledgeBases: boolean
+}
+
 export interface BotonicPluginFlowBuilderOptions {
   apiUrl?: string
   jsonVersion?: FlowBuilderJSONVersion
@@ -13,6 +19,7 @@ export interface BotonicPluginFlowBuilderOptions {
   trackEvent?: TrackEventFunction
   getKnowledgeBaseResponse?: KnowledgeBaseFunction
   smartIntentsConfig?: { numSmartIntentsToUse: number }
+  inShadowing?: Partial<InShadowingConfig>
 }
 
 export type TrackEventFunction = (

package/src/user-input/index.ts

@@ -1,4 +1,3 @@
-import { INPUT } from '@botonic/core'
 import { ActionRequest } from '@botonic/react'
 
 import { FlowBuilderApi } from '../api'
@@ -7,7 +6,11 @@ import {
   HtKeywordNode,
   HtSmartIntentNode,
 } from '../content-fields/hubtype-fields'
-import { inputHasTextData } from '../utils'
+import {
+  inputHasTextData,
+  isKeywordsAllowed,
+  isSmartIntentsAllowed,
+} from '../utils'
 import { getIntentNodeByInput } from './intent'
 import { KeywordMatcher } from './keyword'
 import { SmartIntentsApi, SmartIntentsInferenceConfig } from './smart-intent'
@@ -19,29 +22,38 @@ export async function getNodeByUserInput(
   smartIntentsConfig: SmartIntentsInferenceConfig
 ): Promise<HtSmartIntentNode | HtIntentNode | HtKeywordNode | undefined> {
   if (inputHasTextData(request.input)) {
-    const keywordMatcher = new KeywordMatcher({
-      cmsApi,
-      locale,
-      request,
-    })
-    const keywordNode = await keywordMatcher.getNodeByInput(request.input.data!)
-    if (keywordNode) {
-      return keywordNode
+    if (isKeywordsAllowed(request)) {
+      const keywordMatcher = new KeywordMatcher({
+        cmsApi,
+        locale,
+        request,
+      })
+      const keywordNode = await keywordMatcher.getNodeByInput(
+        request.input.data!
+      )
+      if (keywordNode) {
+        return keywordNode
+      }
     }
 
-    const smartIntentsApi = new SmartIntentsApi(
-      cmsApi,
-      request,
-      smartIntentsConfig
-    )
-    const smartIntentNode = await smartIntentsApi.getNodeByInput()
-    if (smartIntentNode) {
-      return smartIntentNode
+    if (isSmartIntentsAllowed(request)) {
+      const smartIntentsApi = new SmartIntentsApi(
+        cmsApi,
+        request,
+        smartIntentsConfig
+      )
+      const smartIntentNode = await smartIntentsApi.getNodeByInput()
+      if (smartIntentNode) {
+        return smartIntentNode
+      }
     }
 
-    const intentNode = await getIntentNodeByInput(cmsApi, locale, request)
-    if (intentNode) {
-      return intentNode
+    // TODO: Remove this because frontend no allow create intents babel
+    if (isSmartIntentsAllowed(request)) {
+      const intentNode = await getIntentNodeByInput(cmsApi, locale, request)
+      if (intentNode) {
+        return intentNode
+      }
     }
   }
 

package/src/user-input/intent.ts

@@ -1,3 +1,4 @@
+import { NluType } from '@botonic/core'
 import { ActionRequest } from '@botonic/react'
 
 import { FlowBuilderApi } from '../api'
@@ -15,6 +16,13 @@ export async function getIntentNodeByInput(
     await trackIntentEvent(request, intentNode)
 
     if (isIntentValid(intentNode, request, cmsApi)) {
+      const targetPayload = cmsApi.getPayload(intentNode.target)
+
+      request.input.nluResolution = {
+        type: NluType.Keyword,
+        matchedValue: intentNode.content.title,
+        payload: targetPayload,
+      }
       return intentNode
     }
   }

package/src/user-input/keyword.ts

@@ -36,9 +36,12 @@ export class KeywordMatcher {
     if (!keywordNode || !this.matchedKeyword) {
       return undefined
     }
+    const targetPayload = this.cmsApi.getPayload(keywordNode.target)
+
     this.request.input.nluResolution = {
       type: NluType.Keyword,
       matchedValue: this.matchedKeyword,
+      payload: targetPayload,
     }
     await this.trackKeywordEvent()
     return keywordNode

package/src/user-input/smart-intent.ts

@@ -46,11 +46,15 @@ export class SmartIntentsApi {
         smartIntentNode =>
           smartIntentNode.content.title === response.data.smart_intent_title
       )
+
       if (smartIntentNode) {
+        const targetPayload = this.cmsApi.getPayload(smartIntentNode.target)
         this.currentRequest.input.nluResolution = {
           type: NluType.SmartIntent,
           matchedValue: smartIntentNode.content.title,
+          payload: targetPayload,
         }
+
         await trackEvent(this.currentRequest, EventAction.IntentSmart, {
           nluIntentSmartTitle: response.data.smart_intent_title,
           nluIntentSmartNumUsed: response.data.smart_intents_used.length,
@@ -60,6 +64,7 @@ export class SmartIntentsApi {
           flowId: smartIntentNode.flow_id,
           flowNodeId: smartIntentNode.id,
         })
+
         return smartIntentNode
       }
     } catch (e) {

package/src/utils.ts

@@ -1,7 +1,12 @@
 import { INPUT, Input, Session } from '@botonic/core'
 import { ActionRequest } from '@botonic/react'
 
-import { BotonicPluginFlowBuilderOptions, ProcessEnvNodeEnvs } from './types'
+import { getFlowBuilderPlugin } from './helpers'
+import {
+  BotonicPluginFlowBuilderOptions,
+  InShadowingConfig,
+  ProcessEnvNodeEnvs,
+} from './types'
 
 function getAccessTokenFromSession(session: Session): string {
   if (!session._access_token) {
@@ -51,3 +56,24 @@ function resolveObjectKey(object: any, key: string): any {
 export function inputHasTextData(input: Input): boolean {
   return input.data !== undefined && input.type === INPUT.TEXT
 }
+
+function isNluAllowed(
+  request: ActionRequest,
+  nluFlag: keyof InShadowingConfig
+): boolean {
+  const shadowing = Boolean(request.session._shadowing)
+  const flowBuilderPlugin = getFlowBuilderPlugin(request.plugins)
+  return !shadowing || (shadowing && flowBuilderPlugin.inShadowing[nluFlag])
+}
+
+export function isKeywordsAllowed(request: ActionRequest): boolean {
+  return isNluAllowed(request, 'allowKeywords')
+}
+
+export function isSmartIntentsAllowed(request: ActionRequest): boolean {
+  return isNluAllowed(request, 'allowSmartIntents')
+}
+
+export function isKnowledgeBasesAllowed(request: ActionRequest): boolean {
+  return isNluAllowed(request, 'allowKnowledgeBases')
+}