@botonic/core 0.26.0 → 0.27.0-alpha.0

package/lib/esm/utils.js.map

@@ -1 +1 @@
-{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../src/utils.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,MAAM,GAAG,GAAY,EAAE;IAClC,aAAa;IACb,OAAO,OAAO,OAAO,KAAK,WAAW;QACnC,CAAC,CAAC,aAAa;YACb,OAAO;QACT,CAAC,CAAC,OAAO,OAAO,KAAK,WAAW;YAC5B,OAAO,CAAC,QAAQ,KAAK,IAAI;YACzB,OAAO,CAAC,QAAQ,CAAC,IAAI,KAAK,IAAI,CAAA;AACtC,CAAC,CAAA;AAED,MAAM,CAAC,MAAM,SAAS,GAAG,GAAY,EAAE;;IACrC,aAAa;IACb,OAAO,OAAO,UAAU,KAAK,WAAW;QACtC,CAAC,CAAC,aAAa;YACb,UAAU;QACZ,CAAC,CAAC,OAAO,MAAM,KAAK,WAAW;YAC3B,OAAO,MAAM,CAAC,QAAQ,KAAK,WAAW;YACtC,CAAC,CAAA,MAAA,MAAA,MAAM,CAAC,OAAO,0CAAE,QAAQ,0CAAE,IAAI,CAAA,CAAA;AACvC,CAAC,CAAA;AAED,MAAM,CAAC,MAAM,QAAQ,GAAG,CAAC,gBAAgB,GAAG,GAAG,EAAW,EAAE;IAC1D,IAAI,SAAS,EAAE,EAAE;QACf,MAAM,CAAC,GAAG,IAAI,CAAC,GAAG,CAChB,QAAQ,CAAC,eAAe,CAAC,WAAW,EACpC,MAAM,CAAC,UAAU,IAAI,CAAC,CACvB,CAAA;QACD,IAAI,CAAC,GAAG,gBAAgB,EAAE;YACxB,OAAO,IAAI,CAAA;SACZ;KACF;IACD,OAAO,KAAK,CAAA;AACd,CAAC,CAAA;AAED,MAAM,UAAU,UAAU,CAAC,CAAM;IAC/B,OAAO,OAAO,CAAC,KAAK,UAAU,CAAA;AAChC,CAAC;AAED,MAAM,UAAU,WAAW,CAAC,MAAW;IACrC,IAAI,CAAC,MAAM;QAAE,OAAO,EAAE,CAAA;IACtB,yBAAY,MAAM,EAAE;AACtB,CAAC;AAED,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAC,MAAiC,EAAU,EAAE,CAC9E,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC;KACnB,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAM,EAAE,EAAE,CAAC,GAAG,kBAAkB,CAAC,CAAC,CAAC,IAAI,kBAAkB,CAAC,CAAC,CAAC,EAAE,CAAC;KACzE,IAAI,CAAC,GAAG,CAAC,CAAA;AAEd,wEAAwE;AACxE,4DAA4D;AAC5D,wEAAwE;AACxE,MAAM,CAAC,MAAM,IAAI,GAAG,CAAC,GAAG,QAAkB,EAAU,EAAE;IACpD,iDAAiD;IACjD,IAAI,KAAK,GAAa,EAAE,CAAA;IACxB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,QAAQ,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,EAAE;QAC/C,KAAK,GAAG,KAAK,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAA;KAC7C;IACD,4DAA4D;IAC5D,MAAM,QAAQ,GAAa,EAAE,CAAA;IAC7B,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,EAAE;QAC5C,MAAM,IAAI,GAAG,KAAK,CAAC,CAAC,CAAC,CAAA;QACrB,sCAAsC;QACtC,2BAA2B;QAC3B,IAAI,CAAC,IAAI,IAAI,IAAI,KAAK,GAAG;YAAE,SAAQ;QACnC,yCAAyC;QACzC,IAAI,IAAI,KAAK,IAAI;YAAE,QAAQ,CAAC,GAAG,EAAE,CAAA;QACjC,0BAA0B;;YACrB,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;KACzB;IACD,+CAA+C;IAC/C,aAAa;IACb,IAAI,KAAK,CAAC,CAAC,CAAC,KAAK,EAAE;QAAE,QAAQ,CAAC,OAAO,CAAC,EAAE,CAAC,CAAA;IACzC,uCAAuC;IACvC,OAAO,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,CAAA;AAC5D,CAAC,CAAA;AAED,iDAAiD;AACjD,4DAA4D;AAC5D,MAAM,CAAC,MAAM,OAAO,GAAG,CAAC,IAAY,EAAU,EAAE,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,CAAA"}
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../src/utils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAW,MAAM,uBAAuB,CAAA;AAEzD,MAAM,CAAC,MAAM,MAAM,GAAG,GAAY,EAAE;IAClC,aAAa;IACb,OAAO,OAAO,OAAO,KAAK,WAAW;QACnC,CAAC,CAAC,aAAa;YACb,OAAO;QACT,CAAC,CAAC,OAAO,OAAO,KAAK,WAAW;YAC5B,OAAO,CAAC,QAAQ,KAAK,IAAI;YACzB,OAAO,CAAC,QAAQ,CAAC,IAAI,KAAK,IAAI,CAAA;AACtC,CAAC,CAAA;AAED,MAAM,CAAC,MAAM,SAAS,GAAG,GAAY,EAAE;;IACrC,aAAa;IACb,OAAO,OAAO,UAAU,KAAK,WAAW;QACtC,CAAC,CAAC,aAAa;YACb,UAAU;QACZ,CAAC,CAAC,OAAO,MAAM,KAAK,WAAW;YAC3B,OAAO,MAAM,CAAC,QAAQ,KAAK,WAAW;YACtC,CAAC,CAAA,MAAA,MAAA,MAAM,CAAC,OAAO,0CAAE,QAAQ,0CAAE,IAAI,CAAA,CAAA;AACvC,CAAC,CAAA;AAED,MAAM,CAAC,MAAM,QAAQ,GAAG,CAAC,gBAAgB,GAAG,GAAG,EAAW,EAAE;IAC1D,IAAI,SAAS,EAAE,EAAE;QACf,MAAM,CAAC,GAAG,IAAI,CAAC,GAAG,CAChB,QAAQ,CAAC,eAAe,CAAC,WAAW,EACpC,MAAM,CAAC,UAAU,IAAI,CAAC,CACvB,CAAA;QACD,IAAI,CAAC,GAAG,gBAAgB,EAAE;YACxB,OAAO,IAAI,CAAA;SACZ;KACF;IACD,OAAO,KAAK,CAAA;AACd,CAAC,CAAA;AAED,MAAM,UAAU,UAAU,CAAC,CAAM;IAC/B,OAAO,OAAO,CAAC,KAAK,UAAU,CAAA;AAChC,CAAC;AAED,MAAM,UAAU,WAAW,CAAC,MAAW;IACrC,IAAI,CAAC,MAAM;QAAE,OAAO,EAAE,CAAA;IACtB,yBAAY,MAAM,EAAE;AACtB,CAAC;AAED,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAC,MAAiC,EAAU,EAAE,CAC9E,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC;KACnB,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAM,EAAE,EAAE,CAAC,GAAG,kBAAkB,CAAC,CAAC,CAAC,IAAI,kBAAkB,CAAC,CAAC,CAAC,EAAE,CAAC;KACzE,IAAI,CAAC,GAAG,CAAC,CAAA;AAEd,wEAAwE;AACxE,4DAA4D;AAC5D,wEAAwE;AACxE,MAAM,CAAC,MAAM,IAAI,GAAG,CAAC,GAAG,QAAkB,EAAU,EAAE;IACpD,iDAAiD;IACjD,IAAI,KAAK,GAAa,EAAE,CAAA;IACxB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,QAAQ,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,EAAE;QAC/C,KAAK,GAAG,KAAK,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAA;KAC7C;IACD,4DAA4D;IAC5D,MAAM,QAAQ,GAAa,EAAE,CAAA;IAC7B,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,EAAE;QAC5C,MAAM,IAAI,GAAG,KAAK,CAAC,CAAC,CAAC,CAAA;QACrB,sCAAsC;QACtC,2BAA2B;QAC3B,IAAI,CAAC,IAAI,IAAI,IAAI,KAAK,GAAG;YAAE,SAAQ;QACnC,yCAAyC;QACzC,IAAI,IAAI,KAAK,IAAI;YAAE,QAAQ,CAAC,GAAG,EAAE,CAAA;QACjC,0BAA0B;;YACrB,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;KACzB;IACD,+CAA+C;IAC/C,aAAa;IACb,IAAI,KAAK,CAAC,CAAC,CAAC,KAAK,EAAE;QAAE,QAAQ,CAAC,OAAO,CAAC,EAAE,CAAC,CAAA;IACzC,uCAAuC;IACvC,OAAO,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,CAAA;AAC5D,CAAC,CAAA;AAED,iDAAiD;AACjD,4DAA4D;AAC5D,MAAM,CAAC,MAAM,OAAO,GAAG,CAAC,IAAY,EAAU,EAAE,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,CAAA;AAEjE,+BAA+B;AAC/B,MAAM,UAAU,KAAK,CAAC,OAAgB;IACpC,OAAO,OAAO,CAAC,IAAI,CAAC,QAAQ,KAAK,QAAQ,CAAC,GAAG,CAAA;AAC/C,CAAC;AAED,MAAM,UAAU,SAAS,CAAC,OAAgB;IACxC,0EAA0E;IAC1E,OAAO,OAAO,CAAC,IAAI,CAAC,QAAQ,KAAK,QAAQ,CAAC,OAAO,CAAA;AACnD,CAAC;AAED,MAAM,UAAU,UAAU,CAAC,OAAgB;IACzC,OAAO,OAAO,CAAC,IAAI,CAAC,QAAQ,KAAK,QAAQ,CAAC,QAAQ,CAAA;AACpD,CAAC;AAED,MAAM,UAAU,UAAU,CAAC,OAAgB;IACzC,OAAO,OAAO,CAAC,IAAI,CAAC,QAAQ,KAAK,QAAQ,CAAC,QAAQ,CAAA;AACpD,CAAC;AAED,MAAM,UAAU,UAAU,CAAC,OAAgB;IACzC,OAAO,OAAO,CAAC,IAAI,CAAC,QAAQ,KAAK,QAAQ,CAAC,QAAQ,CAAA;AACpD,CAAC;AAED,MAAM,UAAU,WAAW,CAAC,OAAgB;IAC1C,OAAO,OAAO,CAAC,IAAI,CAAC,QAAQ,KAAK,QAAQ,CAAC,SAAS,CAAA;AACrD,CAAC;AAED,MAAM,UAAU,SAAS,CAAC,OAAgB;IACxC,OAAO,OAAO,CAAC,IAAI,CAAC,QAAQ,KAAK,QAAQ,CAAC,OAAO,CAAA;AACnD,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@botonic/core",
-  "version": "0.26.0",
+  "version": "0.27.0-alpha.0",
   "license": "MIT",
   "description": "Build Chatbots using React",
   "main": "./lib/cjs/index.js",
@@ -30,13 +30,8 @@
   ],
   "dependencies": {
     "@babel/plugin-transform-runtime": "^7.23.9",
-    "aws-sdk": "^2.1404.0",
     "axios": "^1.6.8",
     "decode": "^0.3.0",
-    "dynamodb-toolbox": "^0.3.4",
-    "fast-xml-parser": "3.19.0",
-    "html-entities": "^2.4.0",
-    "node-json-db": "^1.6.0",
     "pako": "^2.1.0",
     "process": "^0.11.10",
     "pusher-js": "^5.1.1",

package/src/core-bot.ts

@@ -1,21 +1,15 @@
-import { ulid } from 'ulid'
-
 import { Inspector } from './debug'
 import { getString } from './i18n'
 import {
-  BotonicEvent,
   BotRequest,
   BotResponse,
   INPUT,
   Locales,
-  MessageEventAck,
-  MessageEventFrom,
   ResolvedPlugins,
   Route,
   Routes,
   Session,
 } from './models'
-import { BotonicOutputParser } from './output-parser'
 import { loadPlugins, runPlugins } from './plugins'
 import { getComputedRoutes, Router } from './routing'
 
@@ -44,7 +38,6 @@ export class CoreBot {
   router: Router | null
   routes: Routes
   theme?: any
-  botonicOutputParser = new BotonicOutputParser()
 
   constructor({
     // TODO: Receives dataProvider
@@ -96,7 +89,6 @@ export class CoreBot {
     input,
     session,
     lastRoutePath,
-    dataProvider,
   }: BotRequest): Promise<BotResponse> {
     session = session || {}
     if (!session.__locale) session.__locale = 'en'
@@ -106,27 +98,10 @@ export class CoreBot {
         input,
         session,
         lastRoutePath,
-        dataProvider,
         response: [],
-        messageEvents: null,
       }
     }
 
-    const parsedUserEvent = this.botonicOutputParser.parseFromUserInput(input)
-    const userId = session.user.id
-    if (dataProvider) {
-      // TODO: Next iterations. Review cycle of commited events to DB when messages change their ACK
-      // @ts-ignore
-      const userEvent = await dataProvider.saveEvent({
-        ...parsedUserEvent,
-        userId,
-        eventId: ulid(),
-        createdAt: new Date().toISOString(),
-        from: MessageEventFrom.USER,
-        ack: MessageEventAck.RECEIVED,
-      })
-    }
-
     if (this.plugins) {
       await runPlugins(
         this.plugins,
@@ -134,9 +109,7 @@ export class CoreBot {
         input,
         session,
         lastRoutePath,
-        undefined,
-        undefined,
-        dataProvider
+        undefined
       )
     }
 
@@ -169,20 +142,12 @@ export class CoreBot {
       defaultTyping: this.defaultTyping,
       defaultDelay: this.defaultDelay,
       lastRoutePath,
-      dataProvider,
     }
 
     const response = await this.renderer({
       request,
       actions: [output.fallbackAction, output.action, output.emptyAction],
     })
-    let messageEvents: Partial<BotonicEvent>[] = []
-    try {
-      messageEvents = this.botonicOutputParser.xmlToMessageEvents(response)
-    } catch (e) {
-      // Disabling Botonic 1.0 error log for LTS version:
-      // console.error(e)
-    }
 
     lastRoutePath = output.lastRoutePath
     if (this.plugins) {
@@ -192,35 +157,16 @@ export class CoreBot {
         input,
         session,
         lastRoutePath,
-        response,
-        messageEvents,
-        dataProvider
+        response
       )
     }
 
-    if (dataProvider) {
-      // TODO: save bot responses to db and update user with new session and new params
-      for (const messageEvent of messageEvents) {
-        // @ts-ignore
-        const botEvent = await dataProvider.saveEvent({
-          ...messageEvent,
-          userId,
-          eventId: ulid(),
-          createdAt: new Date().toISOString(),
-          from: MessageEventFrom.BOT,
-          ack: MessageEventAck.SENT,
-        })
-      }
-    }
-
     session.is_first_interaction = false
     return {
       input,
       response,
-      messageEvents,
       session,
       lastRoutePath,
-      dataProvider,
     }
   }
 }

package/src/handoff.ts

@@ -12,14 +12,7 @@ export interface HubtypeAgentsInfo {
   last_message_sent: string
   status: string
 }
-export interface HubtypeSession extends Session {
-  _hubtype_api?: string
-  _access_token: string
-}
 
-export interface SessionWithBotonicAction extends Session {
-  _botonic_action: string
-}
 export interface BackendContext {
   timeoutMs: number
 }
@@ -36,6 +29,11 @@ export type HandoffExtraData = {
   location?: string
 }
 
+interface BotEventData {
+  language: string
+  country: string
+}
+
 function contextDefaults(context: any): BackendContext {
   return {
     timeoutMs: context.timeoutMs || 10000,
@@ -43,7 +41,7 @@ function contextDefaults(context: any): BackendContext {
 }
 
 export async function getOpenQueues(
-  session: HubtypeSession,
+  session: Session,
   context = {}
 ): Promise<{ queues: string[] }> {
   //be aware of https://github.com/axios/axios/issues/1543
@@ -63,7 +61,7 @@ export async function getOpenQueues(
 }
 
 export class HandOffBuilder {
-  _session: SessionWithBotonicAction
+  _session: Session
   _queue: string
   _onFinish: string
   _email: string
@@ -75,8 +73,9 @@ export class HandOffBuilder {
   _autoIdleMessage: string
   _shadowing: boolean
   _extraData: HandoffExtraData
+  _bot_event: BotEventData
 
-  constructor(session: SessionWithBotonicAction) {
+  constructor(session: Session) {
     this._session = session
   }
 
@@ -140,6 +139,11 @@ export class HandOffBuilder {
     return this
   }
 
+  withBotEvent(botEvent: BotEventData): this {
+    this._bot_event = botEvent
+    return this
+  }
+
   async handOff(): Promise<void> {
     return _humanHandOff(
       this._session,
@@ -153,7 +157,8 @@ export class HandOffBuilder {
       this._note,
       this._autoIdleMessage,
       this._shadowing,
-      this._extraData
+      this._extraData,
+      this._bot_event
     )
   }
 }
@@ -190,9 +195,10 @@ interface HubtypeHandoffParams {
   shadowing?: boolean
   on_finish?: string
   case_extra_data?: HandoffExtraData
+  bot_event?: BotEventData
 }
 async function _humanHandOff(
-  session: SessionWithBotonicAction,
+  session: Session,
   queueNameOrId = '',
   onFinish: string,
   agentEmail = '',
@@ -203,7 +209,8 @@ async function _humanHandOff(
   note = '',
   autoIdleMessage = '',
   shadowing = false,
-  extraData: HandoffExtraData | undefined = undefined
+  extraData: HandoffExtraData | undefined = undefined,
+  botEvent: BotEventData
 ) {
   const params: HubtypeHandoffParams = {}
 
@@ -239,11 +246,14 @@ async function _humanHandOff(
   if (extraData) {
     params.case_extra_data = extraData
   }
+  if (botEvent) {
+    params.bot_event = botEvent
+  }
   session._botonic_action = `create_case:${JSON.stringify(params)}`
 }
 
 export async function storeCaseRating(
-  session: HubtypeSession,
+  session: Session,
   rating: number,
   context: any = {}
 ): Promise<{ status: string }> {
@@ -263,7 +273,7 @@ export async function storeCaseRating(
 }
 
 export async function getAvailableAgentsByQueue(
-  session: HubtypeSession,
+  session: Session,
   queueId: string
 ): Promise<{ agents: string[] }> {
   const baseUrl = session._hubtype_api || HUBTYPE_API_URL
@@ -278,7 +288,7 @@ export async function getAvailableAgentsByQueue(
 }
 
 export async function getAvailableAgents(
-  session: HubtypeSession
+  session: Session
 ): Promise<{ agents: HubtypeAgentsInfo[] }> {
   const baseUrl = session._hubtype_api || HUBTYPE_API_URL
   const botId = session.bot.id
@@ -293,7 +303,7 @@ export async function getAvailableAgents(
 }
 
 export async function getAgentVacationRanges(
-  session: HubtypeSession,
+  session: Session,
   { agentId, agentEmail }: { agentId?: string; agentEmail?: string }
 ): Promise<{ vacation_ranges: VacationRange[] }> {
   const baseUrl = session._hubtype_api || HUBTYPE_API_URL
@@ -310,7 +320,7 @@ export async function getAgentVacationRanges(
 }
 
 export function cancelHandoff(
-  session: SessionWithBotonicAction,
+  session: Session,
   typification: string | null = null
 ): void {
   let action = 'discard_case'
@@ -318,6 +328,6 @@ export function cancelHandoff(
   session._botonic_action = action
 }
 
-export function deleteUser(session: SessionWithBotonicAction): void {
+export function deleteUser(session: Session): void {
   session._botonic_action = `delete_user`
 }

package/src/index.ts

@@ -1,13 +1,10 @@
 export * from './constants'
 export * from './core-bot'
-// TODO: Review @botonic/react's tree-shaking to remove dataProvider from bundle
-// export * from './data-provider'
 export * from './debug'
 export * from './handoff'
 export * from './hubtype-service'
 export * from './i18n'
 export * from './models'
-export * from './output-parser'
 export * from './plugins'
 export * from './routing'
 export * from './utils'

package/src/models/legacy-types.ts

@@ -1,19 +1,30 @@
 // TODO: This file contains all the legacy types we had in index.ts. After some refactors, we should be able to get rid of many of them.
 
-import { DataProvider } from '../data-provider'
-import { BotonicEvent } from './events'
+export enum CASE_STATUS {
+  WAITING = 'status_waiting',
+  ATTENDING = 'status_attending',
+  IDLE = 'status_idle',
+  RESOLVED = 'status_resolved',
+}
 
 export type CaseStatusType =
-  | typeof CASE_STATUS.ATTENDING
-  | typeof CASE_STATUS.IDLE
-  | typeof CASE_STATUS.RESOLVED
-  | typeof CASE_STATUS.WAITING
+  | CASE_STATUS.ATTENDING
+  | CASE_STATUS.IDLE
+  | CASE_STATUS.RESOLVED
+  | CASE_STATUS.WAITING
+
+export enum CASE_RESOLUTION {
+  OK = 'result_ok',
+  NOK = 'result_nok',
+  NOT_SOLVED = 'result_not_solved',
+  BANNED = 'result_banned',
+}
 
 export type CaseResolution =
-  | typeof CASE_RESOLUTION.BANNED
-  | typeof CASE_RESOLUTION.NOK
-  | typeof CASE_RESOLUTION.NOT_SOLVED
-  | typeof CASE_RESOLUTION.OK
+  | CASE_RESOLUTION.BANNED
+  | CASE_RESOLUTION.NOK
+  | CASE_RESOLUTION.NOT_SOLVED
+  | CASE_RESOLUTION.OK
 
 export enum PROVIDER {
   APPLE = 'apple',
@@ -30,6 +41,19 @@ export enum PROVIDER {
   WHATSAPP = 'whatsapp',
 }
 
+export type ProviderType =
+  | PROVIDER.DEV
+  | PROVIDER.FACEBOOK
+  | PROVIDER.GENERIC
+  | PROVIDER.INSTAGRAM
+  | PROVIDER.INTERCOM
+  | PROVIDER.SMOOCH
+  | PROVIDER.TELEGRAM
+  | PROVIDER.TWITTER
+  | PROVIDER.WEBCHAT
+  | PROVIDER.WECHAT
+  | PROVIDER.WHATSAPP
+
 export enum INPUT {
   TEXT = 'text',
   POSTBACK = 'postback',
@@ -50,20 +74,6 @@ export enum INPUT {
   WHATSAPP_CTA_URL_BUTTON = 'whatsapp-cta-url-button',
 }
 
-export enum CASE_STATUS {
-  WAITING = 'status_waiting',
-  ATTENDING = 'status_attending',
-  IDLE = 'status_idle',
-  RESOLVED = 'status_resolved',
-}
-
-export enum CASE_RESOLUTION {
-  OK = 'result_ok',
-  NOK = 'result_nok',
-  NOT_SOLVED = 'result_not_solved',
-  BANNED = 'result_banned',
-}
-
 export interface Locales {
   [id: string]: string | string[] | Locales
 }
@@ -86,22 +96,22 @@ export interface ResolvedPlugin extends Plugin {
 export type ResolvedPlugins = Record<string, ResolvedPlugin>
 
 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
-  | typeof INPUT.CHAT_EVENT
-  | typeof INPUT.WHATSAPP_BUTTON_LIST
-  | typeof INPUT.WHATSAPP_CTA_URL_BUTTON
+  | INPUT.AUDIO
+  | INPUT.BUTTON_MESSAGE
+  | INPUT.CAROUSEL
+  | INPUT.CONTACT
+  | INPUT.CUSTOM
+  | INPUT.DOCUMENT
+  | INPUT.IMAGE
+  | INPUT.LOCATION
+  | INPUT.POSTBACK
+  | INPUT.TEXT
+  | INPUT.VIDEO
+  | INPUT.WEBCHAT_SETTINGS
+  | INPUT.WHATSAPP_TEMPLATE
+  | INPUT.CHAT_EVENT
+  | INPUT.WHATSAPP_BUTTON_LIST
+  | INPUT.WHATSAPP_CTA_URL_BUTTON
 
 export interface IntentResult {
   intent: string
@@ -132,21 +142,23 @@ export interface Input extends Partial<NluResult> {
   data?: string
   path?: string
   payload?: string
+  referral?: string
   type: InputType
+  context?: {
+    campaign?: Campaign
+  }
+  message_id?: string
 }
 
-export type ProviderType =
-  | typeof PROVIDER.DEV
-  | typeof PROVIDER.FACEBOOK
-  | typeof PROVIDER.GENERIC
-  | typeof PROVIDER.INSTAGRAM
-  | typeof PROVIDER.INTERCOM
-  | typeof PROVIDER.SMOOCH
-  | typeof PROVIDER.TELEGRAM
-  | typeof PROVIDER.TWITTER
-  | typeof PROVIDER.WEBCHAT
-  | typeof PROVIDER.WECHAT
-  | typeof PROVIDER.WHATSAPP
+export interface Campaign {
+  id: string
+  name: string
+  status: string
+  start_date: string
+  end_date: string
+  bot_path: string
+  template_name: string
+}
 
 export interface SessionUser {
   id: string
@@ -161,8 +173,12 @@ export interface SessionUser {
   imp_id?: string
   provider_id?: string
 }
+export interface HubtypeCaseContactReason {
+  id: string
+  name: string
+  project_id: string
+}
 
-// eslint-disable @typescript-eslint/naming-convention
 export interface Session {
   bot: {
     id: string
@@ -170,18 +186,24 @@ export interface Session {
   }
   __locale?: string
   __retries: number
+  _access_token: string
+  _hubtype_api: string
   is_first_interaction: boolean
   last_session?: any
-  organization: string
   organization_id: string
+  organization: string
   user: SessionUser
   // after handoff
+  _botonic_action?: string
   _hubtype_case_status?: CaseStatusType
+  _hubtype_case_id?: string
   _hubtype_case_typification?: string
+  _hubtype_case_contact_reasons?: HubtypeCaseContactReason[]
   _shadowing?: boolean
-  _access_token?: string
+  external?: any
+  zendesk_ticket_id?: string
+  flow_thread_id?: string
 }
-// eslint-enable @typescript-eslint/naming-convention
 
 export type InputMatcher = (input: Input) => boolean
 export type ParamsMatcher =
@@ -225,7 +247,6 @@ export interface BotRequest {
   input: Input
   lastRoutePath: RoutePath
   session: Session
-  dataProvider?: DataProvider
 }
 
 /** The response of the bot for the triggered actions, which can be
@@ -234,7 +255,6 @@ export interface BotRequest {
  * */
 export interface BotResponse extends BotRequest {
   response: any
-  messageEvents: Partial<BotonicEvent>[] | null
 }
 
 export interface PluginPreRequest extends BotRequest {
@@ -253,24 +273,6 @@ export interface Params {
   [key: string]: any
 }
 
-export const Providers = Object.freeze({
-  Messaging: {
-    APPLE: 'apple',
-    FACEBOOK: 'facebook',
-    GENERIC: 'generic',
-    IMBEE: 'imbee',
-    INSTAGRAM: 'instagram',
-    INTERCOM: 'intercom',
-    SMOOCH_WEB: 'smooch_web',
-    SMOOCH: 'smooch',
-    TELEGRAM: 'telegram',
-    TWITTER: 'twitter',
-    WEBCHAT: 'webchat',
-    WECHAT: 'wechat',
-    WHATSAPP: 'whatsapp',
-  },
-})
-
 export type Nullable<T> = T | null
 
 export type Action = Nullable<() => any>

package/src/plugins.ts

@@ -1,6 +1,4 @@
-import { DataProvider } from './data-provider'
 import {
-  BotonicEvent,
   Input,
   PluginConfig,
   ResolvedPlugins,
@@ -34,15 +32,13 @@ export async function runPlugins(
   input: Input,
   session: Session,
   lastRoutePath: RoutePath,
-  response: string | null = null,
-  messageEvents: Partial<BotonicEvent>[] | null = null,
-  dataProvider?: DataProvider
+  response: string | null = null
 ): Promise<void> {
   for (const key in plugins) {
     const p = await plugins[key]
     try {
       if (mode === 'pre' && p.pre) {
-        await p.pre({ input, session, lastRoutePath, dataProvider, plugins })
+        await p.pre({ input, session, lastRoutePath, plugins })
       }
       if (mode === 'post' && p.post) {
         await p.post({
@@ -50,8 +46,6 @@ export async function runPlugins(
           session,
           lastRoutePath,
           response,
-          messageEvents,
-          dataProvider,
           plugins,
         })
       }

package/src/utils.ts

@@ -1,3 +1,5 @@
+import { PROVIDER, Session } from './models/legacy-types'
+
 export const isNode = (): boolean => {
   // @ts-ignore
   return typeof IS_NODE !== 'undefined'
@@ -76,3 +78,33 @@ export const join = (...segments: string[]): string => {
 // A simple function to get the dirname of a path
 // Trailing slashes are ignored. Leading slash is preserved.
 export const dirname = (path: string): string => join(path, '..')
+
+// To check Provider in session
+export function isDev(session: Session) {
+  return session.user.provider === PROVIDER.DEV
+}
+
+export function isWebchat(session: Session) {
+  // When the provider is DEV should we return true because it is a webchat?
+  return session.user.provider === PROVIDER.WEBCHAT
+}
+
+export function isWhatsapp(session: Session) {
+  return session.user.provider === PROVIDER.WHATSAPP
+}
+
+export function isTelegram(session: Session) {
+  return session.user.provider === PROVIDER.TELEGRAM
+}
+
+export function isFacebook(session: Session) {
+  return session.user.provider === PROVIDER.FACEBOOK
+}
+
+export function isInstagram(session: Session) {
+  return session.user.provider === PROVIDER.INSTAGRAM
+}
+
+export function isTwitter(session: Session) {
+  return session.user.provider === PROVIDER.TWITTER
+}

package/lib/cjs/data-provider/dynamodb-data-provider.d.ts

@@ -1,26 +0,0 @@
-import { Entity, Table } from 'dynamodb-toolbox';
-import { BotonicEvent, User } from '../models';
-import { DataProvider } from './factory';
-export declare class DynamoDBDataProvider implements DataProvider {
-    region: string;
-    tableName: string;
-    userEventsTable: Table;
-    userEntity: Entity<any>;
-    eventEntity: Entity<any>;
-    messageEventEntities: Record<string, Entity<any>>;
-    textMessageEventEntity: Entity<any>;
-    connectionEventEntity: Entity<any>;
-    constructor(url: string);
-    getUsers(limit?: number, offset?: number): Promise<User[]>;
-    getUser(id: string): Promise<User | undefined>;
-    getUserByWebsocketId(websocketId: string): Promise<User | undefined>;
-    getUserByField(field: string, value: any): Promise<User | undefined>;
-    saveUser(user: User): Promise<User>;
-    updateUser(user: User): Promise<User>;
-    deleteUser(id: string): Promise<User | undefined>;
-    getEvents(limit?: number, offset?: number): Promise<BotonicEvent[]>;
-    getEvent(id: string): Promise<BotonicEvent | undefined>;
-    saveEvent(event: BotonicEvent): Promise<BotonicEvent>;
-    updateEvent(event: BotonicEvent): Promise<BotonicEvent>;
-    deleteEvent(id: string): Promise<BotonicEvent | undefined>;
-}