@grammyjs/types 3.24.0 → 3.25.0

package/manage.d.ts

@@ -660,6 +660,8 @@ export interface ChatAdministratorRights {
     can_change_info: boolean;
     /** True, if the user is allowed to invite new users to the chat */
     can_invite_users: boolean;
+    /** True, if the administrator can edit the tags of regular members; for groups and supergroups only. If omitted defaults to the value of can_pin_messages. */
+    can_manage_tags?: boolean;
     /** True, if the administrator can post stories to the chat */
     can_post_stories: boolean;
     /** True, if the administrator can edit stories posted by other users, post stories to the chat page, pin chat stories, and access the chat's story archive */
@@ -739,6 +741,8 @@ export interface ChatMemberAdministrator {
     can_change_info: boolean;
     /** True, if the user is allowed to invite new users to the chat */
     can_invite_users: boolean;
+    /** True, if the administrator can edit the tags of regular members; for groups and supergroups only. If omitted defaults to the value of can_pin_messages. */
+    can_manage_tags?: boolean;
     /** True, if the administrator can post stories to the chat */
     can_post_stories: boolean;
     /** True, if the administrator can edit stories posted by other users, post stories to the chat page, pin chat stories, and access the chat's story archive */
@@ -764,6 +768,8 @@ export interface ChatMemberMember {
     status: "member";
     /** Information about the user */
     user: User;
+    /** Tag of the member */
+    tag?: string;
     /** Date when the user's subscription will expire; Unix time */
     until_date?: number;
 }
@@ -773,6 +779,8 @@ export interface ChatMemberRestricted {
     status: "restricted";
     /** Information about the user */
     user: User;
+    /** Tag of the member */
+    tag?: string;
     /** 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, giveaways, giveaway winners, invoices, locations and venues */
@@ -799,6 +807,8 @@ export interface ChatMemberRestricted {
     can_change_info: boolean;
     /** True, if the user is allowed to invite new users to the chat */
     can_invite_users: boolean;
+    /** True, if the user is allowed to edit their own tag */
+    can_edit_tag: boolean;
     /** True, if the user is allowed to pin messages */
     can_pin_messages: boolean;
     /** True, if the user is allowed to create forum topics */
@@ -863,6 +873,8 @@ export interface ChatPermissions {
     can_change_info?: boolean;
     /** True, if the user is allowed to invite new users to the chat */
     can_invite_users?: boolean;
+    /** True, if the user is allowed to edit their own tag */
+    can_edit_tag?: boolean;
     /** True, if the user is allowed to pin messages. Ignored in public supergroups */
     can_pin_messages?: boolean;
     /** True, if the user is allowed to create forum topics. If omitted defaults to the value of can_pin_messages */

package/message.d.ts

@@ -26,6 +26,8 @@ export declare namespace Message {
         direct_messages_topic?: DirectMessagesTopic;
     }
     interface CommonMessage extends ServiceMessage {
+        /** Tag or custom title of the sender of the message; for supergroups only */
+        sender_tag?: string;
         /** If the sender of the message boosted the chat, the number of boosts added by the user */
         sender_boost_count?: number;
         /** The bot that actually sent the message on behalf of the business account. Available only for outgoing messages sent on behalf of the connected business account. */
@@ -74,7 +76,7 @@ export declare namespace Message {
         caption_entities?: MessageEntity[];
     }
     interface MediaMessage extends CaptionableMessage {
-        /** The unique identifier of a media message group this message belongs to */
+        /** The unique identifier inside this chat 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;
@@ -341,6 +343,19 @@ Links `tg://user?id=<user_id>` can be used to mention a user by their identifier
 
 You can find the list of programming and markup languages for which syntax highlighting is supported at [libprisma#supported-languages](https://github.com/TelegramMessenger/libprisma#supported-languages).
 
+#### Date-time entity formatting
+
+Date-time entity formatting is specified by a format string, which must adhere to the following regular expression: `r|w?[dD]?[tT]?`.
+
+If the format string is empty, the underlying text is displayed as-is; however, the user can still receive the underlying date in their local format. When populated, the format string determines the output based on the presence of the following control characters:
+
+- `r`: Displays the time relative to the current time. Cannot be combined with any other control characters.
+- `w`: Displays the day of the week in the user's localized language.
+- `d`: Displays the date in short form (e.g., “17.03.22”).
+- `D`: Displays the date in long form (e.g., “March 17, 2022”).
+- `t`: Displays the time in short form (e.g., “22:45”).
+- `T`: Displays the time in long form (e.g., “22:45:00”).
+
 #### MarkdownV2 style
 To use this mode, pass *MarkdownV2* in the *parse_mode* field. Use the following syntax in your message:
 
@@ -354,6 +369,10 @@ __underline__
 [inline URL](http://www.example.com/)
 [inline mention of a user](tg://user?id=123456789)
 ![👍](tg://emoji?id=5368324170671202286)
+![22:45 tomorrow](tg://time?unix=1647531900&format=wDT)
+![22:45 tomorrow](tg://time?unix=1647531900&format=t)
+![22:45 tomorrow](tg://time?unix=1647531900&format=r)
+![22:45 tomorrow](tg://time?unix=1647531900)
 `inline fixed-width code`
 `​`​`
 pre-formatted fixed-width code block
@@ -382,6 +401,7 @@ Please note:
 - In case of ambiguity between `italic` and `underline` entities `__` is always greedily treated from left to right as beginning or end of an `underline` entity, so instead of `___italic underline___` use `___italic underline_**__`, adding an empty bold entity as a separator.
 - A valid emoji must be provided as an alternative value for the custom emoji. The emoji will be shown instead of the custom emoji in places where a custom emoji cannot be displayed (e.g., system notifications) or if the message is forwarded by a non-premium user. It is recommended to use the emoji from the emoji field of the custom emoji sticker.
 - Custom emoji entities can only be used by bots that purchased additional usernames on Fragment.
+- See date-time entity formatting for more details about supported date-time formats.
 
 #### HTML style
 To use this mode, pass *HTML* in the *parse_mode* field. The following tags are currently supported:
@@ -396,6 +416,10 @@ To use this mode, pass *HTML* in the *parse_mode* field. The following tags are
 <a href="http://www.example.com/">inline URL</a>
 <a href="tg://user?id=123456789">inline mention of a user</a>
 <tg-emoji emoji-id="5368324170671202286">👍</tg-emoji>
+<tg-time unix="1647531900" format="wDT">22:45 tomorrow</tg-time>
+<tg-time unix="1647531900" format="t">22:45 tomorrow</tg-time>
+<tg-time unix="1647531900" format="r">22:45 tomorrow</tg-time>
+<tg-time unix="1647531900">22:45 tomorrow</tg-time>
 <code>inline fixed-width code</code>
 <pre>pre-formatted fixed-width code block</pre>
 <pre><code class="language-python">pre-formatted fixed-width code block written in the Python programming language</code></pre>
@@ -412,6 +436,7 @@ Please note:
 - Programming language can't be specified for standalone `code` tags.
 - A valid emoji must be used as the content of the tg-emoji tag. The emoji will be shown instead of the custom emoji in places where a custom emoji cannot be displayed (e.g., system notifications) or if the message is forwarded by a non-premium user. It is recommended to use the emoji from the emoji field of the custom emoji sticker.
 - Custom emoji entities can only be used by bots that purchased additional usernames on Fragment.
+- See date-time entity formatting for more details about supported date-time formats.
 
 #### Markdown style
 This is a legacy mode, retained for backward compatibility. To use this mode, pass *Markdown* in the *parse_mode* field. Use the following syntax in your message:
@@ -438,7 +463,7 @@ Please note:
 export type ParseMode = "Markdown" | "MarkdownV2" | "HTML";
 export declare namespace MessageEntity {
     interface AbstractMessageEntity {
-        /** Type of the entity. Currently, can be “mention” (`@username`), “hashtag” (#hashtag or `#hashtag@chatusername`), “cashtag” ($USD or `$USD@chatusername`), “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), “blockquote” (block quotation), “expandable_blockquote” (collapsed-by-default block quotation), “code” (monowidth string), “pre” (monowidth block), “text_link” (for clickable text URLs), “text_mention” (for users without usernames), “custom_emoji” (for inline custom emoji stickers) */
+        /** Type of the entity. Currently, can be “mention” (@username), “hashtag” (#hashtag or #hashtag@chatusername), “cashtag” ($USD or $USD@chatusername), “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), “blockquote” (block quotation), “expandable_blockquote” (collapsed-by-default block quotation), “code” (monowidth string), “pre” (monowidth block), “text_link” (for clickable text URLs), “text_mention” (for users without usernames), “custom_emoji” (for inline custom emoji stickers), or “date_time” (for formatted date and time) */
         type: string;
         /** Offset in UTF-16 code units to the start of the entity */
         offset: number;
@@ -468,9 +493,16 @@ export declare namespace MessageEntity {
         /** For “custom_emoji” only, unique identifier of the custom emoji. Use getCustomEmojiStickers to get full information about the sticker */
         custom_emoji_id: string;
     }
+    interface DateTimeMessageEntity extends AbstractMessageEntity {
+        type: "date_time";
+        /** For “date_time” only, the Unix time associated with the entity */
+        unix_time: number;
+        /** For “date_time” only, the string that defines the formatting of the date and time. See date-time entity formatting for more details. */
+        date_time_format: "r" | `${"w" | ""}${"d" | "D" | ""}${"t" | "T" | ""}`;
+    }
 }
 /** This object represents one special entity in a text message. For example, hashtags, usernames, URLs, etc. */
-export type MessageEntity = MessageEntity.CommonMessageEntity | MessageEntity.CustomEmojiMessageEntity | MessageEntity.PreMessageEntity | MessageEntity.TextLinkMessageEntity | MessageEntity.TextMentionMessageEntity;
+export type MessageEntity = MessageEntity.CommonMessageEntity | MessageEntity.CustomEmojiMessageEntity | MessageEntity.PreMessageEntity | MessageEntity.TextLinkMessageEntity | MessageEntity.TextMentionMessageEntity | MessageEntity.DateTimeMessageEntity;
 /** This object contains information about the quoted part of a message that is replied to by the given message. */
 export interface TextQuote {
     /** Text of the quoted part of a message that is replied to by the given message */

package/methods.d.ts

@@ -110,7 +110,7 @@ export type ApiMethods<F> = {
         /** @deprecated Use `reply_parameters` instead. */
         reply_to_message_id?: number;
     }): Message.TextMessage;
-    /** Use this method to stream a partial message to a user while the message is being generated; supported only for bots with forum topic mode enabled. Returns True on success. */
+    /** Use this method to stream a partial message to a user while the message is being generated. Returns True on success. */
     sendMessageDraft(args: {
         /** Unique identifier for the target private chat */
         chat_id: number;
@@ -966,6 +966,8 @@ export type ApiMethods<F> = {
         can_change_info?: boolean;
         /** Pass True if the administrator can invite new users to the chat */
         can_invite_users?: boolean;
+        /** Pass True if the administrator can edit the tags of regular members; for groups and supergroups only */
+        can_manage_tags?: boolean;
         /** True if the administrator can post stories to the chat */
         can_post_stories?: boolean;
         /** Pass True if the administrator can edit stories posted by other users, post stories to the chat page, pin chat stories, and access the chat's story archive */
@@ -992,6 +994,15 @@ export type ApiMethods<F> = {
         /** New custom title for the administrator; 0-16 characters, emoji are not allowed */
         custom_title: string;
     }): true;
+    /** Use this method to set a tag for a regular member in a group or a supergroup. The bot must be an administrator in the chat for this to work and must have the “can_manage_tags” administrator right. Returns True on success. */
+    setChatMemberTag(args: {
+        /** Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername) */
+        chat_id: number | string;
+        /** Unique identifier of the target user */
+        user_id: number;
+        /** New tag for the member; 0-16 characters, emoji are not allowed */
+        tag?: string;
+    }): true;
     /** Use this method to ban a channel chat in a supergroup or a channel. Until the chat is unbanned, the owner of the banned chat won't be able to send messages on behalf of any of their channels. The bot must be an administrator in the supergroup or channel for this to work and must have the appropriate administrator rights. Returns True on success. */
     banChatSenderChat(args: {
         /** Unique identifier for the target chat or username of the target channel (in the format `@channelusername`) */

package/package.json

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