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

package/src/helpers.ts

@@ -1,19 +1,25 @@
-import { Plugin } from '@botonic/core'
+import { ResolvedPlugins } from '@botonic/core'
 
 import BotonicPluginFlowBuilder from './index'
 
 const FLOW_BUILDER_PLUGIN_NAME = 'BotonicPluginFlowBuilder'
 
-export function getFlowBuilderPlugin(plugins: {
-  [id: string]: Plugin
-}): BotonicPluginFlowBuilder {
+export function getFlowBuilderPlugin(
+  plugins: ResolvedPlugins
+): BotonicPluginFlowBuilder {
+  const ERROR_MESSAGE = `You must include '@botonic/plugin-flow-builder' in your plugins file.`
+
+  if (Object.values(plugins).length === 0) {
+    throw new Error(ERROR_MESSAGE)
+  }
+
   const flowBuilderPlugin = Object.values(plugins).find(
-    // @ts-ignore
-    plugin => plugin.name.includes(FLOW_BUILDER_PLUGIN_NAME)
-  ) as BotonicPluginFlowBuilder
-  if (!flowBuilderPlugin)
-    throw new Error(
-      `You must include '@botonic/plugin-flow-builder' in your plugins file.`
-    )
+    plugin => plugin.constructor.name === FLOW_BUILDER_PLUGIN_NAME
+  ) as unknown as BotonicPluginFlowBuilder
+
+  if (!flowBuilderPlugin) {
+    throw new Error(ERROR_MESSAGE)
+  }
+
   return flowBuilderPlugin
 }

package/src/index.ts

@@ -1,4 +1,9 @@
-import { Plugin, PluginPreRequest, Session } from '@botonic/core'
+import {
+  Plugin,
+  PluginPreRequest,
+  ResolvedPlugins,
+  Session,
+} from '@botonic/core'
 import { ActionRequest } from '@botonic/react'
 import { v7 as uuidv7 } from 'uuid'
 
@@ -61,12 +66,17 @@ export default class BotonicPluginFlowBuilder implements Plugin {
   public jsonVersion: FlowBuilderJSONVersion
   public apiUrl: string
 
-  constructor(options: BotonicPluginFlowBuilderOptions) {
+  constructor(options: BotonicPluginFlowBuilderOptions<ResolvedPlugins, any>) {
     this.apiUrl = options.apiUrl || FLOW_BUILDER_API_URL_PROD
     this.jsonVersion = options.jsonVersion || FlowBuilderJSONVersion.LATEST
     this.flow = options.flow
-    this.getLocale = options.getLocale
-    this.getAccessToken = resolveGetAccessToken(options)
+    this.getLocale =
+      typeof options.getLocale === 'function'
+        ? options.getLocale
+        : (session: Session) => {
+            return session.user.system_locale
+          }
+    this.getAccessToken = resolveGetAccessToken(options.getAccessToken)
     this.trackEvent = options.trackEvent
     this.getKnowledgeBaseResponse = options.getKnowledgeBaseResponse
     this.smartIntentsConfig = {

package/src/tracking.ts

@@ -11,7 +11,6 @@ import { getFlowBuilderPlugin } from './helpers'
 export enum EventAction {
   FlowNode = 'flow_node',
   Keyword = 'nlu_keyword',
-  Intent = 'nlu_intent',
   IntentSmart = 'nlu_intent_smart',
   Knowledgebase = 'knowledgebase',
   Fallback = 'fallback',

package/src/types.ts

@@ -1,5 +1,9 @@
-import { PluginPreRequest, Session } from '@botonic/core'
-import { ActionRequest } from '@botonic/react'
+import {
+  BotContext,
+  PluginPreRequest,
+  ResolvedPlugins,
+  Session,
+} from '@botonic/core'
 
 import { HtFlowBuilderData } from './content-fields/hubtype-fields'
 
@@ -9,27 +13,36 @@ export interface InShadowingConfig {
   allowKnowledgeBases: boolean
 }
 
-export interface BotonicPluginFlowBuilderOptions {
+export interface BotonicPluginFlowBuilderOptions<
+  TPlugins extends ResolvedPlugins = ResolvedPlugins,
+  TExtraData = any,
+> {
   apiUrl?: string
   jsonVersion?: FlowBuilderJSONVersion
   flow?: HtFlowBuilderData
   customFunctions?: Record<any, any>
-  getLocale: (session: Session) => string
+  getLocale?: (session: Session) => string
   getAccessToken: () => string
-  trackEvent?: TrackEventFunction
-  getKnowledgeBaseResponse?: KnowledgeBaseFunction
+  trackEvent?: TrackEventFunction<TPlugins, TExtraData>
+  getKnowledgeBaseResponse?: KnowledgeBaseFunction<TPlugins, TExtraData>
   smartIntentsConfig?: { numSmartIntentsToUse: number }
   inShadowing?: Partial<InShadowingConfig>
 }
 
-export type TrackEventFunction = (
-  request: ActionRequest,
+export type TrackEventFunction<
+  TPlugins extends ResolvedPlugins = ResolvedPlugins,
+  TExtraData = any,
+> = (
+  request: BotContext<TPlugins, TExtraData>,
   eventAction: string,
   args?: Record<string, any>
 ) => Promise<void>
 
-export type KnowledgeBaseFunction = (
-  request: ActionRequest,
+export type KnowledgeBaseFunction<
+  TPlugins extends ResolvedPlugins = ResolvedPlugins,
+  TExtraData = any,
+> = (
+  request: BotContext<TPlugins, TExtraData>,
   sources: string[],
   instructions: string,
   messageId: string,

package/src/user-input/index.ts

@@ -2,7 +2,6 @@ import { ActionRequest } from '@botonic/react'
 
 import { FlowBuilderApi } from '../api'
 import {
-  HtIntentNode,
   HtKeywordNode,
   HtSmartIntentNode,
 } from '../content-fields/hubtype-fields'
@@ -11,7 +10,6 @@ import {
   isKeywordsAllowed,
   isSmartIntentsAllowed,
 } from '../utils'
-import { getIntentNodeByInput } from './intent'
 import { KeywordMatcher } from './keyword'
 import { SmartIntentsApi, SmartIntentsInferenceConfig } from './smart-intent'
 
@@ -20,7 +18,7 @@ export async function getNodeByUserInput(
   locale: string,
   request: ActionRequest,
   smartIntentsConfig: SmartIntentsInferenceConfig
-): Promise<HtSmartIntentNode | HtIntentNode | HtKeywordNode | undefined> {
+): Promise<HtSmartIntentNode | HtKeywordNode | undefined> {
   if (inputHasTextData(request.input)) {
     if (isKeywordsAllowed(request)) {
       const keywordMatcher = new KeywordMatcher({
@@ -47,14 +45,6 @@ export async function getNodeByUserInput(
         return smartIntentNode
       }
     }
-
-    // TODO: Remove this because frontend no allow create intents babel
-    if (isSmartIntentsAllowed(request)) {
-      const intentNode = await getIntentNodeByInput(cmsApi, locale, request)
-      if (intentNode) {
-        return intentNode
-      }
-    }
   }
 
   return undefined

package/src/utils.ts

@@ -2,11 +2,7 @@ import { INPUT, Input, Session } from '@botonic/core'
 import { ActionRequest } from '@botonic/react'
 
 import { getFlowBuilderPlugin } from './helpers'
-import {
-  BotonicPluginFlowBuilderOptions,
-  InShadowingConfig,
-  ProcessEnvNodeEnvs,
-} from './types'
+import { InShadowingConfig, ProcessEnvNodeEnvs } from './types'
 
 function getAccessTokenFromSession(session: Session): string {
   if (!session._access_token) {
@@ -16,13 +12,13 @@ function getAccessTokenFromSession(session: Session): string {
 }
 
 export function resolveGetAccessToken(
-  options: BotonicPluginFlowBuilderOptions
+  getAccessToken: (session: Session) => string
 ): (session: Session) => string {
   switch (process.env.NODE_ENV) {
     case ProcessEnvNodeEnvs.PRODUCTION:
       return getAccessTokenFromSession
     case ProcessEnvNodeEnvs.DEVELOPMENT:
-      return options.getAccessToken
+      return getAccessToken
     default:
       throw new Error('No method defined for getting access token')
   }

package/lib/cjs/content-fields/hubtype-fields/intent.d.ts

@@ -1,10 +0,0 @@
-import { HtBaseNode, HtInputLocale, HtTextLocale } from './common';
-import { HtNodeWithContentType } from './node-types';
-export interface HtIntentNode extends HtBaseNode {
-    type: HtNodeWithContentType.INTENT;
-    content: {
-        title: HtTextLocale[];
-        intents: HtInputLocale[];
-        confidence: number;
-    };
-}

package/lib/cjs/content-fields/hubtype-fields/intent.js

@@ -1,3 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=intent.js.map

package/lib/cjs/content-fields/hubtype-fields/intent.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"intent.js","sourceRoot":"","sources":["../../../../src/content-fields/hubtype-fields/intent.ts"],"names":[],"mappings":""}

package/lib/cjs/user-input/intent.d.ts

@@ -1,4 +0,0 @@
-import { ActionRequest } from '@botonic/react';
-import { FlowBuilderApi } from '../api';
-import { HtIntentNode } from '../content-fields/hubtype-fields';
-export declare function getIntentNodeByInput(cmsApi: FlowBuilderApi, locale: string, request: ActionRequest): Promise<HtIntentNode | undefined>;

package/lib/cjs/user-input/intent.js

@@ -1,45 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getIntentNodeByInput = void 0;
-const tslib_1 = require("tslib");
-const core_1 = require("@botonic/core");
-const tracking_1 = require("../tracking");
-function getIntentNodeByInput(cmsApi, locale, request) {
-    return tslib_1.__awaiter(this, void 0, void 0, function* () {
-        const intentNode = cmsApi.getIntentNode(request.input, locale);
-        if (request.input.confidence && request.input.intent && intentNode) {
-            yield trackIntentEvent(request, intentNode);
-            if (isIntentValid(intentNode, request, cmsApi)) {
-                const targetPayload = cmsApi.getPayload(intentNode.target);
-                request.input.nluResolution = {
-                    type: core_1.NluType.Intent,
-                    matchedValue: request.input.intent,
-                    payload: targetPayload,
-                };
-                return intentNode;
-            }
-        }
-        return undefined;
-    });
-}
-exports.getIntentNodeByInput = getIntentNodeByInput;
-function trackIntentEvent(request, intentNode) {
-    return tslib_1.__awaiter(this, void 0, void 0, function* () {
-        const eventArgs = {
-            nluIntentLabel: request.input.intent,
-            nluIntentConfidence: request.input.confidence,
-            nluIntentThreshold: intentNode === null || intentNode === void 0 ? void 0 : intentNode.content.confidence,
-            nluIntentMessageId: request.input.message_id,
-            userInput: request.input.data,
-            flowThreadId: request.session.flow_thread_id,
-            flowId: intentNode.flow_id,
-            flowNodeId: intentNode.id,
-        };
-        yield (0, tracking_1.trackEvent)(request, tracking_1.EventAction.Intent, eventArgs);
-    });
-}
-function isIntentValid(intentNode, request, cmsApi) {
-    return (request.input.confidence &&
-        cmsApi.hasMetConfidenceThreshold(intentNode, request.input.confidence));
-}
-//# sourceMappingURL=intent.js.map

package/lib/cjs/user-input/intent.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"intent.js","sourceRoot":"","sources":["../../../src/user-input/intent.ts"],"names":[],"mappings":";;;;AAAA,wCAAuC;AAKvC,0CAAqD;AAErD,SAAsB,oBAAoB,CACxC,MAAsB,EACtB,MAAc,EACd,OAAsB;;QAEtB,MAAM,UAAU,GAAG,MAAM,CAAC,aAAa,CAAC,OAAO,CAAC,KAAK,EAAE,MAAM,CAAC,CAAA;QAE9D,IAAI,OAAO,CAAC,KAAK,CAAC,UAAU,IAAI,OAAO,CAAC,KAAK,CAAC,MAAM,IAAI,UAAU,EAAE;YAClE,MAAM,gBAAgB,CAAC,OAAO,EAAE,UAAU,CAAC,CAAA;YAE3C,IAAI,aAAa,CAAC,UAAU,EAAE,OAAO,EAAE,MAAM,CAAC,EAAE;gBAC9C,MAAM,aAAa,GAAG,MAAM,CAAC,UAAU,CAAC,UAAU,CAAC,MAAM,CAAC,CAAA;gBAE1D,OAAO,CAAC,KAAK,CAAC,aAAa,GAAG;oBAC5B,IAAI,EAAE,cAAO,CAAC,MAAM;oBACpB,YAAY,EAAE,OAAO,CAAC,KAAK,CAAC,MAAM;oBAClC,OAAO,EAAE,aAAa;iBACvB,CAAA;gBACD,OAAO,UAAU,CAAA;aAClB;SACF;QAED,OAAO,SAAS,CAAA;IAClB,CAAC;CAAA;AAvBD,oDAuBC;AAED,SAAe,gBAAgB,CAC7B,OAAsB,EACtB,UAAwB;;QAExB,MAAM,SAAS,GAAG;YAChB,cAAc,EAAE,OAAO,CAAC,KAAK,CAAC,MAAM;YACpC,mBAAmB,EAAE,OAAO,CAAC,KAAK,CAAC,UAAU;YAC7C,kBAAkB,EAAE,UAAU,aAAV,UAAU,uBAAV,UAAU,CAAE,OAAO,CAAC,UAAU;YAClD,kBAAkB,EAAE,OAAO,CAAC,KAAK,CAAC,UAAU;YAC5C,SAAS,EAAE,OAAO,CAAC,KAAK,CAAC,IAAI;YAC7B,YAAY,EAAE,OAAO,CAAC,OAAO,CAAC,cAAc;YAC5C,MAAM,EAAE,UAAU,CAAC,OAAO;YAC1B,UAAU,EAAE,UAAU,CAAC,EAAE;SAC1B,CAAA;QACD,MAAM,IAAA,qBAAU,EAAC,OAAO,EAAE,sBAAW,CAAC,MAAM,EAAE,SAAS,CAAC,CAAA;IAC1D,CAAC;CAAA;AAED,SAAS,aAAa,CACpB,UAAwB,EACxB,OAAsB,EACtB,MAAsB;IAEtB,OAAO,CACL,OAAO,CAAC,KAAK,CAAC,UAAU;QACxB,MAAM,CAAC,yBAAyB,CAAC,UAAU,EAAE,OAAO,CAAC,KAAK,CAAC,UAAU,CAAC,CACvE,CAAA;AACH,CAAC"}

package/lib/esm/content-fields/hubtype-fields/intent.d.ts

@@ -1,10 +0,0 @@
-import { HtBaseNode, HtInputLocale, HtTextLocale } from './common';
-import { HtNodeWithContentType } from './node-types';
-export interface HtIntentNode extends HtBaseNode {
-    type: HtNodeWithContentType.INTENT;
-    content: {
-        title: HtTextLocale[];
-        intents: HtInputLocale[];
-        confidence: number;
-    };
-}

package/lib/esm/content-fields/hubtype-fields/intent.js

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=intent.js.map

package/lib/esm/content-fields/hubtype-fields/intent.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"intent.js","sourceRoot":"","sources":["../../../../src/content-fields/hubtype-fields/intent.ts"],"names":[],"mappings":""}

package/lib/esm/user-input/intent.d.ts

@@ -1,4 +0,0 @@
-import { ActionRequest } from '@botonic/react';
-import { FlowBuilderApi } from '../api';
-import { HtIntentNode } from '../content-fields/hubtype-fields';
-export declare function getIntentNodeByInput(cmsApi: FlowBuilderApi, locale: string, request: ActionRequest): Promise<HtIntentNode | undefined>;

package/lib/esm/user-input/intent.js

@@ -1,41 +0,0 @@
-import { __awaiter } from "tslib";
-import { NluType } from '@botonic/core';
-import { EventAction, trackEvent } from '../tracking';
-export function getIntentNodeByInput(cmsApi, locale, request) {
-    return __awaiter(this, void 0, void 0, function* () {
-        const intentNode = cmsApi.getIntentNode(request.input, locale);
-        if (request.input.confidence && request.input.intent && intentNode) {
-            yield trackIntentEvent(request, intentNode);
-            if (isIntentValid(intentNode, request, cmsApi)) {
-                const targetPayload = cmsApi.getPayload(intentNode.target);
-                request.input.nluResolution = {
-                    type: NluType.Intent,
-                    matchedValue: request.input.intent,
-                    payload: targetPayload,
-                };
-                return intentNode;
-            }
-        }
-        return undefined;
-    });
-}
-function trackIntentEvent(request, intentNode) {
-    return __awaiter(this, void 0, void 0, function* () {
-        const eventArgs = {
-            nluIntentLabel: request.input.intent,
-            nluIntentConfidence: request.input.confidence,
-            nluIntentThreshold: intentNode === null || intentNode === void 0 ? void 0 : intentNode.content.confidence,
-            nluIntentMessageId: request.input.message_id,
-            userInput: request.input.data,
-            flowThreadId: request.session.flow_thread_id,
-            flowId: intentNode.flow_id,
-            flowNodeId: intentNode.id,
-        };
-        yield trackEvent(request, EventAction.Intent, eventArgs);
-    });
-}
-function isIntentValid(intentNode, request, cmsApi) {
-    return (request.input.confidence &&
-        cmsApi.hasMetConfidenceThreshold(intentNode, request.input.confidence));
-}
-//# sourceMappingURL=intent.js.map

package/lib/esm/user-input/intent.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"intent.js","sourceRoot":"","sources":["../../../src/user-input/intent.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,eAAe,CAAA;AAKvC,OAAO,EAAE,WAAW,EAAE,UAAU,EAAE,MAAM,aAAa,CAAA;AAErD,MAAM,UAAgB,oBAAoB,CACxC,MAAsB,EACtB,MAAc,EACd,OAAsB;;QAEtB,MAAM,UAAU,GAAG,MAAM,CAAC,aAAa,CAAC,OAAO,CAAC,KAAK,EAAE,MAAM,CAAC,CAAA;QAE9D,IAAI,OAAO,CAAC,KAAK,CAAC,UAAU,IAAI,OAAO,CAAC,KAAK,CAAC,MAAM,IAAI,UAAU,EAAE;YAClE,MAAM,gBAAgB,CAAC,OAAO,EAAE,UAAU,CAAC,CAAA;YAE3C,IAAI,aAAa,CAAC,UAAU,EAAE,OAAO,EAAE,MAAM,CAAC,EAAE;gBAC9C,MAAM,aAAa,GAAG,MAAM,CAAC,UAAU,CAAC,UAAU,CAAC,MAAM,CAAC,CAAA;gBAE1D,OAAO,CAAC,KAAK,CAAC,aAAa,GAAG;oBAC5B,IAAI,EAAE,OAAO,CAAC,MAAM;oBACpB,YAAY,EAAE,OAAO,CAAC,KAAK,CAAC,MAAM;oBAClC,OAAO,EAAE,aAAa;iBACvB,CAAA;gBACD,OAAO,UAAU,CAAA;aAClB;SACF;QAED,OAAO,SAAS,CAAA;IAClB,CAAC;CAAA;AAED,SAAe,gBAAgB,CAC7B,OAAsB,EACtB,UAAwB;;QAExB,MAAM,SAAS,GAAG;YAChB,cAAc,EAAE,OAAO,CAAC,KAAK,CAAC,MAAM;YACpC,mBAAmB,EAAE,OAAO,CAAC,KAAK,CAAC,UAAU;YAC7C,kBAAkB,EAAE,UAAU,aAAV,UAAU,uBAAV,UAAU,CAAE,OAAO,CAAC,UAAU;YAClD,kBAAkB,EAAE,OAAO,CAAC,KAAK,CAAC,UAAU;YAC5C,SAAS,EAAE,OAAO,CAAC,KAAK,CAAC,IAAI;YAC7B,YAAY,EAAE,OAAO,CAAC,OAAO,CAAC,cAAc;YAC5C,MAAM,EAAE,UAAU,CAAC,OAAO;YAC1B,UAAU,EAAE,UAAU,CAAC,EAAE;SAC1B,CAAA;QACD,MAAM,UAAU,CAAC,OAAO,EAAE,WAAW,CAAC,MAAM,EAAE,SAAS,CAAC,CAAA;IAC1D,CAAC;CAAA;AAED,SAAS,aAAa,CACpB,UAAwB,EACxB,OAAsB,EACtB,MAAsB;IAEtB,OAAO,CACL,OAAO,CAAC,KAAK,CAAC,UAAU;QACxB,MAAM,CAAC,yBAAyB,CAAC,UAAU,EAAE,OAAO,CAAC,KAAK,CAAC,UAAU,CAAC,CACvE,CAAA;AACH,CAAC"}

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

@@ -1,12 +0,0 @@
-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: {
-    title: HtTextLocale[]
-    intents: HtInputLocale[]
-    confidence: number
-  }
-}

package/src/user-input/intent.ts

@@ -1,59 +0,0 @@
-import { NluType } from '@botonic/core'
-import { ActionRequest } from '@botonic/react'
-
-import { FlowBuilderApi } from '../api'
-import { HtIntentNode } from '../content-fields/hubtype-fields'
-import { EventAction, trackEvent } from '../tracking'
-
-export async function getIntentNodeByInput(
-  cmsApi: FlowBuilderApi,
-  locale: string,
-  request: ActionRequest
-): Promise<HtIntentNode | undefined> {
-  const intentNode = cmsApi.getIntentNode(request.input, locale)
-
-  if (request.input.confidence && request.input.intent && intentNode) {
-    await trackIntentEvent(request, intentNode)
-
-    if (isIntentValid(intentNode, request, cmsApi)) {
-      const targetPayload = cmsApi.getPayload(intentNode.target)
-
-      request.input.nluResolution = {
-        type: NluType.Intent,
-        matchedValue: request.input.intent,
-        payload: targetPayload,
-      }
-      return intentNode
-    }
-  }
-
-  return undefined
-}
-
-async function trackIntentEvent(
-  request: ActionRequest,
-  intentNode: HtIntentNode
-) {
-  const eventArgs = {
-    nluIntentLabel: request.input.intent,
-    nluIntentConfidence: request.input.confidence,
-    nluIntentThreshold: intentNode?.content.confidence,
-    nluIntentMessageId: request.input.message_id,
-    userInput: request.input.data,
-    flowThreadId: request.session.flow_thread_id,
-    flowId: intentNode.flow_id,
-    flowNodeId: intentNode.id,
-  }
-  await trackEvent(request, EventAction.Intent, eventArgs)
-}
-
-function isIntentValid(
-  intentNode: HtIntentNode,
-  request: ActionRequest,
-  cmsApi: FlowBuilderApi
-) {
-  return (
-    request.input.confidence &&
-    cmsApi.hasMetConfidenceThreshold(intentNode, request.input.confidence)
-  )
-}