grammy 1.12.4 → 1.13.0

package/README.md

@@ -10,7 +10,7 @@
 
 <!-- deno-fmt-ignore-start -->
 
-[![Bot API](https://img.shields.io/badge/Bot%20API-6.3-blue?logo=telegram&style=flat&labelColor=000&color=3b82f6)](https://core.telegram.org/bots/api)
+[![Bot API](https://img.shields.io/badge/Bot%20API-6.4-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 Chat, type ChatPermissions, type InlineQueryResult, type InputFile, type InputMedia, type InputMediaAudio, type InputMediaDocument, type InputMediaPhoto, type InputMediaVideo, type LabeledPrice, type Message, type PassportElementError, type Update, type User, type UserFromGetMe } from "./types.js";
+import { type Chat, type ChatPermissions, type InlineQueryResult, type InputFile, type InputMedia, type InputMediaAudio, type InputMediaDocument, type InputMediaPhoto, type InputMediaVideo, type LabeledPrice, type Message, type MessageEntity, type PassportElementError, type Update, type User, type UserFromGetMe } from "./types.js";
 export type MaybeArray<T> = T | T[];
 export type StringWithSuggestions<S extends string> = (string & {}) | S;
 type Other<M extends Methods<RawApi>, X extends string = never> = OtherApi<RawApi, M, X>;
@@ -138,13 +138,13 @@ export declare class Context implements RenamedUpdate {
      */
     me: UserFromGetMe);
     /** Alias for `ctx.update.message` */
-    get message(): Message | undefined;
+    get message(): (Message & Update.New & Update.NonChannel) | undefined;
     /** Alias for `ctx.update.edited_message` */
-    get editedMessage(): Message | undefined;
+    get editedMessage(): (Message & Update.Edited & Update.NonChannel) | undefined;
     /** Alias for `ctx.update.channel_post` */
-    get channelPost(): Message | undefined;
+    get channelPost(): (Message & Update.New & Update.Channel) | undefined;
     /** Alias for `ctx.update.edited_channel_post` */
-    get editedChannelPost(): Message | undefined;
+    get editedChannelPost(): (Message & Update.Edited & Update.Channel) | undefined;
     /** Alias for `ctx.update.inline_query` */
     get inlineQuery(): import("@grammyjs/types/inline.js").InlineQuery | undefined;
     /** Alias for `ctx.update.chosen_inline_result` */
@@ -193,6 +193,29 @@ export declare class Context implements RenamedUpdate {
      * `(ctx.callbackQuery ?? ctx.chosenInlineResult)?.inline_message_id`
      */
     get inlineMessageId(): string | undefined;
+    /**
+     * Get entities and their text. Extracts the text from `ctx.msg.text` or `ctx.msg.caption`.
+     * Returns an empty array if one of `ctx.msg`, `ctx.msg.text`
+     * or `ctx.msg.entities` is undefined.
+     *
+     * You can filter specific entity types by passing the `types` parameter. Example:
+     *
+     * ```ts
+     * ctx.entities() // Returns all entity types
+     * ctx.entities('url') // Returns only url entities
+     * ctx.enttities(['url', 'email']) // Returns url and email entities
+     * ```
+     *
+     * @param types Types of entities to return. Omit to get all entities.
+     * @returns Array of entities and their texts, or empty array when there's no text
+     */
+    entities(): Array<MessageEntity & {
+        text: string;
+    }>;
+    entities<T extends MessageEntity["type"]>(types: MaybeArray<T>): Array<MessageEntity & {
+        type: T;
+        text: string;
+    }>;
     /**
      * `Context.has` is an object that contains a number of useful functions for
      * probing context objects. Each of these functions can generate a predicate
@@ -466,11 +489,12 @@ export declare class Context implements RenamedUpdate {
      * We only recommend using this method when a response from the bot will take a noticeable amount of time to arrive.
      *
      * @param action Type of action to broadcast. Choose one, depending on what the user is about to receive: typing for text messages, upload_photo for photos, record_video or upload_video for videos, record_voice or upload_voice for voice notes, upload_document for general files, choose_sticker for stickers, find_location for location data, record_video_note or upload_video_note for video notes.
+     * @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#sendchataction
      */
-    replyWithChatAction(action: "typing" | "upload_photo" | "record_video" | "upload_video" | "record_voice" | "upload_voice" | "upload_document" | "choose_sticker" | "find_location" | "record_video_note" | "upload_video_note", signal?: AbortSignal): Promise<true>;
+    replyWithChatAction(action: "typing" | "upload_photo" | "record_video" | "upload_video" | "record_voice" | "upload_voice" | "upload_document" | "choose_sticker" | "find_location" | "record_video_note" | "upload_video_note", other?: Other<"sendChatAction", "chat_id" | "action">, signal?: AbortSignal): Promise<true>;
     /**
      * Context-aware alias for `api.getUserProfilePhotos`. Use this method to get a list of profile pictures for a user. Returns a UserProfilePhotos object.
      *
@@ -762,7 +786,7 @@ export declare class Context implements RenamedUpdate {
      */
     getChatMemberCount(signal?: AbortSignal): Promise<number>;
     /**
-     * Context-aware alias for `api.getChatMember`. Use this method to get information about a member of a chat. Returns a ChatMember object on success.
+     * Context-aware alias for `api.getChatMember`. Use this method to get information about a member of a chat. The method is guaranteed to work only if the bot is an administrator in the chat. Returns a ChatMember object on success.
      *
      * @param signal Optional `AbortSignal` to cancel the request
      *
@@ -770,7 +794,7 @@ export declare class Context implements RenamedUpdate {
      */
     getAuthor(signal?: AbortSignal): Promise<import("@grammyjs/types/manage.js").ChatMember>;
     /**
-     * Context-aware alias for `api.getChatMember`. Use this method to get information about a member of a chat. Returns a ChatMember object on success.
+     * Context-aware alias for `api.getChatMember`. Use this method to get information about a member of a chat. The method is guaranteed to work only if the bot is an administrator in the chat. Returns a ChatMember object on success.
      *
      * @param user_id Unique identifier of the target user
      * @param signal Optional `AbortSignal` to cancel the request
@@ -808,13 +832,12 @@ export declare class Context implements RenamedUpdate {
     /**
      * Context-aware alias for `api.editForumTopic`. Use this method to edit name and icon of a topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have can_manage_topics administrator rights, unless it is the creator of the topic. Returns True on success.
      *
-     * @param name New topic name, 1-128 characters
-     * @param icon_custom_emoji_id New unique identifier of the custom emoji shown as the topic icon. Use getForumTopicIconStickers to get all allowed custom emoji identifiers.
+     * @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#editforumtopic
      */
-    editForumTopic(name: string, icon_custom_emoji_id: string, signal?: AbortSignal): Promise<true>;
+    editForumTopic(other?: Other<"editForumTopic", "chat_id" | "message_thread_id">, signal?: AbortSignal): Promise<true>;
     /**
      * Context-aware alias for `api.closeForumTopic`. Use this method to close an open topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights, unless it is the creator of the topic. Returns True on success.
      *
@@ -847,6 +870,47 @@ export declare class Context implements RenamedUpdate {
      * **Official reference:** https://core.telegram.org/bots/api#unpinallforumtopicmessages
      */
     unpinAllForumTopicMessages(signal?: AbortSignal): Promise<true>;
+    /**
+     * Context-aware alias for `api.editGeneralForumTopic`. Use this method to edit the name of the 'General' topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have can_manage_topics administrator rights. Returns True on success.
+     *
+     * @param name New topic name, 1-128 characters
+     * @param signal Optional `AbortSignal` to cancel the request
+     *
+     * **Official reference:** https://core.telegram.org/bots/api#editgeneralforumtopic
+     */
+    editGeneralForumTopic(name: string, signal?: AbortSignal): Promise<true>;
+    /**
+     * Context-aware alias for `api.closeGeneralForumTopic`. Use this method to close an open 'General' topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights. Returns True on success.
+     *
+     * @param signal Optional `AbortSignal` to cancel the request
+     *
+     * **Official reference:** https://core.telegram.org/bots/api#closegeneralforumtopic
+     */
+    closeGeneralForumTopic(signal?: AbortSignal): Promise<true>;
+    /**
+     * Context-aware alias for `api.reopenGeneralForumTopic`. Use this method to reopen a closed 'General' topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights. The topic will be automatically unhidden if it was hidden. Returns True on success.     *
+     *
+     * @param signal Optional `AbortSignal` to cancel the request
+     *
+     * **Official reference:** https://core.telegram.org/bots/api#reopengeneralforumtopic
+     */
+    reopenGeneralForumTopic(signal?: AbortSignal): Promise<true>;
+    /**
+     * Context-aware alias for `api.hideGeneralForumTopic`. Use this method to hide the 'General' topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights. The topic will be automatically closed if it was open. Returns True on success.
+     *
+     * @param signal Optional `AbortSignal` to cancel the request
+     *
+     * **Official reference:** https://core.telegram.org/bots/api#hidegeneralforumtopic
+     */
+    hideGeneralForumTopic(signal?: AbortSignal): Promise<true>;
+    /**
+     * Context-aware alias for `api.unhideGeneralForumTopic`. Use this method to unhide the 'General' topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights. Returns True on success.
+     *
+     * @param signal Optional `AbortSignal` to cancel the request
+     *
+     * **Official reference:** https://core.telegram.org/bots/api#unhidegeneralforumtopic
+     */
+    unhideGeneralForumTopic(signal?: AbortSignal): Promise<true>;
     /**
      * Context-aware alias for `api.answerCallbackQuery`. Use this method to send answers to callback queries sent from inline keyboards. The answer will be displayed to the user as a notification at the top of the chat screen or as an alert. On success, True is returned.
      *

package/out/context.js

@@ -243,6 +243,26 @@ class Context {
         var _a, _b, _c;
         return ((_b = (_a = this.callbackQuery) === null || _a === void 0 ? void 0 : _a.inline_message_id) !== null && _b !== void 0 ? _b : (_c = this.chosenInlineResult) === null || _c === void 0 ? void 0 : _c.inline_message_id);
     }
+    entities(types) {
+        var _a, _b;
+        const message = this.msg;
+        if (message === undefined)
+            return [];
+        const text = (_a = message.text) !== null && _a !== void 0 ? _a : message.caption;
+        if (text === undefined)
+            return [];
+        let entities = (_b = message.entities) !== null && _b !== void 0 ? _b : message.caption_entities;
+        if (entities === undefined)
+            return [];
+        if (types !== undefined) {
+            const filters = new Set(toArray(types));
+            entities = entities.filter((entity) => filters.has(entity.type));
+        }
+        return entities.map((entity) => ({
+            ...entity,
+            text: text.substring(entity.offset, entity.offset + entity.length),
+        }));
+    }
     /**
      * Returns `true` if this context object matches the given filter query, and
      * `false` otherwise. This uses the same logic as `bot.on`.
@@ -552,12 +572,13 @@ class Context {
      * We only recommend using this method when a response from the bot will take a noticeable amount of time to arrive.
      *
      * @param action Type of action to broadcast. Choose one, depending on what the user is about to receive: typing for text messages, upload_photo for photos, record_video or upload_video for videos, record_voice or upload_voice for voice notes, upload_document for general files, choose_sticker for stickers, find_location for location data, record_video_note or upload_video_note for video notes.
+     * @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#sendchataction
      */
-    replyWithChatAction(action, signal) {
-        return this.api.sendChatAction(orThrow(this.chat, "sendChatAction").id, action, signal);
+    replyWithChatAction(action, other, signal) {
+        return this.api.sendChatAction(orThrow(this.chat, "sendChatAction").id, action, other, signal);
     }
     /**
      * Context-aware alias for `api.getUserProfilePhotos`. Use this method to get a list of profile pictures for a user. Returns a UserProfilePhotos object.
@@ -923,7 +944,7 @@ class Context {
         return this.api.getChatMemberCount(orThrow(this.chat, "getChatMemberCount").id, signal);
     }
     /**
-     * Context-aware alias for `api.getChatMember`. Use this method to get information about a member of a chat. Returns a ChatMember object on success.
+     * Context-aware alias for `api.getChatMember`. Use this method to get information about a member of a chat. The method is guaranteed to work only if the bot is an administrator in the chat. Returns a ChatMember object on success.
      *
      * @param signal Optional `AbortSignal` to cancel the request
      *
@@ -933,7 +954,7 @@ class Context {
         return this.api.getChatMember(orThrow(this.chat, "getAuthor").id, orThrow(this.from, "getAuthor").id, signal);
     }
     /**
-     * Context-aware alias for `api.getChatMember`. Use this method to get information about a member of a chat. Returns a ChatMember object on success.
+     * Context-aware alias for `api.getChatMember`. Use this method to get information about a member of a chat. The method is guaranteed to work only if the bot is an administrator in the chat. Returns a ChatMember object on success.
      *
      * @param user_id Unique identifier of the target user
      * @param signal Optional `AbortSignal` to cancel the request
@@ -979,16 +1000,15 @@ class Context {
     /**
      * Context-aware alias for `api.editForumTopic`. Use this method to edit name and icon of a topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have can_manage_topics administrator rights, unless it is the creator of the topic. Returns True on success.
      *
-     * @param name New topic name, 1-128 characters
-     * @param icon_custom_emoji_id New unique identifier of the custom emoji shown as the topic icon. Use getForumTopicIconStickers to get all allowed custom emoji identifiers.
+     * @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#editforumtopic
      */
-    editForumTopic(name, icon_custom_emoji_id, signal) {
+    editForumTopic(other, signal) {
         const message = orThrow(this.msg, "editForumTopic");
         const thread = orThrow(message.message_thread_id, "editForumTopic");
-        return this.api.editForumTopic(message.chat.id, thread, name, icon_custom_emoji_id, signal);
+        return this.api.editForumTopic(message.chat.id, thread, other, signal);
     }
     /**
      * Context-aware alias for `api.closeForumTopic`. Use this method to close an open topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights, unless it is the creator of the topic. Returns True on success.
@@ -1038,6 +1058,57 @@ class Context {
         const thread = orThrow(message.message_thread_id, "unpinAllForumTopicMessages");
         return this.api.unpinAllForumTopicMessages(message.chat.id, thread, signal);
     }
+    /**
+     * Context-aware alias for `api.editGeneralForumTopic`. Use this method to edit the name of the 'General' topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have can_manage_topics administrator rights. Returns True on success.
+     *
+     * @param name New topic name, 1-128 characters
+     * @param signal Optional `AbortSignal` to cancel the request
+     *
+     * **Official reference:** https://core.telegram.org/bots/api#editgeneralforumtopic
+     */
+    editGeneralForumTopic(name, signal) {
+        return this.api.editGeneralForumTopic(orThrow(this.chat, "editGeneralForumTopic").id, name, signal);
+    }
+    /**
+     * Context-aware alias for `api.closeGeneralForumTopic`. Use this method to close an open 'General' topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights. Returns True on success.
+     *
+     * @param signal Optional `AbortSignal` to cancel the request
+     *
+     * **Official reference:** https://core.telegram.org/bots/api#closegeneralforumtopic
+     */
+    closeGeneralForumTopic(signal) {
+        return this.api.closeGeneralForumTopic(orThrow(this.chat, "closeGeneralForumTopic").id, signal);
+    }
+    /**
+     * Context-aware alias for `api.reopenGeneralForumTopic`. Use this method to reopen a closed 'General' topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights. The topic will be automatically unhidden if it was hidden. Returns True on success.     *
+     *
+     * @param signal Optional `AbortSignal` to cancel the request
+     *
+     * **Official reference:** https://core.telegram.org/bots/api#reopengeneralforumtopic
+     */
+    reopenGeneralForumTopic(signal) {
+        return this.api.reopenGeneralForumTopic(orThrow(this.chat, "reopenGeneralForumTopic").id, signal);
+    }
+    /**
+     * Context-aware alias for `api.hideGeneralForumTopic`. Use this method to hide the 'General' topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights. The topic will be automatically closed if it was open. Returns True on success.
+     *
+     * @param signal Optional `AbortSignal` to cancel the request
+     *
+     * **Official reference:** https://core.telegram.org/bots/api#hidegeneralforumtopic
+     */
+    hideGeneralForumTopic(signal) {
+        return this.api.hideGeneralForumTopic(orThrow(this.chat, "hideGeneralForumTopic").id, signal);
+    }
+    /**
+     * Context-aware alias for `api.unhideGeneralForumTopic`. Use this method to unhide the 'General' topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights. Returns True on success.
+     *
+     * @param signal Optional `AbortSignal` to cancel the request
+     *
+     * **Official reference:** https://core.telegram.org/bots/api#unhidegeneralforumtopic
+     */
+    unhideGeneralForumTopic(signal) {
+        return this.api.unhideGeneralForumTopic(orThrow(this.chat, "unhideGeneralForumTopic").id, signal);
+    }
     /**
      * Context-aware alias for `api.answerCallbackQuery`. Use this method to send answers to callback queries sent from inline keyboards. The answer will be displayed to the user as a notification at the top of the chat screen or as an alert. On success, True is returned.
      *

package/out/convenience/keyboard.d.ts

@@ -28,6 +28,12 @@ import { type InlineKeyboardButton, type KeyboardButton, type LoginUrl } from ".
  */
 export declare class Keyboard {
     readonly keyboard: KeyboardButton[][];
+    /**
+     * Requests clients to always show the keyboard when the regular keyboard is
+     * hidden. Defaults to false, in which case the custom keyboard can be
+     * hidden and opened with a keyboard icon.
+     */
+    is_persistent?: boolean;
     /**
      * Show the current keyboard only to those users that are mentioned in the
      * text of the message object.
@@ -113,6 +119,18 @@ export declare class Keyboard {
      * @param url An HTTPS URL of a Web App to be opened with additional data
      */
     webApp(text: string, url: string): this;
+    /**
+     * Make the current keyboard persistent. See
+     * https://grammy.dev/plugins/keyboard.html#persistent-keyboards for more
+     * details.
+     *
+     * Keyboards are not persistent by default, use this function to enable it
+     * (without any parameters or pass `true`). Pass `false` to force the
+     * keyboard to not persist.
+     *
+     * @param isEnabled `true` if the keyboard should persist, and `false` otherwise
+     */
+    persistent(isEnabled?: boolean): this;
     /**
      * Make the current keyboard selective. See
      * https://grammy.dev/plugins/keyboard.html#selectively-send-custom-keyboards

package/out/convenience/keyboard.js

@@ -115,6 +115,21 @@ class Keyboard {
     webApp(text, url) {
         return this.add({ text, web_app: { url } });
     }
+    /**
+     * Make the current keyboard persistent. See
+     * https://grammy.dev/plugins/keyboard.html#persistent-keyboards for more
+     * details.
+     *
+     * Keyboards are not persistent by default, use this function to enable it
+     * (without any parameters or pass `true`). Pass `false` to force the
+     * keyboard to not persist.
+     *
+     * @param isEnabled `true` if the keyboard should persist, and `false` otherwise
+     */
+    persistent(isEnabled = true) {
+        this.is_persistent = isEnabled;
+        return this;
+    }
     /**
      * Make the current keyboard selective. See
      * https://grammy.dev/plugins/keyboard.html#selectively-send-custom-keyboards

package/out/convenience/session.js

@@ -119,6 +119,9 @@ function strictMultiSession(options) {
  * @param options Optional configuration to pass to the session middleware
  */
 function lazySession(options = {}) {
+    if (options.type !== undefined && options.type !== "single") {
+        throw new Error("Cannot use lazy multi sessions!");
+    }
     const { initial, storage, getSessionKey, custom } = fillDefaults(options);
     return async (ctx, next) => {
         const propSession = new PropertySession(

package/out/core/api.d.ts

@@ -374,11 +374,12 @@ 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 action Type of action to broadcast. Choose one, depending on what the user is about to receive: typing for text messages, upload_photo for photos, record_video or upload_video for videos, record_voice or upload_voice for voice notes, upload_document for general files, choose_sticker for stickers, find_location for location data, record_video_note or upload_video_note for video notes.
+     * @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#sendchataction
      */
-    sendChatAction(chat_id: number | string, action: "typing" | "upload_photo" | "record_video" | "upload_video" | "record_voice" | "upload_voice" | "upload_document" | "choose_sticker" | "find_location" | "record_video_note" | "upload_video_note", signal?: AbortSignal): Promise<true>;
+    sendChatAction(chat_id: number | string, action: "typing" | "upload_photo" | "record_video" | "upload_video" | "record_voice" | "upload_voice" | "upload_document" | "choose_sticker" | "find_location" | "record_video_note" | "upload_video_note", other?: Other<R, "sendChatAction", "chat_id" | "action">, signal?: AbortSignal): Promise<true>;
     /**
      * Use this method to get a list of profile pictures for a user. Returns a UserProfilePhotos object.
      *
@@ -659,7 +660,7 @@ export declare class Api<R extends RawApi = RawApi> {
      */
     getChatMemberCount(chat_id: number | string, signal?: AbortSignal): Promise<number>;
     /**
-     * Use this method to get information about a member of a chat. Returns a ChatMember object on success.
+     * Use this method to get information about a member of a chat. The method is guaranteed to work only if the bot is an administrator in the chat. Returns a ChatMember object on success.
      *
      * @param chat_id Unique identifier for the target chat or username of the target supergroup or channel (in the format @channelusername)
      * @param user_id Unique identifier of the target user
@@ -711,13 +712,12 @@ export declare class Api<R extends RawApi = RawApi> {
      *
      * @param chat_id Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)
      * @param message_thread_id Unique identifier for the target message thread of the forum topic
-     * @param name New topic name, 1-128 characters
-     * @param icon_custom_emoji_id New unique identifier of the custom emoji shown as the topic icon. Use getForumTopicIconStickers to get all allowed custom emoji identifiers.
+     * @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#editforumtopic
      */
-    editForumTopic(chat_id: number | string, message_thread_id: number, name: string, icon_custom_emoji_id: string, signal?: AbortSignal): Promise<true>;
+    editForumTopic(chat_id: number | string, message_thread_id: number, other?: Other<R, "editForumTopic", "chat_id" | "message_thread_id">, signal?: AbortSignal): Promise<true>;
     /**
      * Use this method to close an open topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights, unless it is the creator of the topic. Returns True on success.
      *
@@ -758,6 +758,52 @@ export declare class Api<R extends RawApi = RawApi> {
      * **Official reference:** https://core.telegram.org/bots/api#unpinallforumtopicmessages
      */
     unpinAllForumTopicMessages(chat_id: number | string, message_thread_id: number, signal?: AbortSignal): Promise<true>;
+    /**
+     * Use this method to edit the name of the 'General' topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have can_manage_topics administrator rights. Returns True on success.
+     *
+     * @param chat_id Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)
+     * @param name New topic name, 1-128 characters
+     * @param signal Optional `AbortSignal` to cancel the request
+     *
+     * **Official reference:** https://core.telegram.org/bots/api#editgeneralforumtopic
+     */
+    editGeneralForumTopic(chat_id: number | string, name: string, signal?: AbortSignal): Promise<true>;
+    /**
+     * Use this method to close an open 'General' topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights. Returns True on success.
+     *
+     * @param chat_id Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)
+     * @param signal Optional `AbortSignal` to cancel the request
+     *
+     * **Official reference:** https://core.telegram.org/bots/api#closegeneralforumtopic
+     */
+    closeGeneralForumTopic(chat_id: number | string, signal?: AbortSignal): Promise<true>;
+    /**
+     * Use this method to reopen a closed 'General' topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights. The topic will be automatically unhidden if it was hidden. Returns True on success.     *
+     *
+     * @param chat_id Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)
+     * @param signal Optional `AbortSignal` to cancel the request
+     *
+     * **Official reference:** https://core.telegram.org/bots/api#reopengeneralforumtopic
+     */
+    reopenGeneralForumTopic(chat_id: number | string, signal?: AbortSignal): Promise<true>;
+    /**
+     * Use this method to hide the 'General' topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights. The topic will be automatically closed if it was open. Returns True on success.
+     *
+     * @param chat_id Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)
+     * @param signal Optional `AbortSignal` to cancel the request
+     *
+     * **Official reference:** https://core.telegram.org/bots/api#hidegeneralforumtopic
+     */
+    hideGeneralForumTopic(chat_id: number | string, signal?: AbortSignal): Promise<true>;
+    /**
+     * Use this method to unhide the 'General' topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights. Returns True on success.
+     *
+     * @param chat_id Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)
+     * @param signal Optional `AbortSignal` to cancel the request
+     *
+     * **Official reference:** https://core.telegram.org/bots/api#unhidegeneralforumtopic
+     */
+    unhideGeneralForumTopic(chat_id: number | string, signal?: AbortSignal): Promise<true>;
     /**
      * Use this method to send answers to callback queries sent from inline keyboards. The answer will be displayed to the user as a notification at the top of the chat screen or as an alert. On success, True is returned.
      *

package/out/core/api.js

@@ -397,12 +397,13 @@ class Api {
      *
      * @param chat_id Unique identifier for the target chat or username of the target channel (in the format @channelusername)
      * @param action Type of action to broadcast. Choose one, depending on what the user is about to receive: typing for text messages, upload_photo for photos, record_video or upload_video for videos, record_voice or upload_voice for voice notes, upload_document for general files, choose_sticker for stickers, find_location for location data, record_video_note or upload_video_note for video notes.
+     * @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#sendchataction
      */
-    sendChatAction(chat_id, action, signal) {
-        return this.raw.sendChatAction({ chat_id, action }, signal);
+    sendChatAction(chat_id, action, other, signal) {
+        return this.raw.sendChatAction({ chat_id, action, ...other }, signal);
     }
     /**
      * Use this method to get a list of profile pictures for a user. Returns a UserProfilePhotos object.
@@ -742,7 +743,7 @@ class Api {
         return this.raw.getChatMemberCount({ chat_id }, signal);
     }
     /**
-     * Use this method to get information about a member of a chat. Returns a ChatMember object on success.
+     * Use this method to get information about a member of a chat. The method is guaranteed to work only if the bot is an administrator in the chat. Returns a ChatMember object on success.
      *
      * @param chat_id Unique identifier for the target chat or username of the target supergroup or channel (in the format @channelusername)
      * @param user_id Unique identifier of the target user
@@ -804,19 +805,13 @@ class Api {
      *
      * @param chat_id Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)
      * @param message_thread_id Unique identifier for the target message thread of the forum topic
-     * @param name New topic name, 1-128 characters
-     * @param icon_custom_emoji_id New unique identifier of the custom emoji shown as the topic icon. Use getForumTopicIconStickers to get all allowed custom emoji identifiers.
+     * @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#editforumtopic
      */
-    editForumTopic(chat_id, message_thread_id, name, icon_custom_emoji_id, signal) {
-        return this.raw.editForumTopic({
-            chat_id,
-            message_thread_id,
-            name,
-            icon_custom_emoji_id,
-        }, signal);
+    editForumTopic(chat_id, message_thread_id, other, signal) {
+        return this.raw.editForumTopic({ chat_id, message_thread_id, ...other }, signal);
     }
     /**
      * Use this method to close an open topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights, unless it is the creator of the topic. Returns True on success.
@@ -866,6 +861,62 @@ class Api {
     unpinAllForumTopicMessages(chat_id, message_thread_id, signal) {
         return this.raw.unpinAllForumTopicMessages({ chat_id, message_thread_id }, signal);
     }
+    /**
+     * Use this method to edit the name of the 'General' topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have can_manage_topics administrator rights. Returns True on success.
+     *
+     * @param chat_id Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)
+     * @param name New topic name, 1-128 characters
+     * @param signal Optional `AbortSignal` to cancel the request
+     *
+     * **Official reference:** https://core.telegram.org/bots/api#editgeneralforumtopic
+     */
+    editGeneralForumTopic(chat_id, name, signal) {
+        return this.raw.editGeneralForumTopic({ chat_id, name }, signal);
+    }
+    /**
+     * Use this method to close an open 'General' topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights. Returns True on success.
+     *
+     * @param chat_id Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)
+     * @param signal Optional `AbortSignal` to cancel the request
+     *
+     * **Official reference:** https://core.telegram.org/bots/api#closegeneralforumtopic
+     */
+    closeGeneralForumTopic(chat_id, signal) {
+        return this.raw.closeGeneralForumTopic({ chat_id }, signal);
+    }
+    /**
+     * Use this method to reopen a closed 'General' topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights. The topic will be automatically unhidden if it was hidden. Returns True on success.     *
+     *
+     * @param chat_id Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)
+     * @param signal Optional `AbortSignal` to cancel the request
+     *
+     * **Official reference:** https://core.telegram.org/bots/api#reopengeneralforumtopic
+     */
+    reopenGeneralForumTopic(chat_id, signal) {
+        return this.raw.reopenGeneralForumTopic({ chat_id }, signal);
+    }
+    /**
+     * Use this method to hide the 'General' topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights. The topic will be automatically closed if it was open. Returns True on success.
+     *
+     * @param chat_id Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)
+     * @param signal Optional `AbortSignal` to cancel the request
+     *
+     * **Official reference:** https://core.telegram.org/bots/api#hidegeneralforumtopic
+     */
+    hideGeneralForumTopic(chat_id, signal) {
+        return this.raw.hideGeneralForumTopic({ chat_id }, signal);
+    }
+    /**
+     * Use this method to unhide the 'General' topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights. Returns True on success.
+     *
+     * @param chat_id Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)
+     * @param signal Optional `AbortSignal` to cancel the request
+     *
+     * **Official reference:** https://core.telegram.org/bots/api#unhidegeneralforumtopic
+     */
+    unhideGeneralForumTopic(chat_id, signal) {
+        return this.raw.unhideGeneralForumTopic({ chat_id }, signal);
+    }
     /**
      * Use this method to send answers to callback queries sent from inline keyboards. The answer will be displayed to the user as a notification at the top of the chat screen or as an alert. On success, True is returned.
      *

package/out/filter.d.ts

@@ -45,7 +45,17 @@ declare const UPDATE_KEYS: {
         readonly migrate_from_chat_id: {};
         readonly successful_payment: {};
         readonly connected_website: {};
+        readonly write_access_allowed: {};
         readonly passport_data: {};
+        readonly forum_topic_created: {};
+        readonly forum_topic_edited: {
+            readonly name: {};
+            readonly icon_custom_emoji_id: {};
+        };
+        readonly forum_topic_closed: {};
+        readonly forum_topic_reopened: {};
+        readonly general_forum_topic_hidden: {};
+        readonly general_forum_topic_unhidden: {};
         readonly sticker: {
             readonly is_video: {};
             readonly is_animated: {};
@@ -64,9 +74,6 @@ declare const UPDATE_KEYS: {
         readonly pinned_message: {};
         readonly invoice: {};
         readonly proximity_alert_triggered: {};
-        readonly forum_topic_created: {};
-        readonly forum_topic_closed: {};
-        readonly forum_topic_reopened: {};
         readonly video_chat_scheduled: {};
         readonly video_chat_started: {};
         readonly video_chat_ended: {};
@@ -121,6 +128,7 @@ declare const UPDATE_KEYS: {
             readonly text_mention: {};
             readonly custom_emoji: {};
         };
+        readonly has_media_spoiler: {};
         readonly caption: {};
     };
     readonly edited_message: {
@@ -142,7 +150,17 @@ declare const UPDATE_KEYS: {
         readonly migrate_from_chat_id: {};
         readonly successful_payment: {};
         readonly connected_website: {};
+        readonly write_access_allowed: {};
         readonly passport_data: {};
+        readonly forum_topic_created: {};
+        readonly forum_topic_edited: {
+            readonly name: {};
+            readonly icon_custom_emoji_id: {};
+        };
+        readonly forum_topic_closed: {};
+        readonly forum_topic_reopened: {};
+        readonly general_forum_topic_hidden: {};
+        readonly general_forum_topic_unhidden: {};
         readonly sticker: {
             readonly is_video: {};
             readonly is_animated: {};
@@ -161,9 +179,6 @@ declare const UPDATE_KEYS: {
         readonly pinned_message: {};
         readonly invoice: {};
         readonly proximity_alert_triggered: {};
-        readonly forum_topic_created: {};
-        readonly forum_topic_closed: {};
-        readonly forum_topic_reopened: {};
         readonly video_chat_scheduled: {};
         readonly video_chat_started: {};
         readonly video_chat_ended: {};
@@ -218,6 +233,7 @@ declare const UPDATE_KEYS: {
             readonly text_mention: {};
             readonly custom_emoji: {};
         };
+        readonly has_media_spoiler: {};
         readonly caption: {};
     };
     readonly channel_post: {
@@ -240,9 +256,6 @@ declare const UPDATE_KEYS: {
         readonly pinned_message: {};
         readonly invoice: {};
         readonly proximity_alert_triggered: {};
-        readonly forum_topic_created: {};
-        readonly forum_topic_closed: {};
-        readonly forum_topic_reopened: {};
         readonly video_chat_scheduled: {};
         readonly video_chat_started: {};
         readonly video_chat_ended: {};
@@ -297,6 +310,7 @@ declare const UPDATE_KEYS: {
             readonly text_mention: {};
             readonly custom_emoji: {};
         };
+        readonly has_media_spoiler: {};
         readonly caption: {};
     };
     readonly edited_channel_post: {
@@ -319,9 +333,6 @@ declare const UPDATE_KEYS: {
         readonly pinned_message: {};
         readonly invoice: {};
         readonly proximity_alert_triggered: {};
-        readonly forum_topic_created: {};
-        readonly forum_topic_closed: {};
-        readonly forum_topic_reopened: {};
         readonly video_chat_scheduled: {};
         readonly video_chat_started: {};
         readonly video_chat_ended: {};
@@ -376,6 +387,7 @@ declare const UPDATE_KEYS: {
             readonly text_mention: {};
             readonly custom_emoji: {};
         };
+        readonly has_media_spoiler: {};
         readonly caption: {};
     };
     readonly inline_query: {};

package/out/filter.js

@@ -233,6 +233,7 @@ const EDITABLE_MESSAGE_KEYS = {
     location: {},
     entities: ENTITY_KEYS,
     caption_entities: ENTITY_KEYS,
+    has_media_spoiler: {},
     caption: {},
 };
 const COMMON_MESSAGE_KEYS = {
@@ -251,9 +252,6 @@ const COMMON_MESSAGE_KEYS = {
     pinned_message: {},
     invoice: {},
     proximity_alert_triggered: {},
-    forum_topic_created: {},
-    forum_topic_closed: {},
-    forum_topic_reopened: {},
     video_chat_scheduled: {},
     video_chat_started: {},
     video_chat_ended: {},
@@ -273,7 +271,14 @@ const MESSAGE_KEYS = {
     migrate_from_chat_id: {},
     successful_payment: {},
     connected_website: {},
+    write_access_allowed: {},
     passport_data: {},
+    forum_topic_created: {},
+    forum_topic_edited: { name: {}, icon_custom_emoji_id: {} },
+    forum_topic_closed: {},
+    forum_topic_reopened: {},
+    general_forum_topic_hidden: {},
+    general_forum_topic_unhidden: {},
 };
 const CHANNEL_POST_KEYS = {
     ...COMMON_MESSAGE_KEYS,

package/out/web.mjs

@@ -179,6 +179,7 @@ const EDITABLE_MESSAGE_KEYS = {
     location: {},
     entities: ENTITY_KEYS,
     caption_entities: ENTITY_KEYS,
+    has_media_spoiler: {},
     caption: {}
 };
 const COMMON_MESSAGE_KEYS = {
@@ -197,9 +198,6 @@ const COMMON_MESSAGE_KEYS = {
     pinned_message: {},
     invoice: {},
     proximity_alert_triggered: {},
-    forum_topic_created: {},
-    forum_topic_closed: {},
-    forum_topic_reopened: {},
     video_chat_scheduled: {},
     video_chat_started: {},
     video_chat_ended: {},
@@ -219,7 +217,17 @@ const MESSAGE_KEYS = {
     migrate_from_chat_id: {},
     successful_payment: {},
     connected_website: {},
-    passport_data: {}
+    write_access_allowed: {},
+    passport_data: {},
+    forum_topic_created: {},
+    forum_topic_edited: {
+        name: {},
+        icon_custom_emoji_id: {}
+    },
+    forum_topic_closed: {},
+    forum_topic_reopened: {},
+    general_forum_topic_hidden: {},
+    general_forum_topic_unhidden: {}
 };
 const CHANNEL_POST_KEYS = {
     ...COMMON_MESSAGE_KEYS,
@@ -420,6 +428,22 @@ class Context {
     get inlineMessageId() {
         return this.callbackQuery?.inline_message_id ?? this.chosenInlineResult?.inline_message_id;
     }
+    entities(types) {
+        const message = this.msg;
+        if (message === undefined) return [];
+        const text = message.text ?? message.caption;
+        if (text === undefined) return [];
+        let entities = message.entities ?? message.caption_entities;
+        if (entities === undefined) return [];
+        if (types !== undefined) {
+            const filters = new Set(toArray(types));
+            entities = entities.filter((entity)=>filters.has(entity.type));
+        }
+        return entities.map((entity)=>({
+                ...entity,
+                text: text.substring(entity.offset, entity.offset + entity.length)
+            }));
+    }
     static has = checker;
     has(filter) {
         return Context.has.filterQuery(filter)(this);
@@ -498,8 +522,8 @@ class Context {
     replyWithDice(emoji, other, signal) {
         return this.api.sendDice(orThrow(this.chat, "sendDice").id, emoji, other, signal);
     }
-    replyWithChatAction(action, signal) {
-        return this.api.sendChatAction(orThrow(this.chat, "sendChatAction").id, action, signal);
+    replyWithChatAction(action, other, signal) {
+        return this.api.sendChatAction(orThrow(this.chat, "sendChatAction").id, action, other, signal);
     }
     getUserProfilePhotos(other, signal) {
         return this.api.getUserProfilePhotos(orThrow(this.from, "getUserProfilePhotos").id, other, signal);
@@ -620,10 +644,10 @@ class Context {
     createForumTopic(name, other, signal) {
         return this.api.createForumTopic(orThrow(this.chat, "createForumTopic").id, name, other, signal);
     }
-    editForumTopic(name, icon_custom_emoji_id, signal) {
+    editForumTopic(other, signal) {
         const message = orThrow(this.msg, "editForumTopic");
         const thread = orThrow(message.message_thread_id, "editForumTopic");
-        return this.api.editForumTopic(message.chat.id, thread, name, icon_custom_emoji_id, signal);
+        return this.api.editForumTopic(message.chat.id, thread, other, signal);
     }
     closeForumTopic(signal) {
         const message = orThrow(this.msg, "closeForumTopic");
@@ -645,6 +669,21 @@ class Context {
         const thread = orThrow(message.message_thread_id, "unpinAllForumTopicMessages");
         return this.api.unpinAllForumTopicMessages(message.chat.id, thread, signal);
     }
+    editGeneralForumTopic(name, signal) {
+        return this.api.editGeneralForumTopic(orThrow(this.chat, "editGeneralForumTopic").id, name, signal);
+    }
+    closeGeneralForumTopic(signal) {
+        return this.api.closeGeneralForumTopic(orThrow(this.chat, "closeGeneralForumTopic").id, signal);
+    }
+    reopenGeneralForumTopic(signal) {
+        return this.api.reopenGeneralForumTopic(orThrow(this.chat, "reopenGeneralForumTopic").id, signal);
+    }
+    hideGeneralForumTopic(signal) {
+        return this.api.hideGeneralForumTopic(orThrow(this.chat, "hideGeneralForumTopic").id, signal);
+    }
+    unhideGeneralForumTopic(signal) {
+        return this.api.unhideGeneralForumTopic(orThrow(this.chat, "unhideGeneralForumTopic").id, signal);
+    }
     answerCallbackQuery(other, signal) {
         return this.api.answerCallbackQuery(orThrow(this.callbackQuery, "answerCallbackQuery").id, typeof other === "string" ? {
             text: other
@@ -3487,10 +3526,11 @@ class Api {
             ...other
         }, signal);
     }
-    sendChatAction(chat_id, action, signal) {
+    sendChatAction(chat_id, action, other, signal) {
         return this.raw.sendChatAction({
             chat_id,
-            action
+            action,
+            ...other
         }, signal);
     }
     getUserProfilePhotos(user_id, other, signal) {
@@ -3688,12 +3728,11 @@ class Api {
             ...other
         }, signal);
     }
-    editForumTopic(chat_id, message_thread_id, name, icon_custom_emoji_id, signal) {
+    editForumTopic(chat_id, message_thread_id, other, signal) {
         return this.raw.editForumTopic({
             chat_id,
             message_thread_id,
-            name,
-            icon_custom_emoji_id
+            ...other
         }, signal);
     }
     closeForumTopic(chat_id, message_thread_id, signal) {
@@ -3720,6 +3759,32 @@ class Api {
             message_thread_id
         }, signal);
     }
+    editGeneralForumTopic(chat_id, name, signal) {
+        return this.raw.editGeneralForumTopic({
+            chat_id,
+            name
+        }, signal);
+    }
+    closeGeneralForumTopic(chat_id, signal) {
+        return this.raw.closeGeneralForumTopic({
+            chat_id
+        }, signal);
+    }
+    reopenGeneralForumTopic(chat_id, signal) {
+        return this.raw.reopenGeneralForumTopic({
+            chat_id
+        }, signal);
+    }
+    hideGeneralForumTopic(chat_id, signal) {
+        return this.raw.hideGeneralForumTopic({
+            chat_id
+        }, signal);
+    }
+    unhideGeneralForumTopic(chat_id, signal) {
+        return this.raw.unhideGeneralForumTopic({
+            chat_id
+        }, signal);
+    }
     answerCallbackQuery(callback_query_id, other, signal) {
         return this.raw.answerCallbackQuery({
             callback_query_id,
@@ -4208,6 +4273,7 @@ function sleep(seconds) {
     return new Promise((r)=>setTimeout(r, 1000 * seconds));
 }
 class Keyboard {
+    is_persistent;
     selective;
     one_time_keyboard;
     resize_keyboard;
@@ -4258,6 +4324,10 @@ class Keyboard {
             }
         });
     }
+    persistent(isEnabled = true) {
+        this.is_persistent = isEnabled;
+        return this;
+    }
     selected(isEnabled = true) {
         this.selective = isEnabled;
         return this;
@@ -4390,6 +4460,9 @@ function strictMultiSession(options) {
     };
 }
 function lazySession(options = {}) {
+    if (options.type !== undefined && options.type !== "single") {
+        throw new Error("Cannot use lazy multi sessions!");
+    }
     const { initial , storage , getSessionKey , custom  } = fillDefaults(options);
     return async (ctx, next)=>{
         const propSession = new PropertySession(storage, ctx, "session", initial);

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "grammy",
     "description": "The Telegram Bot Framework.",
-    "version": "1.12.4",
+    "version": "1.13.0",
     "author": "KnorpelSenf",
     "license": "MIT",
     "engines": {
@@ -15,11 +15,10 @@
     "scripts": {
         "prepare": "npm run backport",
         "backport": "deno2node tsconfig.json",
-        "contribs": "all-contributors",
-        "bundle-web": "mkdir -p out deno_cache && cd bundling && DENO_DIR=$PWD/../deno_cache deno run --unstable --quiet --allow-net --allow-read --allow-env=DENO_DIR,XDG_CACHE_HOME,HOME,DENO_AUTH_TOKENS --allow-write=../out,$PWD/../deno_cache bundle-web.ts dev ../src/mod.ts"
+        "contribs": "all-contributors"
     },
     "dependencies": {
-        "@grammyjs/types": "^2.10.3",
+        "@grammyjs/types": "^2.11.0",
         "abort-controller": "^3.0.0",
         "debug": "^4.3.4",
         "node-fetch": "^2.6.7"