feat(sdk): new typing indicator interface (botpress#13254)

Author: franklevasseur

Diff for: integrations/telegram/integration.definition.ts

@@ -1,9 +1,9 @@
-import { z, IntegrationDefinition, messages } from '@botpress/sdk'
+import { z, IntegrationDefinition, messages, interfaces } from '@botpress/sdk'
 import { sentry as sentryHelpers } from '@botpress/sdk-addons'
 
 export default new IntegrationDefinition({
   name: 'telegram',
-  version: '0.4.5',
+  version: '0.5.0',
   title: 'Telegram',
   description: 'This integration allows your bot to interact with Telegram.',
   icon: 'icon.svg',
@@ -32,4 +32,4 @@ export default new IntegrationDefinition({
     },
     creation: { enabled: true, requiredTags: ['id'] },
   },
-})
+}).extend(interfaces.typingIndicator, () => ({}))

Diff for: integrations/telegram/package.json

@@ -18,7 +18,7 @@
     "@botpress/sdk-addons": "workspace:*",
     "@sentry/node": "7.53.1",
     "lodash": "^4.17.21",
-    "telegraf": "^4.11.2",
+    "telegraf": "^4.16.3",
     "zod": "^3.20.6"
   },
   "devDependencies": {

Diff for: integrations/telegram/src/index.ts

@@ -14,6 +14,7 @@ import {
   ackMessage,
   convertTelegramMessageToBotpressMessage,
   wrapHandler,
+  getMessageId,
 } from './misc/utils'
 import * as bp from '.botpress'
 
@@ -26,7 +27,33 @@ const integration = new bp.Integration({
     const telegraf = new Telegraf(ctx.configuration.botToken)
     await telegraf.telegram.deleteWebhook({ drop_pending_updates: true })
   },
-  actions: {},
+  actions: {
+    startTypingIndicator: async ({ input, ctx, client }) => {
+      const telegraf = new Telegraf(ctx.configuration.botToken)
+      const { conversation } = await client.getConversation({ id: input.conversationId })
+      const { message } = await client.getMessage({ id: input.messageId })
+
+      const chat = getChat(conversation)
+      const messageId = getMessageId(message)
+
+      await telegraf.telegram.sendChatAction(chat, 'typing')
+      await telegraf.telegram.setMessageReaction(chat, messageId, [{ type: 'emoji', emoji: '👀' }])
+
+      return {}
+    },
+    stopTypingIndicator: async ({ input, ctx, client }) => {
+      const telegraf = new Telegraf(ctx.configuration.botToken)
+      const { conversation } = await client.getConversation({ id: input.conversationId })
+      const { message } = await client.getMessage({ id: input.messageId })
+
+      const chat = getChat(conversation)
+      const messageId = getMessageId(message)
+
+      await telegraf.telegram.setMessageReaction(chat, messageId, [])
+
+      return {}
+    },
+  },
   channels: {
     channel: {
       messages: {

Diff for: integrations/telegram/src/misc/utils.ts

@@ -1,4 +1,5 @@
 import { axios } from '@botpress/client'
+import { RuntimeError } from '@botpress/sdk'
 import { AssertionError, ok } from 'assert'
 import _ from 'lodash'
 import { Context, Markup, Telegraf, Telegram } from 'telegraf'
@@ -48,12 +49,22 @@ export function getChat(conversation: MessageHandlerProps['conversation']): stri
   const chat = conversation.tags.chatId
 
   if (!chat) {
-    throw Error(`No chat found for conversation ${conversation.id}`)
+    throw new RuntimeError(`No chat found for conversation ${conversation.id}`)
   }
 
   return chat
 }
 
+export function getMessageId(message: MessageHandlerProps['message']): number {
+  const messageId = message.tags.id
+
+  if (!messageId) {
+    throw new RuntimeError(`No message ID found for message ${message.id}`)
+  }
+
+  return Number(messageId)
+}
+
 export const getUserNameFromTelegramUser = (telegramUser: User) => {
   if (telegramUser.first_name && telegramUser.last_name) {
     return `${telegramUser.first_name} ${telegramUser.last_name}`

Diff for: packages/cli/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@botpress/cli",
-  "version": "0.8.60",
+  "version": "0.8.61",
   "description": "Botpress CLI",
   "scripts": {
     "build": "pnpm run bundle && pnpm run template:gen",
@@ -21,7 +21,7 @@
   "main": "dist/index.js",
   "dependencies": {
     "@botpress/client": "0.29.1",
-    "@botpress/sdk": "0.10.11",
+    "@botpress/sdk": "0.10.12",
     "@bpinternal/const": "^0.0.20",
     "@bpinternal/tunnel": "^0.1.1",
     "@bpinternal/yargs-extra": "^0.0.3",

Diff for: packages/cli/templates/echo-bot/package.json

@@ -6,7 +6,7 @@
   "private": true,
   "dependencies": {
     "@botpress/client": "0.29.1",
-    "@botpress/sdk": "0.10.11"
+    "@botpress/sdk": "0.10.12"
   },
   "devDependencies": {
     "@types/node": "^18.11.17",

Diff for: packages/cli/templates/empty-integration/package.json

@@ -7,7 +7,7 @@
   "private": true,
   "dependencies": {
     "@botpress/client": "0.29.1",
-    "@botpress/sdk": "0.10.11"
+    "@botpress/sdk": "0.10.12"
   },
   "devDependencies": {
     "@types/node": "^18.11.17",

Diff for: packages/cli/templates/hello-world/package.json

@@ -7,7 +7,7 @@
   "private": true,
   "dependencies": {
     "@botpress/client": "0.29.1",
-    "@botpress/sdk": "0.10.11"
+    "@botpress/sdk": "0.10.12"
   },
   "devDependencies": {
     "@types/node": "^18.11.17",

Diff for: packages/cli/templates/webhook-message/package.json

@@ -7,7 +7,7 @@
   "private": true,
   "dependencies": {
     "@botpress/client": "0.29.1",
-    "@botpress/sdk": "0.10.11",
+    "@botpress/sdk": "0.10.12",
     "axios": "^1.6.8"
   },
   "devDependencies": {

Diff for: packages/sdk/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@botpress/sdk",
-  "version": "0.10.11",
+  "version": "0.10.12",
   "description": "Botpress SDK",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",

Diff for: packages/sdk/src/interfaces/index.ts

@@ -5,3 +5,4 @@ export * from './llm'
 export * from './speech-to-text'
 export * from './sync'
 export * from './text-to-image'
+export * from './typing-indicator'

Diff for: packages/sdk/src/interfaces/typing-indicator.ts

@@ -0,0 +1,39 @@
+import { InterfaceDeclaration } from '../integration'
+import z from '../zui'
+
+export const typingIndicator = new InterfaceDeclaration({
+  name: 'typingIndicator',
+  version: '0.0.1',
+  entities: {},
+  events: {},
+  actions: {
+    startTypingIndicator: {
+      input: {
+        schema: () =>
+          z.object({
+            conversationId: z.string(),
+            messageId: z.string().describe('The message ID to which the typing indicator should be attached'),
+            timeout: z
+              .number()
+              .optional()
+              .describe('The timeout in milliseconds after which the typing indicator should stop'),
+          }),
+      },
+      output: {
+        schema: () => z.object({}),
+      },
+    },
+    stopTypingIndicator: {
+      input: {
+        schema: () =>
+          z.object({
+            conversationId: z.string(),
+            messageId: z.string().describe('The message ID from which the typing indicator should be removed'),
+          }),
+      },
+      output: {
+        schema: () => z.object({}),
+      },
+    },
+  },
+})