@botonic/core 1.0.0-dev.0 → 2.23.0

package/src/index.ts

@@ -1,233 +0,0 @@
-import { BotonicEvent } from './models/events'
-export { Providers } from './constants'
-export { 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'
-
-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/events/connections/index.ts

@@ -1,11 +0,0 @@
-import { BaseEvent, EventTypes } from '..'
-
-export enum ConnectionEventStatuses {
-  CONNECTED = 'connected',
-  DISCONNECTED = 'disconnected',
-}
-
-export interface ConnectionEvent extends BaseEvent {
-  eventType: EventTypes.CONNECTION
-  status: ConnectionEventStatuses
-}

package/src/models/events/index.ts

@@ -1,39 +0,0 @@
-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

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

@@ -1,23 +0,0 @@
-export interface BaseButton {
-  title: string
-}
-
-export interface WebviewButton extends BaseButton {
-  webview: any
-  params?: any
-}
-
-export interface UrlButton extends BaseButton {
-  url: string
-  target?: string
-}
-
-export interface PayloadButton extends BaseButton {
-  payload: string
-}
-
-export type Button = PayloadButton | UrlButton | WebviewButton
-
-export interface WithButtons {
-  buttons?: Button[]
-}

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

@@ -1,13 +0,0 @@
-import { BotonicMessageEvent, MessageEventTypes } from '.'
-import { WithButtons } from './buttons'
-
-export interface CarouselElement extends WithButtons {
-  pic: string
-  title: string
-  subtitle?: string
-}
-
-export interface CarouselMessageEvent extends BotonicMessageEvent {
-  type: MessageEventTypes.CAROUSEL
-  elements: CarouselElement[]
-}

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

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

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

@@ -1,37 +0,0 @@
-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
-}

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

@@ -1,7 +0,0 @@
-import { BotonicMessageEvent, MessageEventTypes } from '.'
-
-export interface LocationMessageEvent extends BotonicMessageEvent {
-  type: MessageEventTypes.LOCATION
-  lat: number
-  long: number
-}

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

@@ -1,28 +0,0 @@
-import { BotonicMessageEvent, MessageEventTypes } from '.'
-import { WithButtons } from './buttons'
-
-export const MEDIA_TYPES = [
-  MessageEventTypes.AUDIO,
-  MessageEventTypes.IMAGE,
-  MessageEventTypes.DOCUMENT,
-  MessageEventTypes.VIDEO,
-]
-export interface MediaMessageEvent extends BotonicMessageEvent, WithButtons {
-  src: string
-}
-
-export interface AudioMessageEvent extends MediaMessageEvent {
-  type: MessageEventTypes.AUDIO
-}
-
-export interface ImageMessageEvent extends MediaMessageEvent {
-  type: MessageEventTypes.IMAGE
-}
-
-export interface DocumentMessageEvent extends MediaMessageEvent {
-  type: MessageEventTypes.DOCUMENT
-}
-
-export interface VideoMessageEvent extends MediaMessageEvent {
-  type: MessageEventTypes.VIDEO
-}

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

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

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

@@ -1,8 +0,0 @@
-export interface Reply {
-  title: string
-  payload: string
-}
-
-export interface WithReplies {
-  replies?: Reply[]
-}

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

@@ -1,12 +0,0 @@
-import { BotonicMessageEvent, MessageEventTypes } from '.'
-import { WithButtons } from './buttons'
-import { WithReplies } from './replies'
-
-export interface TextMessageEvent
-  extends BotonicMessageEvent,
-    WithReplies,
-    WithButtons {
-  type: MessageEventTypes.TEXT
-  markdown: boolean
-  text: string
-}

package/src/models/user.ts

@@ -1,10 +0,0 @@
-import { Session } from '../index'
-export interface User {
-  id: string //TODO: UUID
-  providerId?: string
-  websocketId?: string
-  session: Session
-  route: string
-  isOnline: boolean
-  locationInfo: string
-}

package/src/output-parser/factory.ts

@@ -1,40 +0,0 @@
-import { BotonicEvent } from '../models/events'
-import { MessageEventTypes } from '../models/events/message'
-import { MEDIA_TYPES } from '../models/events/message/media'
-import {
-  parseButtons,
-  parseCarousel,
-  parseCustom,
-  parseLocation,
-  parseMedia,
-  parseMessage,
-  parsePostback,
-  parseReplies,
-  parseText,
-} from './parsers'
-
-export class MessageParsingFactory {
-  parse(msgToParse: any): Partial<BotonicEvent> {
-    const type = msgToParse.type
-    const parsedMessage = parseMessage({ toParse: msgToParse })
-    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
-    }
-    if (type === MessageEventTypes.LOCATION) {
-      return parseLocation(parsedMessage).parsed
-    }
-    if (type === MessageEventTypes.CAROUSEL) {
-      return parseCarousel(parsedMessage).parsed
-    }
-    if (type === MessageEventTypes.CUSTOM) {
-      return parseCustom(parseReplies(parsedMessage)).parsed
-    }
-    throw new Error(`Parsing for type: '${type}' not implemented.`)
-  }
-}

package/src/output-parser/index.ts

@@ -1,38 +0,0 @@
-// eslint-disable-next-line import/named
-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
-  }
-}