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

package/src/types/debug/inspector.d.ts

@@ -1,33 +0,0 @@
-import { Input, Route, RouteMatcher } from '..'
-
-export declare class RouteInspector {
-  routeMatched(
-    route: Route,
-    routeKey: string,
-    routeValue: RouteMatcher,
-    input: Input
-  ): void
-  routeNotMatched(
-    route: Route,
-    routeKey: string,
-    routeValue: RouteMatcher,
-    input: Input
-  ): void
-}
-
-export declare class FocusRouteInspector extends RouteInspector {
-  focusRoutePaths: string[] | null
-  focusOnMatches: boolean
-  focusOnlyOnRoutes(focusRoutePaths: string[]): FocusRouteInspector
-  focusOnlyOnMatches(): FocusRouteInspector
-  _isOnFocus(route: Route): boolean
-}
-export declare class LogRouteInspector extends FocusRouteInspector {
-  _routeName(obj: Route): string
-  _log(message: string, ...optionalParams: string[]): void
-}
-export declare class Inspector {
-  constructor(routeInspector: RouteInspector | undefined)
-  routeInspector: RouteInspector | undefined
-  getRouteInspector(): RouteInspector
-}

package/src/types/handoff.d.ts

@@ -1,75 +0,0 @@
-import { Session } from '.'
-
-export interface HubtypeAgentsInfo {
-  attending_count: number
-  email: string
-  idle_count: number
-  last_message_sent: string
-  status: string
-}
-
-export declare function getOpenQueues(
-  session: Session
-): Promise<{ queues: string[] }>
-
-export declare function storeCaseRating(
-  session: Session,
-  rating: number
-): Promise<{ status: string }>
-
-export declare function getAvailableAgentsByQueue(
-  session: Session,
-  queueId: string
-): Promise<{ agents: string[] }>
-
-export declare function getAvailableAgents(
-  session: Session
-): Promise<{ agents: HubtypeAgentsInfo[] }>
-
-interface VacationRange {
-  end_date: number // timestamp
-  id: number
-  start_date: number // timestamp
-}
-
-export declare function getAgentVacationRanges(
-  session: Session,
-  agentParams: { agentId?: string; agentEmail?: string }
-): Promise<{ vacation_ranges: VacationRange[] }>
-
-export declare function cancelHandoff(
-  session: Session,
-  typification?: string
-): void
-
-export declare function deleteUser(session: Session): void
-
-export declare class HandOffBuilder {
-  constructor(session: Session)
-  _agentId: string
-  _caseInfo: string
-  _email: string
-  _note: string
-  _onFinish: string
-  _queue: string
-  _session: Session
-  _shadowing: boolean
-  handOff(): Promise<void>
-  withAgentEmail(email: string): HandOffBuilder
-  withAgentId(agentId: string): HandOffBuilder
-  withCaseInfo(caseInfo: string): HandOffBuilder
-  withNote(note: string): HandOffBuilder
-  withOnFinishPath(path: string): HandOffBuilder
-  withOnFinishPayload(payload: string): HandOffBuilder
-  withQueue(queueNameOrId: string): HandOffBuilder
-  withShadowing(shadowing?: boolean): HandOffBuilder
-}
-
-/**
- * @deprecated use {@link HandOffBuilder} class instead
- */
-export declare function humanHandOff(
-  session: Session,
-  queueNameOrId: string, // queue_name for backward compatibility, queue_id for new versions
-  onFinish: { payload?: string; path?: string }
-): Promise<void>

package/src/types/hubtype-service.d.ts

@@ -1,52 +0,0 @@
-import { AxiosResponse } from 'axios'
-import Pusher, { Channel } from 'pusher-js'
-
-import { Input, SessionUser } from '.'
-
-interface UnsentInput {
-  id: string
-  ack: number
-  unsentInput: Input
-}
-
-interface HubtypeServiceArgs {
-  appId: string
-  user: SessionUser
-  lastMessageId: string
-  lastMessageUpdateDate: string
-  onEvent: any
-  unsentInputs: UnsentInput[]
-}
-
-export declare class HubtypeService {
-  constructor(args: HubtypeServiceArgs)
-  appId: string
-  user: SessionUser
-  lastMessageId: string
-  lastMessageUpdateDate: string
-  onEvent: any
-  unsentInputs: UnsentInput[]
-  init(
-    user: SessionUser,
-    lastMessageId: string,
-    lastMessageUpdateDate: string
-  ): Promise<any>
-  pusher: Pusher
-  channel: Channel
-  constructHeaders(): {
-    'X-BOTONIC-USER-ID': string
-    'X-BOTONIC-LAST-MESSAGE-ID': string
-    'X-BOTONIC-LAST-MESSAGE-UPDATE-DATE': string
-  }
-  onPusherEvent(event: any): void
-  get pusherChannel(): string
-  handleSentInput(message: any): void
-  handleUnsentInput(message: any): void
-  postMessage(user: SessionUser, message: any): Promise<void>
-  resendUnsentInputs(): Promise<void>
-  static getWebchatVisibility({
-    appId,
-  }: {
-    appId: string
-  }): Promise<AxiosResponse<any>>
-}

package/src/types/i18n.d.ts

@@ -1,8 +0,0 @@
-/* eslint-disable filenames/match-regex */
-import { Locales } from '.'
-
-export declare function getString(
-  locales: Locales,
-  locale: string,
-  stringID: string
-): string

package/src/types/index.d.ts

@@ -1,226 +0,0 @@
-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'
-
-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 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
-  | 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
-}
-
-/** 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
-}
-
-export interface Input extends Partial<NluResult> {
-  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
-  | 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[])
-
-// 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
-  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
-}
-
-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/types/plugins.d.ts

@@ -1,13 +0,0 @@
-import { Input, PluginConfig, Session } from '.'
-
-type PluginMode = 'pre' | 'post'
-
-export declare function loadPlugins(plugins: PluginConfig<any>[]): any
-export declare function runPlugins(
-  plugins: PluginConfig<any>[],
-  mode: PluginMode,
-  input: Input,
-  session: Session,
-  lastRoutePath: string,
-  response?: any
-): Promise<void>

package/src/types/router.d.ts

@@ -1,57 +0,0 @@
-import { Input, Route, RouteMatcher, Routes, Session } from '.'
-import { RouteInspector } from './debug'
-
-export declare class Router {
-  constructor(routes: Routes, routeInspector?: RouteInspector)
-  routes: Routes
-  routeInspector: RouteInspector
-  processInput(
-    input: Input,
-    session?: Session,
-    lastRoutePath?: string
-  ):
-    | {
-        action: any
-        params: {
-          [x: number]: any
-        }
-        retryAction: any
-        defaultAction: any
-        lastRoutePath: any
-      }
-    | {
-        action: any
-        params: any
-        lastRoutePath: any
-        retryAction?: undefined
-        defaultAction?: undefined
-      }
-    | {
-        action: any
-        params: any
-        retryAction: any
-        lastRoutePath: any
-        defaultAction?: undefined
-      }
-  lastRoutePath: string
-  getOnFinishParams(input: Input): string
-  getRoute(
-    input: Input,
-    routes: Routes,
-    session: Session,
-    lastRoutePath: string
-  ): {
-    route: Route
-    params: any
-  }
-  getRouteByPath(path: string, routeList: Routes): Route
-  matchRoute(
-    route: Route,
-    prop: any,
-    matcher: RouteMatcher,
-    input: Input,
-    session: Session,
-    lastRoutePath: string
-  ): any
-  matchValue(matcher: RouteMatcher, value: any): any
-}

package/src/types/utils.d.ts

@@ -1,12 +0,0 @@
-export declare function getWebpackEnvVar(
-  webpackEnvVar: string | boolean,
-  name: string | boolean,
-  defaultValue: string
-): string
-export declare function isFunction(o: any): boolean
-export declare function isBrowser(): boolean
-export declare function isMobile(mobileBreakpoint?: number): boolean
-export declare function isNode(): boolean
-export declare function params2queryString(params: any): string
-export declare function join(...segments: any[]): string
-export declare function dirname(path: any): string