Add Vercel setup

Author: deptyped

.gitignore

@@ -135,4 +135,7 @@ data/
 
 # Ignore SQLite database
 *.db
-*.db-journal
+*.db-journal
+
+# Vercel project configuration
+.vercel

.vercelignore

@@ -0,0 +1 @@
+.env*

README.md

@@ -54,20 +54,55 @@ Follow these steps to set up and run your bot using this template:
     npm run dev
     ```
 
-   **Production Mode:**
+    **Production Mode:**
 
-    Install only production dependencies:
+    Install Vercel CLI:
     ```bash
-    npm install --only=prod
+    npm i -g vercel
     ```
 
-    Set `DEBUG` environment variable to `false` in your `.env` file.
+    Create a project:
+    ```bash
+    vercel link
+    ```
+
+    Set `NODEJS_HELPERS` environment variable to `0`:
+    ```bash
+    vercel env add NODEJS_HELPERS
+    ```
+
+    Set `BOT_MODE` environment variable to `webhook`:
+    ```bash
+    vercel env add BOT_MODE
+    ```
 
-    Start the bot in production mode:
+    Set `BOT_TOKEN` environment variable:
+    ```bash
+    vercel env add BOT_TOKEN --sensitive
+    ```
+
+    Set `BOT_WEBHOOK_SECRET` environment variable to a random secret token:
+    ```bash
+    # Generate and set secret token using Node
+    node -e "console.log(crypto.randomBytes(256*0.75).toString('base64url'))" | vercel env add BOT_WEBHOOK_SECRET --sensitive production
+    ```
+    ```bash
+    # OR using Python
+    python3 -c "import secrets; print(secrets.token_urlsafe(256))" | vercel env add BOT_WEBHOOK_SECRET --sensitive production
+    ```
     ```bash
-    npm run start:force # skip type checking and start
-    # or
-    npm start # with type checking (requires development dependencies)
+    # OR set manually:
+    vercel env add BOT_WEBHOOK_SECRET --sensitive
+    ```
+
+    Deploy your bot:
+    ```bash
+    vercel
+    ```
+
+    After successful deployment, set up a webhook to connect your Vercel app with Telegram, modify the below URL to your credentials and visit it from your browser:
+    ```
+    https://APP_NAME.vercel.app/BOT_TOKEN
     ```
 
 ### List of Available Commands
@@ -302,16 +337,6 @@ bun add -d @types/bun
       Enables debug mode. You may use <code>config.isDebug</code> flag to enable debugging functions.
     </td>
   </tr>
-  <tr>
-    <td>BOT_WEBHOOK</td>
-    <td>
-        String
-    </td>
-    <td>
-        <i>Optional in <code>polling</code> mode.</i>
-        Webhook endpoint URL, used to configure webhook.
-    </td>
-  </tr>
   <tr>
     <td>BOT_WEBHOOK_SECRET</td>
     <td>

api/index.ts

@@ -0,0 +1,22 @@
+import process from 'node:process'
+import { handle } from '@hono/node-server/vercel'
+import { createBot } from '#root/bot/index.js'
+import { createConfig } from '#root/config.js'
+import { createServer } from '#root/server/index.js'
+import { createLogger } from '#root/logger.js'
+
+// @ts-expect-error create config from environment variables
+const config = createConfig(convertKeysToCamelCase(process.env))
+const logger = createLogger(config)
+
+const bot = createBot(config.botToken, {
+  config,
+  logger,
+})
+const server = createServer({
+  bot,
+  config,
+  logger,
+})
+
+export default handle(server)

src/config.ts

@@ -29,7 +29,6 @@ const configSchema = v.variant('botMode', [
     v.object({
       botMode: v.literal('webhook'),
       ...baseConfigSchema.entries,
-      botWebhook: v.pipe(v.string(), v.url()),
       botWebhookSecret: v.pipe(v.string(), v.minLength(12)),
       serverHost: v.optional(v.string(), '0.0.0.0'),
       serverPort: v.optional(v.pipe(v.string(), v.transform(Number), v.number()), '80'),

src/server/index.ts

@@ -58,6 +58,24 @@ export function createServer(dependencies: Dependencies) {
   server.get('/', c => c.json({ status: true }))
 
   if (config.isWebhookMode) {
+    server.get(`/${bot.token}`, async (c) => {
+      const hostname = c.req.header('x-forwarded-host')
+      if (typeof hostname === 'string') {
+        const webhookUrl = new URL('webhook', `https://${hostname}`).href
+        await bot.api.setWebhook(webhookUrl, {
+          allowed_updates: config.botAllowedUpdates,
+          secret_token: config.botWebhookSecret,
+        })
+        return c.json({
+          status: true,
+        })
+      }
+      c.status(500)
+      return c.json({
+        status: false,
+      })
+    })
+
     server.post(
       '/webhook',
       webhookCallback(bot, 'hono', {

tsconfig.json

@@ -18,6 +18,7 @@
     "preserveWatchOutput": true
   },
   "include": [
+    "api/**/*",
     "src/**/*"
   ]
 }

vercel.json

@@ -0,0 +1,12 @@
+{
+    "installCommand": "npm install",
+    "buildCommand": "npm run build",
+    "devCommand": "npm run dev",
+    "outputDirectory": "build",
+    "rewrites": [
+        {
+            "source": "/(.*)",
+            "destination": "/api"
+        }
+    ]
+}