@grammyjs/types 2.4.5 → 2.6.0

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2021 KnorpelSenf
+Copyright (c) 2022 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

@@ -381,9 +381,9 @@ export interface ChatLocation {
 
 /** This object represents a bot command. */
 export interface BotCommand {
-  /** Text of the command, 1-32 characters. Can contain only lowercase English letters, digits and underscores. */
+  /** Text of the command; 1-32 characters. Can contain only lowercase English letters, digits and underscores. */
   command: string;
-  /** Description of the command, 3-256 characters. */
+  /** Description of the command; 1-256 characters. */
   description: string;
 }
 

package/message.d.ts

@@ -25,7 +25,7 @@ export namespace Message {
     forward_from_chat?: Chat;
     /** For messages forwarded from channels, identifier of the original message in the channel */
     forward_from_message_id?: number;
-    /** For messages forwarded from channels, signature of the post author if present */
+    /** For forwarded messages that were originally sent in channels or by an anonymous chat administrator, signature of the message sender if present */
     forward_signature?: string;
     /** Sender's name for messages forwarded from users who disallow adding a link to their account in forwarded messages */
     forward_sender_name?: string;
@@ -212,13 +212,13 @@ export interface MessageId {
   message_id: number;
 }
 
-/** The Bot API supports basic formatting for messages. You can use bold, italic, underlined and strikethrough 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.
+/** 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).
 
 Message entities can be nested, providing following restrictions are met:
-- If two entities has common characters then one of them is fully contained inside another.
-- bold, italic, underline and strikethrough entities can contain and to be contained in any other entities, except pre and code.
+- If two entities have common characters then one of them is fully contained inside another.
+- bold, italic, underline, strikethrough, and spoiler entities can contain and can be part of any other entities, except pre and code.
 - All other entities can't contain each other.
 
 Links `tg://user?id=<user_id>` can be used to mention a user by their ID without using a username. Please note:
@@ -234,7 +234,8 @@ To use this mode, pass *MarkdownV2* in the *parse_mode* field. Use the following
 _italic \*text_
 __underline__
 ~strikethrough~
-  *bold _italic bold ~italic bold strikethrough~ __underline italic bold___ bold*
+||spoiler||
+*bold _italic bold ~italic bold strikethrough ||italic bold strikethrough spoiler||~ __underline italic bold___ bold*
 [inline URL](http://www.example.com/)
 [inline mention of a user](tg://user?id=123456789)
 `inline fixed-width code`
@@ -261,7 +262,8 @@ 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>
-<b>bold <i>italic bold <s>italic bold strikethrough</s> <u>underline italic bold</u></i> bold</b>
+<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>
 <code>inline fixed-width code</code>
@@ -303,7 +305,7 @@ export type ParseMode = "Markdown" | "MarkdownV2" | "HTML";
 
 export namespace MessageEntity {
   interface AbstractMessageEntity {
-    /** Type of the entity. 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), “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;
@@ -323,6 +325,7 @@ export namespace MessageEntity {
       | "italic"
       | "underline"
       | "strikethrough"
+      | "spoiler"
       | "code";
   }
   export interface TextLinkMessageEntity extends AbstractMessageEntity {
@@ -628,6 +631,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 */
@@ -648,11 +653,13 @@ 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;
 }
 

package/package.json

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

package/proxied.d.ts

@@ -124,6 +124,8 @@ export interface InputFileProxy<F> {
       disable_web_page_preview?: 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 */
+      protect_content?: boolean;
       /** If the message is a reply, ID of the original message */
       reply_to_message_id?: number;
       /** Pass True, if the message should be sent even if the specified replied-to message is not found */
@@ -144,6 +146,8 @@ export interface InputFileProxy<F> {
       from_chat_id: number | string;
       /** Sends the message silently. Users will receive a notification with no sound. */
       disable_notification?: boolean;
+      /** Protects the contents of the forwarded message from forwarding and saving */
+      protect_content?: boolean;
       /** Message identifier in the chat specified in from_chat_id */
       message_id: number;
     }): Message;
@@ -164,6 +168,8 @@ export interface InputFileProxy<F> {
       caption_entities?: MessageEntity[];
       /** 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 */
+      protect_content?: boolean;
       /** If the message is a reply, ID of the original message */
       reply_to_message_id?: number;
       /** Pass True, if the message should be sent even if the specified replied-to message is not found */
@@ -190,6 +196,8 @@ export interface InputFileProxy<F> {
       caption_entities?: MessageEntity[];
       /** 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 */
+      protect_content?: boolean;
       /** If the message is a reply, ID of the original message */
       reply_to_message_id?: number;
       /** Pass True, if the message should be sent even if the specified replied-to message is not found */
@@ -226,6 +234,8 @@ export interface InputFileProxy<F> {
       thumb?: F;
       /** 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 */
+      protect_content?: boolean;
       /** If the message is a reply, ID of the original message */
       reply_to_message_id?: number;
       /** Pass True, if the message should be sent even if the specified replied-to message is not found */
@@ -256,6 +266,8 @@ export interface InputFileProxy<F> {
       disable_content_type_detection?: 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 */
+      protect_content?: boolean;
       /** If the message is a reply, ID of the original message */
       reply_to_message_id?: number;
       /** Pass True, if the message should be sent even if the specified replied-to message is not found */
@@ -292,6 +304,8 @@ export interface InputFileProxy<F> {
       supports_streaming?: 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 */
+      protect_content?: boolean;
       /** If the message is a reply, ID of the original message */
       reply_to_message_id?: number;
       /** Pass True, if the message should be sent even if the specified replied-to message is not found */
@@ -326,6 +340,8 @@ export interface InputFileProxy<F> {
       caption_entities?: MessageEntity[];
       /** 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 */
+      protect_content?: boolean;
       /** If the message is a reply, ID of the original message */
       reply_to_message_id?: number;
       /** Pass True, if the message should be sent even if the specified replied-to message is not found */
@@ -354,6 +370,8 @@ export interface InputFileProxy<F> {
       duration?: number;
       /** 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 */
+      protect_content?: boolean;
       /** If the message is a reply, ID of the original message */
       reply_to_message_id?: number;
       /** Pass True, if the message should be sent even if the specified replied-to message is not found */
@@ -381,6 +399,8 @@ export interface InputFileProxy<F> {
       thumb?: F;
       /** 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 */
+      protect_content?: boolean;
       /** If the message is a reply, ID of the original message */
       reply_to_message_id?: number;
       /** Pass True, if the message should be sent even if the specified replied-to message is not found */
@@ -406,6 +426,8 @@ export interface InputFileProxy<F> {
       >;
       /** Sends the messages silently. Users will receive a notification with no sound. */
       disable_notification?: boolean;
+      /** Protects the contents of the sent messages from forwarding and saving */
+      protect_content?: boolean;
       /** If messages are a reply, ID of the original message */
       reply_to_message_id?: number;
       /** Pass True, if the message should be sent even if the specified replied-to message is not found */
@@ -435,6 +457,8 @@ export interface InputFileProxy<F> {
       proximity_alert_radius?: number;
       /** 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 */
+      protect_content?: boolean;
       /** If the message is a reply, ID of the original message */
       reply_to_message_id?: number;
       /** Pass True, if the message should be sent even if the specified replied-to message is not found */
@@ -503,6 +527,8 @@ export interface InputFileProxy<F> {
       google_place_type?: string;
       /** 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 */
+      protect_content?: boolean;
       /** If the message is a reply, ID of the original message */
       reply_to_message_id?: number;
       /** Pass True, if the message should be sent even if the specified replied-to message is not found */
@@ -529,6 +555,8 @@ export interface InputFileProxy<F> {
       vcard?: string;
       /** 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 */
+      protect_content?: boolean;
       /** If the message is a reply, ID of the original message */
       reply_to_message_id?: number;
       /** Pass True, if the message should be sent even if the specified replied-to message is not found */
@@ -571,6 +599,8 @@ export interface InputFileProxy<F> {
       is_closed?: 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 */
+      protect_content?: boolean;
       /** If the message is a reply, ID of the original message */
       reply_to_message_id?: number;
       /** Pass True, if the message should be sent even if the specified replied-to message is not found */
@@ -591,6 +621,8 @@ export interface InputFileProxy<F> {
       emoji?: string;
       /** Sends the message silently. Users will receive a notification with no sound. */
       disable_notification?: boolean;
+      /** Protects the contents of the sent message from forwarding */
+      protect_content?: boolean;
       /** If the message is a reply, ID of the original message */
       reply_to_message_id?: number;
       /** Pass True, if the message should be sent even if the specified replied-to message is not found */
@@ -662,7 +694,7 @@ export interface InputFileProxy<F> {
 
     /** Use this method to unban a previously banned user in a supergroup or channel. The user will not return to the group or channel automatically, but will be able to join via link, etc. The bot must be an administrator for this to work. By default, this method guarantees that after the call the user is not a member of the chat, but will be able to join it. So if the user is a member of the chat they will also be removed from the chat. If you don't want this, use the parameter only_if_banned. Returns True on success. */
     unbanChatMember(args: {
-      /** Unique identifier for the target group or username of the target supergroup or channel (in the format @username) */
+      /** Unique identifier for the target group or username of the target supergroup or channel (in the format @channelusername) */
       chat_id: number | string;
       /** Unique identifier of the target user */
       user_id: number;
@@ -1052,7 +1084,7 @@ export interface InputFileProxy<F> {
       message_id: number;
     }): true;
 
-    /** Use this method to send static .WEBP or animated .TGS stickers. On success, the sent Message is returned. */
+    /** Use this method to send static .WEBP, animated .TGS, or video .WEBM stickers. On success, the sent Message is returned. */
     sendSticker(args: {
       /** Unique identifier for the target chat or username of the target channel (in the format @channelusername) */
       chat_id: number | string;
@@ -1060,6 +1092,8 @@ export interface InputFileProxy<F> {
       sticker: F | string;
       /** 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 */
+      protect_content?: boolean;
       /** If the message is a reply, ID of the original message */
       reply_to_message_id?: number;
       /** Pass True, if the message should be sent even if the specified replied-to message is not found */
@@ -1086,7 +1120,7 @@ export interface InputFileProxy<F> {
       png_sticker: F;
     }): File;
 
-    /** Use this method to create a new sticker set owned by a user. The bot will be able to edit the sticker set thus created. You must use exactly one of the fields png_sticker or tgs_sticker. Returns True on success. */
+    /** Use this method to create a new sticker set owned by a user. The bot will be able to edit the sticker set thus created. You must use exactly one of the fields png_sticker, tgs_sticker, or webm_sticker. Returns True on success. */
     createNewStickerSet(args: {
       /** User identifier of created sticker set owner */
       user_id: number;
@@ -1096,8 +1130,10 @@ export interface InputFileProxy<F> {
       title: string;
       /** PNG image with the sticker, must be up to 512 kilobytes in size, dimensions must not exceed 512px, and either width or height must be exactly 512px. Pass a file_id as a String to send a file that already exists on the Telegram servers, pass an HTTP URL as a String for Telegram to get a file from the Internet, or upload a new one using multipart/form-data. */
       png_sticker?: F | string;
-      /** TGS animation with the sticker, uploaded using multipart/form-data. See https://core.telegram.org/animated_stickers#technical-requirements for technical requirements */
+      /** TGS animation with the sticker, uploaded using multipart/form-data. See https://core.telegram.org/stickers#animated-sticker-requirements for technical requirements */
       tgs_sticker?: F;
+      /** WEBM video with the sticker, uploaded using multipart/form-data. See https://core.telegram.org/stickers#video-sticker-requirements for technical requirements */
+      webm_sticker?: F;
       /** One or more emoji corresponding to the sticker */
       emojis: string;
       /** Pass True, if a set of mask stickers should be created */
@@ -1106,7 +1142,7 @@ export interface InputFileProxy<F> {
       mask_position?: MaskPosition;
     }): true;
 
-    /** Use this method to add a new sticker to a set created by the bot. You must use exactly one of the fields png_sticker or tgs_sticker. Animated stickers can be added to animated sticker sets and only to them. Animated sticker sets can have up to 50 stickers. Static sticker sets can have up to 120 stickers. Returns True on success. */
+    /** Use this method to add a new sticker to a set created by the bot. You must use exactly one of the fields png_sticker, tgs_sticker, or webm_sticker. Animated stickers can be added to animated sticker sets and only to them. Animated sticker sets can have up to 50 stickers. Static sticker sets can have up to 120 stickers. Returns True on success. */
     addStickerToSet(args: {
       /** User identifier of sticker set owner */
       user_id: number;
@@ -1114,8 +1150,10 @@ export interface InputFileProxy<F> {
       name: string;
       /** PNG image with the sticker, must be up to 512 kilobytes in size, dimensions must not exceed 512px, and either width or height must be exactly 512px. Pass a file_id as a String to send a file that already exists on the Telegram servers, pass an HTTP URL as a String for Telegram to get a file from the Internet, or upload a new one using multipart/form-data. */
       png_sticker?: F | string;
-      /** TGS animation with the sticker, uploaded using multipart/form-data. See https://core.telegram.org/animated_stickers#technical-requirements for technical requirements */
+      /** TGS animation with the sticker, uploaded using multipart/form-data. See https://core.telegram.org/stickers#animated-sticker-requirements for technical requirements */
       tgs_sticker?: F;
+      /** WEBM video with the sticker, uploaded using multipart/form-data. See https://core.telegram.org/stickers#video-sticker-requirements for technical requirements */
+      webm_sticker?: F;
       /** One or more emoji corresponding to the sticker */
       emojis: string;
       /** An object for position where the mask should be placed on faces */
@@ -1136,14 +1174,14 @@ export interface InputFileProxy<F> {
       sticker: string;
     }): true;
 
-    /** Use this method to set the thumbnail of a sticker set. Animated thumbnails can be set for animated sticker sets only. Returns True on success. */
+    /** Use this method to set the thumbnail of a sticker set. Animated thumbnails can be set for animated sticker sets only. Video thumbnails can be set only for video sticker sets only. Returns True on success. */
     setStickerSetThumb(args: {
       /** Sticker set name */
       name: string;
       /** User identifier of the sticker set owner */
       user_id: number;
-      /** A PNG image with the thumbnail, must be up to 128 kilobytes in size and have width and height exactly 100px, or a TGS animation with the thumbnail up to 32 kilobytes in size; see https://core.telegram.org/animated_stickers#technical-requirements for animated sticker technical requirements. Pass a file_id as a String to send a file that already exists on the Telegram servers, pass an HTTP URL as a String for Telegram to get a file from the Internet, or upload a new one using multipart/form-data.. Animated sticker set thumbnail can't be uploaded via HTTP URL. */
-      thumb: F | string;
+      /** A PNG image with the thumbnail, must be up to 128 kilobytes in size and have width and height exactly 100px, or a TGS animation with the thumbnail up to 32 kilobytes in size; see https://core.telegram.org/stickers#animated-sticker-requirements for animated sticker technical requirements, or a WEBM video with the thumbnail up to 32 kilobytes in size; see https://core.telegram.org/stickers#video-sticker-requirements for video sticker technical requirements. Pass a file_id as a String to send a file that already exists on the Telegram servers, pass an HTTP URL as a String for Telegram to get a file from the Internet, or upload a new one using multipart/form-data. More info on Sending Files ». Animated sticker set thumbnails can't be uploaded via HTTP URL. */
+      thumb?: F | string;
     }): true;
 
     /** Use this method to send answers to an inline query. On success, True is returned.
@@ -1215,6 +1253,8 @@ export interface InputFileProxy<F> {
       is_flexible?: 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 */
+      protect_content?: boolean;
       /** If the message is a reply, ID of the original message */
       reply_to_message_id?: number;
       /** Pass True, if the message should be sent even if the specified replied-to message is not found */
@@ -1263,6 +1303,8 @@ export interface InputFileProxy<F> {
       game_short_name: string;
       /** 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 */
+      protect_content?: boolean;
       /** If the message is a reply, ID of the original message */
       reply_to_message_id?: number;
       /** Pass True, if the message should be sent even if the specified replied-to message is not found */