@codebam/cf-workers-telegram-bot 6.1.0 → 6.4.0

package/README.md

@@ -1,12 +1,20 @@
 # cf-workers-telegram-bot
 
+[![Deploy to Cloudflare Workers](https://deploy.workers.cloudflare.com/button)](https://deploy.workers.cloudflare.com/?url=https://github.com/codebam/cf-workers-telegram-bot)
+
+![screenshot of cf-workers-telegram-bot](/screenshot.png)
+
 serverless telegram bot on cf workers
 
 The original `worker.js` is the content of Nikhil John's
 https://github.com/nikhiljohn10/telegram-bot-worker which is licensed with MIT.
 My modifications are licensed under the Apache license.
 
-[![Deploy to Cloudflare Workers](https://deploy.workers.cloudflare.com/button)](https://deploy.workers.cloudflare.com/?url=https://github.com/codebam/cf-workers-telegram-bot)
+The first bot configuration is fully featured, and responds to all received
+messages with llama2 if a command isn't found.
+
+To get continuous conversation with llama2 working make sure you add a database
+to your wrangler.toml and initailize it with the schema.sql
 
 To use the deploy button:
 
@@ -14,8 +22,8 @@ To use the deploy button:
 - Navigate to your new **GitHub repository > Settings > Secrets** and add the following secrets:
 
   ```yaml
-  - Name: CF_API_TOKEN (should be added automatically)
-  - Name: CF_ACCOUNT_ID (should be added automatically)
+  - Name: CLOUDFLARE_API_TOKEN  (should be added automatically)
+  - Name: CLOUDFLARE_ACCOUNT_ID (should be added automatically)
 
   - Name: SECRET_TELEGRAM_API_TOKEN
   - Value: your-telegram-bot-token
@@ -26,9 +34,13 @@ To use the deploy button:
 To fork this repo and use wrangler:
 
 - Click fork
+- `npm i -g wrangler`
 - `wrangler secret put SECRET_TELEGRAM_API_TOKEN` and set it to your telegram
   bot token
-- `wrangler publish`
+- `wrangler d1 create llama2`
+- put the database block from the command in your wrangler.toml
+- `wrangler d1 execute --remote llama2 --file ./schema.sql`
+- `wrangler deploy`
 - Done!
 
 ## Getting started with cf-workers-telegram-bot
@@ -36,10 +48,10 @@ To fork this repo and use wrangler:
 Once you've deployed the bot you can get your Webhook command URL by doing any
 of the following.
 
-- sha256sum(YourTelegramSecretKey) is the path to your webhook commands and
+- sha256sum(SECRET_TELEGRAM_API_TOKEN) is the path to your webhook commands and
   should be put at the end of your worker URL to access commands such as
   setting your webhook
-- Use `sha256sum <<< "your secret key"` to get the path
+- Use `echo -n yoursecretkey | sha256sum` to get the path
 - Open the Cloudflare Worker Logs under **Workers &gt; cf-workers-telegram-bot
   &gt; Logs &gt; Begin log stream** and make a GET request (open it in your browser)
   to your Worker URL and look at the logs to see your Access URL

package/dist/main/src/commands/ban.d.ts

@@ -0,0 +1,5 @@
+/// <reference types="@cloudflare/workers-types" />
+import TelegramBot from '../telegram_bot';
+import { TelegramUpdate } from '../types';
+declare const _default: (self: TelegramBot, update: TelegramUpdate) => Promise<Response>;
+export default _default;

package/dist/main/src/commands/ban.js

@@ -0,0 +1,8 @@
+export default async (self, update) => {
+    const chat_id = update.message?.reply_to_message?.chat.id;
+    const user_id = update.message?.reply_to_message?.from.id;
+    if (chat_id && user_id) {
+        return self.banChatMember(chat_id, user_id, 0, true);
+    }
+    return new Response('ok');
+};

package/dist/main/src/commands/mute.d.ts

@@ -0,0 +1,5 @@
+/// <reference types="@cloudflare/workers-types" />
+import TelegramBot from '../telegram_bot';
+import { TelegramUpdate } from '../types';
+declare const _default: (self: TelegramBot, update: TelegramUpdate) => Promise<Response>;
+export default _default;

package/dist/main/src/commands/mute.js

@@ -0,0 +1,8 @@
+export default async (self, update) => {
+    const chat_id = update.message?.reply_to_message?.chat.id;
+    const user_id = update.message?.reply_to_message?.from.id;
+    if (chat_id && user_id) {
+        return self.restrictChatMember(chat_id, user_id, { can_send_messages: false }, false, 0);
+    }
+    return new Response('ok');
+};

package/dist/main/src/commands/start.d.ts

@@ -0,0 +1,5 @@
+/// <reference types="@cloudflare/workers-types" />
+import TelegramBot from '../telegram_bot';
+import { TelegramUpdate } from '../types';
+declare const _default: (self: TelegramBot, update: TelegramUpdate) => Promise<Response>;
+export default _default;

package/dist/main/src/commands/start.js

@@ -0,0 +1 @@
+export default async (self, update) => self.sendMessage(update.message?.chat.id ?? 0, `Hello, send me a message to start chatting with ${self.chat_model}`);

package/dist/main/src/telegram_api.d.ts

@@ -1,6 +1,6 @@
 /// <reference types="@cloudflare/workers-types" />
 import BotApi from './bot_api';
-import { Commands, TelegramInlineQueryResult, TelegramUpdate, Webhook, Update } from './types';
+import { Commands, TelegramInlineQueryResult, TelegramUpdate, Webhook, Update, ChatPermissions } from './types';
 import Handler from './handler';
 export default class TelegramApi extends BotApi {
     constructor(commands: Commands, webhook: Webhook, handler: Handler);
@@ -29,4 +29,6 @@ export default class TelegramApi extends BotApi {
     sendPoll: (chat_id: number, question: string, options: string[], is_anonymous?: boolean, type?: string, allows_multiple_answers?: boolean, correct_option_id?: number, explanation?: string, explanation_parse_mode?: string, open_period?: number, close_date?: number, is_closed?: boolean, disable_notification?: boolean, reply_to_message_id?: number) => Promise<Response>;
     sendDice: (chat_id: number, emoji?: string, disable_notification?: boolean, reply_to_message_id?: number) => Promise<Response>;
     getUserProfilePhotos: (user_id: number, offset?: number, limit?: number) => Promise<Response>;
+    banChatMember: (chat_id: number | string, user_id: number, until_date?: number, revoke_messages?: boolean) => Promise<Response>;
+    restrictChatMember: (chat_id: number | string, user_id: number, permissions: ChatPermissions, use_independent_chat_permissions: boolean, until_date: number) => Promise<Response>;
 }

package/dist/main/src/telegram_api.js

@@ -170,4 +170,17 @@ export default class TelegramApi extends BotApi {
         offset: offset.toString(),
         limit: limit.toString(),
     }).href));
+    banChatMember = async (chat_id, user_id, until_date = 0, revoke_messages = false) => fetch(log(addSearchParams(new URL(`${this.webhook.api.origin}${this.webhook.api.pathname}/banChatMember`), {
+        chat_id: chat_id.toString(),
+        user_id: user_id.toString(),
+        until_date: until_date.toString(),
+        revoke_messages: revoke_messages.toString(),
+    }).href));
+    restrictChatMember = async (chat_id, user_id, permissions, use_independent_chat_permissions, until_date) => fetch(log(addSearchParams(new URL(`${this.webhook.api.origin}${this.webhook.api.pathname}/restrictChatMember`), {
+        chat_id: chat_id.toString(),
+        user_id: user_id.toString(),
+        permissions: JSON.stringify(permissions),
+        use_independent_chat_permissions: use_independent_chat_permissions.toString(),
+        until_date: until_date.toString(),
+    }).href));
 }

package/dist/main/src/telegram_bot.d.ts

@@ -19,6 +19,9 @@ export default class TelegramBot extends TelegramApi {
     toss: (self: TelegramBot, update: TelegramUpdate) => Promise<Response>;
     ping: (self: TelegramBot, update: TelegramUpdate, args: string[]) => Promise<Response>;
     getChatInfo: (self: TelegramBot, update: TelegramUpdate) => Promise<Response>;
+    start: (self: TelegramBot, update: TelegramUpdate) => Promise<Response>;
+    ban: (self: TelegramBot, update: TelegramUpdate) => Promise<Response>;
+    mute: (self: TelegramBot, update: TelegramUpdate) => Promise<Response>;
     url: URL;
     kv: Kv;
     get_set: KVNamespace;

package/dist/main/src/telegram_bot.js

@@ -16,6 +16,9 @@ import commandlist from './commands/commandlist';
 import toss from './commands/toss';
 import ping from './commands/ping';
 import getchatinfo from './commands/getchatinfo';
+import start from './commands/start';
+import ban from './commands/ban';
+import mute from './commands/mute';
 export default class TelegramBot extends TelegramApi {
     translate;
     clear;
@@ -34,6 +37,9 @@ export default class TelegramBot extends TelegramApi {
     toss;
     ping;
     getChatInfo;
+    start;
+    ban;
+    mute;
     url;
     kv;
     get_set;
@@ -61,6 +67,9 @@ export default class TelegramBot extends TelegramApi {
         this.toss = toss;
         this.ping = ping;
         this.getChatInfo = getchatinfo;
+        this.start = start;
+        this.ban = ban;
+        this.mute = mute;
         this.url = config.url;
         this.kv = config.kv;
         this.get_set = config.kv?.get_set;

package/dist/main/src/telegram_commands.d.ts

@@ -16,4 +16,7 @@ export default class TelegramCommands {
     static commandList: TelegramCommand;
     static image: TelegramCommand;
     static translate: TelegramCommand;
+    static start: TelegramCommand;
+    static ban: TelegramCommand;
+    static mute: TelegramCommand;
 }

package/dist/main/src/telegram_commands.js

@@ -15,4 +15,7 @@ export default class TelegramCommands {
     static commandList = async (bot, update) => bot.commandList(bot, update);
     static image = async (bot, update, args) => bot.image(bot, update, args);
     static translate = async (bot, update, args) => bot.translate(bot, update, args);
+    static start = async (bot, update) => bot.start(bot, update);
+    static ban = async (bot, update) => bot.ban(bot, update);
+    static mute = async (bot, update) => bot.mute(bot, update);
 }

package/dist/main/src/types/ChatPermissions.d.ts

@@ -0,0 +1,17 @@
+type ChatPermissions = {
+    can_send_messages?: boolean;
+    can_send_audios?: boolean;
+    can_send_documents?: boolean;
+    can_send_photos?: boolean;
+    can_send_videos?: boolean;
+    can_send_video_notes?: boolean;
+    can_send_voice_notes?: boolean;
+    can_send_polls?: boolean;
+    can_send_other_messages?: boolean;
+    can_add_web_page_previews?: boolean;
+    can_change_info?: boolean;
+    can_invite_users?: boolean;
+    can_pin_messages?: boolean;
+    can_manage_topics?: boolean;
+};
+export default ChatPermissions;

package/dist/main/src/types/ChatPermissions.js

@@ -0,0 +1 @@
+export {};

package/dist/main/src/types.d.ts

@@ -25,4 +25,5 @@ import TelegramInlineQueryResult from './types/TelegramInlineQueryResult';
 import TelegramInlineQueryResultPhoto from './types/TelegramInlineQueryResultPhoto';
 import TelegramInlineQueryResultArticle from './types/TelegramInlineQueryResultArticle';
 import DDGQueryResponse from './types/DDGQueryResponse';
-export { Webhook, Command, TelegramCommand, Commands, Kv, Config, localhost, WebhookCommands, Joke, Bored, Balance, TelegramFrom, TelegramChat, TelegramUser, TelegramMessageEntity, TelegramPhotoSize, TelegramMessage, TelegramInputMessageContent, TelegramInlineQuery, Update, TelegramUpdate, PartialTelegramUpdate, TelegramInlineQueryType, TelegramInlineQueryResult, TelegramInlineQueryResultPhoto, TelegramInlineQueryResultArticle, DDGQueryResponse, };
+import ChatPermissions from './types/ChatPermissions';
+export { Webhook, Command, TelegramCommand, Commands, Kv, Config, localhost, WebhookCommands, Joke, Bored, Balance, TelegramFrom, TelegramChat, TelegramUser, TelegramMessageEntity, TelegramPhotoSize, TelegramMessage, TelegramInputMessageContent, TelegramInlineQuery, Update, TelegramUpdate, PartialTelegramUpdate, TelegramInlineQueryType, TelegramInlineQueryResult, TelegramInlineQueryResultPhoto, TelegramInlineQueryResultArticle, DDGQueryResponse, ChatPermissions, };

package/dist/worker/src/worker.js

@@ -23,7 +23,9 @@ export default {
                 '/clear': TelegramCommands.clear,
                 '/help': TelegramCommands.commandList,
                 '/image': TelegramCommands.image,
-                '/start': TelegramCommands.question,
+                '/start': TelegramCommands.start,
+                '/ban': TelegramCommands.ban,
+                '/mute': TelegramCommands.mute,
             },
             kv: { get_set: env.KV_GET_SET, uid_data: env.KV_UID_DATA },
             ai: env.AI,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@codebam/cf-workers-telegram-bot",
-  "version": "6.1.0",
+  "version": "6.4.0",
   "description": "serverless telegram bot on cf workers",
   "main": "./dist/main/src/main.js",
   "module": "./dist/main/src/main.js",
@@ -41,5 +41,5 @@
     "typescript": "^5.4.5",
     "typescript-eslint": "^7.8.0"
   },
-  "gitHead": "0f3db27086c56ef9d50370c217ed09b5d5b3d401"
+  "gitHead": "3908a7cd0ca117b7e641960bb8a20cadaddc307e"
 }