@grammyjs/types 2.10.2 → 2.11.0

package/README.md

@@ -89,3 +89,5 @@ The actual type definitions themselves are never different.
 4. No `More info on Sending Files »`.
    File handling is abstracted away by the underlying library.
    Also, without the links, it's useless anyway.
+5. No images.
+   Documentation strings containing an image are adjusted to make sense without the images, too.

package/manage.d.ts

@@ -163,6 +163,8 @@ export namespace Chat {
     extends SupergroupChat, NonGroupGetChat, MultiUserGetChat, LargeGetChat {
     /** For supergroups, the minimum allowed delay between consecutive messages sent by each unpriviledged user; in seconds. Returned only in getChat. */
     slow_mode_delay?: number;
+    /** True, if aggressive anti-spam checks are enabled in the supergroup. The field is only available to chat administrators. Returned only in getChat. */
+    has_aggressive_anti_spam_enabled?: true;
     /** For supergroups, name of group sticker set. Returned only in getChat. */
     sticker_set_name?: string;
     /** For supergroups, the location to which the supergroup is connected. Returned only in getChat. */

package/markup.d.ts

@@ -108,6 +108,8 @@ export interface CallbackQuery {
 export interface ReplyKeyboardMarkup {
   /** Array of button rows, each represented by an Array of KeyboardButton objects */
   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;
   /** Requests clients to resize the keyboard vertically for optimal fit (e.g., make the keyboard smaller if there are just two rows of buttons). Defaults to false, in which case the custom keyboard is always of the same height as the app's standard keyboard. */
   resize_keyboard?: boolean;
   /** Requests clients to hide the keyboard as soon as it's been used. The keyboard will still be available, but clients will automatically display the usual letter-keyboard in the chat – the user can press a special button in the input field to see the custom keyboard again. Defaults to false. */

package/message.d.ts

@@ -59,6 +59,8 @@ export namespace Message {
   interface MediaMessage extends CaptionableMessage {
     /** The unique identifier of a media message group this message belongs to */
     media_group_id?: string;
+    /** True, if the message media is covered by a spoiler animation */
+    has_media_spoiler?: true;
   }
 
   export type TextMessage = CommonMessage & MsgWith<"text">;
@@ -113,6 +115,9 @@ export namespace Message {
   export type ConnectedWebsiteMessage =
     & ServiceMessage
     & MsgWith<"connected_website">;
+  export type WriteAccessAllowedMessage =
+    & ServiceMessage
+    & MsgWith<"write_access_allowed">;
   export type PassportDataMessage = ServiceMessage & MsgWith<"passport_data">;
   export type ProximityAlertTriggeredMessage =
     & ServiceMessage
@@ -120,12 +125,21 @@ export namespace Message {
   export type ForumTopicCreatedMessage =
     & ServiceMessage
     & MsgWith<"forum_topic_created">;
+  export type ForumTopicEditedMessage =
+    & ServiceMessage
+    & MsgWith<"forum_topic_edited">;
   export type ForumTopicClosedMessage =
     & ServiceMessage
     & MsgWith<"forum_topic_closed">;
   export type ForumTopicReopenedMessage =
     & ServiceMessage
     & MsgWith<"forum_topic_reopened">;
+  export type GeneralForumTopicHiddenMessage =
+    & ServiceMessage
+    & MsgWith<"general_forum_topic_hidden">;
+  export type GeneralForumTopicUnhiddenMessage =
+    & ServiceMessage
+    & MsgWith<"general_forum_topic_unhidden">;
   export type VideoChatScheduledMessage =
     & ServiceMessage
     & MsgWith<"video_chat_scheduled">;
@@ -206,16 +220,24 @@ export interface Message extends Message.MediaMessage {
   successful_payment?: SuccessfulPayment;
   /** The domain name of the website on which the user has logged in. More about Telegram Login » */
   connected_website?: string;
+  /** Service message: the user allowed the bot added to the attachment menu to write messages */
+  write_access_allowed?: WriteAccessAllowed;
   /** Telegram Passport data */
   passport_data?: PassportData;
   /** Service message. A user in the chat triggered another user's proximity alert while sharing Live Location. */
   proximity_alert_triggered?: ProximityAlertTriggered;
   /** Service message: forum topic created */
   forum_topic_created?: ForumTopicCreated;
+  /** Service message: forum topic edited */
+  forum_topic_edited?: ForumTopicEdited;
   /** Service message: forum topic closed */
   forum_topic_closed?: ForumTopicClosed;
   /** Service message: forum topic reopened */
   forum_topic_reopened?: ForumTopicReopened;
+  /** Service message: the 'General' forum topic hidden */
+  general_forum_topic_hidden?: GeneralForumTopicHidden;
+  /** Service message: the 'General' forum topic unhidden */
+  general_forum_topic_unhidden?: GeneralForumTopicUnhidden;
   /** Service message: video chat scheduled */
   video_chat_scheduled?: VideoChatScheduled;
   /** Service message: video chat started */
@@ -642,12 +664,29 @@ export interface ForumTopicCreated {
   icon_custom_emoji_id?: string;
 }
 
+/** This object represents a service message about an edited forum topic. */
+export interface ForumTopicEdited {
+  /** New name of the topic, if it was edited */
+  name?: string;
+  /** New identifier of the custom emoji shown as the topic icon, if it was edited; an empty string if the icon was removed */
+  icon_custom_emoji_id?: string;
+}
+
 /** This object represents a service message about a forum topic closed in the chat. Currently holds no information. */
 export interface ForumTopicClosed {}
 
 /** This object represents a service message about a forum topic reopened in the chat. Currently holds no information. */
 export interface ForumTopicReopened {}
 
+/** This object represents a service message about General forum topic hidden in the chat. Currently holds no information. */
+export interface GeneralForumTopicHidden {}
+
+/** This object represents a service message about General forum topic unhidden in the chat. Currently holds no information. */
+export interface GeneralForumTopicUnhidden {}
+
+/** This object represents a service message about a user allowing a bot added to the attachment menu to write messages. Currently holds no information. */
+export interface WriteAccessAllowed {}
+
 /** This object represents a service message about a video chat scheduled in the chat. */
 export interface VideoChatScheduled {
   /** Point in time (Unix timestamp) when the video chat is supposed to be started by a chat administrator */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@grammyjs/types",
-  "version": "2.10.2",
+  "version": "2.11.0",
   "description": "Telegram Bot API type declarations for grammY",
   "main": "index.js",
   "repository": {

package/proxied.d.ts

@@ -209,6 +209,8 @@ export interface InputFileProxy<F> {
       parse_mode?: ParseMode;
       /** A list of special entities that appear in the caption, which can be specified instead of parse_mode */
       caption_entities?: MessageEntity[];
+      /** Pass True if the photo needs to be covered with a spoiler animation */
+      has_spoiler?: boolean;
       /** Sends the message silently. Users will receive a notification with no sound. */
       disable_notification?: boolean;
       /** Protects the contents of the sent message from forwarding and saving */
@@ -321,6 +323,8 @@ export interface InputFileProxy<F> {
       parse_mode?: ParseMode;
       /** A list of special entities that appear in the caption, which can be specified instead of parse_mode */
       caption_entities?: MessageEntity[];
+      /** Pass True if the video needs to be covered with a spoiler animation */
+      has_spoiler?: boolean;
       /** Pass True if the uploaded video is suitable for streaming */
       supports_streaming?: boolean;
       /** Sends the message silently. Users will receive a notification with no sound. */
@@ -361,6 +365,8 @@ export interface InputFileProxy<F> {
       parse_mode?: ParseMode;
       /** A list of special entities that appear in the caption, which can be specified instead of parse_mode */
       caption_entities?: MessageEntity[];
+      /** Pass True if the animation needs to be covered with a spoiler animation */
+      has_spoiler?: boolean;
       /** Sends the message silently. Users will receive a notification with no sound. */
       disable_notification?: boolean;
       /** Protects the contents of the sent message from forwarding and saving */
@@ -695,6 +701,8 @@ export interface InputFileProxy<F> {
         | "find_location"
         | "record_video_note"
         | "upload_video_note";
+      /** Unique identifier for the target message thread; supergroups only */
+      message_thread_id?: number;
     }): true;
 
     /** Use this method to get a list of profile pictures for a user. Returns a UserProfilePhotos object. */
@@ -963,7 +971,7 @@ export interface InputFileProxy<F> {
       chat_id: number | string;
     }): 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. */
     getChatMember(args: {
       /** Unique identifier for the target chat or username of the target supergroup or channel (in the format @channelusername) */
       chat_id: number | string;
@@ -994,7 +1002,7 @@ export interface InputFileProxy<F> {
       chat_id: number | string;
       /** Topic name, 1-128 characters */
       name: string;
-      /** Color of the topic icon in RGB format. Currently, must be one of 0x6FB9F0, 0xFFD67E, 0xCB86DB, 0x8EEE98, 0xFF93B2, or 0xFB6F5F */
+      /** Color of the topic icon in RGB format. Currently, must be one of 7322096 (0x6FB9F0), 16766590 (0xFFD67E), 13338331 (0xCB86DB), 9367192 (0x8EEE98), 16749490 (0xFF93B2), or 16478047 (0xFB6F5F) */
       icon_color?:
         | 0x6FB9F0
         | 0xFFD67E
@@ -1012,10 +1020,10 @@ export interface InputFileProxy<F> {
       chat_id: number | string;
       /** Unique identifier for the target message thread of the forum topic */
       message_thread_id: number;
-      /** New topic name, 1-128 characters */
-      name: string;
-      /** New unique identifier of the custom emoji shown as the topic icon. Use getForumTopicIconStickers to get all allowed custom emoji identifiers. */
-      icon_custom_emoji_id: string;
+      /** New topic name, 0-128 characters. If not specififed or empty, the current name of the topic will be kept */
+      name?: string;
+      /** New unique identifier of the custom emoji shown as the topic icon. Use getForumTopicIconStickers to get all allowed custom emoji identifiers. Pass an empty string to remove the icon. If not specified, the current icon will be kept */
+      icon_custom_emoji_id?: string;
     }): 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. */
@@ -1050,6 +1058,38 @@ export interface InputFileProxy<F> {
       message_thread_id: number;
     }): 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. */
+    editGeneralForumTopic(args: {
+      /** Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername) */
+      chat_id: number | string;
+      /** New topic name, 1-128 characters */
+      name: string;
+    }): 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. */
+    closeGeneralForumTopic(args: {
+      /** Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername) */
+      chat_id: number | string;
+    }): 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. */
+    reopenGeneralForumTopic(args: {
+      /** Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername) */
+      chat_id: number | string;
+    }): 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. */
+    hideGeneralForumTopic(args: {
+      /** Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername) */
+      chat_id: number | string;
+    }): 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. */
+    unhideGeneralForumTopic(args: {
+      /** Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername) */
+      chat_id: number | string;
+    }): 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.
 
     Alternatively, the user can be redirected to the specified Game URL. For this option to work, you must first create a game for your bot via @BotFather and accept the terms. Otherwise, you may use links like t.me/your_bot?start=XXXX that open your bot with a parameter. */
@@ -1568,6 +1608,8 @@ export interface InputFileProxy<F> {
     parse_mode?: ParseMode;
     /** List of special entities that appear in the caption, which can be specified instead of parse_mode */
     caption_entities?: MessageEntity[];
+    /** Pass True if the photo needs to be covered with a spoiler animation */
+    has_spoiler?: boolean;
   };
 
   /** Represents a video to be sent. */
@@ -1592,6 +1634,8 @@ export interface InputFileProxy<F> {
     duration?: number;
     /** Pass True if the uploaded video is suitable for streaming */
     supports_streaming?: boolean;
+    /** Pass True if the photo needs to be covered with a spoiler animation */
+    has_spoiler?: boolean;
   };
 
   /** Represents an animation file (GIF or H.264/MPEG-4 AVC video without sound) to be sent. */
@@ -1614,6 +1658,8 @@ export interface InputFileProxy<F> {
     height?: number;
     /** Animation duration in seconds */
     duration?: number;
+    /** Pass True if the photo needs to be covered with a spoiler animation */
+    has_spoiler?: boolean;
   };
 
   /** Represents an audio file to be treated as music to be sent. */

package/update.d.ts

@@ -6,13 +6,13 @@ import { PreCheckoutQuery, ShippingQuery } from "./payment";
 
 /** Internal namespace used to make some message types more accurate */
 export namespace Update {
-  /** Internal type holding properties that updates in channels share. */
+  /** Internal type holding properties that message updates in channels share. */
   export interface Channel {
     chat: Chat.ChannelChat;
     author_signature?: string;
     from?: never;
   }
-  /** Internal type holding properties that updates outside of channels share. */
+  /** Internal type holding properties that message updates outside of channels share. */
   export interface NonChannel {
     chat: Exclude<Chat, Chat.ChannelChat>;
     author_signature?: never;
@@ -41,13 +41,13 @@ export interface Update {
   /** The update's unique identifier. Update identifiers start from a certain positive number and increase sequentially. This ID becomes especially handy if you're using webhooks, since it allows you to ignore repeated updates or to restore the correct update sequence, should they get out of order. If there are no new updates for at least a week, then identifier of the next update will be chosen randomly instead of sequentially. */
   update_id: number;
   /** New incoming message of any kind - text, photo, sticker, etc. */
-  message?: Message;
+  message?: Message & Update.New & Update.NonChannel;
   /** New version of a message that is known to the bot and was edited */
-  edited_message?: Message;
+  edited_message?: Message & Update.Edited & Update.NonChannel;
   /** New incoming channel post of any kind - text, photo, sticker, etc. */
-  channel_post?: Message;
+  channel_post?: Message & Update.New & Update.Channel;
   /** New version of a channel post that is known to the bot and was edited */
-  edited_channel_post?: Message;
+  edited_channel_post?: Message & Update.Edited & Update.Channel;
   /** New incoming inline query */
   inline_query?: InlineQuery;
   /** The result of an inline query that was chosen by a user and sent to their chat partner. Please see our documentation on the feedback collecting for details on how to enable these updates for your bot. */