@aracna/telegram-bot 1.9.3

package/modules/telegram.js

@@ -0,0 +1,353 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Telegram = void 0;
+const core_1 = require("@aracna/core");
+const add_1 = require("../childs/add");
+const answer_1 = require("../childs/answer");
+const ban_1 = require("../childs/ban");
+const create_1 = require("../childs/create");
+const delete_1 = require("../childs/delete");
+const download_1 = require("../childs/download");
+const edit_1 = require("../childs/edit");
+const export_1 = require("../childs/export");
+const forward_1 = require("../childs/forward");
+const get_1 = require("../childs/get");
+const leave_1 = require("../childs/leave");
+const pin_1 = require("../childs/pin");
+const polling_1 = require("../childs/polling");
+const promote_1 = require("../childs/promote");
+const restrict_1 = require("../childs/restrict");
+const send_1 = require("../childs/send");
+const set_1 = require("../childs/set");
+const stop_1 = require("../childs/stop");
+const unban_1 = require("../childs/unban");
+const unpin_1 = require("../childs/unpin");
+const upload_1 = require("../childs/upload");
+const webhook_1 = require("../childs/webhook");
+const enums_1 = require("../definitions/enums");
+const module_logger_1 = require("../loggers/module.logger");
+const callback_query_utils_1 = require("../utils/callback.query.utils");
+const command_utils_1 = require("../utils/command.utils");
+const reply_to_message_utils_1 = require("../utils/reply.to.message.utils");
+const start_utils_1 = require("../utils/start.utils");
+const api_1 = require("./api");
+const builder_1 = require("./builder");
+const dummy_1 = require("./dummy");
+class Telegram {
+    /** INTERNAL */
+    api;
+    handlers;
+    hostname;
+    id;
+    name;
+    port;
+    token;
+    username;
+    /** BUILDERS */
+    builder;
+    /** CHILDS */
+    add;
+    answer;
+    create;
+    delete;
+    download;
+    edit;
+    export;
+    forward;
+    get;
+    ban;
+    leave;
+    pin;
+    polling;
+    promote;
+    restrict;
+    send;
+    set;
+    stop;
+    unban;
+    unpin;
+    upload;
+    webhook;
+    constructor(token, hostname = '', port = (0, core_1.parseNumber)(process.env.PORT)) {
+        this.api = new api_1.API('https://api.telegram.org/bot' + token + '/');
+        this.handlers = [];
+        this.hostname = hostname;
+        this.name = { first: '', last: '' };
+        this.id = 0;
+        this.port = port;
+        this.token = token;
+        this.username = '';
+        this.builder = new builder_1.Builder();
+        this.add = new add_1.Add(this);
+        this.answer = new answer_1.Answer(this);
+        this.create = new create_1.Create(this);
+        this.delete = new delete_1.Delete(this);
+        this.download = new download_1.Download(this);
+        this.edit = new edit_1.Edit(this);
+        this.export = new export_1.Export(this);
+        this.forward = new forward_1.Forward(this);
+        this.get = new get_1.Get(this);
+        this.ban = new ban_1.Ban(this);
+        this.leave = new leave_1.Leave(this);
+        this.pin = new pin_1.Pin(this);
+        this.polling = new polling_1.Polling(this);
+        this.promote = new promote_1.Promote(this);
+        this.restrict = new restrict_1.Restrict(this);
+        this.send = new send_1.Send(this);
+        this.set = new set_1.Set(this);
+        this.stop = new stop_1.Stop(this);
+        this.unban = new unban_1.Unban(this);
+        this.unpin = new unpin_1.Unpin(this);
+        this.upload = new upload_1.Upload(this);
+        this.webhook = new webhook_1.Webhook(this);
+        this.get.me().then((v) => {
+            if (v instanceof Error)
+                return;
+            this.id = v.id;
+            this.name.first = v.first_name;
+            this.name.last = v.last_name || '';
+            this.username = v.username || '';
+        });
+    }
+    on(type, middleware, key, description, options) {
+        let handler, potential;
+        handler = dummy_1.Dummy.handler;
+        handler.description = description;
+        handler.id = core_1.ID.generate({ blacklist: this.handlerIDs });
+        handler.key = key;
+        handler.middleware = middleware;
+        handler.type = type;
+        handler.options = (0, core_1.mergeObjects)(handler.options, options || {});
+        potential = this.findMatchingHandler(handler.type, handler.key);
+        potential.id ? (potential.middleware = middleware) : this.handlers.push(handler);
+        module_logger_1.ModuleLogger.debug('Telegram', 'register', `The handler has been registered.`, handler);
+    }
+    handle(update) {
+        let handler;
+        switch (true) {
+            case (0, core_1.hasObjectProperty)(update, 'callback_query.data'):
+                handler = this.handleCallbackQuery(update.callback_query);
+                break;
+            case (0, core_1.hasObjectProperty)(update, 'channel_post'):
+                handler = this.handleChannelPost(update.channel_post);
+                break;
+            case (0, core_1.hasObjectProperty)(update, 'chat_join_request'):
+                handler = this.handleChatJoinRequest(update.chat_join_request);
+                break;
+            case (0, core_1.hasObjectProperty)(update, 'chat_member'):
+                handler = this.handleChatMember(update.chat_member);
+                break;
+            case (0, core_1.hasObjectProperty)(update, 'chosen_inline_result'):
+                handler = this.handleChosenInlineResult(update.chosen_inline_result);
+                break;
+            case (0, core_1.hasObjectProperty)(update, 'edited_channel_post'):
+                handler = this.handleEditedChannelPost(update.edited_channel_post);
+                break;
+            case (0, core_1.hasObjectProperty)(update, 'edited_message'):
+                handler = this.handleEditedMessage(update.edited_message);
+                break;
+            case (0, core_1.hasObjectProperty)(update, 'inline_query'):
+                handler = this.handleInlineQuery(update.inline_query);
+                break;
+            case (0, core_1.getObjectProperty)(update, 'message.text', '').includes('/start') &&
+                (0, core_1.getObjectProperty)(update, 'message.text', '').replace('/start', '').trim().length > 0:
+                handler = this.handleStart(update.message);
+                break;
+            case (0, core_1.hasObjectProperty)(update, 'message') && (0, core_1.hasObjectProperty)(update, 'message.reply_to_message.text'):
+                handler = this.handleReplyToMessage(update.message);
+                break;
+            case (0, core_1.hasObjectProperty)(update, 'message.text'):
+                handler = this.handleMessage(update.message);
+                break;
+            case (0, core_1.hasObjectProperty)(update, 'message.document') && (0, core_1.hasObjectProperty)(update, 'message.caption'):
+                handler = this.handleDocument(update.message);
+                break;
+            case (0, core_1.hasObjectProperty)(update, 'my_chat_member'):
+                handler = this.handleMyChatMember(update.my_chat_member);
+                break;
+            case (0, core_1.hasObjectProperty)(update, 'poll'):
+                handler = this.handlePoll(update.poll);
+                break;
+            case (0, core_1.hasObjectProperty)(update, 'poll_answer'):
+                handler = this.handlePollAnswer(update.poll_answer);
+                break;
+            case (0, core_1.hasObjectProperty)(update, 'pre_checkout_query'):
+                handler = this.handlePreCheckoutQuery(update.pre_checkout_query);
+                break;
+            case (0, core_1.hasObjectProperty)(update, 'shipping_query'):
+                handler = this.handleShippingQuery(update.shipping_query);
+                break;
+            default:
+                module_logger_1.ModuleLogger.error('Telegram', 'handle', `Failed to handle the update.`, update);
+                return;
+        }
+        handler.id
+            ? module_logger_1.ModuleLogger.debug('Telegram', 'handle', `A ${handler.type} update has been handled.`, update, handler)
+            : module_logger_1.ModuleLogger.warn('Telegram', 'handle', `Failed to find the matching handler.`, update);
+    }
+    handleCallbackQuery(query) {
+        let handler, body;
+        body = callback_query_utils_1.CallbackQueryUtils.decodeBody(query.data);
+        (0, core_1.setObjectProperty)(query, 'body', body);
+        handler = this.findMatchingHandler(enums_1.UpdateType.CALLBACK_QUERY, body.t);
+        if (!handler.id)
+            return handler;
+        handler.middleware(query);
+        if (handler.options.deleteOnCallbackQuery && query.message) {
+            this.delete.message(body.c ? query.from.id : query.message.chat.id, query.message.message_id);
+        }
+        return handler;
+    }
+    handleChannelPost(post) {
+        let handler;
+        handler = this.findMatchingHandler(enums_1.UpdateType.CHANNEL_POST);
+        if (!handler.id)
+            return handler;
+        handler.middleware(post);
+        module_logger_1.ModuleLogger.debug('Telegram', 'handleChannelPost', `A ${handler.type} update has been handled.`, post, handler);
+        return handler;
+    }
+    handleChatJoinRequest(request) {
+        let handler;
+        handler = this.findMatchingHandler(enums_1.UpdateType.CHAT_JOIN_REQUEST);
+        if (!handler.id)
+            return handler;
+        handler.middleware(request);
+        return handler;
+    }
+    handleChatMember(member) {
+        let handler;
+        handler = this.findMatchingHandler(enums_1.UpdateType.CHAT_MEMBER);
+        if (!handler.id)
+            return handler;
+        handler.middleware(member);
+        return handler;
+    }
+    handleChosenInlineResult(result) {
+        let handler;
+        handler = this.findMatchingHandler(enums_1.UpdateType.CHOSEN_INLINE_RESULT);
+        if (!handler.id)
+            return handler;
+        handler.middleware(result);
+        return handler;
+    }
+    handleDocument(document) {
+        let handler;
+        handler = this.findMatchingHandler(enums_1.UpdateType.DOCUMENT, command_utils_1.CommandUtils.get(document.caption));
+        if (!handler.id)
+            return handler;
+        handler.middleware(document);
+        return handler;
+    }
+    handleEditedChannelPost(post) {
+        let handler;
+        handler = this.findMatchingHandler(enums_1.UpdateType.EDITED_CHANNEL_POST);
+        if (!handler.id)
+            return handler;
+        handler.middleware(post);
+        return handler;
+    }
+    handleEditedMessage(message) {
+        let handler;
+        handler = this.findMatchingHandler(enums_1.UpdateType.EDITED_MESSAGE);
+        if (!handler.id)
+            return handler;
+        handler.middleware(message);
+        return handler;
+    }
+    handleInlineQuery(query) {
+        let handler;
+        handler = this.findMatchingHandler(enums_1.UpdateType.INLINE_QUERY);
+        if (!handler.id)
+            return handler;
+        handler.middleware(query);
+        return handler;
+    }
+    handleMessage(message) {
+        let handler;
+        handler = this.findMatchingHandler(enums_1.UpdateType.MESSAGE, command_utils_1.CommandUtils.get(message.text));
+        if (!handler.id)
+            return handler;
+        handler.middleware(message);
+        return handler;
+    }
+    handleMyChatMember(member) {
+        let handler;
+        handler = this.findMatchingHandler(enums_1.UpdateType.MY_CHAT_MEMBER);
+        if (!handler.id)
+            return handler;
+        handler.middleware(member);
+        return handler;
+    }
+    handlePoll(poll) {
+        let handler;
+        handler = this.findMatchingHandler(enums_1.UpdateType.POLL);
+        if (!handler.id)
+            return handler;
+        handler.middleware(poll);
+        return handler;
+    }
+    handlePollAnswer(answer) {
+        let handler;
+        handler = this.findMatchingHandler(enums_1.UpdateType.POLL_ANSWER);
+        if (!handler.id)
+            return handler;
+        handler.middleware(answer);
+        return handler;
+    }
+    handlePreCheckoutQuery(query) {
+        let handler;
+        handler = this.findMatchingHandler(enums_1.UpdateType.PRE_CHECKOUT_QUERY);
+        if (!handler.id)
+            return handler;
+        handler.middleware(query);
+        return handler;
+    }
+    handleReplyToMessage(reply) {
+        let body, handler;
+        body = reply_to_message_utils_1.ReplyToMessageUtils.decodeBody(reply.reply_to_message?.entities || []);
+        (0, core_1.setObjectProperty)(reply, 'body', body);
+        handler = this.findMatchingHandler(enums_1.UpdateType.REPLY_TO_MESSAGE, body.type);
+        if (!handler.id)
+            return handler;
+        handler.middleware(reply);
+        if (handler.id.length > 0 && handler.options.deleteOnReply && reply.from && reply.reply_to_message) {
+            this.delete.message(reply.from.id, reply.message_id);
+            this.delete.message(reply.from.id, reply.reply_to_message.message_id);
+        }
+        return handler;
+    }
+    handleShippingQuery(query) {
+        let handler;
+        handler = this.findMatchingHandler(enums_1.UpdateType.SHIPPING_QUERY);
+        if (!handler.id)
+            return handler;
+        handler.middleware(query);
+        return handler;
+    }
+    handleStart(start) {
+        let handler, body;
+        body = start_utils_1.StartUtils.decodeBody(start.text);
+        (0, core_1.setObjectProperty)(start, 'body', body);
+        handler = this.findMatchingHandler(enums_1.UpdateType.START, body.type);
+        if (!handler.id)
+            return handler;
+        handler.middleware(start);
+        if (handler.id.length > 0 && handler.options.deleteOnMessageStart) {
+            this.delete.message(body.chatID ? start.from?.id || 0 : start.chat.id, start.message_id);
+        }
+        return handler;
+    }
+    findMatchingHandler(type, key = '') {
+        return this.handlers.find((v) => v.key === key && v.type === type) || dummy_1.Dummy.handler;
+    }
+    get commands() {
+        return this.handlers
+            .filter((v) => v.key && v.type === enums_1.UpdateType.MESSAGE)
+            .map((v) => ({ command: v.key || '', description: v.description || '' }));
+    }
+    get handlerIDs() {
+        return this.handlers.reduce((r, v) => [...r, v.id], []);
+    }
+}
+exports.Telegram = Telegram;

package/package.json

@@ -0,0 +1,28 @@
+{
+  "author": "Dario Sechi",
+  "devDependencies": {
+    "@aracna/core": "^1.1.12",
+    "@aracna/telegram-bot-types": "^1.2.0",
+    "@microsoft/api-extractor": "^7.33.5",
+    "@vitest/coverage-c8": "^0.24.5",
+    "@vitest/ui": "^0.24.5",
+    "dotenv": "^16.0.3",
+    "fastify": "^4.9.2",
+    "typescript": "^4.8.4",
+    "vitest": "^0.24.5"
+  },
+  "license": "MIT",
+  "main": "index.js",
+  "name": "@aracna/telegram-bot",
+  "peerDependencies": {
+    "@aracna/core": ">= 1.1.12",
+    "@aracna/telegram-bot-types": ">= 1.2.0"
+  },
+  "scripts": {
+    "test": "yarn vitest run",
+    "build": "rm -rf dist && yarn tsc && yarn api-extractor run --local",
+    "tarball": "yarn version && cp LICENSE package.json README.md dist/. && cd dist && yarn pack",
+    "deploy": "yarn test && yarn build && yarn tarball && yarn publish dist/*.tgz && git push"
+  },
+  "version": "1.9.3"
+}

package/utils/callback.query.utils.js

@@ -0,0 +1,26 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CallbackQueryUtils = void 0;
+const core_1 = require("@aracna/core");
+const dummy_1 = require("../modules/dummy");
+class CallbackQueryUtils {
+    static decodeBody(data) {
+        let body;
+        if (!data) {
+            return dummy_1.Dummy.callbackQueryBody;
+        }
+        body = (0, core_1.tc)(() => JSON.parse(Buffer.from(data, 'base64').toString()));
+        if (body instanceof Error)
+            return dummy_1.Dummy.callbackQueryBody;
+        return body;
+    }
+    static encodeBody(data, type, chatID) {
+        let body;
+        body = dummy_1.Dummy.callbackQueryBody;
+        body.c = chatID;
+        body.d = data;
+        body.t = type;
+        return Buffer.from(JSON.stringify(body)).toString('base64');
+    }
+}
+exports.CallbackQueryUtils = CallbackQueryUtils;

package/utils/command.utils.js

@@ -0,0 +1,29 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CommandUtils = void 0;
+const core_1 = require("@aracna/core");
+const constants_1 = require("../definitions/constants");
+class CommandUtils {
+    static getByContext(context) {
+        let string;
+        switch (true) {
+            case (0, core_1.hasObjectProperty)(context, 'caption'):
+                string = (0, core_1.getObjectProperty)(context, 'caption', '');
+                break;
+            case (0, core_1.hasObjectProperty)(context, 'text'):
+                string = (0, core_1.getObjectProperty)(context, 'caption', '');
+                break;
+            default:
+                string = '';
+                break;
+        }
+        return this.get(string);
+    }
+    static get(string) {
+        return (constants_1.REGEXP_COMMAND.exec(string?.slice(0, 512) || '') || [''])[0].slice(1);
+    }
+    static omit(string) {
+        return string.replace(constants_1.REGEXP_COMMAND_WITH_USERNAME, '').trim();
+    }
+}
+exports.CommandUtils = CommandUtils;

package/utils/context.utils.js

@@ -0,0 +1,43 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ContextUtils = void 0;
+const core_1 = require("@aracna/core");
+class ContextUtils {
+    static getChatID(context) {
+        return this.getChat(context).id;
+    }
+    static getChatType(context) {
+        return this.getChat(context).type;
+    }
+    static getChat(context) {
+        switch (true) {
+            case (0, core_1.hasObjectProperty)(context, 'chat'):
+                return (0, core_1.getObjectProperty)(context, 'chat', { id: 0, type: '' });
+            case (0, core_1.hasObjectProperty)(context, 'message.chat'):
+                return (0, core_1.getObjectProperty)(context, 'chat', { id: 0, type: '' });
+            default:
+                return { id: 0, type: '' };
+        }
+    }
+    static getUserID(context) {
+        return this.getUser(context).id;
+    }
+    static getUserFirstName(context) {
+        return this.getUser(context).first_name;
+    }
+    static getUserLastName(context) {
+        return this.getUser(context).last_name || '';
+    }
+    static getUserUsername(context) {
+        return this.getUser(context).username || '';
+    }
+    static getUser(context) {
+        switch (true) {
+            case (0, core_1.hasObjectProperty)(context, 'from'):
+                return (0, core_1.getObjectProperty)(context, 'from', { first_name: '', id: 0, is_bot: false, username: '' });
+            default:
+                return { first_name: '', id: 0, is_bot: false, username: '' };
+        }
+    }
+}
+exports.ContextUtils = ContextUtils;

package/utils/html.utils.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HTMLUtils = void 0;
+const core_1 = require("@aracna/core");
+class HTMLUtils {
+    static tags = ['b', 'strong', 'i', 'em', 'u', 'ins', 's', 'strike', 'del', 'span', 'tg-spoiler', 'a', 'code', 'pre', '/', '"'];
+    static sanitize(text) {
+        return text
+            .replace(new RegExp(`<(?!(${this.tags.join('|')}))`, 'gm'), '&lt;')
+            .replace(new RegExp(`(?<!(${this.tags.join('|')}))>`, 'gm'), '&gt;')
+            .replace(/&/gm, '&amp;');
+    }
+    static progress(value, minimum = 0, maximum = 100, size = 20) {
+        let percentage, steps;
+        percentage = (0, core_1.getNumberPercentage)(value, minimum, maximum);
+        steps = new Array(size).fill(0).map((v, k) => ((k * maximum) / size < percentage ? '=' : ' '));
+        return `<code>[${steps.join('')}]</code>`;
+    }
+}
+exports.HTMLUtils = HTMLUtils;

package/utils/inline.keyboard.utils.js

@@ -0,0 +1,26 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.InlineKeyboardUtils = void 0;
+class InlineKeyboardUtils {
+    static getButtonsType(buttons) {
+        switch (Object.keys(buttons[0]).filter((v) => v !== 'text')[0]) {
+            case 'url':
+                return 'url';
+            case 'login_url':
+                return 'login';
+            case 'callback_data':
+                return 'callback';
+            case 'switch_inline_query':
+                return 'query';
+            case 'switch_inline_query_current_chat':
+                return 'queryCurrentChat';
+            case 'callback_game':
+                return 'game';
+            case 'pay':
+                return 'pay';
+            default:
+                return '';
+        }
+    }
+}
+exports.InlineKeyboardUtils = InlineKeyboardUtils;

package/utils/reply.to.message.utils.js

@@ -0,0 +1,27 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ReplyToMessageUtils = void 0;
+const core_1 = require("@aracna/core");
+const dummy_1 = require("../modules/dummy");
+class ReplyToMessageUtils {
+    static decodeBody(entities) {
+        let entity, encoded, body;
+        entity = entities[entities.length - 1];
+        if (!entity || !entity.url)
+            return dummy_1.Dummy.messageBody;
+        encoded = entity.url.replace('https://t.me/?a=', '');
+        body = (0, core_1.tc)(() => JSON.parse(Buffer.from(encoded, 'base64').toString()));
+        if (body instanceof Error)
+            return dummy_1.Dummy.messageBody;
+        return body;
+    }
+    static encodeBody(data, type, chatID) {
+        let body;
+        body = dummy_1.Dummy.messageBody;
+        body.chatID = chatID;
+        body.data = data;
+        body.type = type;
+        return `\n<a href="https://t.me/?a=${Buffer.from(JSON.stringify(body)).toString('base64')}">ㅤ</a>`;
+    }
+}
+exports.ReplyToMessageUtils = ReplyToMessageUtils;

package/utils/start.utils.js

@@ -0,0 +1,32 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.StartUtils = void 0;
+const core_1 = require("@aracna/core");
+const dummy_1 = require("../modules/dummy");
+class StartUtils {
+    static decodeBody(text) {
+        let body;
+        if (!text) {
+            return dummy_1.Dummy.messageBody;
+        }
+        body = (0, core_1.tc)(() => JSON.parse(Buffer.from(text.replace('/start', '').trim(), 'base64').toString()));
+        if (body instanceof Error)
+            return dummy_1.Dummy.messageBody;
+        return body;
+    }
+    static encodeBody(data, type, chatID) {
+        let body;
+        body = dummy_1.Dummy.messageBody;
+        body.chatID = chatID;
+        body.data = data;
+        body.type = type;
+        return Buffer.from(JSON.stringify(body)).toString('base64');
+    }
+    static encodeBodyToHREF(username, data, type, chatID) {
+        return `https://t.me/${username}?start=${this.encodeBody(data, type, chatID)}`;
+    }
+    static encodeBodyToAnchorTag(username, data, type, children, chatID) {
+        return `<a href="${this.encodeBodyToHREF(username, data, type, chatID)}">${children}</a>`;
+    }
+}
+exports.StartUtils = StartUtils;