@grammyjs/types 2.11.1 → 2.12.0

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2022 KnorpelSenf
+Copyright (c) 2021-2023 KnorpelSenf
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/manage.d.ts

@@ -243,7 +243,7 @@ export interface ChatAdministratorRights {
   can_manage_video_chats: boolean;
   /** True, if the administrator can restrict, ban or unban chat members */
   can_restrict_members: boolean;
-  /** True, if the administrator can add new administrators with a subset of their own privileges or demote administrators that he has promoted, directly or indirectly (promoted by administrators that were appointed by the user) */
+  /** True, if the administrator can add new administrators with a subset of their own privileges or demote administrators that they have promoted, directly or indirectly (promoted by administrators that were appointed by the user) */
   can_promote_members: boolean;
   /** True, if the user is allowed to change the chat title, photo and other settings */
   can_change_info: boolean;
@@ -304,7 +304,7 @@ export interface ChatMemberAdministrator {
   can_manage_video_chats: boolean;
   /** True, if the administrator can restrict, ban or unban chat members */
   can_restrict_members: boolean;
-  /** True, if the administrator can add new administrators with a subset of their own privileges or demote administrators that he has promoted, directly or indirectly (promoted by administrators that were appointed by the user) */
+  /** True, if the administrator can add new administrators with a subset of their own privileges or demote administrators that they have promoted, directly or indirectly (promoted by administrators that were appointed by the user) */
   can_promote_members: boolean;
   /** True, if the user is allowed to change the chat title, photo and other settings */
   can_change_info: boolean;
@@ -338,6 +338,26 @@ export interface ChatMemberRestricted {
   user: User;
   /** True, if the user is a member of the chat at the moment of the request */
   is_member: boolean;
+  /** True, if the user is allowed to send text messages, contacts, invoices, locations and venues */
+  can_send_messages: boolean;
+  /** True, if the user is allowed to send audios */
+  can_send_audios: boolean;
+  /** True, if the user is allowed to send documents */
+  can_send_documents: boolean;
+  /** True, if the user is allowed to send photos */
+  can_send_photos: boolean;
+  /** True, if the user is allowed to send videos */
+  can_send_videos: boolean;
+  /** True, if the user is allowed to send video notes */
+  can_send_video_notes: boolean;
+  /** True, if the user is allowed to send voice notes */
+  can_send_voice_notes: boolean;
+  /** True, if the user is allowed to send polls */
+  can_send_polls: boolean;
+  /** True, if the user is allowed to send animations, games, stickers and use inline bots */
+  can_send_other_messages: boolean;
+  /** True, if the user is allowed to add web page previews to their messages */
+  can_add_web_page_previews: boolean;
   /** True, if the user is allowed to change the chat title, photo and other settings */
   can_change_info: boolean;
   /** True, if the user is allowed to invite new users to the chat */
@@ -346,16 +366,6 @@ export interface ChatMemberRestricted {
   can_pin_messages: boolean;
   /** True, if the user is allowed to create forum topics */
   can_manage_topics: boolean;
-  /** True, if the user is allowed to send text messages, contacts, locations and venues */
-  can_send_messages: boolean;
-  /** True, if the user is allowed to send audios, documents, photos, videos, video notes and voice notes */
-  can_send_media_messages: boolean;
-  /** True, if the user is allowed to send polls */
-  can_send_polls: boolean;
-  /** True, if the user is allowed to send animations, games, stickers and use inline bots */
-  can_send_other_messages: boolean;
-  /** True, if the user is allowed to add web page previews to their messages */
-  can_add_web_page_previews: boolean;
   /** Date when restrictions will be lifted for this user; unix time. If 0, then the user is restricted forever */
   until_date: number;
 }
@@ -400,6 +410,8 @@ export interface ChatJoinRequest {
   chat: Chat.SupergroupChat | Chat.ChannelChat;
   /** User that sent the join request */
   from: User;
+  /** Identifier of a private chat with the user who sent the join request. This number may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a 64-bit integer or double-precision float type are safe for storing this identifier. The bot can use this identifier for 24 hours to send messages until the join request is processed, assuming no other administrator contacted the user. */
+  user_chat_id: number;
   /** Date the request was sent in Unix time */
   date: number;
   /** Bio of the user. */
@@ -410,15 +422,25 @@ export interface ChatJoinRequest {
 
 /** Describes actions that a non-administrator user is allowed to take in a chat. */
 export interface ChatPermissions {
-  /** True, if the user is allowed to send text messages, contacts, locations and venues */
+  /** True, if the user is allowed to send text messages, contacts, invoices, locations and venues */
   can_send_messages?: boolean;
-  /** True, if the user is allowed to send audios, documents, photos, videos, video notes and voice notes, implies can_send_messages */
-  can_send_media_messages?: boolean;
-  /** True, if the user is allowed to send polls, implies can_send_messages */
+  /** True, if the user is allowed to send audios */
+  can_send_audios?: boolean;
+  /** True, if the user is allowed to send documents */
+  can_send_documents?: boolean;
+  /** True, if the user is allowed to send photos */
+  can_send_photos?: boolean;
+  /** True, if the user is allowed to send videos */
+  can_send_videos?: boolean;
+  /** True, if the user is allowed to send video notes */
+  can_send_video_notes?: boolean;
+  /** True, if the user is allowed to send voice notes */
+  can_send_voice_notes?: boolean;
+  /** True, if the user is allowed to send polls */
   can_send_polls?: boolean;
-  /** True, if the user is allowed to send animations, games, stickers and use inline bots, implies can_send_media_messages */
+  /** True, if the user is allowed to send animations, games, stickers and use inline bots */
   can_send_other_messages?: boolean;
-  /** True, if the user is allowed to add web page previews to their messages, implies can_send_media_messages */
+  /** True, if the user is allowed to add web page previews to their messages */
   can_add_web_page_previews?: boolean;
   /** True, if the user is allowed to change the chat title, photo and other settings. Ignored in public supergroups */
   can_change_info?: boolean;

package/markup.d.ts

@@ -1,4 +1,4 @@
-import { User } from "./manage";
+import { ChatAdministratorRights, User } from "./manage";
 import { Message } from "./message";
 
 /** This object represents an inline keyboard that appears right next to the message it belongs to. */
@@ -127,6 +127,14 @@ export namespace KeyboardButton {
     /** Text of the button. If none of the optional fields are used, it will be sent as a message when the button is pressed */
     text: string;
   }
+  export interface RequestUserButton extends CommonButton {
+    /** If specified, pressing the button will open a list of suitable users. Tapping on any user will send their identifier to the bot in a “user_shared” service message. Available in private chats only. */
+    request_user: KeyboardButtonRequestUser;
+  }
+  export interface RequestChatButton extends CommonButton {
+    /** If specified, pressing the button will open a list of suitable chats. Tapping on a chat will send its identifier to the bot in a “chat_shared” service message. Available in private chats only. */
+    request_chat: KeyboardButtonRequestChat;
+  }
   export interface RequestContactButton extends CommonButton {
     /** If True, the user's phone number will be sent as a contact when the button is pressed. Available in private chats only. */
     request_contact: boolean;
@@ -145,9 +153,11 @@ export namespace KeyboardButton {
   }
 }
 
-/** This object represents one button of the reply keyboard. For simple text buttons String can be used instead of this object to specify text of the button. Optional fields web_app, request_contact, request_location, and request_poll are mutually exclusive. */
+/** This object represents one button of the reply keyboard. For simple text buttons, String can be used instead of this object to specify the button text. The optional fields web_app, request_user, request_chat, request_contact, request_location, and request_poll are mutually exclusive. */
 export type KeyboardButton =
   | KeyboardButton.CommonButton
+  | KeyboardButton.RequestUserButton
+  | KeyboardButton.RequestChatButton
   | KeyboardButton.RequestContactButton
   | KeyboardButton.RequestLocationButton
   | KeyboardButton.RequestPollButton
@@ -193,3 +203,33 @@ export interface WebAppInfo {
   /** An HTTPS URL of a Web App to be opened with additional data as specified in Initializing Web Apps */
   url: string;
 }
+
+/** This object defines the criteria used to request a suitable user. The identifier of the selected user will be shared with the bot when the corresponding button is pressed. */
+export interface KeyboardButtonRequestUser {
+  /** Signed 32-bit identifier of the request */
+  request_id: number;
+  /** Pass True to request a bot, pass False to request a regular user. If not specified, no additional restrictions are applied. */
+  user_is_bot?: boolean;
+  /** Pass True to request a premium user, pass False to request a non-premium user. If not specified, no additional restrictions are applied. */
+  user_is_premium?: boolean;
+}
+
+/** This object defines the criteria used to request a suitable chat. The identifier of the selected chat will be shared with the bot when the corresponding button is pressed. */
+export interface KeyboardButtonRequestChat {
+  /** Signed 32-bit identifier of the request */
+  request_id: number;
+  /** Pass True to request a channel chat, pass False to request a group or a supergroup chat. */
+  chat_is_channel: boolean;
+  /** Pass True to request a forum supergroup, pass False to request a non-forum chat. If not specified, no additional restrictions are applied. */
+  chat_is_forum?: boolean;
+  /** Pass True to request a supergroup or a channel with a username, pass False to request a chat without a username. If not specified, no additional restrictions are applied. */
+  chat_has_username?: boolean;
+  /** Pass True to request a chat owned by the user. Otherwise, no additional restrictions are applied. */
+  chat_is_created?: boolean;
+  /** A JSON-serialized object listing the required administrator rights of the user in the chat. If not specified, no additional restrictions are applied. */
+  user_administrator_rights?: ChatAdministratorRights;
+  /** A JSON-serialized object listing the required administrator rights of the bot in the chat. The rights must be a subset of user_administrator_rights. If not specified, no additional restrictions are applied. */
+  bot_administrator_rights?: ChatAdministratorRights;
+  /** Pass True to request a chat with the bot as a member. Otherwise, no additional restrictions are applied. */
+  bot_is_member?: boolean;
+}

package/message.d.ts

@@ -112,6 +112,8 @@ export namespace Message {
   export type SuccessfulPaymentMessage =
     & ServiceMessage
     & MsgWith<"successful_payment">;
+  export type UserSharedMessage = ServiceMessage & MsgWith<"user_shared">;
+  export type ChatSharedMessage = ServiceMessage & MsgWith<"chat_shared">;
   export type ConnectedWebsiteMessage =
     & ServiceMessage
     & MsgWith<"connected_website">;
@@ -218,6 +220,10 @@ export interface Message extends Message.MediaMessage {
   invoice?: Invoice;
   /** Message is a service message about a successful payment, information about the payment. More about payments » */
   successful_payment?: SuccessfulPayment;
+  /** Service message: a user was shared with the bot */
+  user_shared?: UserShared;
+  /** Service message: a chat was shared with the bot */
+  chat_shared?: ChatShared;
   /** 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 */
@@ -274,7 +280,7 @@ Message entities can be nested, providing following restrictions are met:
 Links `tg://user?id=<user_id>` can be used to mention a user by their ID without using a username. Please note:
 
 - These links will work only if they are used inside an inline link or in an inline keyboard button. For example, they will not work, when used in a message text.
-- These mentions are only guaranteed to work if the user has contacted the bot in the past, has sent a callback query to the bot via an inline button or is a member in the group where he was mentioned.
+- Unless the user is a member of the chat where they were mentioned, these mentions are only guaranteed to work if the user has contacted the bot in private in the past or has sent a callback query to the bot via an inline button and doesn't have Forwarded Messages privacy enabled for the bot.
 
 #### MarkdownV2 style
 To use this mode, pass *MarkdownV2* in the *parse_mode* field. Use the following syntax in your message:
@@ -684,6 +690,22 @@ 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 contains information about the user whose identifier was shared with the bot using a KeyboardButtonRequestUser button. */
+export interface UserShared {
+  /** Identifier of the request */
+  request_id: number;
+  /** Identifier of the shared user. This number may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a 64-bit integer or double-precision float type are safe for storing this identifier. The bot may not have access to the user and could be unable to use this identifier, unless the user is already known to the bot by some other means. */
+  user_id: number;
+}
+
+/** This object contains information about the chat whose identifier was shared with the bot using a KeyboardButtonRequestChat button. */
+export interface ChatShared {
+  /** Identifier of the request */
+  request_id: number;
+  /** Identifier of the shared chat. This number may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a 64-bit integer or double-precision float type are safe for storing this identifier. The bot may not have access to the chat and could be unable to use this identifier, unless the chat is already known to the bot by some other means. */
+  chat_id: number;
+}
+
 /** 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 {}
 

package/package.json

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

package/proxied.d.ts

@@ -757,6 +757,8 @@ export interface InputFileProxy<F> {
       user_id: number;
       /** An object for new user permissions */
       permissions: ChatPermissions;
+      /** Pass True if chat permissions are set independently. Otherwise, the can_send_other_messages and can_add_web_page_previews permissions will imply the can_send_messages, can_send_audios, can_send_documents, can_send_photos, can_send_videos, can_send_video_notes, and can_send_voice_notes permissions; the can_send_polls permission will imply the can_send_messages permission. */
+      use_independent_chat_permissions?: boolean;
       /** Date when restrictions will be lifted for the user, unix time. If user is restricted for more than 366 days or less than 30 seconds from the current time, they are considered to be restricted forever */
       until_date?: number;
     }): true;
@@ -781,7 +783,7 @@ export interface InputFileProxy<F> {
       can_manage_video_chats?: boolean;
       /** Pass True if the administrator can restrict, ban or unban chat members */
       can_restrict_members?: boolean;
-      /** Pass True if the administrator can add new administrators with a subset of their own privileges or demote administrators that he has promoted, directly or indirectly (promoted by administrators that were appointed by him) */
+      /** Pass True if the administrator can add new administrators with a subset of their own privileges or demote administrators that they have promoted, directly or indirectly (promoted by administrators that were appointed by him) */
       can_promote_members?: boolean;
       /** Pass True if the administrator can change chat title, photo and other settings */
       can_change_info?: boolean;
@@ -825,6 +827,8 @@ export interface InputFileProxy<F> {
       chat_id: number | string;
       /** An object for new default chat permissions */
       permissions: ChatPermissions;
+      /** Pass True if chat permissions are set independently. Otherwise, the can_send_other_messages and can_add_web_page_previews permissions will imply the can_send_messages, can_send_audios, can_send_documents, can_send_photos, can_send_videos, can_send_video_notes, and can_send_voice_notes permissions; the can_send_polls permission will imply the can_send_messages permission. */
+      use_independent_chat_permissions?: boolean;
     }): true;
 
     /** Use this method to generate a new primary invite link for a chat; any previously generated primary link is revoked. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns the new invite link as String on success.
@@ -1020,7 +1024,7 @@ 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, 0-128 characters. If not specififed or empty, the current name of the topic will be kept */
+      /** New topic name, 0-128 characters. If not specified 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;
@@ -1212,13 +1216,7 @@ export interface InputFileProxy<F> {
       media: InputFileProxy<F>["InputMedia"];
       /** An object for a new inline keyboard. */
       reply_markup?: InlineKeyboardMarkup;
-    }):
-      | (Update.Edited & Message.AnimationMessage)
-      | (Update.Edited & Message.AudioMessage)
-      | (Update.Edited & Message.DocumentMessage)
-      | (Update.Edited & Message.PhotoMessage)
-      | (Update.Edited & Message.VideoMessage)
-      | true;
+    }): (Update.Edited & Message) | true;
 
     /** Use this method to edit only the reply markup of messages. On success, if the edited message is not an inline message, the edited Message is returned, otherwise True is returned. */
     editMessageReplyMarkup(args: {