@botonic/core 0.19.0 → 0.20.2-alpha.0

package/src/models/events/index.ts

@@ -1,39 +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 { PostbackMessageEvent } from './message/postback'
-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
-  | PostbackMessageEvent
-  | AudioMessageEvent
-  | DocumentMessageEvent
-  | ImageMessageEvent
-  | VideoMessageEvent
-  | LocationMessageEvent
-  | CarouselMessageEvent
-  | CustomMessageEvent
-  | ConnectionEvent
+export * from './base-event'
+export * from './botonic-event'
+export * from './connections'
+export * from './message'

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,37 +1,9 @@
-import { BaseEvent } from '..'
-
-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
-}
+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

@@ -1,4 +1,4 @@
-import { BotonicMessageEvent } from '.'
+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,3 @@
+export * from './events'
+export * from './legacy-types'
+export * from './user'

package/src/{types/index.d.ts → models/legacy-types.ts}

@@ -1,11 +1,63 @@
-export { Providers } from './constants'
-export { BotOptions, CoreBot } from './core-bot'
-export * from './debug'
-export * from './handoff'
-export { HubtypeService } from './hubtype-service'
-export { getString } from './i18n'
-export { Router } from './router'
-export * from './utils'
+// 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 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
@@ -21,22 +73,6 @@ export interface PluginConfig<T> {
   resolve: { default: PluginConstructor<T> }
 }
 
-export const INPUT: Readonly<{
-  AUDIO: 'audio'
-  BUTTON_MESSAGE: 'buttonmessage'
-  CAROUSEL: 'carousel'
-  CONTACT: 'contact'
-  CUSTOM: 'custom'
-  DOCUMENT: 'document'
-  IMAGE: 'image'
-  LOCATION: 'location'
-  POSTBACK: 'postback'
-  TEXT: 'text'
-  VIDEO: 'video'
-  WEBCHAT_SETTINGS: 'webchatsettings'
-  WHATSAPP_TEMPLATE: 'whatsapptemplate'
-}>
-
 export type InputType =
   | typeof INPUT.AUDIO
   | typeof INPUT.BUTTON_MESSAGE
@@ -75,25 +111,14 @@ export interface NluResult {
 }
 
 export interface Input extends Partial<NluResult> {
+  text?: string
+  src?: string
   data?: string
   path?: string
   payload?: string
   type: InputType
 }
 
-export const PROVIDER: Readonly<{
-  DEV: 'dev'
-  FACEBOOK: 'facebook'
-  GENERIC: 'generic'
-  INTERCOM: 'intercom'
-  SMOOCH: 'smooch'
-  TELEGRAM: 'telegram'
-  TWITTER: 'twitter'
-  WEBCHAT: 'webchat'
-  WECHAT: 'wechat'
-  WHATSAPP: 'whatsapp'
-}>
-
 export type ProviderType =
   | typeof PROVIDER.DEV
   | typeof PROVIDER.FACEBOOK
@@ -127,7 +152,7 @@ export interface Session {
     name?: string
   }
   __locale?: string
-  __retries?: number
+  __retries: number
   is_first_interaction: boolean
   last_session?: any
   organization?: string
@@ -139,13 +164,13 @@ export interface Session {
 }
 // eslint-enable @typescript-eslint/naming-convention
 
-type InputMatcher = (input: Input) => boolean
-type ParamsMatcher =
+export type InputMatcher = (input: Input) => boolean
+export 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 SessionMatcher = (session: Session) => boolean
+export type RequestMatcher = (request: BotRequest) => boolean
+export type StringMatcher = RegExp | string | ((data: string) => boolean)
 
 export type RouteMatcher =
   | InputMatcher
@@ -157,13 +182,11 @@ export type RouteMatcher =
 export interface Route {
   action?: any
   childRoutes?: Route[]
-  defaultAction?: any
   lastRoutePath?: string
   ignoreRetry?: boolean
-  path?: StringMatcher
+  path: RoutePath
   redirect?: string
   retry?: number
-  retryAction?: any
 
   // matchers
   input?: InputMatcher
@@ -179,38 +202,11 @@ export interface Route {
 
 export type Routes<R = Route> = R[] | ((_: BotRequest) => R[])
 
-// Desk
-
-export const CASE_STATUS: Readonly<{
-  ATTENDING: 'status_attending'
-  IDLE: 'status_idle'
-  RESOLVED: 'status_resolved'
-  WAITING: 'status_waiting'
-}>
-
-export type CaseStatusType =
-  | typeof CASE_STATUS.ATTENDING
-  | typeof CASE_STATUS.IDLE
-  | typeof CASE_STATUS.RESOLVED
-  | typeof CASE_STATUS.WAITING
-
-export const CASE_RESOLUTION: Readonly<{
-  BANNED: 'result_banned'
-  NOK: 'result_nok'
-  NOT_SOLVED: 'result_not_solved'
-  OK: 'result_ok'
-}>
-
-export type CaseResolution =
-  | typeof CASE_RESOLUTION.BANNED
-  | typeof CASE_RESOLUTION.NOK
-  | typeof CASE_RESOLUTION.NOT_SOLVED
-  | typeof CASE_RESOLUTION.OK
-
 export interface BotRequest {
   input: Input
-  lastRoutePath: string
+  lastRoutePath: RoutePath
   session: Session
+  dataProvider?: DataProvider
 }
 
 /** The response of the bot for the triggered actions, which can be
@@ -219,14 +215,79 @@ export interface BotRequest {
  * */
 export interface BotResponse extends BotRequest {
   response: any
+  messageEvents: Partial<BotonicEvent>[] | null
 }
 
-export type PluginPreRequest = BotRequest
-export type PluginPostRequest = BotResponse
+export interface PluginPreRequest extends BotRequest {
+  plugins: Plugin[]
+}
+export interface PluginPostRequest extends BotResponse {
+  plugins: Plugin[]
+}
 
 export interface Plugin {
-  post(_: PluginPostRequest): void
-  pre(pluginRequest: PluginPreRequest): void
+  post(request: PluginPostRequest): void
+  pre(request: PluginPreRequest): void
+}
+
+export interface Params {
+  [key: string]: any
 }
 
-export type Params = { [key: string]: string }
+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
+  lastRoutePath: RoutePath
+  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/user.ts

@@ -1,4 +1,5 @@
-import { Session } from '../types/'
+import { Session } from './legacy-types'
+
 export interface User {
   id: string //TODO: UUID
   providerId?: 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.
+   */
+  parseFromUserInput(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,

package/src/output-parser/index.ts

@@ -1,37 +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))
-  }
-
-  /**
-   * 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.
-   */
-  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'

package/src/output-parser/parsers.ts

@@ -1,23 +1,31 @@
-import { EventTypes } from '../models/events'
-import { BotonicMessageEvent } from '../models/events/message'
-import { Button, WithButtons } from '../models/events/message/buttons'
 import {
+  AudioMessageEvent,
+  BotonicMessageEvent,
+  Button,
   CarouselElement,
   CarouselMessageEvent,
-} from '../models/events/message/carousel'
-import { CustomMessageEvent } from '../models/events/message/custom'
-import { LocationMessageEvent } from '../models/events/message/location'
-import {
-  AudioMessageEvent,
+  CustomMessageEvent,
   DocumentMessageEvent,
+  EventTypes,
   ImageMessageEvent,
+  LocationMessageEvent,
+  PostbackMessageEvent,
+  Reply,
+  TextMessageEvent,
   VideoMessageEvent,
-} from '../models/events/message/media'
-import { Reply, WithReplies } from '../models/events/message/replies'
-import { TextMessageEvent } from '../models/events/message/text'
-import { TEXT_NODE_NAME } from '.'
-import { parseBoolean, parseNumber } from './util'
-import { PostbackMessageEvent } from 'src/models/events/message/postback'
+  WithButtons,
+  WithReplies,
+} from '../models'
+import { TEXT_NODE_NAME } from './botonic-output-parser'
+
+export function parseNumber(strNumber: string): number {
+  return parseInt(strNumber)
+}
+
+export function parseBoolean(strNumber: string): boolean {
+  if (strNumber === '0') return false
+  return true
+}
 
 export type ParseFunction<Out> = (args: {
   toParse: any
@@ -42,6 +50,8 @@ export const parseMessage: ParseFunction<BotonicMessageEvent> = args => {
       // Following properties added later before saving event: eventId, userId, createdAt, from, ack
       eventType: EventTypes.MESSAGE,
       type: args.toParse.type,
+      ack: args.toParse.ack,
+      from: args.toParse.from,
       ...typingAndDelay,
     },
   }
@@ -110,7 +120,7 @@ export const parseText: ParseFunction<TextMessageEvent> = args => {
     toParse: args.toParse,
     parsed: {
       ...args.parsed,
-      text: args.toParse[TEXT_NODE_NAME] || args.toParse.data,
+      text: args.toParse[TEXT_NODE_NAME],
       markdown: parseBoolean(args.toParse.markdown),
     },
   }
@@ -139,7 +149,7 @@ export const parseMedia: ParseFunction<
     toParse: args.toParse,
     parsed: {
       ...args.parsed,
-      src: args.toParse.src || args.toParse.data,
+      src: args.toParse.src,
     },
   }
 }
@@ -184,7 +194,7 @@ export const parseCustom: ParseFunction<CustomMessageEvent> = args => {
     toParse: args.toParse,
     parsed: {
       ...args.parsed,
-      customTypeName: JSON.parse(args.toParse.json).customTypeName,
+      json: JSON.parse(args.toParse.json),
     },
   }
 }