⚡ Introduce a new high-performing standalone chat API

.npmrc

@@ -1 +1 @@
-public-hoist-pattern[]=*prisma*
+public-hoist-pattern[]=*prisma*

apps/builder/.prettierignore

@@ -1,3 +1,3 @@
 emojiList.json
 iconNames.ts
-reporters
+reporters

apps/builder/next.config.mjs

@@ -21,6 +21,12 @@ const injectViewerUrlIfVercelPreview = (val) => {
       process.env.VERCEL_BUILDER_PROJECT_NAME,
       process.env.NEXT_PUBLIC_VERCEL_VIEWER_PROJECT_NAME
     )
+  if (process.env.NEXT_PUBLIC_CHAT_API_URL.includes('{{pr_id}}'))
+    process.env.NEXT_PUBLIC_CHAT_API_URL =
+      process.env.NEXT_PUBLIC_CHAT_API_URL.replace(
+        '{{pr_id}}',
+        process.env.VERCEL_GIT_PULL_REQUEST_ID
+      )
 }
 
 injectViewerUrlIfVercelPreview(process.env.NEXT_PUBLIC_VIEWER_URL)

apps/builder/package.json

@@ -75,7 +75,7 @@
     "next": "14.1.0",
     "next-auth": "4.22.1",
     "nextjs-cors": "2.1.2",
-    "nodemailer": "6.9.3",
+    "nodemailer": "6.9.8",
     "nprogress": "0.2.0",
     "openai": "4.28.4",
     "papaparse": "5.4.1",
@@ -108,7 +108,7 @@
     "@types/jsonwebtoken": "9.0.2",
     "@types/micro-cors": "0.1.3",
     "@types/node": "20.4.2",
-    "@types/nodemailer": "6.4.8",
+    "@types/nodemailer": "6.4.14",
     "@types/nprogress": "0.2.0",
     "@types/papaparse": "5.3.7",
     "@types/prettier": "2.7.3",

apps/builder/src/features/whatsapp/startWhatsAppPreview.ts

@@ -114,6 +114,7 @@ export const startWhatsAppPreview = authenticatedProcedure
         typebotId,
         startFrom,
         userId: user.id,
+        isStreamEnabled: false,
       },
       initialSessionState: {
         whatsApp: (existingSession?.state as SessionState | undefined)

apps/chat-api/package.json

@@ -0,0 +1,36 @@
+{
+  "name": "chat-api",
+  "version": "1.0.0",
+  "license": "AGPL-3.0-or-later",
+  "private": true,
+  "scripts": {
+    "dev": "dotenv -e ./.env -e ../../.env  -- bun --hot src/index.ts",
+    "build": "dotenv -e ./.env -e ../../.env  -- bun build --target=bun ./src/index.ts --outdir ./dist",
+    "start": "bun src/index.ts"
+  },
+  "dependencies": {
+    "@hono/prometheus": "1.0.0",
+    "@hono/sentry": "1.0.1",
+    "@hono/typebox-validator": "0.2.2",
+    "@sinclair/typebox": "0.32.5",
+    "@trpc/server": "10.40.0",
+    "@typebot.io/bot-engine": "workspace:*",
+    "@typebot.io/env": "workspace:*",
+    "@typebot.io/forge": "workspace:*",
+    "@typebot.io/forge-repository": "workspace:*",
+    "@typebot.io/lib": "workspace:*",
+    "@typebot.io/prisma": "workspace:*",
+    "@typebot.io/schemas": "workspace:*",
+    "@typebot.io/variables": "workspace:*",
+    "ai": "3.0.12",
+    "hono": "4.0.5",
+    "openai": "4.28.4",
+    "prom-client": "15.1.0"
+  },
+  "devDependencies": {
+    "dotenv-cli": "7.2.1",
+    "@typebot.io/tsconfig": "workspace:*",
+    "@types/react": "18.2.15",
+    "react": "18.2.0"
+  }
+}

apps/chat-api/src/auth.ts

@@ -0,0 +1,30 @@
+import { env } from '@typebot.io/env'
+import { mockedUser } from '@typebot.io/lib/mockedUser'
+import prisma from '@typebot.io/lib/prisma'
+
+export const getAuthenticatedUserId = async (
+  authorizationHeaderValue: string | undefined
+): Promise<string | undefined> => {
+  if (env.NEXT_PUBLIC_E2E_TEST) return mockedUser.id
+  const bearerToken = extractBearerToken(authorizationHeaderValue)
+  if (!bearerToken) return
+  return authenticateByToken(bearerToken)
+}
+
+const authenticateByToken = async (
+  token: string
+): Promise<string | undefined> => {
+  if (typeof window !== 'undefined') return
+  const apiToken = await prisma.apiToken.findFirst({
+    where: {
+      token,
+    },
+    select: {
+      ownerId: true,
+    },
+  })
+  return apiToken?.ownerId
+}
+
+const extractBearerToken = (authorizationHeaderValue: string | undefined) =>
+  authorizationHeaderValue?.slice(7)

apps/chat-api/src/index.ts

@@ -0,0 +1,30 @@
+import { Hono } from 'hono'
+import { webRuntime } from './runtimes/web'
+import { whatsAppRuntime } from './runtimes/whatsapp'
+import { prometheus } from '@hono/prometheus'
+import { sentry } from '@hono/sentry'
+import { env } from '@typebot.io/env'
+
+const app = new Hono()
+
+app.use(
+  '*',
+  sentry({
+    environment: env.NODE_ENV,
+    dsn: env.NEXT_PUBLIC_SENTRY_DSN,
+    release: process.env.NEXT_PUBLIC_VERCEL_GIT_COMMIT_SHA + '-chat-api',
+  })
+)
+
+const { printMetrics, registerMetrics } = prometheus()
+app.use('*', registerMetrics)
+app.get('/metrics', printMetrics)
+
+app.get('/ping', (c) => c.json({ status: 'ok' }, 200))
+app.route('/', webRuntime)
+app.route('/', whatsAppRuntime)
+
+export default {
+  port: process.env.PORT ?? 3002,
+  fetch: app.fetch,
+}

apps/chat-api/src/runtimes/web.ts

@@ -0,0 +1,132 @@
+import { startChat } from '@typebot.io/bot-engine/apiHandlers/startChat'
+import { continueChat } from '@typebot.io/bot-engine/apiHandlers/continueChat'
+import { startChatPreview } from '@typebot.io/bot-engine/apiHandlers/startChatPreview'
+import { getMessageStream } from '@typebot.io/bot-engine/apiHandlers/getMessageStream'
+import { Hono } from 'hono'
+import { cors } from 'hono/cors'
+import { tbValidator } from '@hono/typebox-validator'
+import { Type as t } from '@sinclair/typebox'
+import { getAuthenticatedUserId } from '../auth'
+
+export const webRuntime = new Hono()
+
+webRuntime.use('*', cors())
+
+webRuntime.post(
+  '/api/v1/typebots/:publicId/startChat',
+  tbValidator(
+    'json',
+    t.Object({
+      message: t.Optional(t.String()),
+      isStreamEnabled: t.Optional(t.Boolean()),
+      resultId: t.Optional(t.String()),
+      isOnlyRegistering: t.Optional(t.Boolean()),
+      prefilledVariables: t.Optional(t.Record(t.String(), t.Unknown())),
+    }),
+    (result, c) => {
+      if (!result.success) return c.json({ message: 'Invalid input' }, 400)
+    }
+  ),
+  async (c) => {
+    const data = c.req.valid('json')
+    const { corsOrigin, ...response } = await startChat({
+      ...data,
+      publicId: c.req.param('publicId'),
+      isStreamEnabled: data.isStreamEnabled ?? true,
+      isOnlyRegistering: data.isOnlyRegistering ?? false,
+      origin: c.req.header('origin'),
+    })
+    if (corsOrigin) c.res.headers.set('Access-Control-Allow-Origin', corsOrigin)
+    return c.json(response)
+  }
+)
+
+webRuntime.post(
+  '/api/v1/typebots/:id/preview/startChat',
+  tbValidator(
+    'json',
+    t.Object({
+      message: t.Optional(t.String()),
+      isStreamEnabled: t.Optional(t.Boolean()),
+      resultId: t.Optional(t.String()),
+      isOnlyRegistering: t.Optional(t.Boolean()),
+      prefilledVariables: t.Optional(t.Record(t.String(), t.Unknown())),
+      startFrom: t.Optional(
+        t.Union([
+          t.Object({
+            type: t.Literal('group'),
+            groupId: t.String(),
+          }),
+          t.Object({
+            type: t.Literal('event'),
+            eventId: t.String(),
+          }),
+        ])
+      ),
+      typebot: t.Optional(t.Any()),
+    }),
+    (result, c) => {
+      if (!result.success) return c.json({ message: 'Invalid input' }, 400)
+    }
+  ),
+  async (c) => {
+    const data = c.req.valid('json')
+    const userId = !data.typebot
+      ? await getAuthenticatedUserId(c.req.header('Authorization'))
+      : undefined
+    return c.json(
+      await startChatPreview({
+        ...data,
+        typebotId: c.req.param('id'),
+        userId,
+        isStreamEnabled: data.isStreamEnabled ?? true,
+        isOnlyRegistering: data.isOnlyRegistering ?? false,
+      })
+    )
+  }
+)
+
+webRuntime.post(
+  '/api/v1/sessions/:sessionId/continueChat',
+  tbValidator(
+    'json',
+    t.Object({
+      message: t.Optional(t.String()),
+    }),
+    (result, c) => {
+      if (!result.success) return c.json({ message: 'Invalid input' }, 400)
+    }
+  ),
+  async (c) => {
+    const data = c.req.valid('json')
+    const { corsOrigin, ...response } = await continueChat({
+      ...data,
+      sessionId: c.req.param('sessionId'),
+      origin: c.req.header('origin'),
+    })
+    if (corsOrigin) c.res.headers.set('Access-Control-Allow-Origin', corsOrigin)
+    return c.json(response)
+  }
+)
+
+webRuntime.post(
+  '/api/v1/sessions/:sessionId/streamMessage',
+  tbValidator(
+    'json',
+    t.Object({
+      messages: t.Optional(t.Array(t.Any())),
+    }),
+    (result, c) => {
+      if (!result.success) return c.json({ message: 'Invalid input' }, 400)
+    }
+  ),
+  async (c) => {
+    const data = c.req.valid('json')
+    const { stream, status, message } = await getMessageStream({
+      sessionId: c.req.param('sessionId'),
+      messages: data.messages,
+    })
+    if (!stream) return c.json({ message }, (status ?? 400) as ResponseInit)
+    return new Response(stream)
+  }
+)

apps/chat-api/src/runtimes/whatsapp.ts

@@ -0,0 +1,51 @@
+import { receiveMessage } from '@typebot.io/bot-engine/apiHandlers/receiveMessage'
+import { receiveMessagePreview } from '@typebot.io/bot-engine/apiHandlers/receiveMessagePreview'
+import { tbValidator } from '@hono/typebox-validator'
+import { Hono } from 'hono'
+import { Type as t } from '@sinclair/typebox'
+
+export const whatsAppRuntime = new Hono()
+
+whatsAppRuntime.post(
+  '/api/v1/workspaces/:workspaceId/whatsapp/:credentialsId/webhook',
+  tbValidator(
+    'json',
+    t.Object({
+      object: t.String(),
+      entry: t.Any(),
+    }),
+    (result, c) => {
+      if (!result.success) return c.json({ message: 'Invalid input' }, 400)
+    }
+  ),
+  async (c) => {
+    const data = c.req.valid('json')
+    receiveMessage({
+      workspaceId: c.req.param('workspaceId'),
+      credentialsId: c.req.param('credentialsId'),
+      ...data,
+    })
+    return c.json({ message: 'Webhook received' }, 200)
+  }
+)
+
+whatsAppRuntime.post(
+  '/api/v1/whatsapp/preview/webhook',
+  tbValidator(
+    'json',
+    t.Object({
+      object: t.String(),
+      entry: t.Any(),
+    }),
+    (result, c) => {
+      if (!result.success) return c.json({ message: 'Invalid input' }, 400)
+    }
+  ),
+  async (c) => {
+    const data = c.req.valid('json')
+    receiveMessagePreview({
+      ...data,
+    })
+    return c.json({ message: 'Webhook received' }, 200)
+  }
+)

apps/chat-api/tsconfig.json

@@ -0,0 +1,8 @@
+{
+  "extends": "@typebot.io/tsconfig/base.json",
+  "include": ["src/**/*.ts"],
+  "exclude": ["node_modules"],
+  "compilerOptions": {
+    "jsx": "react"
+  }
+}

apps/docs/openapi/viewer.json

@@ -1772,14 +1772,16 @@
                 "type": "object",
                 "properties": {
                   "isStreamEnabled": {
-                    "type": "boolean"
+                    "type": "boolean",
+                    "default": false
                   },
                   "message": {
                     "type": "string"
                   },
                   "isOnlyRegistering": {
                     "type": "boolean",
-                    "description": "If set to `true`, it will only register the session and not start the bot. This is used for 3rd party chat platforms as it can require a session to be registered before sending the first message."
+                    "description": "If set to `true`, it will only register the session and not start the bot. This is used for 3rd party chat platforms as it can require a session to be registered before sending the first message.",
+                    "default": false
                   },
                   "typebot": {
                     "oneOf": [

apps/landing-page/package.json

@@ -2,7 +2,7 @@
   "name": "landing-page",
   "version": "1.0.0",
   "scripts": {
-    "dev": "dotenv -e ./.env -e ../../.env -- next dev -p 3002",
+    "dev": "dotenv -e ./.env -e ../../.env -- next dev -p 3003",
     "start": "dotenv -e ./.env -e ../../.env -- next start",
     "build": "dotenv -e ./.env -e ../../.env -- next build",
     "lint": "next lint",

apps/viewer/next.config.mjs

@@ -17,6 +17,12 @@ const injectViewerUrlIfVercelPreview = (val) => {
   )
     return
   process.env.NEXT_PUBLIC_VIEWER_URL = `https://${process.env.VERCEL_BRANCH_URL}`
+  if (process.env.NEXT_PUBLIC_CHAT_API_URL.includes('{{pr_id}}'))
+    process.env.NEXT_PUBLIC_CHAT_API_URL =
+      process.env.NEXT_PUBLIC_CHAT_API_URL.replace(
+        '{{pr_id}}',
+        process.env.VERCEL_GIT_PULL_REQUEST_ID
+      )
 }
 
 injectViewerUrlIfVercelPreview(process.env.NEXT_PUBLIC_VIEWER_URL)