@botonic/core 1.0.0-dev.0 → 1.0.0-dev.2

package/src/core-bot.ts

@@ -1,16 +1,23 @@
-import { Inspector } from './debug/inspector'
+import { Inspector } from './debug'
 import { getString } from './i18n'
-import { BotRequest, BotResponse, Locales, Routes, Session } from './index'
-import { BotonicEvent } from './models/events'
+import {
+  BotonicEvent,
+  BotRequest,
+  BotResponse,
+  BotState,
+  Locales,
+  Route,
+  Routes,
+  Session,
+} from './models'
 import { BotonicOutputParser } from './output-parser'
 import { loadPlugins, runPlugins } from './plugins'
-import { Router } from './router'
-import { isFunction } from './utils'
+import { getComputedRoutes, Router } from './routing'
 
 interface CoreBotConfig {
   appId?: string
   defaultDelay?: number
-  defaultRoutes?: Routes
+  defaultRoutes?: Route[]
   defaultTyping?: number
   inspector?: Inspector
   locales: Locales
@@ -22,18 +29,20 @@ interface CoreBotConfig {
 export class CoreBot {
   appId?: string
   defaultDelay?: number
-  defaultRoutes?: Routes
+  defaultRoutes: Route[]
   defaultTyping?: number
-  inspector?: Inspector
+  inspector: Inspector
   locales: Locales
   plugins?: Record<string, Plugin>
   renderer: any
   rootElement: any
-  router: any
+  router: Router | null
   routes: Routes
   theme?: any
+  botonicOutputParser = new BotonicOutputParser()
 
   constructor({
+    // TODO: Receives dataProvider
     renderer,
     routes,
     locales,
@@ -60,85 +69,113 @@ export class CoreBot {
     this.inspector = inspector || new Inspector()
     this.routes = routes
     this.defaultRoutes = defaultRoutes || []
-    this.router = isFunction(this.routes)
-      ? null
-      : new Router(
-          // @ts-ignore
-          [...this.routes, ...this.defaultRoutes],
-          this.inspector.routeInspector
-        )
+    this.router =
+      this.routes instanceof Function
+        ? null
+        : new Router(
+            [...this.routes, ...this.defaultRoutes],
+            this.inspector.routeInspector
+          )
   }
 
-  getString(id: string, session: Session): string {
-    // @ts-ignore
-    return getString(this.locales, session.__locale, id)
+  getString(id: string, botState: BotState): string {
+    if (!botState.locale) {
+      console.error('Locale is not defined')
+      return ''
+    }
+    return getString(this.locales, botState.locale, id)
   }
 
-  setLocale(locale: string, session: Session): void {
-    session.__locale = locale
+  setLocale(locale: string, botState: BotState): void {
+    botState.locale = locale
   }
 
   async input({
     input,
     session,
-    lastRoutePath,
+    botState,
+    dataProvider,
   }: BotRequest): Promise<BotResponse> {
-    session = session || {}
-    if (!session.__locale) session.__locale = 'en'
-
+    if (!botState?.locale) botState.locale = 'en'
     if (this.plugins) {
-      await runPlugins(this.plugins, 'pre', input, session, lastRoutePath)
+      await runPlugins(
+        this.plugins,
+        'pre',
+        input,
+        session,
+        botState,
+        undefined,
+        undefined,
+        dataProvider
+      )
     }
 
-    if (isFunction(this.routes)) {
+    if (this.routes instanceof Function) {
       this.router = new Router(
         [
-          // @ts-ignore
-          ...(await this.routes({ input, session, lastRoutePath })),
-          // @ts-ignore
+          ...(await getComputedRoutes(this.routes, {
+            input,
+            session,
+            botState,
+          })),
           ...this.defaultRoutes,
         ],
-        // @ts-ignore
         this.inspector.routeInspector
       )
     }
 
-    const output = this.router.processInput(input, session, lastRoutePath)
+    const output = (this.router as Router).processInput(
+      input,
+      session,
+      botState
+    )
 
     const request = {
-      getString: stringId => this.getString(stringId, session),
-      setLocale: locale => this.setLocale(locale, session),
+      getString: stringId => this.getString(stringId, botState),
+      setLocale: locale => this.setLocale(locale, botState),
       session: session || {},
       params: output.params || {},
       input: input,
       plugins: this.plugins,
       defaultTyping: this.defaultTyping,
       defaultDelay: this.defaultDelay,
-      lastRoutePath,
+      botState,
+      dataProvider,
     }
 
-    const actions = [output.action, output.retryAction, output.defaultAction]
+    const response = await this.renderer({
+      request,
+      actions: [output.fallbackAction, output.action, output.emptyAction],
+    })
+
+    const messageEvents: Partial<BotonicEvent>[] = this.botonicOutputParser.xmlToMessageEvents(
+      response
+    )
 
-    const response = await this.renderer({ request, actions })
-    let parsedResponse: Partial<BotonicEvent>[] | null = null
-    try {
-      parsedResponse = new BotonicOutputParser().xmlToMessageEvents(response)
-    } catch (e) {}
+    botState.lastRoutePath = output.botState.lastRoutePath // not needed if updated below
 
-    lastRoutePath = output.lastRoutePath
     if (this.plugins) {
       await runPlugins(
         this.plugins,
         'post',
         input,
-        session,
-        lastRoutePath,
+        session, // passing output.session instead
+        botState, // passing output.botState instead
         response,
-        parsedResponse
+        messageEvents,
+        dataProvider
       )
     }
 
-    session.is_first_interaction = false
-    return { input, response, parsedResponse, session, lastRoutePath }
+    botState.isFirstInteraction = false
+
+    return {
+      input, // Delete
+      response, // xml/rendered react for actions (not needed)
+      messageEvents, // xml to Botonic Events
+      session, // to be output.session
+      botState, // to be output.botState
+      dataProvider, // no need to return it
+    }
   }
 }

package/src/debug/index.ts

@@ -1,6 +1 @@
-export {
-  FocusRouteInspector,
-  Inspector,
-  LogRouteInspector,
-  RouteInspector,
-} from './inspector'
+export * from './inspector'

package/src/debug/inspector.ts

@@ -1,4 +1,4 @@
-import { Input, Route, RouteMatcher } from '../index'
+import { Route, RouteMatcher } from '../models'
 export class RouteInspector {
   routeMatched(
     _route: Route,

package/src/handoff.ts

@@ -1,6 +1,7 @@
 import axios from 'axios'
 
-import { Session } from './index'
+import { PATH_PAYLOAD_IDENTIFIER } from './constants'
+import { BotState, Session } from './models'
 
 const HUBTYPE_API_URL = 'https://api.hubtype.com'
 
@@ -56,7 +57,7 @@ export async function getOpenQueues(
 }
 
 export class HandOffBuilder {
-  _session: SessionWithBotonicAction
+  _botState: any
   _queue: string
   _onFinish: string
   _email: string
@@ -65,8 +66,8 @@ export class HandOffBuilder {
   _caseInfo: string
   _shadowing: boolean
 
-  constructor(session: SessionWithBotonicAction) {
-    this._session = session
+  constructor(botState: any) {
+    this._botState = botState
   }
 
   withQueue(queueNameOrId: string): this {
@@ -80,7 +81,7 @@ export class HandOffBuilder {
   }
 
   withOnFinishPath(path: string): this {
-    this._onFinish = `__PATH_PAYLOAD__${path}`
+    this._onFinish = `${PATH_PAYLOAD_IDENTIFIER}${path}`
     return this
   }
 
@@ -111,7 +112,7 @@ export class HandOffBuilder {
 
   async handOff(): Promise<void> {
     return _humanHandOff(
-      this._session,
+      this._botState,
       this._queue,
       this._onFinish,
       this._email,
@@ -153,7 +154,7 @@ interface HubtypeHandoffParams {
   on_finish?: string
 }
 async function _humanHandOff(
-  session: SessionWithBotonicAction,
+  botState: any,
   queueNameOrId = '',
   onFinish: string,
   agentEmail = '',
@@ -184,7 +185,8 @@ async function _humanHandOff(
   if (onFinish) {
     params.on_finish = onFinish
   }
-  session._botonic_action = `create_case:${JSON.stringify(params)}`
+  botState.botonicAction = `create_case:${JSON.stringify(params)}`
+  botState.isHandoff = true
 }
 
 export async function storeCaseRating(
@@ -255,14 +257,15 @@ export async function getAgentVacationRanges(
 }
 
 export function cancelHandoff(
-  session: SessionWithBotonicAction,
+  botState: BotState,
   typification: string | null = null
 ): void {
   let action = 'discard_case'
   if (typification) action = `${action}:${JSON.stringify({ typification })}`
-  session._botonic_action = action
+  botState.botonicAction = action
+  botState.isHandoff = false // TODO: Review handoff functionalities
 }
 
-export function deleteUser(session: SessionWithBotonicAction): void {
-  session._botonic_action = `delete_user`
+export function deleteUser(botState: BotState): void {
+  botState.botonicAction = `delete_user`
 }

package/src/hubtype-service.ts

@@ -2,7 +2,7 @@ import axios, { AxiosResponse } from 'axios'
 import Pusher, { AuthOptions, Channel } from 'pusher-js'
 import Channels from 'pusher-js/types/src/core/channels/channels'
 
-import { Input, SessionUser } from './index'
+import { Input } from './models'
 import { getWebpackEnvVar } from './utils'
 
 interface UnsentInput {
@@ -21,7 +21,7 @@ interface ServerConfig {
 }
 interface HubtypeServiceArgs {
   appId: string
-  user: SessionUser
+  user: any
   lastMessageId: string
   lastMessageUpdateDate: string
   onEvent: any
@@ -50,7 +50,7 @@ const PONG_TIMEOUT = 5 * 1000 // https://pusher.com/docs/channels/using_channels
  */
 export class HubtypeService {
   appId: string
-  user: SessionUser
+  user: any
   lastMessageId: string
   lastMessageUpdateDate: string
   onEvent: any
@@ -185,7 +185,7 @@ export class HubtypeService {
   }
 
   handleConnectionChange(online: boolean): void {
-    this.onPusherEvent({ action: 'connectionChange', online })
+    this.onPusherEvent({ action: 'connection_change', online })
   }
 
   onPusherEvent(event: any): void {
@@ -213,7 +213,7 @@ export class HubtypeService {
   /**
    * @return {Promise<void>}
    */
-  async postMessage(user: SessionUser, message: any): Promise<void> {
+  async postMessage(user: any, message: any): Promise<void> {
     try {
       // @ts-ignore
       await this.init(user)

package/src/i18n.ts

@@ -1,5 +1,5 @@
 // eslint-disable-next-line filenames/match-regex
-import { Locales } from './index'
+import { Locales } from './models'
 
 export const getString = (
   locales: Locales,

package/src/index.ts

@@ -1,233 +1,11 @@
-import { BotonicEvent } from './models/events'
-export { Providers } from './constants'
-export { CoreBot } from './core-bot'
+export * from './constants'
+export * from './core-bot'
 export * from './debug'
 export * from './handoff'
-export { HubtypeService } from './hubtype-service'
-export { getString } from './i18n'
-export { Router } from './router'
+export * from './hubtype-service'
+export * from './i18n'
+export * from './models'
+export * from './output-parser'
+export * from './plugins'
+export * from './routing'
 export * from './utils'
-
-export type CaseStatusType =
-  | typeof CASE_STATUS.ATTENDING
-  | typeof CASE_STATUS.IDLE
-  | typeof CASE_STATUS.RESOLVED
-  | typeof CASE_STATUS.WAITING
-
-export type CaseResolution =
-  | typeof CASE_RESOLUTION.BANNED
-  | typeof CASE_RESOLUTION.NOK
-  | typeof CASE_RESOLUTION.NOT_SOLVED
-  | typeof CASE_RESOLUTION.OK
-
-export const PROVIDER = Object.freeze({
-  DEV: 'dev',
-  FACEBOOK: 'facebook',
-  GENERIC: 'generic',
-  INTERCOM: 'intercom',
-  SMOOCH: 'smooch',
-  TELEGRAM: 'telegram',
-  TWITTER: 'twitter',
-  WEBCHAT: 'webchat',
-  WECHAT: 'wechat',
-  WHATSAPP: 'whatsapp',
-})
-
-export const INPUT = Object.freeze({
-  TEXT: 'text',
-  POSTBACK: 'postback',
-  AUDIO: 'audio',
-  IMAGE: 'image',
-  VIDEO: 'video',
-  DOCUMENT: 'document',
-  LOCATION: 'location',
-  CONTACT: 'contact',
-  BUTTON_MESSAGE: 'buttonmessage',
-  CAROUSEL: 'carousel',
-  CUSTOM: 'custom',
-  WEBCHAT_SETTINGS: 'webchatsettings',
-  WHATSAPP_TEMPLATE: 'whatsapptemplate',
-  RAW: 'raw',
-})
-
-export const CASE_STATUS = Object.freeze({
-  WAITING: 'status_waiting',
-  ATTENDING: 'status_attending',
-  IDLE: 'status_idle',
-  RESOLVED: 'status_resolved',
-})
-
-export const CASE_RESOLUTION = Object.freeze({
-  OK: 'result_ok',
-  NOK: 'result_nok',
-  NOT_SOLVED: 'result_not_solved',
-  BANNED: 'result_banned',
-})
-
-export interface Locales {
-  [id: string]: string | string[] | Locales
-}
-
-interface PluginConstructor<T> {
-  new (arg: T): Plugin
-}
-
-export interface PluginConfig<T> {
-  id: string
-  options?: T
-  resolve: { default: PluginConstructor<T> }
-}
-
-export type InputType =
-  | typeof INPUT.AUDIO
-  | typeof INPUT.BUTTON_MESSAGE
-  | typeof INPUT.CAROUSEL
-  | typeof INPUT.CONTACT
-  | typeof INPUT.CUSTOM
-  | typeof INPUT.DOCUMENT
-  | typeof INPUT.IMAGE
-  | typeof INPUT.LOCATION
-  | typeof INPUT.POSTBACK
-  | typeof INPUT.TEXT
-  | typeof INPUT.VIDEO
-  | typeof INPUT.WEBCHAT_SETTINGS
-  | typeof INPUT.WHATSAPP_TEMPLATE
-
-export interface IntentResult {
-  intent: string
-  confidence: number
-}
-
-/** Generated by Translation plugins: GoogleTranslation **/
-export interface Translations {
-  [languageCode: string]: string
-}
-
-/** Fields set by NLU plugins: Luis, Dialogflow, ... **/
-export interface NluResult {
-  // the name of the highest confidence intent
-  confidence: number
-  intent: string
-  intents: IntentResult[]
-  language: string
-  // entity recognition results in the format provided by the NLU engine
-  entities?: any
-  translations: Translations
-}
-
-export interface Input extends Partial<NluResult> {
-  data?: string
-  path?: string
-  payload?: string
-  type: InputType
-}
-
-export type ProviderType =
-  | typeof PROVIDER.DEV
-  | typeof PROVIDER.FACEBOOK
-  | typeof PROVIDER.GENERIC
-  | typeof PROVIDER.INTERCOM
-  | typeof PROVIDER.SMOOCH
-  | typeof PROVIDER.TELEGRAM
-  | typeof PROVIDER.TWITTER
-  | typeof PROVIDER.WEBCHAT
-  | typeof PROVIDER.WECHAT
-  | typeof PROVIDER.WHATSAPP
-
-export interface SessionUser {
-  id: string
-  // login
-  username?: string
-  // person name
-  name?: string
-  // whatsapp, telegram,...
-  provider: ProviderType
-  // The provider's user id
-  extra_data?: any
-  imp_id?: string
-  provider_id?: string
-}
-
-// eslint-disable @typescript-eslint/naming-convention
-export interface Session {
-  bot: {
-    id: string
-    name?: string
-  }
-  __locale?: string
-  __retries?: number
-  is_first_interaction: boolean
-  last_session?: any
-  organization?: string
-  user: SessionUser
-  // after handoff
-  _hubtype_case_status?: CaseStatusType
-  _hubtype_case_typification?: string
-  _shadowing?: boolean
-}
-// eslint-enable @typescript-eslint/naming-convention
-
-type InputMatcher = (input: Input) => boolean
-type ParamsMatcher =
-  | { [key: string]: string }
-  | ((params: { [key: string]: string }) => boolean)
-type SessionMatcher = (session: Session) => boolean
-type RequestMatcher = (request: BotRequest) => boolean
-type StringMatcher = RegExp | string | ((data: string) => boolean)
-
-export type RouteMatcher =
-  | InputMatcher
-  | ParamsMatcher
-  | RequestMatcher
-  | SessionMatcher
-  | StringMatcher
-
-export interface Route {
-  action?: any
-  childRoutes?: Route[]
-  defaultAction?: any
-  lastRoutePath?: string
-  ignoreRetry?: boolean
-  path?: StringMatcher
-  redirect?: string
-  retry?: number
-  retryAction?: any
-
-  // matchers
-  input?: InputMatcher
-  intent?: StringMatcher
-  params?: ParamsMatcher
-  payload?: StringMatcher
-  request?: RequestMatcher
-  session?: SessionMatcher
-  text?: StringMatcher
-  data?: StringMatcher
-  type?: StringMatcher
-}
-
-export type Routes<R = Route> = R[] | ((_: BotRequest) => R[])
-
-export interface BotRequest {
-  input: Input
-  lastRoutePath: string
-  session: Session
-}
-
-/** The response of the bot for the triggered actions, which can be
- * the one matched by the routes, the default action and the retry actions.
- * See Response at @botonic/react's index.d.ts for the React type
- * */
-export interface BotResponse extends BotRequest {
-  response: any
-  parsedResponse: Partial<BotonicEvent>[] | null
-}
-
-export type PluginPreRequest = BotRequest
-export type PluginPostRequest = BotResponse
-
-export interface Plugin {
-  post(_: PluginPostRequest): void
-  pre(pluginRequest: PluginPreRequest): void
-}
-
-export type Params = { [key: string]: string }

package/src/models/bot-state.ts

@@ -0,0 +1,12 @@
+import { RoutePath } from './legacy-types'
+
+export interface BotState {
+  botId: string
+  isFirstInteraction: boolean
+  isHandoff: boolean
+  isShadowing: boolean
+  lastRoutePath: RoutePath
+  locale?: string
+  retries: number
+  botonicAction?: any
+}

package/src/models/channels.ts

@@ -0,0 +1,9 @@
+export enum Channels {
+  DEV = 'dev',
+  FACEBOOK = 'facebook',
+  GENERIC = 'generic',
+  TELEGRAM = 'telegram',
+  TWITTER = 'twitter',
+  WEBCHAT = 'webchat',
+  WHATSAPP = 'whatsapp',
+}

package/src/models/events/base-event.ts

@@ -0,0 +1,22 @@
+export enum EventTypes {
+  CONNECTION = 'connection',
+  MESSAGE = 'message',
+  ACK = 'ack',
+  TRACK = 'track',
+  // Integration Events
+  NEW_USER = 'newUser',
+  RECEIVED_MESSAGE = 'receivedMessage',
+  BOT_EXECUTED = 'botExecuted',
+  BOT_ACTION = 'botAction',
+  ACTION_SENT = 'actionSent',
+}
+
+export interface BaseEvent {
+  eventId: string
+  userId: string
+  eventType: EventTypes
+  createdAt: string
+  modifiedAt?: string
+  channel: string
+  idFromChannel: string
+}

package/src/models/events/botonic-event.ts

@@ -0,0 +1,26 @@
+import { ConnectionEvent } from './connection'
+import { IntegrationEvent } from './integration'
+import {
+  AudioMessageEvent,
+  CarouselMessageEvent,
+  CustomMessageEvent,
+  DocumentMessageEvent,
+  ImageMessageEvent,
+  LocationMessageEvent,
+  PostbackMessageEvent,
+  TextMessageEvent,
+  VideoMessageEvent,
+} from './message'
+
+export type BotonicEvent =
+  | TextMessageEvent
+  | PostbackMessageEvent
+  | AudioMessageEvent
+  | DocumentMessageEvent
+  | ImageMessageEvent
+  | VideoMessageEvent
+  | LocationMessageEvent
+  | CarouselMessageEvent
+  | CustomMessageEvent
+  | ConnectionEvent
+  | IntegrationEvent

package/src/models/events/{connections/index.ts → connection/connection-event.ts}

@@ -1,4 +1,4 @@
-import { BaseEvent, EventTypes } from '..'
+import { BaseEvent, EventTypes } from '../base-event'
 
 export enum ConnectionEventStatuses {
   CONNECTED = 'connected',

package/src/models/events/connection/index.ts

@@ -0,0 +1 @@
+export * from './connection-event'