@codebam/cf-workers-telegram-bot 11.6.1 → 11.9.0

package/README.md

@@ -33,24 +33,24 @@ npm install @codebam/cf-workers-telegram-bot
 import TelegramBot, { TelegramExecutionContext } from '@codebam/cf-workers-telegram-bot';
 
 export interface Env {
-  SECRET_TELEGRAM_API_TOKEN: string;
+	SECRET_TELEGRAM_API_TOKEN: string;
 }
 
 export default {
-  async fetch(request: Request, env: Env): Promise<Response> {
-    const bot = new TelegramBot(env.SECRET_TELEGRAM_API_TOKEN);
-
-    await bot
-      .command('start', async (ctx) => {
-        await ctx.reply('Hello! I am running on Cloudflare Workers.');
-      })
-      .onMessage(async (ctx) => {
-        await ctx.reply(`You said: ${ctx.text}`);
-      })
-      .handle(request);
-
-    return new Response('ok');
-  },
+	async fetch(request: Request, env: Env): Promise<Response> {
+		const bot = new TelegramBot(env.SECRET_TELEGRAM_API_TOKEN);
+
+		await bot
+			.command('start', async (ctx) => {
+				await ctx.reply('Hello! I am running on Cloudflare Workers.');
+			})
+			.onMessage(async (ctx) => {
+				await ctx.reply(`You said: ${ctx.text}`);
+			})
+			.handle(request);
+
+		return new Response('ok');
+	},
 };
 ```
 
@@ -66,15 +66,19 @@ export default {
 The `consumer` directory in this repository serves as a template for new projects. It is included as a git submodule.
 
 1. **Clone the repository with submodules**:
+
    ```sh
    git clone --recursive https://github.com/codebam/cf-workers-telegram-bot.git
    ```
-   *Or, if you've already cloned it:*
+
+   _Or, if you've already cloned it:_
+
    ```sh
    git submodule update --init --recursive
    ```
 
 2. **Copy the consumer directory**:
+
    ```sh
    cp -r consumer my-new-bot
    cd my-new-bot
@@ -86,33 +90,39 @@ The `consumer` directory in this repository serves as a template for new project
 
 4. **Set your Telegram Token**:
    Get a token from [@BotFather](https://t.me/BotFather) and add it to your worker:
+
    ```sh
    npx wrangler secret put SECRET_TELEGRAM_API_TOKEN
    ```
 
 5. **Deploy**:
+
    ```sh
    npm run deploy
    ```
 
-5. **Set Webhook**:
+6. **Set Webhook**:
    Visit the following URL in your browser to register your worker with Telegram:
    `https://<your-worker>.<your-subdomain>.workers.dev/<SECRET_TELEGRAM_API_TOKEN>/setWebhook`
 
 ## Deployment
 
 ### Manual Deployment
+
 Use [Wrangler](https://developers.cloudflare.com/workers/wrangler/) to deploy:
+
 ```sh
 npx wrangler deploy
 ```
 
 ### GitHub Actions
-To automate deployments, use the [Wrangler Action](https://github.com/cloudflare/wrangler-action) or Cloudflare's built-in [GitHub integration](https://developers.cloudflare.com/workers/ci-cd/github-actions/).
 
+To automate deployments, use the [Wrangler Action](https://github.com/cloudflare/wrangler-action) or Cloudflare's built-in [GitHub integration](https://developers.cloudflare.com/workers/ci-cd/github-actions/).
 
 ## API Documentation
+
 Detailed API documentation is available at [cf-workers-telegram-bot.codebam.ca](https://cf-workers-telegram-bot.codebam.ca).
 
 ## License
+
 Apache-2.0

package/dist/main.d.ts

@@ -20,6 +20,7 @@ import TelegramInlineQueryResult from './types/TelegramInlineQueryResult.js';
 import TelegramInlineQueryResultPhoto from './types/TelegramInlineQueryResultPhoto.js';
 import TelegramInlineQueryResultArticle from './types/TelegramInlineQueryResultArticle.js';
 import TelegramInlineQueryResultVideo from './types/TelegramInlineQueryResultVideo.js';
+import TelegramInlineQueryResultVoice from './types/TelegramInlineQueryResultVoice.js';
 import ChatPermissions from './types/ChatPermissions.js';
 import TelegramBusinessMessage from './types/TelegramBusinessMessage.js';
 import TelegramCallbackQuery from './types/TelegramCallbackQuery.js';
@@ -27,4 +28,4 @@ import TelegramPreCheckoutQuery from './types/TelegramPreCheckoutQuery.js';
 import TelegramDocument from './types/TelegramDocument.js';
 import TelegramSuccessfulPayment from './types/TelegramSuccessfulPayment.js';
 export default TelegramBot;
-export { TelegramBot, TelegramExecutionContext, Webhook, TelegramApi, TelegramApiBaseParams, SendMessageParams, SendMessageDraftParams, SendPhotoParams, SendVideoParams, SendVoiceParams, SendChatActionParams, AnswerCallbackParams, AnswerInlineParams, AnswerGuestParams, SendInvoiceParams, AnswerPreCheckoutParams, TelegramApiParams, TelegramCommand, TelegramFrom, TelegramChat, TelegramUser, TelegramMessageEntity, TelegramPhotoSize, TelegramMessage, TelegramVoice, TelegramGuestMessage, TelegramInputMessageContent, TelegramInlineQuery, TelegramUpdate, PartialTelegramUpdate, TelegramInlineQueryType, TelegramInlineQueryResult, TelegramInlineQueryResultPhoto, TelegramInlineQueryResultArticle, TelegramInlineQueryResultVideo, ChatPermissions, TelegramBusinessMessage, TelegramCallbackQuery, TelegramPreCheckoutQuery, TelegramDocument, TelegramSuccessfulPayment, };
+export { TelegramBot, TelegramExecutionContext, Webhook, TelegramApi, TelegramApiBaseParams, SendMessageParams, SendMessageDraftParams, SendPhotoParams, SendVideoParams, SendVoiceParams, SendChatActionParams, AnswerCallbackParams, AnswerInlineParams, AnswerGuestParams, SendInvoiceParams, AnswerPreCheckoutParams, TelegramApiParams, TelegramCommand, TelegramFrom, TelegramChat, TelegramUser, TelegramMessageEntity, TelegramPhotoSize, TelegramMessage, TelegramVoice, TelegramGuestMessage, TelegramInputMessageContent, TelegramInlineQuery, TelegramUpdate, PartialTelegramUpdate, TelegramInlineQueryType, TelegramInlineQueryResult, TelegramInlineQueryResultPhoto, TelegramInlineQueryResultArticle, TelegramInlineQueryResultVideo, TelegramInlineQueryResultVoice, ChatPermissions, TelegramBusinessMessage, TelegramCallbackQuery, TelegramPreCheckoutQuery, TelegramDocument, TelegramSuccessfulPayment, };

package/dist/main.js

@@ -7,5 +7,6 @@ import TelegramInlineQueryResult from './types/TelegramInlineQueryResult.js';
 import TelegramInlineQueryResultPhoto from './types/TelegramInlineQueryResultPhoto.js';
 import TelegramInlineQueryResultArticle from './types/TelegramInlineQueryResultArticle.js';
 import TelegramInlineQueryResultVideo from './types/TelegramInlineQueryResultVideo.js';
+import TelegramInlineQueryResultVoice from './types/TelegramInlineQueryResultVoice.js';
 export default TelegramBot;
-export { TelegramBot, TelegramExecutionContext, Webhook, TelegramApi, TelegramUpdate, TelegramInlineQueryResult, TelegramInlineQueryResultPhoto, TelegramInlineQueryResultArticle, TelegramInlineQueryResultVideo, };
+export { TelegramBot, TelegramExecutionContext, Webhook, TelegramApi, TelegramUpdate, TelegramInlineQueryResult, TelegramInlineQueryResultPhoto, TelegramInlineQueryResultArticle, TelegramInlineQueryResultVideo, TelegramInlineQueryResultVoice, };

package/dist/telegram_api.d.ts

@@ -1,6 +1,4 @@
-import TelegramInlineQueryResultArticle from './types/TelegramInlineQueryResultArticle.js';
-import TelegramInlineQueryResultPhoto from './types/TelegramInlineQueryResultPhoto.js';
-import TelegramInlineQueryResultVideo from './types/TelegramInlineQueryResultVideo.js';
+import TelegramInlineQueryResult from './types/TelegramInlineQueryResult.js';
 /** Interface for common Telegram API parameters */
 export interface TelegramApiBaseParams {
     chat_id: number | string;
@@ -56,7 +54,7 @@ export interface AnswerCallbackParams {
 /** Interface for inline query parameters */
 export interface AnswerInlineParams {
     inline_query_id: number | string;
-    results: TelegramInlineQueryResultArticle[] | TelegramInlineQueryResultPhoto[] | TelegramInlineQueryResultVideo[];
+    results: TelegramInlineQueryResult[];
     cache_time?: number;
     is_personal?: boolean;
     next_offset?: string;
@@ -64,7 +62,7 @@ export interface AnswerInlineParams {
 /** Interface for guest query parameters */
 export interface AnswerGuestParams {
     guest_query_id: string;
-    result: TelegramInlineQueryResultArticle | TelegramInlineQueryResultPhoto | TelegramInlineQueryResultVideo;
+    result: TelegramInlineQueryResult;
 }
 /** Interface for invoice parameters */
 export interface SendInvoiceParams extends TelegramApiBaseParams {

package/dist/telegram_execution_context.d.ts

@@ -1,6 +1,7 @@
 import TelegramApi from './telegram_api.js';
 import TelegramBot from './telegram_bot.js';
 import TelegramUpdate from './types/TelegramUpdate.js';
+import TelegramInlineQueryResult from './types/TelegramInlineQueryResult.js';
 /** Class representing the context of execution */
 export default class TelegramExecutionContext {
     /** an instance of the telegram bot */
@@ -103,19 +104,52 @@ export default class TelegramExecutionContext {
     replyInline(title: string, message: string, parse_mode?: string): Promise<Response | null>;
     /**
      * Answer a guest query
+     * @param result - the result to reply with
+     * @returns Promise with the API response
+     */
+    answerGuestQuery(result: TelegramInlineQueryResult): Promise<Response>;
+    /**
+     * Answer a guest query with text
      * @param message - text to reply with
      * @param parse_mode - one of HTML, MarkdownV2, Markdown, or an empty string for ascii
      * @returns Promise with the API response
      */
-    answerGuestQuery(message: string, parse_mode?: string): Promise<Response>;
+    answerGuestQueryText(message: string, parse_mode?: string): Promise<Response>;
+    /**
+     * Answer a guest query with a photo
+     * @param photo - url or file_id to photo
+     * @param caption - photo caption
+     * @param parse_mode - one of HTML, MarkdownV2, Markdown, or an empty string for ascii
+     * @returns Promise with the API response
+     */
+    answerGuestQueryPhoto(photo: string, caption?: string, parse_mode?: string): Promise<Response>;
+    /**
+     * Answer a guest query with a video
+     * @param video - url or file_id to video
+     * @param caption - video caption
+     * @param parse_mode - one of HTML, MarkdownV2, Markdown, or an empty string for ascii
+     * @returns Promise with the API response
+     */
+    answerGuestQueryVideo(video: string, caption?: string, parse_mode?: string): Promise<Response>;
+    /**
+     * Answer a guest query with a voice message
+     * @param voice - url or file_id to voice
+     * @param caption - voice caption
+     * @param parse_mode - one of HTML, MarkdownV2, Markdown, or an empty string for ascii
+     * @returns Promise with the API response
+     */
+    answerGuestQueryVoice(voice: string, caption?: string, parse_mode?: string): Promise<Response>;
+    /** Map of draft IDs to message IDs for streaming */
+    private drafts;
     /**
      * Reply to the last message with a stream of text
      * @param message - text to reply with
+     * @param draft_id - unique ID for this stream
      * @param parse_mode - one of HTML, MarkdownV2, Markdown, or an empty string for ascii
-     * @param options - any additional options to pass to sendMessage
+     * @param options - any additional options to pass to sendMessage/editMessageText
      * @returns Promise with the API response
      */
-    streamReply(message: string, draft_id: number, parse_mode?: string, options?: Record<string, number | string | boolean>): Promise<Response>;
+    streamReply(message: string, draft_id: number, parse_mode?: string, options?: Record<string, number | string | boolean | object>): Promise<Response>;
     /**
      * Reply to the last message with text
      * @param message - text to reply with

package/dist/telegram_execution_context.js

@@ -2,6 +2,7 @@ import TelegramApi from './telegram_api.js';
 import TelegramInlineQueryResultArticle from './types/TelegramInlineQueryResultArticle.js';
 import TelegramInlineQueryResultPhoto from './types/TelegramInlineQueryResultPhoto.js';
 import TelegramInlineQueryResultVideo from './types/TelegramInlineQueryResultVideo.js';
+import TelegramInlineQueryResultVoice from './types/TelegramInlineQueryResultVoice.js';
 /** Class representing the context of execution */
 export default class TelegramExecutionContext {
     /** an instance of the telegram bot */
@@ -55,7 +56,7 @@ export default class TelegramExecutionContext {
             case 'message':
             case 'business_message':
             case 'guest_message':
-                return (this.update.message?.text ?? this.update.guest_message?.text)?.split(' ') ?? [];
+                return (this.update.message?.text ?? this.update.business_message?.text ?? this.update.guest_message?.text)?.toString().split(' ') ?? [];
             case 'inline':
                 return this.update.inline_query?.query.split(' ') ?? [];
             default:
@@ -148,7 +149,6 @@ export default class TelegramExecutionContext {
         switch (this.update_type) {
             case 'voice':
             case 'message':
-            case 'guest_message':
                 return await this.api.sendVideo(this.bot.api.toString(), {
                     ...options,
                     chat_id: this.getChatId(),
@@ -156,11 +156,13 @@ export default class TelegramExecutionContext {
                     reply_to_message_id: this.getMessageId(),
                     video,
                 });
+            case 'guest_message':
+                return await this.answerGuestQueryVideo(video);
             case 'inline':
                 return await this.api.answerInline(this.bot.api.toString(), {
                     ...options,
                     inline_query_id: this.update.inline_query?.id.toString() ?? '',
-                    results: [new TelegramInlineQueryResultVideo(video)],
+                    results: [new TelegramInlineQueryResultVideo({ video })],
                 });
             default:
                 return null;
@@ -186,7 +188,6 @@ export default class TelegramExecutionContext {
             case 'voice':
             case 'photo':
             case 'message':
-            case 'guest_message':
                 return await this.api.sendPhoto(this.bot.api.toString(), {
                     ...options,
                     chat_id: this.getChatId(),
@@ -195,10 +196,12 @@ export default class TelegramExecutionContext {
                     photo,
                     caption,
                 });
+            case 'guest_message':
+                return await this.answerGuestQueryPhoto(photo, caption);
             case 'inline':
                 return await this.api.answerInline(this.bot.api.toString(), {
                     inline_query_id: this.update.inline_query?.id.toString() ?? '',
-                    results: [new TelegramInlineQueryResultPhoto(photo)],
+                    results: [new TelegramInlineQueryResultPhoto({ photo })],
                 });
             default:
                 return null;
@@ -215,7 +218,6 @@ export default class TelegramExecutionContext {
         switch (this.update_type) {
             case 'voice':
             case 'message':
-            case 'guest_message':
                 return await this.api.sendVoice(this.bot.api.toString(), {
                     ...options,
                     chat_id: this.getChatId(),
@@ -224,6 +226,8 @@ export default class TelegramExecutionContext {
                     voice,
                     caption,
                 });
+            case 'guest_message':
+                return await this.answerGuestQueryVoice(voice, caption);
             default:
                 return null;
         }
@@ -272,32 +276,102 @@ export default class TelegramExecutionContext {
     }
     /**
      * Answer a guest query
-     * @param message - text to reply with
-     * @param parse_mode - one of HTML, MarkdownV2, Markdown, or an empty string for ascii
+     * @param result - the result to reply with
      * @returns Promise with the API response
      */
-    async answerGuestQuery(message, parse_mode = '') {
+    async answerGuestQuery(result) {
         return await this.api.answerGuestQuery(this.bot.api.toString(), {
             guest_query_id: this.update.guest_message?.guest_query_id ?? '',
-            result: new TelegramInlineQueryResultArticle({ content: message, title: 'Response', parse_mode }),
+            result,
         });
     }
+    /**
+     * Answer a guest query with text
+     * @param message - text to reply with
+     * @param parse_mode - one of HTML, MarkdownV2, Markdown, or an empty string for ascii
+     * @returns Promise with the API response
+     */
+    async answerGuestQueryText(message, parse_mode = '') {
+        return await this.answerGuestQuery(new TelegramInlineQueryResultArticle({ content: message, title: 'Response', parse_mode }));
+    }
+    /**
+     * Answer a guest query with a photo
+     * @param photo - url or file_id to photo
+     * @param caption - photo caption
+     * @param parse_mode - one of HTML, MarkdownV2, Markdown, or an empty string for ascii
+     * @returns Promise with the API response
+     */
+    async answerGuestQueryPhoto(photo, caption = '', parse_mode = '') {
+        return await this.answerGuestQuery(new TelegramInlineQueryResultPhoto({ photo, caption, parse_mode }));
+    }
+    /**
+     * Answer a guest query with a video
+     * @param video - url or file_id to video
+     * @param caption - video caption
+     * @param parse_mode - one of HTML, MarkdownV2, Markdown, or an empty string for ascii
+     * @returns Promise with the API response
+     */
+    async answerGuestQueryVideo(video, caption = '', parse_mode = '') {
+        return await this.answerGuestQuery(new TelegramInlineQueryResultVideo({ video, caption, parse_mode }));
+    }
+    /**
+     * Answer a guest query with a voice message
+     * @param voice - url or file_id to voice
+     * @param caption - voice caption
+     * @param parse_mode - one of HTML, MarkdownV2, Markdown, or an empty string for ascii
+     * @returns Promise with the API response
+     */
+    async answerGuestQueryVoice(voice, caption = '', parse_mode = '') {
+        return await this.answerGuestQuery(new TelegramInlineQueryResultVoice({ voice, caption, parse_mode }));
+    }
+    /** Map of draft IDs to message IDs for streaming */
+    drafts = new Map();
     /**
      * Reply to the last message with a stream of text
      * @param message - text to reply with
+     * @param draft_id - unique ID for this stream
      * @param parse_mode - one of HTML, MarkdownV2, Markdown, or an empty string for ascii
-     * @param options - any additional options to pass to sendMessage
+     * @param options - any additional options to pass to sendMessage/editMessageText
      * @returns Promise with the API response
      */
     async streamReply(message, draft_id, parse_mode = '', options = {}) {
-        return await this.api.sendMessageDraft(this.bot.api.toString(), {
+        const message_id = this.drafts.get(draft_id);
+        if (message_id) {
+            return await this.api.editMessageText(this.bot.api.toString(), {
+                chat_id: this.getChatId(),
+                message_id,
+                text: message,
+                parse_mode,
+                ...options,
+            });
+        }
+        if (this.update_type === 'guest_message') {
+            if (this.drafts.has(draft_id)) {
+                return new Response('Query already answered', { status: 200 });
+            }
+            this.drafts.set(draft_id, -1);
+            return await this.answerGuestQueryText(message, parse_mode);
+        }
+        const response = await this.api.sendMessage(this.bot.api.toString(), {
             ...options,
             chat_id: this.getChatId(),
             message_thread_id: this.getThreadId(),
             text: message,
             parse_mode,
-            draft_id,
         });
+        if (response.status === 200) {
+            const cloned = response.clone();
+            try {
+                const json = (await cloned.json());
+                if (json.ok && json.result?.message_id) {
+                    this.drafts.set(draft_id, json.result.message_id);
+                }
+            }
+            catch {
+                // ignore
+            }
+        }
+        return response;
     }
     /**
      * Reply to the last message with text
@@ -312,10 +386,6 @@ export default class TelegramExecutionContext {
             case 'message':
             case 'photo':
             case 'document':
-            case 'guest_message':
-                if (this.update_type === 'guest_message') {
-                    return await this.answerGuestQuery(message, parse_mode);
-                }
                 if (reply) {
                     return await this.api.sendMessage(this.bot.api.toString(), {
                         ...options,
@@ -333,6 +403,8 @@ export default class TelegramExecutionContext {
                     text: message,
                     parse_mode,
                 });
+            case 'guest_message':
+                return await this.answerGuestQueryText(message, parse_mode);
             case 'business_message':
                 return await this.api.sendMessage(this.bot.api.toString(), {
                     chat_id: this.getChatId(),

package/dist/types/TelegramInlineQueryResultPhoto.d.ts

@@ -11,5 +11,11 @@ export default class TelegramInlineQueryResultPhoto extends TelegramInlineQueryR
     parse_mode?: string;
     caption_entities?: string;
     input_message_content?: TelegramInputMessageContent;
-    constructor(photo: string);
+    constructor(data: {
+        photo: string;
+        caption?: string;
+        parse_mode?: string;
+        title?: string;
+        description?: string;
+    });
 }

package/dist/types/TelegramInlineQueryResultPhoto.js

@@ -11,9 +11,13 @@ export default class TelegramInlineQueryResultPhoto extends TelegramInlineQueryR
     caption_entities;
     // reply_markup?: TelegramInlineKeyboardMarkup;
     input_message_content;
-    constructor(photo) {
+    constructor(data) {
         super('photo');
-        this.photo_url = photo;
-        this.thumb_url = photo;
+        this.photo_url = data.photo;
+        this.thumb_url = data.photo;
+        this.caption = data.caption;
+        this.parse_mode = data.parse_mode;
+        this.title = data.title;
+        this.description = data.description;
     }
 }

package/dist/types/TelegramInlineQueryResultVideo.d.ts

@@ -2,14 +2,20 @@ import TelegramInlineQueryResult from './TelegramInlineQueryResult.js';
 import TelegramInputMessageContent from './TelegramInputMessageContent.js';
 export default class TelegramInlineQueryResultVideo extends TelegramInlineQueryResult {
     video_url: string;
+    mime_type: string;
     thumb_url: string;
-    photo_width?: number;
-    photo_height?: number;
-    title?: string;
-    description?: string;
+    title: string;
     caption?: string;
     parse_mode?: string;
-    caption_entities?: string;
+    video_width?: number;
+    video_height?: number;
+    video_duration?: number;
+    description?: string;
     input_message_content?: TelegramInputMessageContent;
-    constructor(video: string);
+    constructor(data: {
+        video: string;
+        title?: string;
+        caption?: string;
+        parse_mode?: string;
+    });
 }

package/dist/types/TelegramInlineQueryResultVideo.js

@@ -1,19 +1,23 @@
 import TelegramInlineQueryResult from './TelegramInlineQueryResult.js';
 export default class TelegramInlineQueryResultVideo extends TelegramInlineQueryResult {
     video_url;
+    mime_type;
     thumb_url;
-    photo_width;
-    photo_height;
     title;
-    description;
     caption;
     parse_mode;
-    caption_entities;
-    // reply_markup?: TelegramInlineKeyboardMarkup;
+    video_width;
+    video_height;
+    video_duration;
+    description;
     input_message_content;
-    constructor(video) {
+    constructor(data) {
         super('video');
-        this.video_url = video;
-        this.thumb_url = video;
+        this.video_url = data.video;
+        this.mime_type = 'video/mp4';
+        this.thumb_url = data.video;
+        this.title = data.title ?? 'Video';
+        this.caption = data.caption;
+        this.parse_mode = data.parse_mode;
     }
 }

package/dist/types/TelegramInlineQueryResultVoice.d.ts

@@ -0,0 +1,13 @@
+import TelegramInlineQueryResult from './TelegramInlineQueryResult.js';
+export default class TelegramInlineQueryResultVoice extends TelegramInlineQueryResult {
+    voice_url: string;
+    title: string;
+    caption?: string;
+    parse_mode?: string;
+    constructor(data: {
+        voice: string;
+        title?: string;
+        caption?: string;
+        parse_mode?: string;
+    });
+}

package/dist/types/TelegramInlineQueryResultVoice.js

@@ -0,0 +1,14 @@
+import TelegramInlineQueryResult from './TelegramInlineQueryResult.js';
+export default class TelegramInlineQueryResultVoice extends TelegramInlineQueryResult {
+    voice_url;
+    title;
+    caption;
+    parse_mode;
+    constructor(data) {
+        super('voice');
+        this.voice_url = data.voice;
+        this.title = data.title ?? 'Voice';
+        this.caption = data.caption;
+        this.parse_mode = data.parse_mode;
+    }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@codebam/cf-workers-telegram-bot",
-	"version": "11.6.1",
+	"version": "11.9.0",
 	"description": "serverless telegram bot on cf workers",
 	"main": "./dist/main.js",
 	"module": "./dist/main.js",