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

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'

package/src/models/events/index.ts

@@ -1,37 +1,4 @@
-import { ConnectionEvent } from './connections'
-import { CarouselMessageEvent } from './message/carousel'
-import { CustomMessageEvent } from './message/custom'
-import { LocationMessageEvent } from './message/location'
-import {
-  AudioMessageEvent,
-  DocumentMessageEvent,
-  ImageMessageEvent,
-  VideoMessageEvent,
-} from './message/media'
-import { TextMessageEvent } from './message/text'
-
-export enum EventTypes {
-  CONNECTION = 'connection',
-  MESSAGE = 'message',
-  ACK = 'ack',
-  TRACK = 'track',
-}
-
-export interface BaseEvent {
-  eventId: string
-  userId: string
-  eventType: EventTypes
-  createdAt: string
-  modifiedAt?: string
-}
-
-export type BotonicEvent =
-  | TextMessageEvent
-  | AudioMessageEvent
-  | DocumentMessageEvent
-  | ImageMessageEvent
-  | VideoMessageEvent
-  | LocationMessageEvent
-  | CarouselMessageEvent
-  | CustomMessageEvent
-  | ConnectionEvent
+export * from './base-event'
+export * from './botonic-event'
+export * from './connection'
+export * from './message'

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

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

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

@@ -0,0 +1,13 @@
+import { BaseEvent, EventTypes } from '../base-event'
+
+export type IntegrationEventType =
+  | EventTypes.NEW_USER
+  | EventTypes.RECEIVED_MESSAGE
+  | EventTypes.BOT_EXECUTED
+  | EventTypes.BOT_ACTION
+  | EventTypes.ACTION_SENT
+
+export interface IntegrationEvent extends BaseEvent {
+  eventType: IntegrationEventType
+  details: any
+}

package/src/models/events/message/carousel.ts

@@ -1,5 +1,5 @@
-import { BotonicMessageEvent, MessageEventTypes } from '.'
 import { WithButtons } from './buttons'
+import { BotonicMessageEvent, MessageEventTypes } from './message-event'
 
 export interface CarouselElement extends WithButtons {
   pic: string

package/src/models/events/message/custom.ts

@@ -1,7 +1,7 @@
-import { BotonicMessageEvent, MessageEventTypes } from '.'
+import { BotonicMessageEvent, MessageEventTypes } from './message-event'
 import { WithReplies } from './replies'
 
 export interface CustomMessageEvent extends BotonicMessageEvent, WithReplies {
   type: MessageEventTypes.CUSTOM
-  customTypeName: string
+  json: any
 }

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

@@ -1,33 +1,9 @@
-import { BaseEvent } from '..'
-
-export enum MessageEventTypes {
-  AUDIO = 'audio',
-  CAROUSEL = 'carousel',
-  CUSTOM = 'custom',
-  DOCUMENT = 'document',
-  IMAGE = 'image',
-  LOCATION = 'location',
-  TEXT = 'text',
-  VIDEO = 'video',
-}
-
-export enum MessageEventAck {
-  DRAFT = 'draft',
-  READ = 'read',
-  RECEIVED = 'received',
-  SENT = 'sent',
-}
-
-export enum MessageEventFrom {
-  AGENT = 'agent',
-  BOT = 'bot',
-  USER = 'user',
-}
-
-export interface BotonicMessageEvent extends BaseEvent {
-  ack: MessageEventAck
-  from: MessageEventFrom
-  type: MessageEventTypes
-  typing: number
-  delay: number
-}
+export * from './buttons'
+export * from './carousel'
+export * from './custom'
+export * from './location'
+export * from './media'
+export * from './message-event'
+export * from './postback'
+export * from './replies'
+export * from './text'

package/src/models/events/message/location.ts

@@ -1,4 +1,4 @@
-import { BotonicMessageEvent, MessageEventTypes } from '.'
+import { BotonicMessageEvent, MessageEventTypes } from './message-event'
 
 export interface LocationMessageEvent extends BotonicMessageEvent {
   type: MessageEventTypes.LOCATION

package/src/models/events/message/media.ts

@@ -1,5 +1,5 @@
-import { BotonicMessageEvent, MessageEventTypes } from '.'
 import { WithButtons } from './buttons'
+import { BotonicMessageEvent, MessageEventTypes } from './message-event'
 
 export const MEDIA_TYPES = [
   MessageEventTypes.AUDIO,

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

@@ -0,0 +1,37 @@
+import { BaseEvent } from '../base-event'
+
+export enum MessageEventTypes {
+  AUDIO = 'audio',
+  CAROUSEL = 'carousel',
+  CUSTOM = 'custom',
+  DOCUMENT = 'document',
+  IMAGE = 'image',
+  LOCATION = 'location',
+  TEXT = 'text',
+  POSTBACK = 'postback',
+  VIDEO = 'video',
+  /**
+   * TODO: contact, buttonmessage?, webchatsettings, whatsapp template
+   */
+}
+
+export enum MessageEventAck {
+  DRAFT = 'draft',
+  READ = 'read',
+  RECEIVED = 'received',
+  SENT = 'sent',
+}
+
+export enum MessageEventFrom {
+  AGENT = 'agent',
+  BOT = 'bot',
+  USER = 'user',
+}
+
+export interface BotonicMessageEvent extends BaseEvent {
+  ack: MessageEventAck
+  from: MessageEventFrom
+  type: MessageEventTypes
+  typing: number
+  delay: number
+}

package/src/models/events/message/postback.ts

@@ -0,0 +1,5 @@
+import { BotonicMessageEvent } from './message-event'
+
+export interface PostbackMessageEvent extends BotonicMessageEvent {
+  payload: string
+}

package/src/models/events/message/text.ts

@@ -1,5 +1,5 @@
-import { BotonicMessageEvent, MessageEventTypes } from '.'
 import { WithButtons } from './buttons'
+import { BotonicMessageEvent, MessageEventTypes } from './message-event'
 import { WithReplies } from './replies'
 
 export interface TextMessageEvent

package/src/models/index.ts

@@ -0,0 +1,6 @@
+export * from './bot-state'
+export * from './channels'
+export * from './events'
+export * from './legacy-types'
+export * from './session'
+export * from './user'

package/src/models/legacy-types.ts

@@ -0,0 +1,262 @@
+// 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 { BotState } from './bot-state'
+import { BotonicEvent } from './events'
+import { Session } from './session'
+
+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> {
+  text?: string
+  src?: string
+  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
+
+// eslint-enable @typescript-eslint/naming-convention
+
+export type InputMatcher = (input: Input) => boolean
+export type ParamsMatcher =
+  | { [key: string]: string }
+  | ((params: { [key: string]: string }) => boolean)
+export type SessionMatcher = (session: Session) => boolean
+export type RequestMatcher = (request: BotRequest) => boolean
+export type StringMatcher = RegExp | string | ((data: string) => boolean)
+
+export type RouteMatcher =
+  | InputMatcher
+  | ParamsMatcher
+  | RequestMatcher
+  | SessionMatcher
+  | StringMatcher
+
+export interface Route {
+  action?: any
+  childRoutes?: Route[]
+  lastRoutePath?: string
+  ignoreRetry?: boolean
+  path: RoutePath
+  redirect?: string
+  retry?: number
+
+  // 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
+  session: Session
+  botState: BotState
+  dataProvider?: any // TODO: type as dataProvider
+}
+
+/** 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
+  messageEvents: Partial<BotonicEvent>[] | null
+}
+
+export interface PluginPreRequest extends BotRequest {
+  plugins: Plugin[]
+}
+export interface PluginPostRequest extends BotResponse {
+  plugins: Plugin[]
+}
+
+export interface Plugin {
+  post(request: PluginPostRequest): void
+  pre(request: PluginPreRequest): void
+}
+
+export interface Params {
+  [key: string]: any
+}
+
+export const Providers = Object.freeze({
+  Messaging: {
+    FACEBOOK: 'facebook',
+    GENERIC: 'generic',
+    IMBEE: 'imbee',
+    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>
+export type RoutePath = Nullable<string>
+
+export interface ProcessInputResult {
+  action: Action
+  emptyAction: Action
+  fallbackAction: Action
+  botState: BotState
+  params: Params
+}
+
+export type MatchedValue = boolean | RegExpExecArray | null
+
+export type RoutingState = {
+  currentRoute: Nullable<Route>
+  matchedRoute: Nullable<Route>
+  params: Params
+  isFlowBroken: boolean
+}
+
+export interface RouteParams {
+  route: Nullable<Route>
+  params: Params
+}
+export interface PathParams {
+  path: RoutePath
+  params: Params
+}
+
+export type MatchingProp =
+  | 'text'
+  | 'payload'
+  | 'intent'
+  | 'type'
+  | 'input'
+  | 'session'
+  | 'request'
+
+export type Matcher = string | RegExp | ((args) => boolean)

package/src/models/session.ts

@@ -0,0 +1,3 @@
+export interface Session {
+  [key: string]: any
+}

package/src/models/user.ts

@@ -1,9 +1,16 @@
-import { Session } from '../types/'
+import { BotState } from './bot-state'
+import { Session } from './session'
+
 export interface User {
   id: string //TODO: UUID
-  websocketId: string
+  name?: string
+  userName?: string
+  channel: string
+  idFromChannel: string // providerId
   session: Session
-  route: string
+  botState: BotState
   isOnline: boolean
+  websocketId?: string
+  // part of details?
   locationInfo: string
 }

package/src/output-parser/botonic-output-parser.ts

@@ -0,0 +1,38 @@
+// eslint-disable-next-line import/named
+import { parse, X2jOptions } from 'fast-xml-parser'
+import { decode } from 'html-entities'
+
+import { BotonicEvent } from '../models'
+import { MessageParsingFactory } from './factory'
+
+export const TEXT_NODE_NAME = 'text'
+
+export class BotonicOutputParser {
+  private static OPTIONS: Partial<X2jOptions> = {
+    ignoreAttributes: false,
+    attributeNamePrefix: '',
+    textNodeName: TEXT_NODE_NAME,
+    arrayMode: true,
+    attrValueProcessor: a => decode(a),
+  }
+
+  constructor(private readonly factory = new MessageParsingFactory()) {}
+
+  xmlToMessageEvents(html: string): Partial<BotonicEvent>[] {
+    const jsonMessages = this.xmlToJSONMessages(html)
+    return jsonMessages.map(msgToParse => this.factory.parse(msgToParse))
+  }
+
+  /**
+   * Right now, when saving BotonicEvents to DataProvider, we need the standarized Botonic event
+   * to be saved. This is, converting a botonic input like: '{id: 'msgId', data: 'rawData', payload: 'somePayload'}'
+   * into a BotonicEvent with the expected properties.
+   */
+  inputToBotonicEvent(input: any): Partial<BotonicEvent> {
+    return this.factory.parse(input)
+  }
+
+  private xmlToJSONMessages(html: any): any {
+    return parse(html, BotonicOutputParser.OPTIONS).message
+  }
+}

package/src/output-parser/factory.ts

@@ -1,6 +1,4 @@
-import { BotonicEvent } from '../models/events'
-import { MessageEventTypes } from '../models/events/message'
-import { MEDIA_TYPES } from '../models/events/message/media'
+import { BotonicEvent, MEDIA_TYPES, MessageEventTypes } from '../models'
 import {
   parseButtons,
   parseCarousel,
@@ -8,6 +6,7 @@ import {
   parseLocation,
   parseMedia,
   parseMessage,
+  parsePostback,
   parseReplies,
   parseText,
 } from './parsers'
@@ -19,6 +18,9 @@ export class MessageParsingFactory {
     if (type === MessageEventTypes.TEXT) {
       return parseText(parseReplies(parseButtons(parsedMessage))).parsed
     }
+    if (type === MessageEventTypes.POSTBACK) {
+      return parsePostback(parsedMessage).parsed
+    }
     if (MEDIA_TYPES.includes(type)) {
       return parseMedia(parseButtons(parsedMessage)).parsed
     }

package/src/output-parser/index.ts

@@ -1,32 +1,3 @@
-import { parse, X2jOptions } from 'fast-xml-parser'
-import { decode } from 'html-entities'
-
-import { BotonicEvent } from '../models/events'
-import { MessageParsingFactory } from './factory'
-
-export const TEXT_NODE_NAME = 'text'
-
-export class BotonicOutputParser {
-  private static OPTIONS: Partial<X2jOptions> = {
-    ignoreAttributes: false,
-    attributeNamePrefix: '',
-    textNodeName: TEXT_NODE_NAME,
-    arrayMode: true,
-    attrValueProcessor: a => decode(a),
-  }
-
-  constructor(private readonly factory = new MessageParsingFactory()) {}
-
-  xmlToMessageEvents(html: string): Partial<BotonicEvent>[] {
-    const jsonMessages = this.xmlToJSONMessages(html)
-    return jsonMessages.map(msgToParse => this.factory.parse(msgToParse))
-  }
-
-  parseFromUserInput(input: any): Partial<BotonicEvent> {
-    return this.factory.parse(input)
-  }
-
-  private xmlToJSONMessages(html: any): any {
-    return parse(html, BotonicOutputParser.OPTIONS).message
-  }
-}
+export * from './botonic-output-parser'
+export * from './factory'
+export * from './parsers'