@grammyjs/types 2.12.0 → 3.0.0

package/{menu-button.d.ts → settings.d.ts}

@@ -1,38 +1,40 @@
-import { WebAppInfo } from "./markup";
-
+import type { WebAppInfo } from "./markup.js";
+/** This object represents the bot's description. */
+export interface BotDescription {
+    /** The bot's description */
+    description: string;
+}
+/** This object represents the bot's short description. */
+export interface BotShortDescription {
+    /** The bot's short description */
+    short_description: string;
+}
 /** This object describes the bot's menu button in a private chat. It should be one of
 - MenuButtonCommands
 - MenuButtonWebApp
 - MenuButtonDefault
 
 If a menu button other than MenuButtonDefault is set for a private chat, then it is applied in the chat. Otherwise the default menu button is applied. By default, the menu button opens the list of bot commands. */
-export type MenuButton =
-  | MenuButtonCommands
-  | MenuButtonWebApp
-  | MenuButtonDefault;
-
+export type MenuButton = MenuButtonCommands | MenuButtonWebApp | MenuButtonDefault;
 /** Represents a menu button, which opens the bot's list of commands. */
 export interface MenuButtonCommands {
-  /** Type of the button, must be commands */
-  type: "commands";
+    /** Type of the button, must be commands */
+    type: "commands";
 }
-
 /** Represents a menu button, which launches a Web App. */
 export interface MenuButtonWebApp {
-  /** Button type, must be web_app */
-  type: "web_app";
-  /** Text on the button */
-  text: string;
-  /** Description of the Web App that will be launched when the user presses the button. The Web App will be able to send an arbitrary message on behalf of the user using the method answerWebAppQuery. */
-  web_app: WebAppInfo;
+    /** Button type, must be web_app */
+    type: "web_app";
+    /** Text on the button */
+    text: string;
+    /** Description of the Web App that will be launched when the user presses the button. The Web App will be able to send an arbitrary message on behalf of the user using the method answerWebAppQuery. */
+    web_app: WebAppInfo;
 }
-
 /** Describes that no specific value for the menu button was set. */
 export interface MenuButtonDefault {
-  /** Type of the button, must be default */
-  type: "default";
+    /** Type of the button, must be default */
+    type: "default";
 }
-
 /** This object represents the scope to which bot commands are applied. Currently, the following 7 scopes are supported:
 - BotCommandScopeDefault
 - BotCommandScopeAllPrivateChats
@@ -67,61 +69,47 @@ The following algorithm is used to determine the list of commands for a particul
 - botCommandScopeAllGroupChats
 - botCommandScopeDefault + language_code
 - botCommandScopeDefault */
-export type BotCommandScope =
-  | BotCommandScopeDefault
-  | BotCommandScopeAllPrivateChats
-  | BotCommandScopeAllGroupChats
-  | BotCommandScopeAllChatAdministrators
-  | BotCommandScopeChat
-  | BotCommandScopeChatAdministrators
-  | BotCommandScopeChatMember;
-
+export type BotCommandScope = BotCommandScopeDefault | BotCommandScopeAllPrivateChats | BotCommandScopeAllGroupChats | BotCommandScopeAllChatAdministrators | BotCommandScopeChat | BotCommandScopeChatAdministrators | BotCommandScopeChatMember;
 /** Represents the default scope of bot commands. Default commands are used if no commands with a narrower scope are specified for the user. */
 export interface BotCommandScopeDefault {
-  /** Scope type, must be default */
-  type: "default";
+    /** Scope type, must be default */
+    type: "default";
 }
-
 /** Represents the scope of bot commands, covering all private chats. */
 export interface BotCommandScopeAllPrivateChats {
-  /** Scope type, must be all_private_chats */
-  type: "all_private_chats";
+    /** Scope type, must be all_private_chats */
+    type: "all_private_chats";
 }
-
 /** Represents the scope of bot commands, covering all group and supergroup chats. */
 export interface BotCommandScopeAllGroupChats {
-  /** Scope type, must be all_group_chats */
-  type: "all_group_chats";
+    /** Scope type, must be all_group_chats */
+    type: "all_group_chats";
 }
-
 /** Represents the scope of bot commands, covering all group and supergroup chat administrators. */
 export interface BotCommandScopeAllChatAdministrators {
-  /** Scope type, must be all_chat_administrators */
-  type: "all_chat_administrators";
+    /** Scope type, must be all_chat_administrators */
+    type: "all_chat_administrators";
 }
-
 /** Represents the scope of bot commands, covering a specific chat. */
 export interface BotCommandScopeChat {
-  /** Scope type, must be chat */
-  type: "chat";
-  /** Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername) */
-  chat_id: number | string;
+    /** Scope type, must be chat */
+    type: "chat";
+    /** Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername) */
+    chat_id: number | string;
 }
-
 /** Represents the scope of bot commands, covering all administrators of a specific group or supergroup chat. */
 export interface BotCommandScopeChatAdministrators {
-  /** Scope type, must be chat_administrators */
-  type: "chat_administrators";
-  /** Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername) */
-  chat_id: number | string;
+    /** Scope type, must be chat_administrators */
+    type: "chat_administrators";
+    /** Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername) */
+    chat_id: number | string;
 }
-
 /** Represents the scope of bot commands, covering a specific member of a group or supergroup chat. */
 export interface BotCommandScopeChatMember {
-  /** Scope type, must be chat_member */
-  type: "chat_member";
-  /** 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;
+    /** Scope type, must be chat_member */
+    type: "chat_member";
+    /** 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;
 }

package/update.d.ts

@@ -1,58 +1,56 @@
-import { CallbackQuery } from "./markup";
-import { ChosenInlineResult, InlineQuery } from "./inline";
-import { Chat, ChatJoinRequest, ChatMemberUpdated, User } from "./manage";
-import { Message, Poll, PollAnswer } from "./message";
-import { PreCheckoutQuery, ShippingQuery } from "./payment";
-
+import type { CallbackQuery } from "./markup.js";
+import type { ChosenInlineResult, InlineQuery } from "./inline.js";
+import type { Chat, ChatJoinRequest, ChatMemberUpdated, User } from "./manage.js";
+import type { Message, Poll, PollAnswer } from "./message.js";
+import type { PreCheckoutQuery, ShippingQuery } from "./payment.js";
 /** Internal namespace used to make some message types more accurate */
-export namespace Update {
-  /** Internal type holding properties that message updates in channels share. */
-  export interface Channel {
-    chat: Chat.ChannelChat;
-  }
-  /** Internal type holding properties that message updates outside of channels share. */
-  export interface NonChannel {
-    chat: Exclude<Chat, Chat.ChannelChat>;
-    from: User;
-  }
-  /** Internal type holding properties that updates about edited messages share. */
-  export interface Edited {
-    /** Date the message was last edited in Unix time */
-    edit_date: number;
-  }
+export declare namespace Update {
+    /** Internal type holding properties that message updates in channels share. */
+    interface Channel {
+        chat: Chat.ChannelChat;
+    }
+    /** Internal type holding properties that message updates outside of channels share. */
+    interface NonChannel {
+        chat: Exclude<Chat, Chat.ChannelChat>;
+        from: User;
+    }
+    /** Internal type holding properties that updates about edited messages share. */
+    interface Edited {
+        /** Date the message was last edited in Unix time */
+        edit_date: number;
+    }
 }
-
 /** This object represents an incoming update.
 At most one of the optional parameters can be present in any given update. */
 export interface Update {
-  /** The update's unique identifier. Update identifiers start from a certain positive number and increase sequentially. This ID becomes especially handy if you're using webhooks, since it allows you to ignore repeated updates or to restore the correct update sequence, should they get out of order. If there are no new updates for at least a week, then identifier of the next update will be chosen randomly instead of sequentially. */
-  update_id: number;
-  /** New incoming message of any kind - text, photo, sticker, etc. */
-  message?: Message & Update.NonChannel;
-  /** New version of a message that is known to the bot and was edited */
-  edited_message?: Message & Update.Edited & Update.NonChannel;
-  /** New incoming channel post of any kind - text, photo, sticker, etc. */
-  channel_post?: Message & Update.Channel;
-  /** New version of a channel post that is known to the bot and was edited */
-  edited_channel_post?: Message & Update.Edited & Update.Channel;
-  /** New incoming inline query */
-  inline_query?: InlineQuery;
-  /** The result of an inline query that was chosen by a user and sent to their chat partner. Please see our documentation on the feedback collecting for details on how to enable these updates for your bot. */
-  chosen_inline_result?: ChosenInlineResult;
-  /** New incoming callback query */
-  callback_query?: CallbackQuery;
-  /** New incoming shipping query. Only for invoices with flexible price */
-  shipping_query?: ShippingQuery;
-  /** New incoming pre-checkout query. Contains full information about checkout */
-  pre_checkout_query?: PreCheckoutQuery;
-  /** New poll state. Bots receive only updates about stopped polls and polls, which are sent by the bot */
-  poll?: Poll;
-  /** A user changed their answer in a non-anonymous poll. Bots receive new votes only in polls that were sent by the bot itself. */
-  poll_answer?: PollAnswer;
-  /** The bot's chat member status was updated in a chat. For private chats, this update is received only when the bot is blocked or unblocked by the user. */
-  my_chat_member?: ChatMemberUpdated;
-  /** A chat member's status was updated in a chat. The bot must be an administrator in the chat and must explicitly specify “chat_member” in the list of allowed_updates to receive these updates. */
-  chat_member?: ChatMemberUpdated;
-  /** A request to join the chat has been sent. The bot must have the can_invite_users administrator right in the chat to receive these updates. */
-  chat_join_request?: ChatJoinRequest;
+    /** The update's unique identifier. Update identifiers start from a certain positive number and increase sequentially. This ID becomes especially handy if you're using webhooks, since it allows you to ignore repeated updates or to restore the correct update sequence, should they get out of order. If there are no new updates for at least a week, then identifier of the next update will be chosen randomly instead of sequentially. */
+    update_id: number;
+    /** New incoming message of any kind - text, photo, sticker, etc. */
+    message?: Message & Update.NonChannel;
+    /** New version of a message that is known to the bot and was edited */
+    edited_message?: Message & Update.Edited & Update.NonChannel;
+    /** New incoming channel post of any kind - text, photo, sticker, etc. */
+    channel_post?: Message & Update.Channel;
+    /** New version of a channel post that is known to the bot and was edited */
+    edited_channel_post?: Message & Update.Edited & Update.Channel;
+    /** New incoming inline query */
+    inline_query?: InlineQuery;
+    /** The result of an inline query that was chosen by a user and sent to their chat partner. Please see our documentation on the feedback collecting for details on how to enable these updates for your bot. */
+    chosen_inline_result?: ChosenInlineResult;
+    /** New incoming callback query */
+    callback_query?: CallbackQuery;
+    /** New incoming shipping query. Only for invoices with flexible price */
+    shipping_query?: ShippingQuery;
+    /** New incoming pre-checkout query. Contains full information about checkout */
+    pre_checkout_query?: PreCheckoutQuery;
+    /** New poll state. Bots receive only updates about stopped polls and polls, which are sent by the bot */
+    poll?: Poll;
+    /** A user changed their answer in a non-anonymous poll. Bots receive new votes only in polls that were sent by the bot itself. */
+    poll_answer?: PollAnswer;
+    /** The bot's chat member status was updated in a chat. For private chats, this update is received only when the bot is blocked or unblocked by the user. */
+    my_chat_member?: ChatMemberUpdated;
+    /** A chat member's status was updated in a chat. The bot must be an administrator in the chat and must explicitly specify “chat_member” in the list of allowed_updates to receive these updates. */
+    chat_member?: ChatMemberUpdated;
+    /** A request to join the chat has been sent. The bot must have the can_invite_users administrator right in the chat to receive these updates. */
+    chat_join_request?: ChatJoinRequest;
 }

package/.editorconfig

@@ -1,8 +0,0 @@
-[*]
-end_of_line = lf
-charset = utf-8
-indent_style = space
-indent_size = 2
-insert_final_newline = true
-trim_trailing_whitespace = true
-max_line_length = 80

package/deno.jsonc

@@ -1 +0,0 @@
-{ "fmt": { "options": { "indentWidth": 2, "proseWrap": "preserve" } } }

package/index.d.ts

@@ -1,10 +0,0 @@
-export * from "./api";
-export * from "./inline";
-export * from "./manage";
-export * from "./markup";
-export * from "./menu-button";
-export * from "./message";
-export * from "./passport";
-export * from "./payment";
-export * from "./proxied";
-export * from "./update";