@tgify/tgify 0.1.5 → 1.0.3

package/README.md

@@ -28,6 +28,10 @@ These accounts serve as an interface for code running somewhere on your server.
 
 Tgify is a library that makes it simple for you to develop your own Telegram bots using JavaScript or [TypeScript](https://www.typescriptlang.org/).
 
+### Release-notes
+
+- Version [1.0.0](https://github.com/IATNAOD/tgify/tree/main/release-notes/1.0.0.md) from 18.02.26
+
 ### Features
 
 - Full [Telegram Bot API 7.1](https://core.telegram.org/bots/api) support
@@ -44,10 +48,10 @@ Tgify is a library that makes it simple for you to develop your own Telegram bot
 ### Example
 
 ```js
-const { Telegraf } = require('@tgify/tgify')
+const { Tgify } = require('@tgify/tgify')
 const { message } = require('@tgify/tgify/filters')
 
-const bot = new Telegraf(process.env.BOT_TOKEN)
+const bot = new Tgify(process.env.BOT_TOKEN)
 bot.start((ctx) => ctx.reply('Welcome'))
 bot.help((ctx) => ctx.reply('Send me a sticker'))
 bot.on(message('sticker'), (ctx) => ctx.reply('👍'))
@@ -59,6 +63,8 @@ process.once('SIGINT', () => bot.stop('SIGINT'))
 process.once('SIGTERM', () => bot.stop('SIGTERM'))
 ```
 
+The `Telegraf` class can also be used, it will replicate all the basic functionality:
+
 ```js
 const { Telegraf } = require('@tgify/tgify')
 
@@ -108,16 +114,16 @@ or
 $ pnpm add @tgify/tgify
 ```
 
-### `Telegraf` class
+### `Tgify` class
 
-[`Telegraf`] instance represents your bot. It's responsible for obtaining updates and passing them to your handlers.
+[`Tgify`] instance represents your bot. It's responsible for obtaining updates and passing them to your handlers.
 
 Start by [listening to commands](https://telegraf.js.org/classes/Telegraf-1.html#command) and [launching](https://telegraf.js.org/classes/Telegraf-1.html#launch) your bot.
 
 ### `Context` class
 
 `ctx` you can see in every example is a [`Context`] instance.
-[`Telegraf`] creates one for each incoming update and passes it to your middleware.
+[`Tgify`] creates one for each incoming update and passes it to your middleware.
 It contains the `update`, `botInfo`, and `telegram` for making arbitrary Bot API requests,
 as well as shorthand methods and getters.
 
@@ -126,10 +132,10 @@ This is probably the class you'll be using the most.
 #### Shorthand methods
 
 ```js
-import { Telegraf } from '@tgify/tgify'
+import { Tgify } from '@tgify/tgify'
 import { message } from '@tgify/tgify/filters'
 
-const bot = new Telegraf(process.env.BOT_TOKEN)
+const bot = new Tgify(process.env.BOT_TOKEN)
 
 bot.command('quit', async (ctx) => {
   // Explicit usage
@@ -176,10 +182,10 @@ process.once('SIGTERM', () => bot.stop('SIGTERM'))
 ### Webhooks
 
 ```TS
-import { Telegraf } from "@tgify/tgify";
+import { Tgify } from "@tgify/tgify";
 import { message } from '@tgify/tgify/filters';
 
-const bot = new Telegraf(token);
+const bot = new Tgify(token);
 
 bot.on(message("text"), ctx => ctx.reply("Hello"));
 
@@ -203,7 +209,7 @@ bot.launch({
 });
 ```
 
-Use `createWebhook()` if you want to attach Telegraf to an existing http server.
+Use `createWebhook()` if you want to attach Tgify to an existing http server.
 
 <!-- global bot, tlsOptions -->
 
@@ -229,7 +235,7 @@ createServer(tlsOptions, await bot.createWebhook({ domain: "example.com" })).lis
 
 ### Error handling
 
-If middleware throws an error or times out, Telegraf calls `bot.handleError`. If it rethrows, update source closes, and then the error is printed to console and process terminates. If it does not rethrow, the error is swallowed.
+If middleware throws an error or times out, Tgify calls `bot.handleError`. If it rethrows, update source closes, and then the error is printed to console and process terminates. If it does not rethrow, the error is swallowed.
 
 Default `bot.handleError` always rethrows. You can overwrite it using `bot.catch` if you need to.
 
@@ -287,10 +293,10 @@ As in Koa and some other middleware-based libraries,
 `await next()` will call next middleware and wait for it to finish:
 
 ```TS
-import { Telegraf } from '@tgify/tgify';
+import { Tgify } from '@tgify/tgify';
 import { message } from '@tgify/tgify/filters';
 
-const bot = new Telegraf(process.env.BOT_TOKEN);
+const bot = new Tgify(process.env.BOT_TOKEN);
 
 bot.use(async (ctx, next) => {
   console.time(`Processing update ${ctx.update.update_id}`);
@@ -316,7 +322,7 @@ With this simple ability, you can:
 - reuse [other people's code](https://www.npmjs.com/search?q=telegraf-),
 - do whatever **you** come up with!
 
-[`Telegraf`]: https://telegraf.js.org/classes/Telegraf-1.html
+[`Tgify`]: https://telegraf.js.org/classes/Telegraf-1.html
 [`Composer`]: https://telegraf.js.org/classes/Composer.html
 [`Context`]: https://telegraf.js.org/classes/Context.html
 [`Router`]: https://telegraf.js.org/classes/Router.html
@@ -332,12 +338,12 @@ While most types of Tgify's API surface are self-explanatory, there's some notab
 #### Extending `Context`
 
 The exact shape of `ctx` can vary based on the installed middleware.
-Some custom middleware might register properties on the context object that Telegraf is not aware of.
+Some custom middleware might register properties on the context object that Tgify is not aware of.
 Consequently, you can change the type of `ctx` to fit your needs in order for you to have proper TypeScript types for your data.
 This is done through Generics:
 
 ```ts
-import { Context, Telegraf } from '@tgify/tgify'
+import { Context, Tgify } from '@tgify/tgify'
 
 // Define your own context type
 interface MyContext extends Context {
@@ -346,7 +352,7 @@ interface MyContext extends Context {
 }
 
 // Create your bot and tell it about your context type
-const bot = new Telegraf<MyContext>('SECRET TOKEN')
+const bot = new Tgify<MyContext>('SECRET TOKEN')
 
 // Register middleware and launch your bot as usual
 bot.use((ctx, next) => {

package/lib/button.js

@@ -16,8 +16,8 @@ exports.game = game;
 exports.pay = pay;
 exports.login = login;
 exports.webApp = webApp;
-function text(text, hide = false) {
-    return { text, hide };
+function text(text, hide = false, extra) {
+    return { text, hide, ...extra };
 }
 function contactRequest(text, hide = false) {
     return { text, request_contact: true, hide };
@@ -64,37 +64,38 @@ request_id, extra, hide = false) {
         hide,
     };
 }
-function url(text, url, hide = false) {
-    return { text, url, hide };
+function url(text, url, hide = false, extra) {
+    return { text, url, hide, ...extra };
 }
-function callback(text, data, hide = false) {
-    return { text, callback_data: data, hide };
+function callback(text, data, hide = false, extra) {
+    return { text, callback_data: data, hide, ...extra };
 }
-function switchToChat(text, value, hide = false) {
-    return { text, switch_inline_query: value, hide };
+function switchToChat(text, value, hide = false, extra) {
+    return { text, switch_inline_query: value, hide, ...extra };
 }
-function switchToCurrentChat(text, value, hide = false) {
-    return { text, switch_inline_query_current_chat: value, hide };
+function switchToCurrentChat(text, value, hide = false, extra) {
+    return { text, switch_inline_query_current_chat: value, hide, ...extra };
 }
-function game(text, hide = false) {
-    return { text, callback_game: {}, hide };
+function game(text, hide = false, extra) {
+    return { text, callback_game: {}, hide, ...extra };
 }
-function pay(text, hide = false) {
-    return { text, pay: true, hide };
+function pay(text, hide = false, extra) {
+    return { text, pay: true, hide, ...extra };
 }
-function login(text, url, opts = {}, hide = false) {
+function login(text, url, opts = {}, hide = false, extra) {
     return {
         text,
-        login_url: { ...opts, url },
         hide,
+        login_url: { ...opts, url },
+        ...extra
     };
 }
-function webApp(text, url, hide = false
 // works as both InlineKeyboardButton and KeyboardButton
-) {
+function webApp(text, url, hide = false, extra) {
     return {
         text,
-        web_app: { url },
         hide,
+        web_app: { url },
+        ...extra
     };
 }

package/lib/core/types/typegram.js

@@ -15,13 +15,13 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 // internal type provisions
-__exportStar(require("@telegraf/types/api"), exports);
-__exportStar(require("@telegraf/types/inline"), exports);
-__exportStar(require("@telegraf/types/manage"), exports);
-__exportStar(require("@telegraf/types/markup"), exports);
-__exportStar(require("@telegraf/types/message"), exports);
-__exportStar(require("@telegraf/types/methods"), exports);
-__exportStar(require("@telegraf/types/passport"), exports);
-__exportStar(require("@telegraf/types/payment"), exports);
-__exportStar(require("@telegraf/types/settings"), exports);
-__exportStar(require("@telegraf/types/update"), exports);
+__exportStar(require("@tgify/types/api"), exports);
+__exportStar(require("@tgify/types/inline"), exports);
+__exportStar(require("@tgify/types/manage"), exports);
+__exportStar(require("@tgify/types/markup"), exports);
+__exportStar(require("@tgify/types/message"), exports);
+__exportStar(require("@tgify/types/methods"), exports);
+__exportStar(require("@tgify/types/passport"), exports);
+__exportStar(require("@tgify/types/payment"), exports);
+__exportStar(require("@tgify/types/settings"), exports);
+__exportStar(require("@tgify/types/update"), exports);

package/lib/index.js

@@ -33,7 +33,9 @@ var __importStar = (this && this.__importStar) || (function () {
     };
 })();
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Scenes = exports.MemorySessionStore = exports.session = exports.deunionize = exports.Format = exports.Input = exports.Markup = exports.Types = exports.Telegram = exports.TelegramError = exports.Router = exports.Composer = exports.Context = exports.Telegraf = void 0;
+exports.Scenes = exports.MemorySessionStore = exports.session = exports.deunionize = exports.Format = exports.Input = exports.Markup = exports.Types = exports.Telegram = exports.TelegramError = exports.Router = exports.Composer = exports.Context = exports.Telegraf = exports.Tgify = void 0;
+var tgify_1 = require("./tgify");
+Object.defineProperty(exports, "Tgify", { enumerable: true, get: function () { return tgify_1.Tgify; } });
 var telegraf_1 = require("./telegraf");
 Object.defineProperty(exports, "Telegraf", { enumerable: true, get: function () { return telegraf_1.Telegraf; } });
 var context_1 = require("./context");

package/lib/reactions.js

@@ -4,10 +4,12 @@ exports.MessageReactions = exports.ReactionList = exports.Digit = void 0;
 const util_1 = require("./core/helpers/util");
 exports.Digit = new Set(['0', '1', '2', '3', '4', '5', '6', '7', '8', '9']);
 const inspectReaction = (reaction) => {
+    if (reaction.type === 'emoji')
+        return reaction.emoji;
     if (reaction.type === 'custom_emoji')
         return `Custom(${reaction.custom_emoji_id})`;
     else
-        return reaction.emoji;
+        return 'paid()';
 };
 class ReactionList {
     constructor(list) {

package/lib/telegraf.js

@@ -1,256 +1,5 @@
 "use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || (function () {
-    var ownKeys = function(o) {
-        ownKeys = Object.getOwnPropertyNames || function (o) {
-            var ar = [];
-            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
-            return ar;
-        };
-        return ownKeys(o);
-    };
-    return function (mod) {
-        if (mod && mod.__esModule) return mod;
-        var result = {};
-        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
-        __setModuleDefault(result, mod);
-        return result;
-    };
-})();
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Telegraf = void 0;
-const crypto = __importStar(require("crypto"));
-const http = __importStar(require("http"));
-const https = __importStar(require("https"));
-const composer_1 = require("./composer");
-const compact_1 = require("./core/helpers/compact");
-const context_1 = __importDefault(require("./context"));
-const debug_1 = __importDefault(require("debug"));
-const webhook_1 = __importDefault(require("./core/network/webhook"));
-const polling_1 = require("./core/network/polling");
-const p_timeout_1 = __importDefault(require("p-timeout"));
-const telegram_1 = __importDefault(require("./telegram"));
-const url_1 = require("url");
-const safeCompare = require("safe-compare");
-const debug = (0, debug_1.default)('telegraf:main');
-const DEFAULT_OPTIONS = {
-    telegram: {},
-    handlerTimeout: 90000, // 90s in ms
-    contextType: context_1.default,
-};
-function always(x) {
-    return () => x;
-}
-const anoop = always(Promise.resolve());
-const TOKEN_HEADER = 'x-telegram-bot-api-secret-token';
-class Telegraf extends composer_1.Composer {
-    constructor(token, options) {
-        super();
-        this.context = {};
-        /** Assign to this to customise the webhook filter middleware.
-         * `{ path, secretToken }` will be bound to this rather than the Telegraf instance.
-         * Remember to assign a regular function and not an arrow function so it's bindable.
-         */
-        this.webhookFilter = function (req) {
-            const debug = (0, debug_1.default)('telegraf:webhook');
-            if (req.method === 'POST') {
-                if (safeCompare(this.path, req.url)) {
-                    // no need to check if secret_token was not set
-                    if (!this.secretToken)
-                        return true;
-                    else {
-                        const token = req.headers[TOKEN_HEADER];
-                        if (safeCompare(this.secretToken, token))
-                            return true;
-                        else
-                            debug('Secret token does not match:', token, this.secretToken);
-                    }
-                }
-                else
-                    debug('Path does not match:', req.url, this.path);
-            }
-            else
-                debug('Unexpected request method, not POST. Received:', req.method);
-            return false;
-        };
-        this.handleError = (err, ctx) => {
-            // set exit code to emulate `warn-with-error-code` behavior of
-            // https://nodejs.org/api/cli.html#cli_unhandled_rejections_mode
-            // to prevent a clean exit despite an error being thrown
-            process.exitCode = 1;
-            console.error('Unhandled error while processing', ctx.update);
-            throw err;
-        };
-        // @ts-expect-error Trust me, TS
-        this.options = {
-            ...DEFAULT_OPTIONS,
-            ...(0, compact_1.compactOptions)(options),
-        };
-        this.telegram = new telegram_1.default(token, this.options.telegram);
-        debug('Created a `Telegraf` instance');
-    }
-    get token() {
-        return this.telegram.token;
-    }
-    /** @deprecated use `ctx.telegram.webhookReply` */
-    set webhookReply(webhookReply) {
-        this.telegram.webhookReply = webhookReply;
-    }
-    /** @deprecated use `ctx.telegram.webhookReply` */
-    get webhookReply() {
-        return this.telegram.webhookReply;
-    }
-    /**
-     * _Override_ error handling
-     */
-    catch(handler) {
-        this.handleError = handler;
-        return this;
-    }
-    /**
-     * You must call `bot.telegram.setWebhook` for this to work.
-     * You should probably use {@link Telegraf.createWebhook} instead.
-     */
-    webhookCallback(path = '/', opts = {}) {
-        const { secretToken } = opts;
-        return (0, webhook_1.default)(this.webhookFilter.bind({ hookPath: path, path, secretToken }), (update, res) => this.handleUpdate(update, res));
-    }
-    getDomainOpts(opts) {
-        var _a;
-        const protocol = opts.domain.startsWith('https://') || opts.domain.startsWith('http://');
-        if (protocol)
-            debug('Unexpected protocol in domain, telegraf will use https:', opts.domain);
-        const domain = protocol ? new url_1.URL(opts.domain).host : opts.domain;
-        const path = (_a = opts.path) !== null && _a !== void 0 ? _a : `/telegraf/${this.secretPathComponent()}`;
-        const url = `https://${domain}${path}`;
-        return { domain, path, url };
-    }
-    /**
-     * Specify a url to receive incoming updates via webhook.
-     * Returns an Express-style middleware you can pass to app.use()
-     */
-    async createWebhook(opts) {
-        const { domain, path, ...extra } = opts;
-        const domainOpts = this.getDomainOpts({ domain, path });
-        await this.telegram.setWebhook(domainOpts.url, extra);
-        debug(`Webhook set to ${domainOpts.url}`);
-        return this.webhookCallback(domainOpts.path, {
-            secretToken: extra.secret_token,
-        });
-    }
-    startPolling(allowedUpdates = []) {
-        this.polling = new polling_1.Polling(this.telegram, allowedUpdates);
-        return this.polling.loop(async (update) => {
-            await this.handleUpdate(update);
-        });
-    }
-    startWebhook(path, tlsOptions, port, host, cb, secretToken) {
-        const webhookCb = this.webhookCallback(path, { secretToken });
-        const callback = typeof cb === 'function'
-            ? (req, res) => webhookCb(req, res, () => cb(req, res))
-            : webhookCb;
-        this.webhookServer =
-            tlsOptions != null
-                ? https.createServer(tlsOptions, callback)
-                : http.createServer(callback);
-        this.webhookServer.listen(port, host, () => {
-            debug('Webhook listening on port: %s', port);
-        });
-        return this;
-    }
-    secretPathComponent() {
-        return crypto
-            .createHash('sha3-256')
-            .update(this.token)
-            .update(process.version) // salt
-            .digest('hex');
-    }
-    /**
-     * @see https://github.com/telegraf/telegraf/discussions/1344#discussioncomment-335700
-     */
-    async launch(config = {}, 
-    /** @experimental */
-    onLaunch) {
-        var _a, _b;
-        const [cfg, onMe] = typeof config === 'function' ? [{}, config] : [config, onLaunch];
-        const drop_pending_updates = cfg.dropPendingUpdates;
-        const allowed_updates = cfg.allowedUpdates;
-        const webhook = cfg.webhook;
-        debug('Connecting to Telegram');
-        (_a = this.botInfo) !== null && _a !== void 0 ? _a : (this.botInfo = await this.telegram.getMe());
-        onMe === null || onMe === void 0 ? void 0 : onMe();
-        debug(`Launching @${this.botInfo.username}`);
-        if (webhook === undefined) {
-            await this.telegram.deleteWebhook({ drop_pending_updates });
-            debug('Bot started with long polling');
-            await this.startPolling(allowed_updates);
-            return;
-        }
-        const domainOpts = this.getDomainOpts({
-            domain: webhook.domain,
-            path: (_b = webhook.path) !== null && _b !== void 0 ? _b : webhook.hookPath,
-        });
-        const { tlsOptions, port, host, cb, secretToken } = webhook;
-        this.startWebhook(domainOpts.path, tlsOptions, port, host, cb, secretToken);
-        await this.telegram.setWebhook(domainOpts.url, {
-            drop_pending_updates: drop_pending_updates,
-            allowed_updates: allowed_updates,
-            ip_address: webhook.ipAddress,
-            max_connections: webhook.maxConnections,
-            secret_token: webhook.secretToken,
-            certificate: webhook.certificate,
-        });
-        debug(`Bot started with webhook @ ${domainOpts.url}`);
-    }
-    stop(reason = 'unspecified') {
-        var _a, _b;
-        debug('Stopping bot... Reason:', reason);
-        // https://github.com/telegraf/telegraf/pull/1224#issuecomment-742693770
-        if (this.polling === undefined && this.webhookServer === undefined) {
-            throw new Error('Bot is not running!');
-        }
-        (_a = this.webhookServer) === null || _a === void 0 ? void 0 : _a.close();
-        (_b = this.polling) === null || _b === void 0 ? void 0 : _b.stop();
-    }
-    async handleUpdate(update, webhookResponse) {
-        var _a, _b;
-        (_a = this.botInfo) !== null && _a !== void 0 ? _a : (this.botInfo = (debug('Update %d is waiting for `botInfo` to be initialized', update.update_id),
-            await ((_b = this.botInfoCall) !== null && _b !== void 0 ? _b : (this.botInfoCall = this.telegram.getMe()))));
-        debug('Processing update', update.update_id);
-        const tg = new telegram_1.default(this.token, this.telegram.options, webhookResponse);
-        const TelegrafContext = this.options.contextType;
-        const ctx = new TelegrafContext(update, tg, this.botInfo);
-        Object.assign(ctx, this.context);
-        try {
-            await (0, p_timeout_1.default)(Promise.resolve(this.middleware()(ctx, anoop)), this.options.handlerTimeout);
-        }
-        catch (err) {
-            return await this.handleError(err, ctx);
-        }
-        finally {
-            if ((webhookResponse === null || webhookResponse === void 0 ? void 0 : webhookResponse.writableEnded) === false) {
-                webhookResponse.end();
-            }
-            debug('Finished processing update', update.update_id);
-        }
-    }
-}
-exports.Telegraf = Telegraf;
+var tgify_1 = require("./tgify");
+Object.defineProperty(exports, "Telegraf", { enumerable: true, get: function () { return tgify_1.Tgify; } });

package/lib/telegram.js

@@ -681,9 +681,9 @@ class Telegram extends client_1.default {
      */
     editMessageReplyMarkup(chatId, messageId, inlineMessageId, markup) {
         return this.callApi('editMessageReplyMarkup', {
-            chat_id: chatId,
-            message_id: messageId,
-            inline_message_id: inlineMessageId,
+            ...(chatId !== undefined && { chat_id: chatId }),
+            ...(messageId !== undefined && { message_id: messageId }),
+            ...(inlineMessageId !== undefined && { inline_message_id: inlineMessageId }),
             reply_markup: markup,
         });
     }
@@ -989,12 +989,14 @@ class Telegram extends client_1.default {
      * HTTP URL as a String for Telegram to get a file from the Internet, or upload a new one using
      * Input helpers. Animated and video sticker set thumbnails can't be uploaded via HTTP URL.
      * If omitted, then the thumbnail is dropped and the first sticker is used as the thumbnail.
+     * @param format Format of the sticker set thumbnail; must be one of "static", "animated", or "video"
      */
-    setStickerSetThumbnail(name, userId, thumbnail) {
+    setStickerSetThumbnail(name, userId, thumbnail, format = 'static') {
         return this.callApi('setStickerSetThumbnail', {
             name,
-            user_id: userId,
+            format,
             thumbnail,
+            user_id: userId,
         });
     }
     setStickerMaskPosition(sticker, mask_position) {