@grammyjs/types 2.5.0 → 2.7.0

package/message.d.ts

@@ -1,4 +1,4 @@
-import { InlineKeyboardMarkup } from "./inline";
+import { InlineKeyboardMarkup } from "./markup";
 import { Chat, User } from "./manage";
 import { PassportData } from "./passport";
 import { Invoice, SuccessfulPayment } from "./payment";
@@ -72,59 +72,44 @@ export namespace Message {
   export type PollMessage = CommonMessage & MsgWith<"poll">;
   export type LocationMessage = CommonMessage & MsgWith<"location">;
   export type VenueMessage = LocationMessage & MsgWith<"venue">;
-  export type NewChatMembersMessage =
-    & ServiceMessage
-    & MsgWith<"new_chat_members">;
-  export type LeftChatMemberMessage =
-    & ServiceMessage
-    & MsgWith<"left_chat_member">;
+  export type NewChatMembersMessage = ServiceMessage &
+    MsgWith<"new_chat_members">;
+  export type LeftChatMemberMessage = ServiceMessage &
+    MsgWith<"left_chat_member">;
   export type NewChatTitleMessage = ServiceMessage & MsgWith<"new_chat_title">;
   export type NewChatPhotoMessage = ServiceMessage & MsgWith<"new_chat_photo">;
-  export type DeleteChatPhotoMessage =
-    & ServiceMessage
-    & MsgWith<"delete_chat_photo">;
-  export type GroupChatCreatedMessage =
-    & ServiceMessage
-    & MsgWith<"group_chat_created">;
-  export type SupergroupChatCreated =
-    & ServiceMessage
-    & MsgWith<"supergroup_chat_created">;
-  export type ChannelChatCreatedMessage =
-    & ServiceMessage
-    & MsgWith<"channel_chat_created">;
-  export type MessageAutoDeleteTimerChangedMessage =
-    & ServiceMessage
-    & MsgWith<"message_auto_delete_timer_changed">;
-  export type MigrateToChatIdMessage =
-    & ServiceMessage
-    & MsgWith<"migrate_to_chat_id">;
-  export type MigrateFromChatIdMessage =
-    & ServiceMessage
-    & MsgWith<"migrate_from_chat_id">;
+  export type DeleteChatPhotoMessage = ServiceMessage &
+    MsgWith<"delete_chat_photo">;
+  export type GroupChatCreatedMessage = ServiceMessage &
+    MsgWith<"group_chat_created">;
+  export type SupergroupChatCreated = ServiceMessage &
+    MsgWith<"supergroup_chat_created">;
+  export type ChannelChatCreatedMessage = ServiceMessage &
+    MsgWith<"channel_chat_created">;
+  export type MessageAutoDeleteTimerChangedMessage = ServiceMessage &
+    MsgWith<"message_auto_delete_timer_changed">;
+  export type MigrateToChatIdMessage = ServiceMessage &
+    MsgWith<"migrate_to_chat_id">;
+  export type MigrateFromChatIdMessage = ServiceMessage &
+    MsgWith<"migrate_from_chat_id">;
   export type PinnedMessageMessage = ServiceMessage & MsgWith<"pinned_message">;
   export type InvoiceMessage = ServiceMessage & MsgWith<"invoice">;
-  export type SuccessfulPaymentMessage =
-    & ServiceMessage
-    & MsgWith<"successful_payment">;
-  export type ConnectedWebsiteMessage =
-    & ServiceMessage
-    & MsgWith<"connected_website">;
+  export type SuccessfulPaymentMessage = ServiceMessage &
+    MsgWith<"successful_payment">;
+  export type ConnectedWebsiteMessage = ServiceMessage &
+    MsgWith<"connected_website">;
   export type PassportDataMessage = ServiceMessage & MsgWith<"passport_data">;
-  export type ProximityAlertTriggeredMessage =
-    & ServiceMessage
-    & MsgWith<"proximity_alert_triggered">;
-  export type VoiceChatScheduledMessage =
-    & ServiceMessage
-    & MsgWith<"voice_chat_scheduled">;
-  export type VoiceChatStartedMessage =
-    & ServiceMessage
-    & MsgWith<"voice_chat_started">;
-  export type VoiceChatEndedMessage =
-    & ServiceMessage
-    & MsgWith<"voice_chat_ended">;
-  export type VoiceChatParticipantsInvitedMessage =
-    & ServiceMessage
-    & MsgWith<"voice_chat_participants_invited">;
+  export type ProximityAlertTriggeredMessage = ServiceMessage &
+    MsgWith<"proximity_alert_triggered">;
+  export type VideoChatScheduledMessage = ServiceMessage &
+    MsgWith<"video_chat_scheduled">;
+  export type VideoChatStartedMessage = ServiceMessage &
+    MsgWith<"video_chat_started">;
+  export type VideoChatEndedMessage = ServiceMessage &
+    MsgWith<"video_chat_ended">;
+  export type VideoChatParticipantsInvitedMessage = ServiceMessage &
+    MsgWith<"video_chat_participants_invited">;
+  export type WebAppDataMessage = ServiceMessage & MsgWith<"web_app_data">;
 }
 
 type ReplyMessage = Message & { reply_to_message: undefined };
@@ -197,13 +182,16 @@ export interface Message extends Message.MediaMessage {
   /** Service message. A user in the chat triggered another user's proximity alert while sharing Live Location. */
   proximity_alert_triggered?: ProximityAlertTriggered;
   /** Service message: voice chat scheduled */
-  voice_chat_scheduled?: VoiceChatScheduled;
-  /** Service message: voice chat started */
-  voice_chat_started?: VoiceChatStarted;
-  /** Service message: voice chat ended */
-  voice_chat_ended?: VoiceChatEnded;
-  /** Service message: new participants invited to a voice chat */
-  voice_chat_participants_invited?: VoiceChatParticipantsInvited;
+  /** Service message: video chat scheduled */
+  video_chat_scheduled?: VideoChatScheduled;
+  /** Service message: video chat started */
+  video_chat_started?: VideoChatStarted;
+  /** Service message: video chat ended */
+  video_chat_ended?: VideoChatEnded;
+  /** Service message: new participants invited to a video chat */
+  video_chat_participants_invited?: VideoChatParticipantsInvited;
+  /** Service message: data sent by a Web App */
+  web_app_data?: WebAppData;
 }
 
 /** This object represents a unique message identifier. */
@@ -212,6 +200,12 @@ export interface MessageId {
   message_id: number;
 }
 
+/** Contains information about an inline message sent by a Web App on behalf of a user. */
+export interface SentWebAppMessage {
+  /** Identifier of the sent inline message. Available only if there is an inline keyboard attached to the message. */
+  inline_message_id: string;
+}
+
 /** The Bot API supports basic formatting for messages. You can use bold, italic, underlined, strikethrough, and spoiler text, as well as inline links and pre-formatted code in your bots' messages. Telegram clients will render them accordingly. You can use either markdown-style or HTML-style formatting.
 
 Note that Telegram clients will display an **alert** to the user before opening an inline link ('Open this link?' together with the full URL).
@@ -262,7 +256,7 @@ To use this mode, pass *HTML* in the *parse_mode* field. The following tags are
 <i>italic</i>, <em>italic</em>
 <u>underline</u>, <ins>underline</ins>
 <s>strikethrough</s>, <strike>strikethrough</strike>, <del>strikethrough</del>
-<span class="tg-spoiler">spoiler</span>
+<span class="tg-spoiler">spoiler</span>, <tg-spoiler>spoiler</tg-spoiler>
 <b>bold <i>italic bold <s>italic bold strikethrough <span class="tg-spoiler">italic bold strikethrough spoiler</span></s> <u>underline italic bold</u></i> bold</b>
 <a href="http://www.example.com/">inline URL</a>
 <a href="tg://user?id=123456789">inline mention of a user</a>
@@ -305,7 +299,7 @@ export type ParseMode = "Markdown" | "MarkdownV2" | "HTML";
 
 export namespace MessageEntity {
   interface AbstractMessageEntity {
-    /** Type of the entity. Currently, can be “mention” (@username), “hashtag” (#hashtag), “cashtag” ($USD), “bot_command” (/start@jobs_bot), “url” (https://telegram.org), “email” (do-not-reply@telegram.org), “phone_number” (+1-212-555-0123), “bold” (bold text), “italic” (italic text), “underline” (underlined text), “strikethrough” (strikethrough text), “spoiler” (spoiler message), “code” (monowidth string), “pre” (monowidth block), “text_link” (for clickable text URLs), “text_mention” (for users without usernames) */
+    /** Type of the entity. Currently, can be "mention" (@username), "hashtag" (#hashtag), "cashtag" ($USD), "bot_command" (/start@jobs_bot), "url" (https://telegram.org), "email" (do-not-reply@telegram.org), "phone_number" (+1-212-555-0123), "bold" (bold text), "italic" (italic text), "underline" (underlined text), "strikethrough" (strikethrough text), "spoiler" (spoiler message), "code" (monowidth string), "pre" (monowidth block), "text_link" (for clickable text URLs), "text_mention" (for users without usernames) */
     type: string;
     /** Offset in UTF-16 code units to the start of the entity */
     offset: number;
@@ -330,17 +324,17 @@ export namespace MessageEntity {
   }
   export interface TextLinkMessageEntity extends AbstractMessageEntity {
     type: "text_link";
-    /** For “text_link” only, url that will be opened after user taps on the text */
+    /** For "text_link" only, url that will be opened after user taps on the text */
     url: string;
   }
   export interface TextMentionMessageEntity extends AbstractMessageEntity {
     type: "text_mention";
-    /** For “text_mention” only, the mentioned user */
+    /** For "text_mention" only, the mentioned user */
     user: User;
   }
   export interface PreMessageEntity extends AbstractMessageEntity {
     type: "pre";
-    /** For “pre” only, the programming language of the entity text */
+    /** For "pre" only, the programming language of the entity text */
     language?: string;
   }
 }
@@ -496,7 +490,7 @@ export interface Contact {
 export interface Dice {
   /** Emoji on which the dice throw animation is based */
   emoji: string;
-  /** Value of the dice, 1-6 for “🎲”, “🎯” and “🎳” base emoji, 1-5 for “🏀” and “⚽” base emoji, 1-64 for “🎰” base emoji */
+  /** Value of the dice, 1-6 for "🎲", "🎯" and "🎳" base emoji, 1-5 for "🏀" and "⚽" base emoji, 1-64 for "🎰" base emoji */
   value: number;
 }
 
@@ -532,7 +526,7 @@ export interface Poll {
   is_closed: boolean;
   /** True, if the poll is anonymous */
   is_anonymous: boolean;
-  /** Poll type, currently can be “regular” or “quiz” */
+  /** Poll type, currently can be "regular" or "quiz" */
   type: "regular" | "quiz";
   /** True, if the poll allows multiple answers */
   allows_multiple_answers: boolean;
@@ -574,7 +568,7 @@ export interface Venue {
   address: string;
   /** Foursquare identifier of the venue */
   foursquare_id?: string;
-  /** Foursquare type of the venue. (For example, “arts_entertainment/default”, “arts_entertainment/aquarium” or “food/icecream”.) */
+  /** Foursquare type of the venue. (For example, "arts_entertainment/default", "arts_entertainment/aquarium" or "food/icecream".) */
   foursquare_type?: string;
   /** Google Places identifier of the venue */
   google_place_id?: string;
@@ -598,27 +592,35 @@ export interface MessageAutoDeleteTimerChanged {
   message_auto_delete_time: number;
 }
 
-/** This object represents a service message about a voice chat scheduled in the chat. */
-export interface VoiceChatScheduled {
-  /** Point in time (Unix timestamp) when the voice chat is supposed to be started by a chat administrator */
+/** 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 */
   start_date: number;
 }
 
-/** This object represents a service message about a voice chat started in the chat. Currently holds no information. */
-export interface VoiceChatStarted {}
+/** This object represents a service message about a video chat started in the chat. Currently holds no information. */
+export interface VideoChatStarted {}
 
-/** This object represents a service message about a voice chat ended in the chat. */
-export interface VoiceChatEnded {
-  /** Voice chat duration in seconds */
+/** This object represents a service message about a video chat ended in the chat. */
+export interface VideoChatEnded {
+  /** Video chat duration in seconds */
   duration: number;
 }
 
-/** This object represents a service message about new members invited to a voice chat. */
-export interface VoiceChatParticipantsInvited {
-  /** New members that were invited to the voice chat */
+/** This object represents a service message about new members invited to a video chat. */
+export interface VideoChatParticipantsInvited {
+  /** New members that were invited to the video chat */
   users: User[];
 }
 
+/** Contains data sent from a Web App to the bot. */
+export interface WebAppData {
+  /** The data. Be aware that a bad client can send arbitrary data in this field. */
+  data: string;
+  /** Text of the web_app keyboard button, from which the Web App was opened. Be aware that a bad client can send arbitrary data in this field. */
+  button_text: string;
+}
+
 /** This object represents a sticker. */
 export interface Sticker {
   /** Identifier for this file, which can be used to download or reuse the file */
@@ -631,6 +633,8 @@ export interface Sticker {
   height: number;
   /** True, if the sticker is animated */
   is_animated: boolean;
+  /** True, if the sticker is a video sticker */
+  is_video: boolean;
   /** Sticker thumbnail in the .WEBP or .JPG format */
   thumb?: PhotoSize;
   /** Emoji associated with the sticker */
@@ -651,17 +655,19 @@ export interface StickerSet {
   title: string;
   /** True, if the sticker set contains animated stickers */
   is_animated: boolean;
+  /** True, if the sticker set contains video stickers */
+  is_video: boolean;
   /** True, if the sticker set contains masks */
   contains_masks: boolean;
   /** List of all set stickers */
   stickers: Sticker[];
-  /** Sticker set thumbnail in the .WEBP or .TGS format */
+  /** Sticker set thumbnail in the .WEBP, .TGS, or .WEBM format */
   thumb?: PhotoSize;
 }
 
 /** This object describes the position on faces where a mask should be placed by default. */
 export interface MaskPosition {
-  /** The part of the face relative to which the mask should be placed. One of “forehead”, “eyes”, “mouth”, or “chin”. */
+  /** The part of the face relative to which the mask should be placed. One of "forehead", "eyes", "mouth", or "chin". */
   point: "forehead" | "eyes" | "mouth" | "chin";
   /** Shift by X-axis measured in widths of the mask scaled to the face size, from left to right. For example, choosing -1.0 will place mask just to the left of the default mask position. */
   x_shift: number;

package/package.json

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

package/passport.d.ts

@@ -20,7 +20,7 @@ export interface PassportFile {
 
 /** Contains information about documents or other Telegram Passport elements shared with the bot by the user. */
 export interface EncryptedPassportElement {
-  /** Element type. One of “personal_details”, “passport”, “driver_license”, “identity_card”, “internal_passport”, “address”, “utility_bill”, “bank_statement”, “rental_agreement”, “passport_registration”, “temporary_registration”, “phone_number”, “email”. */
+  /** Element type. One of "personal_details", "passport", "driver_license", "identity_card", "internal_passport", "address", "utility_bill", "bank_statement", "rental_agreement", "passport_registration", "temporary_registration", "phone_number", "email". */
   type:
     | "personal_details"
     | "passport"
@@ -35,21 +35,21 @@ export interface EncryptedPassportElement {
     | "temporary_registration"
     | "phone_number"
     | "email";
-  /** Base64-encoded encrypted Telegram Passport element data provided by the user, available for “personal_details”, “passport”, “driver_license”, “identity_card”, “internal_passport” and “address” types. Can be decrypted and verified using the accompanying EncryptedCredentials. */
+  /** Base64-encoded encrypted Telegram Passport element data provided by the user, available for "personal_details", "passport", "driver_license", "identity_card", "internal_passport" and "address" types. Can be decrypted and verified using the accompanying EncryptedCredentials. */
   data?: string;
-  /** User's verified phone number, available only for “phone_number” type */
+  /** User's verified phone number, available only for "phone_number" type */
   phone_number?: string;
-  /** User's verified email address, available only for “email” type */
+  /** User's verified email address, available only for "email" type */
   email?: string;
-  /** Array of encrypted files with documents provided by the user, available for “utility_bill”, “bank_statement”, “rental_agreement”, “passport_registration” and “temporary_registration” types. Files can be decrypted and verified using the accompanying EncryptedCredentials. */
+  /** Array of encrypted files with documents provided by the user, available for "utility_bill", "bank_statement", "rental_agreement", "passport_registration" and "temporary_registration" types. Files can be decrypted and verified using the accompanying EncryptedCredentials. */
   files?: PassportFile[];
-  /** Encrypted file with the front side of the document, provided by the user. Available for “passport”, “driver_license”, “identity_card” and “internal_passport”. The file can be decrypted and verified using the accompanying EncryptedCredentials. */
+  /** Encrypted file with the front side of the document, provided by the user. Available for "passport", "driver_license", "identity_card" and "internal_passport". The file can be decrypted and verified using the accompanying EncryptedCredentials. */
   front_side?: PassportFile;
-  /** Encrypted file with the reverse side of the document, provided by the user. Available for “driver_license” and “identity_card”. The file can be decrypted and verified using the accompanying EncryptedCredentials. */
+  /** Encrypted file with the reverse side of the document, provided by the user. Available for "driver_license" and "identity_card". The file can be decrypted and verified using the accompanying EncryptedCredentials. */
   reverse_side?: PassportFile;
-  /** Encrypted file with the selfie of the user holding a document, provided by the user; available for “passport”, “driver_license”, “identity_card” and “internal_passport”. The file can be decrypted and verified using the accompanying EncryptedCredentials. */
+  /** Encrypted file with the selfie of the user holding a document, provided by the user; available for "passport", "driver_license", "identity_card" and "internal_passport". The file can be decrypted and verified using the accompanying EncryptedCredentials. */
   selfie?: PassportFile;
-  /** Array of encrypted files with translated versions of documents provided by the user. Available if requested for “passport”, “driver_license”, “identity_card”, “internal_passport”, “utility_bill”, “bank_statement”, “rental_agreement”, “passport_registration” and “temporary_registration” types. Files can be decrypted and verified using the accompanying EncryptedCredentials. */
+  /** Array of encrypted files with translated versions of documents provided by the user. Available if requested for "passport", "driver_license", "identity_card", "internal_passport", "utility_bill", "bank_statement", "rental_agreement", "passport_registration" and "temporary_registration" types. Files can be decrypted and verified using the accompanying EncryptedCredentials. */
   translation?: PassportFile[];
   /** Base64-encoded element hash for using in PassportElementErrorUnspecified */
   hash: string;
@@ -91,7 +91,7 @@ export type PassportElementError =
 export interface PassportElementErrorDataField {
   /** Error source, must be data */
   source: "data";
-  /** The section of the user's Telegram Passport which has the error, one of “personal_details”, “passport”, “driver_license”, “identity_card”, “internal_passport”, “address” */
+  /** The section of the user's Telegram Passport which has the error, one of "personal_details", "passport", "driver_license", "identity_card", "internal_passport", "address" */
   type:
     | "personal_details"
     | "passport"
@@ -111,7 +111,7 @@ export interface PassportElementErrorDataField {
 export interface PassportElementErrorFrontSide {
   /** Error source, must be front_side */
   source: "front_side";
-  /** The section of the user's Telegram Passport which has the issue, one of “passport”, “driver_license”, “identity_card”, “internal_passport” */
+  /** The section of the user's Telegram Passport which has the issue, one of "passport", "driver_license", "identity_card", "internal_passport" */
   type: "passport" | "driver_license" | "identity_card" | "internal_passport";
   /** Base64-encoded hash of the file with the front side of the document */
   file_hash: string;
@@ -123,7 +123,7 @@ export interface PassportElementErrorFrontSide {
 export interface PassportElementErrorReverseSide {
   /** Error source, must be reverse_side */
   source: "reverse_side";
-  /** The section of the user's Telegram Passport which has the issue, one of “driver_license”, “identity_card” */
+  /** The section of the user's Telegram Passport which has the issue, one of "driver_license", "identity_card" */
   type: "driver_license" | "identity_card";
   /** Base64-encoded hash of the file with the reverse side of the document */
   file_hash: string;
@@ -135,7 +135,7 @@ export interface PassportElementErrorReverseSide {
 export interface PassportElementErrorSelfie {
   /** Error source, must be selfie */
   source: "selfie";
-  /** The section of the user's Telegram Passport which has the issue, one of “passport”, “driver_license”, “identity_card”, “internal_passport” */
+  /** The section of the user's Telegram Passport which has the issue, one of "passport", "driver_license", "identity_card", "internal_passport" */
   type: "passport" | "driver_license" | "identity_card" | "internal_passport";
   /** Base64-encoded hash of the file with the selfie */
   file_hash: string;
@@ -147,7 +147,7 @@ export interface PassportElementErrorSelfie {
 export interface PassportElementErrorFile {
   /** Error source, must be file */
   source: "file";
-  /** The section of the user's Telegram Passport which has the issue, one of “utility_bill”, “bank_statement”, “rental_agreement”, “passport_registration”, “temporary_registration” */
+  /** The section of the user's Telegram Passport which has the issue, one of "utility_bill", "bank_statement", "rental_agreement", "passport_registration", "temporary_registration" */
   type:
     | "utility_bill"
     | "bank_statement"
@@ -164,7 +164,7 @@ export interface PassportElementErrorFile {
 export interface PassportElementErrorFiles {
   /** Error source, must be files */
   source: "files";
-  /** The section of the user's Telegram Passport which has the issue, one of “utility_bill”, “bank_statement”, “rental_agreement”, “passport_registration”, “temporary_registration” */
+  /** The section of the user's Telegram Passport which has the issue, one of "utility_bill", "bank_statement", "rental_agreement", "passport_registration", "temporary_registration" */
   type:
     | "utility_bill"
     | "bank_statement"
@@ -181,7 +181,7 @@ export interface PassportElementErrorFiles {
 export interface PassportElementErrorTranslationFile {
   /** Error source, must be translation_file */
   source: "translation_file";
-  /** Type of element of the user's Telegram Passport which has the issue, one of “passport”, “driver_license”, “identity_card”, “internal_passport”, “utility_bill”, “bank_statement”, “rental_agreement”, “passport_registration”, “temporary_registration” */
+  /** Type of element of the user's Telegram Passport which has the issue, one of "passport", "driver_license", "identity_card", "internal_passport", "utility_bill", "bank_statement", "rental_agreement", "passport_registration", "temporary_registration" */
   type:
     | "passport"
     | "driver_license"
@@ -202,7 +202,7 @@ export interface PassportElementErrorTranslationFile {
 export interface PassportElementErrorTranslationFiles {
   /** Error source, must be translation_files */
   source: "translation_files";
-  /** Type of element of the user's Telegram Passport which has the issue, one of “passport”, “driver_license”, “identity_card”, “internal_passport”, “utility_bill”, “bank_statement”, “rental_agreement”, “passport_registration”, “temporary_registration” */
+  /** Type of element of the user's Telegram Passport which has the issue, one of "passport", "driver_license", "identity_card", "internal_passport", "utility_bill", "bank_statement", "rental_agreement", "passport_registration", "temporary_registration" */
   type:
     | "passport"
     | "driver_license"