grammy 1.36.3 → 1.37.0

package/README.md

@@ -10,7 +10,7 @@
 
 <!-- deno-fmt-ignore-start -->
 
-[![Bot API](https://img.shields.io/badge/Bot%20API-9.0-blue?logo=telegram&style=flat&labelColor=000&color=3b82f6)](https://core.telegram.org/bots/api)
+[![Bot API](https://img.shields.io/badge/Bot%20API-9.1-blue?logo=telegram&style=flat&labelColor=000&color=3b82f6)](https://core.telegram.org/bots/api)
 [![Deno](https://shield.deno.dev/x/grammy)](https://deno.land/x/grammy)
 [![npm](https://img.shields.io/npm/v/grammy?logo=npm&style=flat&labelColor=000&color=3b82f6)](https://www.npmjs.org/package/grammy)
 [![All Contributors](https://img.shields.io/github/all-contributors/grammyjs/grammy?style=flat&labelColor=000&color=3b82f6)](#contributors-)

package/out/context.d.ts

@@ -1,7 +1,7 @@
 import { type Api, type Other as OtherApi } from "./core/api.js";
 import { type Methods, type RawApi } from "./core/client.js";
 import { type Filter, type FilterCore, type FilterQuery } from "./filter.js";
-import { type AcceptedGiftTypes, type Chat, type ChatPermissions, type InlineQueryResult, type InputFile, type InputMedia, type InputMediaAudio, type InputMediaDocument, type InputMediaPhoto, type InputMediaVideo, type InputPaidMedia, type InputPollOption, type InputProfilePhoto, type InputStoryContent, type LabeledPrice, type Message, type MessageEntity, type PassportElementError, type ReactionType, type ReactionTypeEmoji, type Update, type User, type UserFromGetMe } from "./types.js";
+import { type AcceptedGiftTypes, type Chat, type ChatPermissions, type InlineQueryResult, type InputChecklist, type InputFile, type InputMedia, type InputMediaAudio, type InputMediaDocument, type InputMediaPhoto, type InputMediaVideo, type InputPaidMedia, type InputPollOption, type InputProfilePhoto, type InputStoryContent, type LabeledPrice, type Message, type MessageEntity, type PassportElementError, type ReactionType, type ReactionTypeEmoji, type Update, type User, type UserFromGetMe } from "./types.js";
 export type MaybeArray<T> = T | T[];
 /** permits `string` but gives hints */
 export type StringWithCommandSuggestions = (string & Record<never, never>) | "start" | "help" | "settings" | "privacy" | "developer_info";
@@ -671,13 +671,33 @@ export declare class Context implements RenamedUpdate {
      * Context-aware alias for `api.sendPoll`. Use this method to send a native poll. On success, the sent Message is returned.
      *
      * @param question Poll question, 1-300 characters
-     * @param options A list of answer options, 2-10 strings 1-100 characters each
+     * @param options A list of answer options, 2-12 strings 1-100 characters each
      * @param other Optional remaining parameters, confer the official reference below
      * @param signal Optional `AbortSignal` to cancel the request
      *
      * **Official reference:** https://core.telegram.org/bots/api#sendpoll
      */
-    replyWithPoll(question: string, options: InputPollOption[], other?: Other<"sendPoll", "chat_id" | "question" | "options">, signal?: AbortSignal): Promise<Message.PollMessage>;
+    replyWithPoll(question: string, options: (string | InputPollOption)[], other?: Other<"sendPoll", "chat_id" | "question" | "options">, signal?: AbortSignal): Promise<Message.PollMessage>;
+    /**
+     * Context-aware alias for `api.sendChecklist`. Use this method to send a checklist on behalf of a connected business account. On success, the sent Message is returned.
+     *
+     * @param checklist An object for the checklist to send
+     * @param other Optional remaining parameters, confer the official reference below
+     * @param signal Optional `AbortSignal` to cancel the request
+     *
+     * **Official reference:** https://core.telegram.org/bots/api#sendchecklist
+     */
+    replyWithChecklist(checklist: InputChecklist, other?: Other<"sendChecklist", "business_connection_id" | "chat_id" | "checklist">, signal?: AbortSignal): Promise<Message.ChecklistMessage>;
+    /**
+     * Context-aware alias for `api.editMessageChecklist`. Use this method to edit a checklist on behalf of a connected business account. On success, the edited Message is returned.
+     *
+     * @param checklist An object for the new checklist
+     * @param other Optional remaining parameters, confer the official reference below
+     * @param signal Optional `AbortSignal` to cancel the request
+     *
+     * **Official reference:** https://core.telegram.org/bots/api#editmessagechecklist
+     */
+    editMessageChecklist(checklist: InputChecklist, other?: Other<"editMessageChecklist", "business_connection_id" | "chat_id" | "messaage_id" | "checklist">, signal?: AbortSignal): Promise<Message.ChecklistMessage>;
     /**
      * Context-aware alias for `api.sendDice`. Use this method to send an animated emoji that will display a random value. On success, the sent Message is returned.
      *

package/out/context.js

@@ -905,7 +905,7 @@ class Context {
      * Context-aware alias for `api.sendPoll`. Use this method to send a native poll. On success, the sent Message is returned.
      *
      * @param question Poll question, 1-300 characters
-     * @param options A list of answer options, 2-10 strings 1-100 characters each
+     * @param options A list of answer options, 2-12 strings 1-100 characters each
      * @param other Optional remaining parameters, confer the official reference below
      * @param signal Optional `AbortSignal` to cancel the request
      *
@@ -914,6 +914,33 @@ class Context {
     replyWithPoll(question, options, other, signal) {
         return this.api.sendPoll(orThrow(this.chatId, "sendPoll"), question, options, { business_connection_id: this.businessConnectionId, ...other }, signal);
     }
+    /**
+     * Context-aware alias for `api.sendChecklist`. Use this method to send a checklist on behalf of a connected business account. On success, the sent Message is returned.
+     *
+     * @param checklist An object for the checklist to send
+     * @param other Optional remaining parameters, confer the official reference below
+     * @param signal Optional `AbortSignal` to cancel the request
+     *
+     * **Official reference:** https://core.telegram.org/bots/api#sendchecklist
+     */
+    replyWithChecklist(checklist, other, signal) {
+        return this.api.sendChecklist(orThrow(this.businessConnectionId, "sendChecklist"), orThrow(this.chatId, "sendChecklist"), checklist, other, signal);
+    }
+    /**
+     * Context-aware alias for `api.editMessageChecklist`. Use this method to edit a checklist on behalf of a connected business account. On success, the edited Message is returned.
+     *
+     * @param checklist An object for the new checklist
+     * @param other Optional remaining parameters, confer the official reference below
+     * @param signal Optional `AbortSignal` to cancel the request
+     *
+     * **Official reference:** https://core.telegram.org/bots/api#editmessagechecklist
+     */
+    editMessageChecklist(checklist, other, signal) {
+        var _a, _b, _c, _d;
+        const msg = orThrow(this.msg, "editMessageChecklist");
+        const target = (_d = (_b = (_a = msg.checklist_tasks_done) === null || _a === void 0 ? void 0 : _a.checklist_message) !== null && _b !== void 0 ? _b : (_c = msg.checklist_tasks_added) === null || _c === void 0 ? void 0 : _c.checklist_message) !== null && _d !== void 0 ? _d : msg;
+        return this.api.editMessageChecklist(orThrow(this.businessConnectionId, "editMessageChecklist"), orThrow(target.chat.id, "editMessageChecklist"), orThrow(target.message_id, "editMessageChecklist"), checklist, other, signal);
+    }
     /**
      * Context-aware alias for `api.sendDice`. Use this method to send an animated emoji that will display a random value. On success, the sent Message is returned.
      *

package/out/core/api.d.ts

@@ -1,4 +1,4 @@
-import { type AcceptedGiftTypes, type BotCommand, type ChatPermissions, type InlineQueryResult, type InputFile, type InputMedia, type InputMediaAudio, type InputMediaDocument, type InputMediaPhoto, type InputMediaVideo, type InputPaidMedia, type InputPollOption, type InputProfilePhoto, type InputSticker, type InputStoryContent, type LabeledPrice, type MaskPosition, type PassportElementError, type ReactionType } from "../types.js";
+import { type AcceptedGiftTypes, type BotCommand, type ChatPermissions, type InlineQueryResult, type InputChecklist, type InputFile, type InputMedia, type InputMediaAudio, type InputMediaDocument, type InputMediaPhoto, type InputMediaVideo, type InputPaidMedia, type InputPollOption, type InputProfilePhoto, type InputSticker, type InputStoryContent, type LabeledPrice, type MaskPosition, type PassportElementError, type ReactionType } from "../types.js";
 import { type ApiClientOptions, type Methods, type Payload, type RawApi, type Transformer, type TransformerConsumer, type WebhookReplyEnvelope } from "./client.js";
 /**
  * Helper type to derive remaining properties of a given API method call M,
@@ -402,13 +402,38 @@ export declare class Api<R extends RawApi = RawApi> {
      *
      * @param chat_id Unique identifier for the target chat or username of the target channel (in the format @channelusername)
      * @param question Poll question, 1-300 characters
-     * @param options A list of answer options, 2-10 strings 1-100 characters each
+     * @param options A list of answer options, 2-12 strings 1-100 characters each
      * @param other Optional remaining parameters, confer the official reference below
      * @param signal Optional `AbortSignal` to cancel the request
      *
      * **Official reference:** https://core.telegram.org/bots/api#sendpoll
      */
-    sendPoll(chat_id: number | string, question: string, options: InputPollOption[], other?: Other<R, "sendPoll", "chat_id" | "question" | "options">, signal?: AbortSignal): Promise<import("@grammyjs/types/message.js").Message.PollMessage>;
+    sendPoll(chat_id: number | string, question: string, options: (string | InputPollOption)[], other?: Other<R, "sendPoll", "chat_id" | "question" | "options">, signal?: AbortSignal): Promise<import("@grammyjs/types/message.js").Message.PollMessage>;
+    /**
+     * Use this method to send a checklist on behalf of a connected business account. On success, the sent Message is returned.
+     *
+     * @param business_connection_id Unique identifier of the business connection on behalf of which the message will be sent
+     * @param chat_id Unique identifier for the target chat
+     * @param checklist An object for the checklist to send
+     * @param other Optional remaining parameters, confer the official reference below
+     * @param signal Optional `AbortSignal` to cancel the request
+     *
+     * **Official reference:** https://core.telegram.org/bots/api#sendchecklist
+     */
+    sendChecklist(business_connection_id: string, chat_id: number, checklist: InputChecklist, other?: Other<R, "sendChecklist", "business_connection_id" | "chat_id" | "checklist">, signal?: AbortSignal): Promise<import("@grammyjs/types/message.js").Message.ChecklistMessage>;
+    /**
+     * Use this method to edit a checklist on behalf of a connected business account. On success, the edited Message is returned.
+     *
+     * @param business_connection_id Unique identifier of the business connection on behalf of which the message will be sent
+     * @param chat_id Unique identifier for the target chat
+     * @param message_id Unique identifier for the target message
+     * @param checklist An object for the new checklist
+     * @param other Optional remaining parameters, confer the official reference below
+     * @param signal Optional `AbortSignal` to cancel the request
+     *
+     * **Official reference:** https://core.telegram.org/bots/api#editmessagechecklist
+     */
+    editMessageChecklist(business_connection_id: string, chat_id: number, message_id: number, checklist: InputChecklist, other?: Other<R, "editMessageChecklist", "business_connection_id" | "chat_id" | "messaage_id" | "checklist">, signal?: AbortSignal): Promise<import("@grammyjs/types/message.js").Message.ChecklistMessage>;
     /**
      * Use this method to send an animated emoji that will display a random value. On success, the sent Message is returned.
      *
@@ -1066,6 +1091,14 @@ export declare class Api<R extends RawApi = RawApi> {
      * **Official reference:** https://core.telegram.org/bots/api#getmydefaultadministratorrights
      */
     getMyDefaultAdministratorRights(other?: Other<R, "getMyDefaultAdministratorRights">, signal?: AbortSignal): Promise<import("@grammyjs/types/manage.js").ChatAdministratorRights>;
+    /**
+     * A method to get the current Telegram Stars balance of the bot. Requires no parameters. On success, returns a StarAmount object.
+     *
+     * @param signal Optional `AbortSignal` to cancel the request
+     *
+     * **Official reference:** https://core.telegram.org/bots/api#getmystarbalance
+     */
+    getMyStarBalance(signal?: AbortSignal): Promise<import("@grammyjs/types/payment.js").StarAmount>;
     /**
      * Use this method to edit text and game messages. On success, if the edited message is not an inline message, the edited Message is returned, otherwise True is returned. Note that business messages that were not sent by the bot and do not contain an inline keyboard can only be edited within 48 hours from the time they were sent.
      *

package/out/core/api.js

@@ -429,14 +429,55 @@ class Api {
      *
      * @param chat_id Unique identifier for the target chat or username of the target channel (in the format @channelusername)
      * @param question Poll question, 1-300 characters
-     * @param options A list of answer options, 2-10 strings 1-100 characters each
+     * @param options A list of answer options, 2-12 strings 1-100 characters each
      * @param other Optional remaining parameters, confer the official reference below
      * @param signal Optional `AbortSignal` to cancel the request
      *
      * **Official reference:** https://core.telegram.org/bots/api#sendpoll
      */
     sendPoll(chat_id, question, options, other, signal) {
-        return this.raw.sendPoll({ chat_id, question, options, ...other }, signal);
+        const opts = options.map((o) => typeof o === "string" ? { text: o } : o);
+        return this.raw.sendPoll({ chat_id, question, options: opts, ...other }, signal);
+    }
+    /**
+     * Use this method to send a checklist on behalf of a connected business account. On success, the sent Message is returned.
+     *
+     * @param business_connection_id Unique identifier of the business connection on behalf of which the message will be sent
+     * @param chat_id Unique identifier for the target chat
+     * @param checklist An object for the checklist to send
+     * @param other Optional remaining parameters, confer the official reference below
+     * @param signal Optional `AbortSignal` to cancel the request
+     *
+     * **Official reference:** https://core.telegram.org/bots/api#sendchecklist
+     */
+    sendChecklist(business_connection_id, chat_id, checklist, other, signal) {
+        return this.raw.sendChecklist({
+            business_connection_id,
+            chat_id,
+            checklist,
+            ...other,
+        }, signal);
+    }
+    /**
+     * Use this method to edit a checklist on behalf of a connected business account. On success, the edited Message is returned.
+     *
+     * @param business_connection_id Unique identifier of the business connection on behalf of which the message will be sent
+     * @param chat_id Unique identifier for the target chat
+     * @param message_id Unique identifier for the target message
+     * @param checklist An object for the new checklist
+     * @param other Optional remaining parameters, confer the official reference below
+     * @param signal Optional `AbortSignal` to cancel the request
+     *
+     * **Official reference:** https://core.telegram.org/bots/api#editmessagechecklist
+     */
+    editMessageChecklist(business_connection_id, chat_id, message_id, checklist, other, signal) {
+        return this.raw.editMessageChecklist({
+            business_connection_id,
+            chat_id,
+            message_id,
+            checklist,
+            ...other,
+        }, signal);
     }
     /**
      * Use this method to send an animated emoji that will display a random value. On success, the sent Message is returned.
@@ -1234,6 +1275,16 @@ class Api {
     getMyDefaultAdministratorRights(other, signal) {
         return this.raw.getMyDefaultAdministratorRights({ ...other }, signal);
     }
+    /**
+     * A method to get the current Telegram Stars balance of the bot. Requires no parameters. On success, returns a StarAmount object.
+     *
+     * @param signal Optional `AbortSignal` to cancel the request
+     *
+     * **Official reference:** https://core.telegram.org/bots/api#getmystarbalance
+     */
+    getMyStarBalance(signal) {
+        return this.raw.getMyStarBalance(signal);
+    }
     /**
      * Use this method to edit text and game messages. On success, if the edited message is not an inline message, the edited Message is returned, otherwise True is returned. Note that business messages that were not sent by the bot and do not contain an inline keyboard can only be edited within 48 hours from the time they were sent.
      *

package/out/core/client.js

@@ -123,7 +123,8 @@ function createRawApi(token, options, webhookReplyEnvelope) {
                     m === "getForumTopicIconStickers" ||
                     m === "getAvailableGifts" ||
                     m === "logOut" ||
-                    m === "close"
+                    m === "close" ||
+                    m === "getMyStarBalance"
                     ? client.callApi.bind(client, m, {})
                     : client.callApi.bind(client, m);
         },

package/out/filter.d.ts

@@ -62,6 +62,12 @@ declare const UPDATE_KEYS: {
         readonly forum_topic_reopened: {};
         readonly general_forum_topic_hidden: {};
         readonly general_forum_topic_unhidden: {};
+        readonly checklist: {
+            readonly others_can_add_tasks: {};
+            readonly others_can_mark_tasks_as_done: {};
+        };
+        readonly checklist_tasks_done: {};
+        readonly checklist_tasks_added: {};
         readonly sender_boost_count: {};
         readonly forward_origin: {
             readonly user: {};
@@ -206,6 +212,12 @@ declare const UPDATE_KEYS: {
         readonly forum_topic_reopened: {};
         readonly general_forum_topic_hidden: {};
         readonly general_forum_topic_unhidden: {};
+        readonly checklist: {
+            readonly others_can_add_tasks: {};
+            readonly others_can_mark_tasks_as_done: {};
+        };
+        readonly checklist_tasks_done: {};
+        readonly checklist_tasks_added: {};
         readonly sender_boost_count: {};
         readonly forward_origin: {
             readonly user: {};
@@ -318,6 +330,7 @@ declare const UPDATE_KEYS: {
     };
     readonly channel_post: {
         readonly channel_chat_created: {};
+        readonly direct_message_price_changed: {};
         readonly forward_origin: {
             readonly user: {};
             readonly hidden_user: {};
@@ -429,6 +442,7 @@ declare const UPDATE_KEYS: {
     };
     readonly edited_channel_post: {
         readonly channel_chat_created: {};
+        readonly direct_message_price_changed: {};
         readonly forward_origin: {
             readonly user: {};
             readonly hidden_user: {};
@@ -576,6 +590,12 @@ declare const UPDATE_KEYS: {
         readonly forum_topic_reopened: {};
         readonly general_forum_topic_hidden: {};
         readonly general_forum_topic_unhidden: {};
+        readonly checklist: {
+            readonly others_can_add_tasks: {};
+            readonly others_can_mark_tasks_as_done: {};
+        };
+        readonly checklist_tasks_done: {};
+        readonly checklist_tasks_added: {};
         readonly sender_boost_count: {};
         readonly forward_origin: {
             readonly user: {};
@@ -720,6 +740,12 @@ declare const UPDATE_KEYS: {
         readonly forum_topic_reopened: {};
         readonly general_forum_topic_hidden: {};
         readonly general_forum_topic_unhidden: {};
+        readonly checklist: {
+            readonly others_can_add_tasks: {};
+            readonly others_can_mark_tasks_as_done: {};
+        };
+        readonly checklist_tasks_done: {};
+        readonly checklist_tasks_added: {};
         readonly sender_boost_count: {};
         readonly forward_origin: {
             readonly user: {};

package/out/filter.js

@@ -321,11 +321,15 @@ const MESSAGE_KEYS = {
     forum_topic_reopened: {},
     general_forum_topic_hidden: {},
     general_forum_topic_unhidden: {},
+    checklist: { others_can_add_tasks: {}, others_can_mark_tasks_as_done: {} },
+    checklist_tasks_done: {},
+    checklist_tasks_added: {},
     sender_boost_count: {},
 };
 const CHANNEL_POST_KEYS = {
     ...COMMON_MESSAGE_KEYS,
     channel_chat_created: {},
+    direct_message_price_changed: {},
 };
 const BUSINESS_CONNECTION_KEYS = {
     can_reply: {},

package/out/web.mjs

@@ -276,11 +276,18 @@ const MESSAGE_KEYS = {
     forum_topic_reopened: {},
     general_forum_topic_hidden: {},
     general_forum_topic_unhidden: {},
+    checklist: {
+        others_can_add_tasks: {},
+        others_can_mark_tasks_as_done: {}
+    },
+    checklist_tasks_done: {},
+    checklist_tasks_added: {},
     sender_boost_count: {}
 };
 const CHANNEL_POST_KEYS = {
     ...COMMON_MESSAGE_KEYS,
-    channel_chat_created: {}
+    channel_chat_created: {},
+    direct_message_price_changed: {}
 };
 const BUSINESS_CONNECTION_KEYS = {
     can_reply: {},
@@ -852,6 +859,14 @@ class Context {
             ...other
         }, signal);
     }
+    replyWithChecklist(checklist, other, signal) {
+        return this.api.sendChecklist(orThrow(this.businessConnectionId, "sendChecklist"), orThrow(this.chatId, "sendChecklist"), checklist, other, signal);
+    }
+    editMessageChecklist(checklist, other, signal) {
+        const msg = orThrow(this.msg, "editMessageChecklist");
+        const target = msg.checklist_tasks_done?.checklist_message ?? msg.checklist_tasks_added?.checklist_message ?? msg;
+        return this.api.editMessageChecklist(orThrow(this.businessConnectionId, "editMessageChecklist"), orThrow(target.chat.id, "editMessageChecklist"), orThrow(target.message_id, "editMessageChecklist"), checklist, other, signal);
+    }
     replyWithDice(emoji, other, signal) {
         return this.api.sendDice(orThrow(this.chatId, "sendDice"), emoji, {
             business_connection_id: this.businessConnectionId,
@@ -2455,7 +2470,7 @@ function createRawApi(token, options, webhookReplyEnvelope) {
     const client = new ApiClient(token, options, webhookReplyEnvelope);
     const proxyHandler = {
         get (_, m) {
-            return m === "toJSON" ? "__internal" : m === "getMe" || m === "getWebhookInfo" || m === "getForumTopicIconStickers" || m === "getAvailableGifts" || m === "logOut" || m === "close" ? client.callApi.bind(client, m, {}) : client.callApi.bind(client, m);
+            return m === "toJSON" ? "__internal" : m === "getMe" || m === "getWebhookInfo" || m === "getForumTopicIconStickers" || m === "getAvailableGifts" || m === "logOut" || m === "close" || m === "getMyStarBalance" ? client.callApi.bind(client, m, {}) : client.callApi.bind(client, m);
         },
         ...proxyMethods
     };
@@ -2757,10 +2772,30 @@ class Api {
         }, signal);
     }
     sendPoll(chat_id, question, options, other, signal) {
+        const opts = options.map((o)=>typeof o === "string" ? {
+                text: o
+            } : o);
         return this.raw.sendPoll({
             chat_id,
             question,
-            options,
+            options: opts,
+            ...other
+        }, signal);
+    }
+    sendChecklist(business_connection_id, chat_id, checklist, other, signal) {
+        return this.raw.sendChecklist({
+            business_connection_id,
+            chat_id,
+            checklist,
+            ...other
+        }, signal);
+    }
+    editMessageChecklist(business_connection_id, chat_id, message_id, checklist, other, signal) {
+        return this.raw.editMessageChecklist({
+            business_connection_id,
+            chat_id,
+            message_id,
+            checklist,
             ...other
         }, signal);
     }
@@ -3150,6 +3185,9 @@ class Api {
             ...other
         }, signal);
     }
+    getMyStarBalance(signal) {
+        return this.raw.getMyStarBalance(signal);
+    }
     editMessageText(chat_id, message_id, text, other, signal) {
         return this.raw.editMessageText({
             chat_id,

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "grammy",
     "description": "The Telegram Bot Framework.",
-    "version": "1.36.3",
+    "version": "1.37.0",
     "author": "KnorpelSenf",
     "license": "MIT",
     "engines": {
@@ -17,7 +17,7 @@
         "backport": "deno2node tsconfig.json"
     },
     "dependencies": {
-        "@grammyjs/types": "3.20.0",
+        "@grammyjs/types": "3.21.0",
         "abort-controller": "^3.0.0",
         "debug": "^4.3.4",
         "node-fetch": "^2.7.0"