@codebam/cf-workers-telegram-bot 7.22.0 → 7.24.0

package/README.md

@@ -5,7 +5,12 @@ CF Workers Telegram Bot
 <br/>
 </h3>
 
-<p  align="center">
+<h6 align="center">
+  <a href="https://codebam.github.io/cf-workers-telegram-bot/">Docs</a>
+  <a href="https://github.com/codebam/cf-workers-telegram-bot/wiki">Wiki</a>
+</h6>
+
+<p align="center">
 <a href="https://github.com/codebam/cf-workers-telegram-bot/stargazers">  <img src="https://img.shields.io/github/stars/codebam/cf-workers-telegram-bot?style=for-the-badge&logo=starship&color=111111&logoColor=ffffff&labelColor=000000" alt="GitHub stars"/></a>
 <a href="https://github.com/codebam/cf-workers-telegram-bot/issues">
   <img src="https://img.shields.io/github/issues/codebam/cf-workers-telegram-bot?style=for-the-badge&logo=gitbook&color=111111&logoColor=ffffff&labelColor=000000" alt="GitHub issues"/></a>

package/dist/main.d.ts

@@ -3,12 +3,7 @@ import TelegramExecutionContext from './telegram_execution_context.js';
 import Webhook from './webhook.js';
 import TelegramApi from './telegram_api.js';
 import TelegramCommand from './types/TelegramCommand.js';
-import Kv from './types/Kv.js';
-import localhost from './types/localhost.js';
 import WebhookCommands from './types/WebhookCommands.js';
-import Joke from './types/Joke.js';
-import Bored from './types/Bored.js';
-import Balance from './types/Balance.js';
 import TelegramFrom from './types/TelegramFrom.js';
 import TelegramChat from './types/TelegramChat.js';
 import TelegramUser from './types/TelegramUser.js';
@@ -24,9 +19,6 @@ import TelegramInlineQueryType from './types/TelegramInlineQueryType.js';
 import TelegramInlineQueryResult from './types/TelegramInlineQueryResult.js';
 import TelegramInlineQueryResultPhoto from './types/TelegramInlineQueryResultPhoto.js';
 import TelegramInlineQueryResultArticle from './types/TelegramInlineQueryResultArticle.js';
-import DDGQueryResponse from './types/DDGQueryResponse.js';
 import ChatPermissions from './types/ChatPermissions.js';
-import Kanye from './types/Kanye.js';
-import SerializableData from './types/SerializableData.js';
 export default TelegramBot;
-export { TelegramBot, TelegramExecutionContext, Webhook, TelegramApi, TelegramCommand, Kv, localhost, WebhookCommands, Joke, Bored, Balance, TelegramFrom, TelegramChat, TelegramUser, TelegramMessageEntity, TelegramPhotoSize, TelegramMessage, TelegramInputMessageContent, TelegramInlineQuery, Update, TelegramUpdate, PartialTelegramUpdate, TelegramInlineQueryType, TelegramInlineQueryResult, TelegramInlineQueryResultPhoto, TelegramInlineQueryResultArticle, DDGQueryResponse, ChatPermissions, Kanye, SerializableData, };
+export { TelegramBot, TelegramExecutionContext, Webhook, TelegramApi, TelegramCommand, WebhookCommands, TelegramFrom, TelegramChat, TelegramUser, TelegramMessageEntity, TelegramPhotoSize, TelegramMessage, TelegramInputMessageContent, TelegramInlineQuery, Update, TelegramUpdate, PartialTelegramUpdate, TelegramInlineQueryType, TelegramInlineQueryResult, TelegramInlineQueryResultPhoto, TelegramInlineQueryResultArticle, ChatPermissions, };

package/dist/main.js

@@ -2,7 +2,6 @@ import TelegramBot from './telegram_bot.js';
 import TelegramExecutionContext from './telegram_execution_context.js';
 import Webhook from './webhook.js';
 import TelegramApi from './telegram_api.js';
-import localhost from './types/localhost.js';
 import WebhookCommands from './types/WebhookCommands.js';
 import Update from './types/Update.js';
 import TelegramUpdate from './types/TelegramUpdate.js';
@@ -10,4 +9,4 @@ import TelegramInlineQueryResult from './types/TelegramInlineQueryResult.js';
 import TelegramInlineQueryResultPhoto from './types/TelegramInlineQueryResultPhoto.js';
 import TelegramInlineQueryResultArticle from './types/TelegramInlineQueryResultArticle.js';
 export default TelegramBot;
-export { TelegramBot, TelegramExecutionContext, Webhook, TelegramApi, localhost, WebhookCommands, Update, TelegramUpdate, TelegramInlineQueryResult, TelegramInlineQueryResultPhoto, TelegramInlineQueryResultArticle, };
+export { TelegramBot, TelegramExecutionContext, Webhook, TelegramApi, WebhookCommands, Update, TelegramUpdate, TelegramInlineQueryResult, TelegramInlineQueryResultPhoto, TelegramInlineQueryResultArticle, };

package/dist/telegram_api.d.ts

@@ -1,30 +1,60 @@
 /// <reference types="@cloudflare/workers-types" />
-import SerializableData from './types/SerializableData.js';
 import TelegramInlineQueryResultArticle from './types/TelegramInlineQueryResultArticle.js';
 import TelegramInlineQueryResultPhoto from './types/TelegramInlineQueryResultPhoto.js';
 import TelegramInlineQueryResultVideo from './types/TelegramInlineQueryResultVideo.js';
+/** Class representing the Telegram API and all it's methods */
 export default class TelegramApi {
-    getApiUrl(botApi: string, slug: string, data: Record<string, SerializableData>): Request<unknown, CfProperties<unknown>>;
-    getFile(botApi: string, data: {
-        file_id: string;
-    }, token: string): Promise<Response>;
+    /**
+     * Get the API URL for a given bot API and slug
+     * @param botApi - full URL to the telegram API without slug
+     * @param slug - slug to append to the API URL
+     * @param data - data to append to the request
+     */
+    getApiUrl(botApi: string, slug: string, data: Record<string, number | string | boolean>): Request<unknown, CfProperties<unknown>>;
+    /**
+     * Get a file with a given file_id
+     * @param botApi - full URL to the telegram API without slug
+     * @param data - data to append to the request
+     * @param token - bot token
+     */
+    getFile(botApi: string, data: Record<string, number | string | boolean>, token: string): Promise<Response>;
+    /**
+     * Send a message to a given botApi
+     * @param botApi - full URL to the telegram API without slug
+     * @param data - data to append to the request
+     */
     sendMessage(botApi: string, data: {
         reply_to_message_id: number | string;
         chat_id: number | string;
         text: string;
         parse_mode: string;
     }): Promise<Response>;
+    /**
+     * Send a video message to a given botApi
+     * @param botApi - full URL to the telegram API without slug
+     * @param data - data to append to the request
+     */
     sendVideo(botApi: string, data: {
         reply_to_message_id: number | string;
         chat_id: number | string;
         video: string;
     }): Promise<Response>;
+    /**
+     * Send a photo message to a given botApi
+     * @param botApi - full URL to the telegram API without slug
+     * @param data - data to append to the request
+     */
     sendPhoto(botApi: string, data: {
         reply_to_message_id: number | string;
         chat_id: number | string;
         photo: string;
         caption: string;
     }): Promise<Response>;
+    /**
+     * Send an inline response to a given botApi
+     * @param botApi - full URL to the telegram API without slug
+     * @param data - data to append to the request
+     */
     answerInline(botApi: string, data: {
         inline_query_id: number | string;
         results: TelegramInlineQueryResultArticle[] | TelegramInlineQueryResultPhoto[] | TelegramInlineQueryResultVideo[];

package/dist/telegram_api.js

@@ -1,4 +1,11 @@
+/** Class representing the Telegram API and all it's methods */
 export default class TelegramApi {
+    /**
+     * Get the API URL for a given bot API and slug
+     * @param botApi - full URL to the telegram API without slug
+     * @param slug - slug to append to the API URL
+     * @param data - data to append to the request
+     */
     getApiUrl(botApi, slug, data) {
         const request = new URL(botApi + (slug.startsWith('/') || botApi.endsWith('/') ? '' : '/') + slug);
         const params = new URLSearchParams();
@@ -7,6 +14,12 @@ export default class TelegramApi {
         }
         return new Request(`${request.toString()}?${params.toString()}`);
     }
+    /**
+     * Get a file with a given file_id
+     * @param botApi - full URL to the telegram API without slug
+     * @param data - data to append to the request
+     * @param token - bot token
+     */
     async getFile(botApi, data, token) {
         const url = this.getApiUrl(botApi, 'getFile', data);
         const response = await fetch(url);
@@ -21,18 +34,38 @@ export default class TelegramApi {
         }
         return await fetch(`https://api.telegram.org/file/bot${token}/${file_path}`);
     }
+    /**
+     * Send a message to a given botApi
+     * @param botApi - full URL to the telegram API without slug
+     * @param data - data to append to the request
+     */
     async sendMessage(botApi, data) {
         const url = this.getApiUrl(botApi, 'sendMessage', data);
         return await fetch(url);
     }
+    /**
+     * Send a video message to a given botApi
+     * @param botApi - full URL to the telegram API without slug
+     * @param data - data to append to the request
+     */
     async sendVideo(botApi, data) {
         const url = this.getApiUrl(botApi, 'sendVideo', data);
         return await fetch(url);
     }
+    /**
+     * Send a photo message to a given botApi
+     * @param botApi - full URL to the telegram API without slug
+     * @param data - data to append to the request
+     */
     async sendPhoto(botApi, data) {
         const url = this.getApiUrl(botApi, 'sendPhoto', data);
         return await fetch(url);
     }
+    /**
+     * Send an inline response to a given botApi
+     * @param botApi - full URL to the telegram API without slug
+     * @param data - data to append to the request
+     */
     async answerInline(botApi, data) {
         const url = this.getApiUrl(botApi, 'answerInlineQuery', {
             inline_query_id: data.inline_query_id,

package/dist/telegram_bot.d.ts

@@ -2,14 +2,34 @@
 import TelegramUpdate from './types/TelegramUpdate.js';
 import TelegramExecutionContext from './telegram_execution_context.js';
 import Webhook from './webhook.js';
+/** Class representing a telegram bot. */
 export default class TelegramBot {
+    /** The telegram token */
     token: string;
+    /** The telegram api URL */
     api: URL;
+    /** The telegram webhook object */
     webhook: Webhook;
+    /** The telegram update object */
     update: TelegramUpdate;
+    /** The telegram commands record map */
     commands: Record<string, (ctx: TelegramExecutionContext) => Promise<Response>>;
+    /** The current bot context */
     currentContext: TelegramExecutionContext;
+    /**
+     *	Create a bot
+     *	@param token - the telegram secret token
+     */
     constructor(token: string);
+    /**
+     * Register a function on the bot
+     * @param event - the event or command name
+     * @param callback - the bot context
+     */
     on(event: string, callback: (ctx: TelegramExecutionContext) => Promise<Response>): this;
+    /**
+     * Handle a request on a given bot
+     * @param request - the request to handle
+     */
     handle(request: Request): Promise<Response>;
 }

package/dist/telegram_bot.js

@@ -1,23 +1,43 @@
 import TelegramUpdate from './types/TelegramUpdate.js';
 import TelegramExecutionContext from './telegram_execution_context.js';
 import Webhook from './webhook.js';
+/** Class representing a telegram bot. */
 export default class TelegramBot {
+    /** The telegram token */
     token;
+    /** The telegram api URL */
     api;
+    /** The telegram webhook object */
     webhook = new Webhook('', new Request('http://127.0.0.1'));
+    /** The telegram update object */
     update = new TelegramUpdate({});
+    /** The telegram commands record map */
     commands = {};
+    /** The current bot context */
     currentContext;
+    /**
+     *	Create a bot
+     *	@param token - the telegram secret token
+     */
     constructor(token) {
         this.token = token;
         this.api = new URL('https://api.telegram.org/bot' + token);
     }
+    /**
+     * Register a function on the bot
+     * @param event - the event or command name
+     * @param callback - the bot context
+     */
     on(event, callback) {
         if (!['on', 'handle'].includes(event)) {
             this.commands[event] = callback;
         }
         return this;
     }
+    /**
+     * Handle a request on a given bot
+     * @param request - the request to handle
+     */
     async handle(request) {
         this.webhook = new Webhook(this.token, request);
         const url = new URL(request.url);

package/dist/telegram_execution_context.d.ts

@@ -1,21 +1,46 @@
 /// <reference types="@cloudflare/workers-types" />
 import TelegramApi from './telegram_api.js';
 import TelegramBot from './telegram_bot.js';
-import SerializableData from './types/SerializableData.js';
 import TelegramUpdate from './types/TelegramUpdate.js';
+/** Class representing the context of execution */
 export default class TelegramExecutionContext {
+    /** an instance of the telegram bot */
     bot: TelegramBot;
+    /** an instance of the telegram update */
     update: TelegramUpdate;
+    /** string representing the type of update that was sent */
     update_type: string;
+    /** reference to TelegramApi class */
     api: TelegramApi;
-    private data;
+    /**
+     * Create a telegram execution context
+     * @param bot - the telegram bot
+     * @param update - the telegram update
+     */
     constructor(bot: TelegramBot, update: TelegramUpdate);
-    getText(): string;
-    next(): Response;
-    setData(key: string, value: SerializableData): this;
-    getData(key: string): SerializableData;
-    replyVideo(video: string, options?: Record<string, SerializableData>): Promise<Response | undefined>;
+    /**
+     * Reply to the last message with a video
+     * @param video - string to a video on the internet or a file_id on telegram
+     * @param options - any additional options to pass to sendVideo
+     */
+    replyVideo(video: string, options?: Record<string, number | string | boolean>): Promise<Response | undefined>;
+    /**
+     * Get File from telegram file_id
+     * @param file_id - telegram file_id
+     */
     getFile(file_id: string): Promise<Response>;
-    replyPhoto(photo: string, caption?: string, options?: Record<string, SerializableData>): Promise<Response | undefined>;
-    reply(message: string, parse_mode?: string, options?: Record<string, SerializableData>): Promise<Response | undefined>;
+    /**
+     * Reply to the last message with a photo
+     * @param photo - url or file_id to photo
+     * @param caption - photo caption
+     * @param options - any additional options to pass to sendPhoto
+     */
+    replyPhoto(photo: string, caption?: string, options?: Record<string, number | string | boolean>): Promise<Response | undefined>;
+    /**
+     * Reply to the last message with text
+     * @param message - text to reply with
+     * @param parse_mode - one of HTML, MarkdownV2, Markdown, or an empty string for ascii
+     * @param options - any additional options to pass to sendMessage
+     */
+    reply(message: string, parse_mode?: string, options?: Record<string, number | string | boolean>): Promise<Response | undefined>;
 }

package/dist/telegram_execution_context.js

@@ -2,12 +2,21 @@ import TelegramApi from './telegram_api.js';
 import TelegramInlineQueryResultArticle from './types/TelegramInlineQueryResultArticle.js';
 import TelegramInlineQueryResultPhoto from './types/TelegramInlineQueryResultPhoto.js';
 import TelegramInlineQueryResultVideo from './types/TelegramInlineQueryResultVideo.js';
+/** Class representing the context of execution */
 export default class TelegramExecutionContext {
+    /** an instance of the telegram bot */
     bot;
+    /** an instance of the telegram update */
     update;
+    /** string representing the type of update that was sent */
     update_type = '';
+    /** reference to TelegramApi class */
     api = new TelegramApi();
-    data = {};
+    /**
+     * Create a telegram execution context
+     * @param bot - the telegram bot
+     * @param update - the telegram update
+     */
     constructor(bot, update) {
         this.bot = bot;
         this.update = update;
@@ -24,19 +33,11 @@ export default class TelegramExecutionContext {
             this.update_type = 'document';
         }
     }
-    getText() {
-        return this.update.message?.text ?? this.update.inline_query?.query ?? '';
-    }
-    next() {
-        return new Response('ok');
-    }
-    setData(key, value) {
-        this.data[key] = value;
-        return this;
-    }
-    getData(key) {
-        return this.data[key];
-    }
+    /**
+     * Reply to the last message with a video
+     * @param video - string to a video on the internet or a file_id on telegram
+     * @param options - any additional options to pass to sendVideo
+     */
     async replyVideo(video, options = {}) {
         switch (this.update_type) {
             case 'message':
@@ -56,9 +57,19 @@ export default class TelegramExecutionContext {
                 break;
         }
     }
+    /**
+     * Get File from telegram file_id
+     * @param file_id - telegram file_id
+     */
     async getFile(file_id) {
         return await this.api.getFile(this.bot.api.toString(), { file_id }, this.bot.token);
     }
+    /**
+     * Reply to the last message with a photo
+     * @param photo - url or file_id to photo
+     * @param caption - photo caption
+     * @param options - any additional options to pass to sendPhoto
+     */
     async replyPhoto(photo, caption = '', options = {}) {
         switch (this.update_type) {
             case 'photo':
@@ -86,6 +97,12 @@ export default class TelegramExecutionContext {
                 break;
         }
     }
+    /**
+     * Reply to the last message with text
+     * @param message - text to reply with
+     * @param parse_mode - one of HTML, MarkdownV2, Markdown, or an empty string for ascii
+     * @param options - any additional options to pass to sendMessage
+     */
     async reply(message, parse_mode = '', options = {}) {
         switch (this.update_type) {
             case 'message':

package/dist/types.d.ts

@@ -3,12 +3,7 @@ import TelegramExecutionContext from './telegram_execution_context.js';
 import Webhook from './webhook.js';
 import TelegramApi from './telegram_api.js';
 import TelegramCommand from './types/TelegramCommand.js';
-import Kv from './types/Kv.js';
-import localhost from './types/localhost.js';
 import WebhookCommands from './types/WebhookCommands.js';
-import Joke from './types/Joke.js';
-import Bored from './types/Bored.js';
-import Balance from './types/Balance.js';
 import TelegramFrom from './types/TelegramFrom.js';
 import TelegramChat from './types/TelegramChat.js';
 import TelegramUser from './types/TelegramUser.js';
@@ -24,9 +19,6 @@ import TelegramInlineQueryType from './types/TelegramInlineQueryType.js';
 import TelegramInlineQueryResult from './types/TelegramInlineQueryResult.js';
 import TelegramInlineQueryResultPhoto from './types/TelegramInlineQueryResultPhoto.js';
 import TelegramInlineQueryResultArticle from './types/TelegramInlineQueryResultArticle.js';
-import DDGQueryResponse from './types/DDGQueryResponse.js';
 import ChatPermissions from './types/ChatPermissions.js';
-import Kanye from './types/Kanye.js';
-import SerializableData from './types/SerializableData.js';
 export default TelegramBot;
-export { TelegramBot, TelegramExecutionContext, Webhook, TelegramApi, TelegramCommand, Kv, localhost, WebhookCommands, Joke, Bored, Balance, TelegramFrom, TelegramChat, TelegramUser, TelegramMessageEntity, TelegramPhotoSize, TelegramMessage, TelegramInputMessageContent, TelegramInlineQuery, Update, TelegramUpdate, PartialTelegramUpdate, TelegramInlineQueryType, TelegramInlineQueryResult, TelegramInlineQueryResultPhoto, TelegramInlineQueryResultArticle, DDGQueryResponse, ChatPermissions, Kanye, SerializableData, };
+export { TelegramBot, TelegramExecutionContext, Webhook, TelegramApi, TelegramCommand, WebhookCommands, TelegramFrom, TelegramChat, TelegramUser, TelegramMessageEntity, TelegramPhotoSize, TelegramMessage, TelegramInputMessageContent, TelegramInlineQuery, Update, TelegramUpdate, PartialTelegramUpdate, TelegramInlineQueryType, TelegramInlineQueryResult, TelegramInlineQueryResultPhoto, TelegramInlineQueryResultArticle, ChatPermissions, };

package/dist/types.js

@@ -2,7 +2,6 @@ import TelegramBot from './telegram_bot.js';
 import TelegramExecutionContext from './telegram_execution_context.js';
 import Webhook from './webhook.js';
 import TelegramApi from './telegram_api.js';
-import localhost from './types/localhost.js';
 import WebhookCommands from './types/WebhookCommands.js';
 import Update from './types/Update.js';
 import TelegramUpdate from './types/TelegramUpdate.js';
@@ -10,4 +9,4 @@ import TelegramInlineQueryResult from './types/TelegramInlineQueryResult.js';
 import TelegramInlineQueryResultPhoto from './types/TelegramInlineQueryResultPhoto.js';
 import TelegramInlineQueryResultArticle from './types/TelegramInlineQueryResultArticle.js';
 export default TelegramBot;
-export { TelegramBot, TelegramExecutionContext, Webhook, TelegramApi, localhost, WebhookCommands, Update, TelegramUpdate, TelegramInlineQueryResult, TelegramInlineQueryResultPhoto, TelegramInlineQueryResultArticle, };
+export { TelegramBot, TelegramExecutionContext, Webhook, TelegramApi, WebhookCommands, Update, TelegramUpdate, TelegramInlineQueryResult, TelegramInlineQueryResultPhoto, TelegramInlineQueryResultArticle, };

package/package.json

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

package/dist/types/Balance.d.ts

@@ -1,6 +0,0 @@
-type Balance = Record<string, {
-    final_balance: number;
-    n_tx: number;
-    total_received: number;
-}>;
-export default Balance;

package/dist/types/Balance.js

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

package/dist/types/Bored.d.ts

@@ -1,10 +0,0 @@
-interface Bored {
-    activity: string;
-    type: string;
-    participants: number;
-    price: number;
-    link: string;
-    key: string;
-    accessibility: 0;
-}
-export default Bored;

package/dist/types/Bored.js

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

package/dist/types/DDGQueryResponse.d.ts

@@ -1,12 +0,0 @@
-interface DDGQueryResponse {
-    AbstractSource: string;
-    AbstractURL: string;
-    Redirect: string;
-    Image: string;
-    RelatedTopics: {
-        Icon: {
-            URL: string;
-        };
-    }[];
-}
-export default DDGQueryResponse;

package/dist/types/DDGQueryResponse.js

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

package/dist/types/Joke.d.ts

@@ -1,20 +0,0 @@
-interface Joke {
-    error: boolean;
-    category: string;
-    type: string;
-    setup?: string;
-    delivery?: string;
-    joke?: string;
-    flags: {
-        nsfw: boolean;
-        religious: boolean;
-        political: boolean;
-        racist: boolean;
-        sexist: boolean;
-        explicit: boolean;
-    };
-    id: number;
-    safe: boolean;
-    lang: string;
-}
-export default Joke;

package/dist/types/Joke.js

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

package/dist/types/Kanye.d.ts

@@ -1,4 +0,0 @@
-interface Kanye {
-    quote: string;
-}
-export default Kanye;

package/dist/types/Kanye.js

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

package/dist/types/Kv.d.ts

@@ -1,3 +0,0 @@
-/// <reference types="@cloudflare/workers-types" />
-type Kv = Record<string, KVNamespace> | undefined;
-export default Kv;

package/dist/types/Kv.js

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

package/dist/types/SerializableData.d.ts

@@ -1,2 +0,0 @@
-type SerializableData = number | string | boolean;
-export default SerializableData;

package/dist/types/SerializableData.js

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

package/dist/types/localhost.d.ts

@@ -1,3 +0,0 @@
-/// <reference types="@cloudflare/workers-types" />
-declare const _default: URL;
-export default _default;

package/dist/types/localhost.js

@@ -1 +0,0 @@
-export default new URL('http://localhost');