@grammyjs/types 2.4.4 → 2.5.1

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

@@ -11,7 +11,7 @@ export namespace Message {
     message_id: number;
     /** Sender of the message; empty for messages sent to channels. For backward compatibility, the field contains a fake sender user in non-channel chats, if the message was sent on behalf of a chat. */
     from?: User;
-    /** Sender of the message, sent on behalf of a chat. For backward compatibility, the field from contains a fake sender user in non-channel chats, if the message was sent on behalf of a chat. */
+    /** Sender of the message, sent on behalf of a chat. For example, the channel itself for channel posts, the supergroup itself for messages from anonymous group administrators, the linked channel for messages automatically forwarded to the discussion group. For backward compatibility, the field from contains a fake sender user in non-channel chats, if the message was sent on behalf of a chat. */
     sender_chat?: Chat;
     /** Date the message was sent in Unix time */
     date: number;
@@ -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>
+<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 {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@grammyjs/types",
-  "version": "2.4.4",
+  "version": "2.5.1",
   "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 */
@@ -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 */
@@ -1215,6 +1249,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 +1299,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 */