feat(messenger): messenger v1

packages/channels/example/app.ts

@@ -2,37 +2,49 @@ import clc from 'cli-color'
 import { Router } from 'express'
 import { Channel } from '../src/base/channel'
 import { MessengerChannel } from '../src/messenger/channel'
-import { SlackChannel } from '../src/slack/channel'
-import { SmoochChannel } from '../src/smooch/channel'
-import { TeamsChannel } from '../src/teams/channel'
-import { TelegramChannel } from '../src/telegram/channel'
-import { TwilioChannel } from '../src/twilio/channel'
-import { VonageChannel } from '../src/vonage/channel'
 import payloads from './payloads.json'
 
 export class App {
   constructor(private router: Router, private config: any) {}
 
   async setup() {
-    await this.setupChannel('telegram', new TelegramChannel())
-    await this.setupChannel('twilio', new TwilioChannel())
-    await this.setupChannel('smooch', new SmoochChannel())
-    await this.setupChannel('teams', new TeamsChannel())
-    await this.setupChannel('slack', new SlackChannel())
     await this.setupChannel('messenger', new MessengerChannel())
-    await this.setupChannel('vonage', new VonageChannel())
   }
 
   async setupChannel(name: string, channel: Channel) {
-    await channel.setup(this.router)
+    await channel.setup(this.router, {
+      info: (message: string, data?: any) => {
+        // eslint-disable-next-line no-console
+        console.log(message, data)
+      },
+      debug: (message: string, data?: any) => {
+        console.debug(message, data)
+      },
+      warn: (message: string, data?: any) => {
+        console.warn(message, data)
+      },
+      error: (error: Error, message?: string, data?: any) => {
+        console.error(message, error?.message, (<any>error).response?.data, data)
+      }
+    })
 
     channel.on('message', async ({ scope, endpoint, content }) => {
       this.log('message', name, scope, { endpoint, content })
 
       const respond = async () => {
         try {
-          for (const payload of payloads) {
-            await channel.send(scope, endpoint, payload)
+          if (content.type === 'say_something') {
+            await channel.send(scope, endpoint, { type: 'text', text: `Say Something: ${content.text}` })
+          } else if (content.type === 'postback') {
+            await channel.send(scope, endpoint, { type: 'text', text: `Postback: ${content.payload}` })
+          } else if (content.type === 'quick_reply') {
+            await channel.send(scope, endpoint, { type: 'text', text: `Quick Reply: ${content.text}` })
+          } else if (content.text?.startsWith('test')) {
+            for (const payload of this.filterResponsePayloads(payloads, content.text)) {
+              await channel.send(scope, endpoint, payload)
+            }
+          } else {
+            await channel.send(scope, endpoint, { type: 'text', text: 'OK', typing: true })
           }
         } catch (e) {
           console.error('Error occurred sending message', e)
@@ -48,13 +60,30 @@ export class App {
 
     for (const [key, val] of Object.entries<any>(this.config.scopes)) {
       if (val[name]) {
-        await channel.start(key, val[name])
-        this.log('conf', name, key, val[name])
+        const { error } = channel.meta.schema.validate(val[name])
+        if (error) {
+          this.log('conf-err', name, key, error.message)
+        } else {
+          await channel.start(key, val[name])
+          await channel.initialize(key)
+          this.log('conf', name, key, val[name])
+        }
       }
     }
   }
 
   private log(type: string, channel: string, context: string, obj: any) {
     console.info(clc.blue(type), clc.bold(channel), context, obj)
   }
+
+  private filterResponsePayloads(payloads: any[], filter: string) {
+    const filtered = []
+    for (const payload of payloads) {
+      if (filter?.includes(payload.type)) {
+        filtered.push(payload)
+      }
+    }
+
+    return filtered.length ? filtered : payloads
+  }
 }

packages/channels/example/payloads.json

@@ -6,6 +6,12 @@
     "image": "https://upload.wikimedia.org/wikipedia/commons/a/a1/Mallard2.jpg",
     "typing": true
   },
+  {
+    "type": "image",
+    "title": "YOU SHALL NOT PASS",
+    "image": "https://digginginthedirt.de/photos/upload/2018/05/26/20180526172235-15859610.gif",
+    "typing": true
+  },
   {
     "type": "card",
     "title": "A banana card",
@@ -80,12 +86,55 @@
       }
     ]
   },
+  {
+    "type": "file",
+    "title": "here is a zip of the 1.0.0 messaging codebase",
+    "file": "https://github.com/botpress/messaging/archive/refs/tags/v1.0.0.zip",
+    "typing": true
+  },
+  {
+    "type": "video",
+    "title": "look at the big bunny video",
+    "video": "https://www.w3schools.com/html/mov_bbb.mp4",
+    "typing": true
+  },
+  {
+    "type": "audio",
+    "title": "this is audio of a horse",
+    "audio": "https://www.w3schools.com/html/horse.mp3",
+    "typing": true
+  },
+  {
+    "type": "location",
+    "title": "this is the location of my house",
+    "address": "1600 Pennsylvania Avenue NW, Washington, DC 20500, États-Unis",
+    "latitude": 38.89764765487744,
+    "longitude": -77.03709704833226,
+    "typing": true
+  },
+  {
+    "type": "dropdown",
+    "message": "Pick something :",
+    "options": [
+      { "label": "Mars", "value": "planet_mars" },
+      { "label": "Venus", "value": "planet_venus" },
+      { "label": "Jupiter", "value": "planet_jupiter" },
+      { "label": "Mars2", "value": "planet_mars2" },
+      { "label": "Venus2", "value": "planet_venus2" },
+      { "label": "Jupiter2", "value": "planet_jupiter2" },
+      { "label": "Mars3", "value": "planet_mars3" },
+      { "label": "Venus3", "value": "planet_venus3" },
+      { "label": "Jupiter3", "value": "planet_jupiter3" }
+    ],
+    "typing": true
+  },
   {
     "type": "single-choice",
     "text": "Make a choice :",
     "choices": [
       { "title": "Yay", "value": "YES" },
       { "title": "Nay", "value": "NO" }
-    ]
+    ],
+    "typing": true
   }
 ]

packages/channels/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@botpress/messaging-channels",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "source": "src/index.ts",
@@ -25,23 +25,13 @@
     "@types/uuid": "^8.3.4"
   },
   "dependencies": {
-    "@slack/events-api": "^2.3.2",
-    "@slack/interactive-messages": "^1.5.0",
-    "@slack/rtm-api": "^5.0.3",
-    "@slack/web-api": "^5.8.0",
-    "@vonage/server-sdk": "2.10.7-beta-2",
     "axios": "^0.24.0",
-    "botbuilder": "^4.14.1",
     "cli-color": "^2.0.1",
     "express": "^4.17.2",
     "joi": "^17.5.0",
-    "jsonwebtoken": "^8.5.1",
     "lodash": "^4.17.21",
     "lru-cache": "^6.0.0",
     "ms": "^2.1.3",
-    "smooch-core": "^8.11.4",
-    "telegraf": "^3.27.1",
-    "twilio": "^3.67.0",
     "uuid": "^8.3.2",
     "yn": "^4.0.0"
   }

packages/channels/src/base/api.ts

@@ -1,6 +1,4 @@
-import clc from 'cli-color'
 import { Request, Router, Response, RequestHandler, NextFunction } from 'express'
-import yn from 'yn'
 import { Logger } from './logger'
 import { ChannelService } from './service'
 
@@ -14,22 +12,9 @@ export class ChannelApi<TService extends ChannelService<any, any>> {
   makeUrl(callback: (scope: string) => Promise<string>) {
     this.urlCallback = callback
   }
-
-  protected async printWebhook(scope: string, name: string, path?: string) {
-    // TODO: remove this dependency on server env vars
-    if (yn(process.env.SPINNED)) {
-      const externalUrl = await this.urlCallback!(scope)
-
-      this.service.logger?.info(
-        `[${scope}] ${clc.bold(name.charAt(0).toUpperCase() + name.slice(1))}${
-          path ? ' ' + path : ''
-        } webhook ${clc.blackBright(`${externalUrl}/${name}${path ? `/${path}` : ''}`)}`
-      )
-    }
-  }
 }
 
-export type Middleware<T> = (req: T, res: Response, next: NextFunction) => Promise<void>
+export type Middleware<T> = (req: T, res: Response, next: NextFunction) => Promise<any>
 
 export class ChannelApiManager {
   constructor(private service: ChannelService<any, any>, private router: Router, private logger?: Logger) {}

packages/channels/src/base/channel.ts

@@ -70,6 +70,7 @@ export abstract class ChannelTemplate<
   constructor(public readonly service: TService, public readonly api: TApi, public readonly stream: TStream) {}
 
   async setup(router: Router, logger?: Logger) {
+    this.logger = logger
     await this.service.setup()
     await this.api.setup(new ChannelApiManager(this.service, router, logger))
     await this.stream.setup()

packages/channels/src/base/context.ts

@@ -13,7 +13,7 @@ export type ChannelContext<TState extends ChannelState<any>> = {
 export interface IndexChoiceOption {
   type: IndexChoiceType
   title: string
-  value: string
+  value?: string
 }
 
 export enum IndexChoiceType {

packages/channels/src/base/renderers/audio.ts

@@ -0,0 +1,21 @@
+import { ChannelRenderer } from '../../base/renderer'
+import { AudioContent } from '../../content/types'
+import { ChannelContext } from '../context'
+
+export abstract class AudioRenderer implements ChannelRenderer<any> {
+  get priority(): number {
+    return 0
+  }
+
+  handles(context: ChannelContext<any>): boolean {
+    const payload = context.payload as AudioContent
+    return !!payload.audio
+  }
+
+  render(context: ChannelContext<any>) {
+    const payload = context.payload as AudioContent
+    this.renderAudio(context, payload)
+  }
+
+  abstract renderAudio(context: ChannelContext<any>, payload: AudioContent): void
+}

packages/channels/src/base/renderers/file.ts

@@ -0,0 +1,21 @@
+import { ChannelRenderer } from '../../base/renderer'
+import { FileContent } from '../../content/types'
+import { ChannelContext } from '../context'
+
+export abstract class FileRenderer implements ChannelRenderer<any> {
+  get priority(): number {
+    return 0
+  }
+
+  handles(context: ChannelContext<any>): boolean {
+    const payload = context.payload as FileContent
+    return !!payload.file
+  }
+
+  render(context: ChannelContext<any>) {
+    const payload = context.payload as FileContent
+    this.renderFile(context, payload)
+  }
+
+  abstract renderFile(context: ChannelContext<any>, payload: FileContent): void
+}

packages/channels/src/base/renderers/location.ts

@@ -0,0 +1,21 @@
+import { ChannelRenderer } from '../../base/renderer'
+import { LocationContent } from '../../content/types'
+import { ChannelContext } from '../context'
+
+export abstract class LocationRenderer implements ChannelRenderer<any> {
+  get priority(): number {
+    return 0
+  }
+
+  handles(context: ChannelContext<any>): boolean {
+    const payload = context.payload as LocationContent
+    return !!payload.latitude && !!payload.longitude
+  }
+
+  render(context: ChannelContext<any>) {
+    const payload = context.payload as LocationContent
+    this.renderLocation(context, payload)
+  }
+
+  abstract renderLocation(context: ChannelContext<any>, payload: LocationContent): void
+}

packages/channels/src/base/renderers/video.ts

@@ -0,0 +1,21 @@
+import { VideoContent } from '../../content/types'
+import { ChannelContext } from '../context'
+import { ChannelRenderer } from '../renderer'
+
+export abstract class VideoRenderer implements ChannelRenderer<any> {
+  get priority(): number {
+    return 0
+  }
+
+  handles(context: ChannelContext<any>): boolean {
+    const payload = context.payload as VideoContent
+    return !!payload.video
+  }
+
+  render(context: ChannelContext<any>) {
+    const payload = context.payload as VideoContent
+    this.renderVideo(context, payload)
+  }
+
+  abstract renderVideo(context: ChannelContext<any>, payload: VideoContent): void
+}

packages/channels/src/base/service.ts

@@ -112,9 +112,6 @@ export abstract class ChannelService<
     if (index) {
       const key = this.getIndexCacheKey(scope, identity, sender)
       const options = this.cacheIndexResponses.get(key)
-
-      this.cacheIndexResponses.del(key)
-
       const option = options?.[index - 1]
 
       if (option) {

packages/channels/src/index.ts

@@ -1,9 +1,2 @@
 export * from './base/channel'
 export * from './base/endpoint'
-export * from './messenger/channel'
-export * from './slack/channel'
-export * from './smooch/channel'
-export * from './teams/channel'
-export * from './telegram/channel'
-export * from './twilio/channel'
-export * from './vonage/channel'

packages/channels/src/messenger/README.md

@@ -0,0 +1,28 @@
+### Sending
+
+| Channels | Twilio |
+| -------- | :----: |
+| Text     |   ✅   |
+| Image    |   ❌   |
+| Choice   |   ❌   |
+| Dropdown |   ❌   |
+| Card     |   ❌   |
+| Carousel |   ❌   |
+| File     |   ❌   |
+| Audio    |   ❌   |
+| Video    |   ❌   |
+| Location |   ❌   |
+
+### Receiving
+
+| Channels      | Twilio |
+| ------------- | :----: |
+| Text          |   ✅   |
+| Postback      |   ❌   |
+| Say Something |   ❌   |
+| Voice         |   ❌   |
+| Image         |   ❌   |
+| File          |   ❌   |
+| Audio         |   ❌   |
+| Video         |   ❌   |
+| Location      |   ❌   |