Merge branch 'master-lts' into BLT-1591-remove-get-string-function-from-request-bot-context

Author: Iru89

packages/botonic-core/src/models/legacy-types.ts

@@ -225,7 +225,7 @@ export interface Campaign {
   template_name: string
 }
 
-export interface SessionUser {
+export interface SessionUser<TExtraData = any> {
   id: string
   // login
   username?: string
@@ -234,7 +234,7 @@ export interface SessionUser {
   // whatsapp, telegram,...
   provider: ProviderType
   // The provider's user id
-  extra_data?: any
+  extra_data?: TExtraData
   imp_id?: string
   provider_id?: string
   locale: string
@@ -253,7 +253,7 @@ export interface SessionBot {
   name?: string
 }
 
-export interface Session {
+export interface Session<TExtraData = any> {
   bot: SessionBot
   __retries: number
   _access_token: string
@@ -263,7 +263,7 @@ export interface Session {
   last_session?: any
   organization_id: string
   organization: string
-  user: SessionUser
+  user: SessionUser<TExtraData>
   // after handoff
   _botonic_action?: BotonicActionType
   _hubtype_case_status?: CaseStatusType
@@ -314,14 +314,18 @@ export interface Route {
 
 export type Routes<R = Route> = R[] | ((_: BotRequest) => R[])
 
-export interface BotRequest {
+export interface BotRequest<TExtraData = any> {
   input: Input
   lastRoutePath: RoutePath
-  session: Session
+  session: Session<TExtraData>
 }
 
-export interface BotContext<T extends ResolvedPlugins = ResolvedPlugins>
-  extends BotRequest {
+export interface BotContext<
+  TPlugins extends ResolvedPlugins = ResolvedPlugins,
+  TExtraData = any,
+> extends BotRequest<TExtraData> {
+  // TODO: remove getString function?
+  getString: (stringId: string) => string
   getUserCountry: () => string
   getUserLocale: () => string
   getSystemLocale: () => string
@@ -331,7 +335,7 @@ export interface BotContext<T extends ResolvedPlugins = ResolvedPlugins>
   defaultDelay: number
   defaultTyping: number
   params: Record<string, string>
-  plugins: T
+  plugins: TPlugins
 }
 
 /** The response of the bot for the triggered actions, which can be
@@ -342,13 +346,17 @@ export interface BotResponse extends BotRequest {
   response: any
 }
 
-export type PluginPreRequest<T extends ResolvedPlugins = ResolvedPlugins> =
-  BotContext<T>
+export type PluginPreRequest<
+  TPlugins extends ResolvedPlugins = ResolvedPlugins,
+  TExtraData = any,
+> = BotContext<TPlugins, TExtraData>
 
-export type PluginPostRequest<T extends ResolvedPlugins = ResolvedPlugins> =
-  BotContext<T> & {
-    response: string | null
-  }
+export type PluginPostRequest<
+  TPlugins extends ResolvedPlugins = ResolvedPlugins,
+  TExtraData = any,
+> = BotContext<TPlugins, TExtraData> & {
+  response: string | null
+}
 
 export interface Plugin {
   post?(request: PluginPostRequest): void | Promise<void>

packages/botonic-plugin-flow-builder/src/index.ts

@@ -66,7 +66,7 @@ export default class BotonicPluginFlowBuilder implements Plugin {
   public jsonVersion: FlowBuilderJSONVersion
   public apiUrl: string
 
-  constructor(options: BotonicPluginFlowBuilderOptions<ResolvedPlugins>) {
+  constructor(options: BotonicPluginFlowBuilderOptions<ResolvedPlugins, any>) {
     this.apiUrl = options.apiUrl || FLOW_BUILDER_API_URL_PROD
     this.jsonVersion = options.jsonVersion || FlowBuilderJSONVersion.LATEST
     this.flow = options.flow

packages/botonic-plugin-flow-builder/src/types.ts

@@ -13,33 +13,41 @@ export interface InShadowingConfig {
   allowKnowledgeBases: boolean
 }
 
-export interface BotonicPluginFlowBuilderOptions<T extends ResolvedPlugins> {
+export interface BotonicPluginFlowBuilderOptions<
+  TPlugins extends ResolvedPlugins = ResolvedPlugins,
+  TExtraData = any,
+> {
   apiUrl?: string
   jsonVersion?: FlowBuilderJSONVersion
   flow?: HtFlowBuilderData
   customFunctions?: Record<any, any>
   getLocale: (session: Session) => string
   getAccessToken: () => string
-  trackEvent?: TrackEventFunction<T>
-  getKnowledgeBaseResponse?: KnowledgeBaseFunction<T>
+  trackEvent?: TrackEventFunction<TPlugins, TExtraData>
+  getKnowledgeBaseResponse?: KnowledgeBaseFunction<TPlugins, TExtraData>
   smartIntentsConfig?: { numSmartIntentsToUse: number }
   inShadowing?: Partial<InShadowingConfig>
 }
 
-export type TrackEventFunction<T extends ResolvedPlugins = ResolvedPlugins> = (
-  request: BotContext<T>,
+export type TrackEventFunction<
+  TPlugins extends ResolvedPlugins = ResolvedPlugins,
+  TExtraData = any,
+> = (
+  request: BotContext<TPlugins, TExtraData>,
   eventAction: string,
   args?: Record<string, any>
 ) => Promise<void>
 
-export type KnowledgeBaseFunction<T extends ResolvedPlugins = ResolvedPlugins> =
-  (
-    request: BotContext<T>,
-    sources: string[],
-    instructions: string,
-    messageId: string,
-    memoryLength: number
-  ) => Promise<KnowledgeBaseResponse>
+export type KnowledgeBaseFunction<
+  TPlugins extends ResolvedPlugins = ResolvedPlugins,
+  TExtraData = any,
+> = (
+  request: BotContext<TPlugins, TExtraData>,
+  sources: string[],
+  instructions: string,
+  messageId: string,
+  memoryLength: number
+) => Promise<KnowledgeBaseResponse>
 
 export interface FlowBuilderApiOptions {
   url: string