@telegram.ts/types 1.0.1 → 1.3.0

package/src/botCommandTypes.d.ts

@@ -0,0 +1,184 @@
+import type {
+  WebAppInfo
+} from "./markupTypes.js";
+
+/**
+* This interface represents the name of the bot.
+*/
+export interface BotName {
+  /** The bot's name. */
+  name: string;
+}
+
+/**
+* This interface represents the description of the bot.
+*/
+export interface BotDescription {
+  /** The bot's description. */
+  description: string;
+}
+
+/**
+* This interface represents the short description of the bot.
+*/
+export interface BotShortDescription {
+  /** The bot's short description. */
+  short_description: string;
+}
+
+/**
+* This interface describes the bot's menu button in a private chat.
+* It can be one of the following:
+* - 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;
+
+/**
+* Represents a menu button that opens the bot's list of commands.
+*/
+export interface MenuButtonCommands {
+  /** The type of the button, must be "commands". */
+  type: "commands";
+}
+
+/**
+* Represents a menu button that launches a Web App.
+*/
+export interface MenuButtonWebApp {
+  /** The button type, must be "web_app". */
+  type: "web_app";
+  /** The text on the button. */
+  text: string;
+  /**
+  * The 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 {
+  /** The type of the button, must be "default". */
+  type: "default";
+}
+
+/**
+* This interface represents the scope to which bot commands are applied.
+* Currently, the following 7 scopes are supported:
+* - BotCommandScopeDefault
+* - BotCommandScopeAllPrivateChats
+* - BotCommandScopeAllGroupChats
+* - BotCommandScopeAllChatAdministrators
+* - BotCommandScopeChat
+* - BotCommandScopeChatAdministrators
+* - BotCommandScopeChatMember
+*
+* Determining list of commands:
+* The following algorithm is used to determine the list of commands for a particular user viewing the bot menu.
+* The first list of commands that is set is returned.
+*
+* Commands in the chat with the bot:
+* - botCommandScopeChat + language_code
+* - botCommandScopeChat
+* - botCommandScopeAllPrivateChats + language_code
+* - botCommandScopeAllPrivateChats
+* - botCommandScopeDefault + language_code
+* - botCommandScopeDefault
+*
+* Commands in group and supergroup chats:
+* - botCommandScopeChatMember + language_code
+* - botCommandScopeChatMember
+* - botCommandScopeChatAdministrators + language_code (administrators only)
+* - botCommandScopeChatAdministrators (administrators only)
+* - botCommandScopeChat + language_code
+* - botCommandScopeChat
+* - botCommandScopeAllChatAdministrators + language_code (administrators only)
+* - botCommandScopeAllChatAdministrators (administrators only)
+* - botCommandScopeAllGroupChats + language_code
+* - botCommandScopeAllGroupChats
+* - botCommandScopeDefault + language_code
+* - botCommandScopeDefault
+*/
+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 {
+  /** The scope type, must be "default". */
+  type: "default";
+}
+
+/**
+* Represents the scope of bot commands, covering all private chats.
+*/
+export interface BotCommandScopeAllPrivateChats {
+  /** The 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 {
+  /** The 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 {
+  /** The scope type, must be "all_chat_administrators". */
+  type: "all_chat_administrators";
+}
+
+/**
+* Represents the scope of bot commands, covering a specific chat.
+*/
+export interface BotCommandScopeChat {
+  /** The scope type, must be "chat". */
+  type: "chat";
+  /** The 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 {
+  /** The scope type, must be "chat_administrators". */
+  type: "chat_administrators";
+  /** The 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 {
+  /** The scope type, must be "chat_member". */
+  type: "chat_member";
+  /** The unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername). */
+  chat_id: number | string;
+  /** The unique identifier of the target user. */
+  user_id: number;
+}

package/src/index.d.ts

@@ -1,10 +1,10 @@
-export * from "./api.js";
-export * from "./inline.js";
-export * from "./manage.js";
-export * from "./markup.js";
-export * from "./message.js";
-export * from "./methods.js";
-export * from "./passport.js";
-export * from "./payment.js";
-export * from "./settings.js";
-export * from "./update.js";
+export * from "./telegramTypes.js";
+export * from "./inlineTypes.js";
+export * from "./manageTypes.js";
+export * from "./markupTypes.js";
+export * from "./messageTypes.js";
+export * from "./apiMethodsTypes.js";
+export * from "./passportTypes.js";
+export * from "./invoiceTypes.js";
+export * from "./botCommandTypes.js";
+export * from "./updateTypes.js";

package/src/{inline.d.ts → inlineTypes.d.ts}

@@ -1,19 +1,19 @@
 import type {
   Chat,
   User
-} from "./manage.js";
+} from "./manageTypes.js";
 import type {
   InlineKeyboardMarkup,
   WebAppInfo
-} from "./markup.js";
+} from "./markupTypes.js";
 import type {
   Location,
   MessageEntity,
   ParseMode
-} from "./message.js";
+} from "./messageTypes.js";
 import type {
   LabeledPrice
-} from "./payment.js";
+} from "./invoiceTypes.js";
 /** This object represents an incoming inline query. When the user sends an empty query, your bot could return some default or trending results. */
 export interface InlineQuery {
   /** Unique identifier for this query */

package/src/invoiceTypes.d.ts

@@ -0,0 +1,149 @@
+import type {
+  User
+} from "./manageTypes.js";
+
+/**
+* This interface represents a labeled portion of the price for goods or services.
+*/
+export interface LabeledPrice {
+  /** The label of the portion. */
+  label: string;
+  /**
+  * The price of the product in the smallest units of the currency (integer, not float/double).
+  * For example, for a price of US$ 1.45, the amount would be 145.
+  * See the 'exp' parameter in currencies.json for the number of digits past the decimal point for each currency
+  * (2 for the majority of currencies).
+  */
+  amount: number;
+}
+
+/**
+* This interface contains basic information about an invoice.
+*/
+export interface Invoice {
+  /** The name of the product. */
+  title: string;
+  /** The description of the product. */
+  description: string;
+  /** A unique bot deep-linking parameter that can be used to generate this invoice. */
+  start_parameter: string;
+  /** The three-letter ISO 4217 currency code. */
+  currency: string;
+  /**
+  * The total price in the smallest units of the currency (integer, not float/double).
+  * For example, for a price of US$ 1.45, the total_amount would be 145.
+  * See the 'exp' parameter in currencies.json for the number of digits past the decimal point for each currency
+  * (2 for the majority of currencies).
+  */
+  total_amount: number;
+}
+
+/**
+* This interface represents a shipping address.
+*/
+export interface ShippingAddress {
+  /** The two-letter ISO 3166-1 alpha-2 country code. */
+  country_code: string;
+  /** The state, if applicable. */
+  state: string;
+  /** The city. */
+  city: string;
+  /** The first line for the address. */
+  street_line1: string;
+  /** The second line for the address. */
+  street_line2: string;
+  /** The address postal code. */
+  post_code: string;
+}
+
+/**
+* This interface represents information about an order.
+*/
+export interface OrderInfo {
+  /** The user's name. */
+  name?: string;
+  /** The user's phone number. */
+  phone_number?: string;
+  /** The user's email. */
+  email?: string;
+  /** The user's shipping address. */
+  shipping_address?: ShippingAddress;
+}
+
+/**
+* This interface represents a shipping option.
+*/
+export interface ShippingOption {
+  /** The shipping option identifier. */
+  id: string;
+  /** The title of the option. */
+  title: string;
+  /** The list of price portions. */
+  prices: LabeledPrice[];
+}
+
+/**
+* This interface contains basic information about a successful payment.
+*/
+export interface SuccessfulPayment {
+  /** The three-letter ISO 4217 currency code. */
+  currency: string;
+  /**
+  * The total price in the smallest units of the currency (integer, not float/double).
+  * For example, for a price of US$ 1.45, the total_amount would be 145.
+  * See the 'exp' parameter in currencies.json for the number of digits past the decimal point for each currency
+  * (2 for the majority of currencies).
+  */
+  total_amount: number;
+  /** The bot-specified invoice payload. */
+  invoice_payload: string;
+  /** The identifier of the shipping option chosen by the user. */
+  shipping_option_id?: string;
+  /** The order information provided by the user. */
+  order_info?: OrderInfo;
+  /** The Telegram payment identifier. */
+  telegram_payment_charge_id: string;
+  /** The provider payment identifier. */
+  provider_payment_charge_id:
+
+  string;
+}
+
+/**
+* This interface contains information about an incoming shipping query.
+*/
+export interface ShippingQuery {
+  /** The unique query identifier. */
+  id: string;
+  /** The user who sent the query. */
+  from: User;
+  /** The bot-specified invoice payload. */
+  invoice_payload: string;
+  /** The user-specified shipping address. */
+  shipping_address: ShippingAddress;
+}
+
+/**
+* This interface contains information about an incoming pre-checkout query.
+*/
+export interface PreCheckoutQuery {
+  /** The unique query identifier. */
+  id: string;
+  /** The user who sent the query. */
+  from: User;
+  /** The three-letter ISO 4217 currency code. */
+  currency: string;
+  /**
+  * The total price in the smallest units of the currency (integer, not float/double).
+  * For example, for a price of US$ 1.45, the total_amount would be 145.
+  * See the 'exp' parameter in currencies.json for the number of digits past the decimal point for each currency
+  * (2 for the majority of currencies).
+  */
+  total_amount: number;
+  /** The bot-specified invoice payload. */
+  invoice_payload: string;
+  /** The identifier of the shipping option chosen by the user. */
+  shipping_option_id?: string;
+  /** The order information provided by the user. */
+  order_info?: OrderInfo;
+}

package/src/{manage.d.ts → manageTypes.d.ts}

@@ -2,10 +2,10 @@ import type {
   Location,
   Message,
   PhotoSize
-} from "./message.js";
+} from "./messageTypes.js";
 import type {
   Update
-} from "./update.js";
+} from "./updateTypes.js";
 /** Describes the current status of a webhook. */
 export interface WebhookInfo {
   /** Webhook URL, may be empty if webhook is not set up */

package/src/{markup.d.ts → markupTypes.d.ts}

@@ -1,10 +1,10 @@
 import type {
   ChatAdministratorRights,
   User
-} from "./manage.js";
+} from "./manageTypes.js";
 import type {
   Message
-} from "./message.js";
+} from "./messageTypes.js";
 /** This object represents an inline keyboard that appears right next to the message it belongs to. */
 export interface InlineKeyboardMarkup {
   /** Array of button rows, each represented by an Array of InlineKeyboardButton objects */

package/src/{message.d.ts → messageTypes.d.ts}

@@ -2,17 +2,17 @@ import type {
   Chat,
   File,
   User
-} from "./manage.js";
+} from "./manageTypes.js";
 import type {
   InlineKeyboardMarkup
-} from "./markup.js";
+} from "./markupTypes.js";
 import type {
   PassportData
-} from "./passport.js";
+} from "./passportTypes.js";
 import type {
   Invoice,
   SuccessfulPayment
-} from "./payment.js";
+} from "./invoiceTypes.js";
 type MsgWith < P extends keyof Message > = Record < P, NonNullable < Message[P]>>;
 export declare namespace Message {
   interface ServiceMessage {
@@ -256,12 +256,12 @@ __underline__
 [inline mention of a user](tg://user?id=123456789)
 ![👍](tg://emoji?id=5368324170671202286)
 `inline fixed-width code`
-`​`​`
+```
 pre-formatted fixed-width code block
-`​`​`
-`​`​`python
+```
+```python
 pre-formatted fixed-width code block written in the Python programming language
-`​`​`
+```
 ```
 Please note:
 

package/src/passportTypes.d.ts

@@ -0,0 +1,197 @@
+/** Describes the user's Telegram Passport data shared with the bot. */
+export interface PassportData {
+  /** Array containing information about documents and other Telegram Passport elements shared with the bot. */
+  data: EncryptedPassportElement[];
+  /** Encrypted credentials required to decrypt the data. */
+  credentials: EncryptedCredentials;
+}
+
+/** This object represents a file uploaded to Telegram Passport. Currently, all Telegram Passport files are in JPEG format when decrypted and do not exceed 10MB. */
+export interface PassportFile {
+  /** Identifier for this file, which can be used to download or reuse the file. */
+  file_id: string;
+  /** Unique identifier for this file, which remains the same over time and for different bots. This identifier cannot be used to download or reuse the file. */
+  file_unique_id: string;
+  /** File size in bytes. */
+  file_size: number;
+  /** Unix time when the file was uploaded. */
+  file_date: number;
+}
+
+/** Describes documents or other Telegram Passport elements shared with the bot by the user. */
+export interface EncryptedPassportElement {
+  /** Element type. Possible values are "personal_details", "passport", "driver_license", "identity_card", "internal_passport", "address", "utility_bill", "bank_statement", "rental_agreement", "passport_registration", "temporary_registration", "phone_number", and "email". */
+  type: "personal_details" | "passport" | "driver_license" | "identity_card" | "internal_passport" | "address" | "utility_bill" | "bank_statement" | "rental_agreement" | "passport_registration" | "temporary_registration" | "phone_number" | "email";
+  /** Base64-encoded encrypted Telegram Passport element data provided by the user. This data is available for types "personal_details", "passport", "driver_license", "identity_card", "internal_passport", and "address". It can be decrypted and verified using the accompanying EncryptedCredentials. */
+  data?: string;
+  /** User's verified phone number, available only for type "phone_number". */
+  phone_number?: string;
+  /** User's verified email address, available only for type "email". */
+  email?: string;
+  /** Array of encrypted files with documents provided by the user. This array is available for types "utility_bill", "bank_statement", "rental_agreement", "passport_registration", and "temporary_registration". The 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. This file is available for types "passport", "driver_license", "identity_card", and "internal_passport". It 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. This file is available for types "driver_license" and "identity_card". It 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. This file is available for types "passport", "driver_license", "identity_card", and "internal_passport". It can be decrypted and verified using the accompanying EncryptedCredentials. */
+  selfie?: PassportFile;
+  /** Array of encrypted files with translated versions of documents provided by the user. This array is available for types "passport", "driver_license", "identity_card", "internal_passport", "utility_bill", "bank_statement", "rental_agreement", "passport_registration", and "temporary_registration". The
+
+  files can be decrypted and verified using the accompanying EncryptedCredentials. */
+  translation?: PassportFile[];
+  /** Base64-encoded element hash for use in PassportElementErrorUnspecified. */
+  hash: string;
+}
+
+/** Describes data required for decrypting and authenticating EncryptedPassportElement. See the Telegram Passport Documentation for a complete description of the data decryption and authentication processes. */
+export interface EncryptedCredentials {
+  /** Base64-encoded encrypted JSON-serialized data with the user's payload, data hashes, and secrets required for EncryptedPassportElement decryption and authentication. */
+  data: string;
+  /** Base64-encoded data hash for data authentication. */
+  hash: string;
+  /** Base64-encoded secret encrypted with the bot's public RSA key, required for data decryption. */
+  secret: string;
+}
+
+/** This object represents an error in the Telegram Passport element that was submitted and should be resolved by the user. It can be one of the following:
+- PassportElementErrorDataField
+- PassportElementErrorFrontSide
+- PassportElementErrorReverseSide
+- PassportElementErrorSelfie
+- PassportElementErrorFile
+- PassportElementErrorFiles
+- PassportElementErrorTranslationFile
+- PassportElementErrorTranslationFiles
+- PassportElementErrorUnspecified
+*/
+export type PassportElementError =
+| PassportElementErrorDataField
+| PassportElementErrorFrontSide
+| PassportElementErrorReverseSide
+| PassportElementErrorSelfie
+| PassportElementErrorFile
+| PassportElementErrorFiles
+| PassportElementErrorTranslationFile
+| PassportElementErrorTranslationFiles
+| PassportElementErrorUnspecified;
+
+/** Represents an issue in one of the data fields provided by the user. The error is considered resolved when the field's value changes. */
+export interface PassportElementErrorDataField {
+  /** Error source, must be "data". */
+  source: "data";
+  /** The section of the user's Telegram Passport that has the error. Possible values are "personal_details", "passport", "driver_license", "identity_card", "internal_passport", and "address". */
+  type: "personal_details" | "passport" | "driver_license" | "identity_card" | "internal_passport" | "address";
+  /** Name of the data field that has the error. */
+  field_name: string;
+  /** Base64-encoded data hash. */
+  data_hash: string;
+  /** Error message. */
+  message: string;
+}
+
+/** Represents an issue with the front side of a document. The error is considered resolved when the file with the front side of the document changes. */
+export interface PassportElementErrorFrontSide {
+  /** Error source, must be "front_side". */
+  source: "front_side";
+  /** The section of the user's Telegram Passport that has the issue. Possible values are "passport", "driver_license", "identity_card", and "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;
+  /** Error message. */
+  message: string;
+}
+
+/** Represents an issue with the reverse side of a document. The error is considered resolved when the file with the reverse side of the document changes. */
+export interface PassportElementErrorReverseSide {
+  /** Error source, must be "reverse_side". */
+  source: "reverse_side";
+  /** The section of the user's Telegram Passport that has the issue. Possible values are "driver_license" and "identity_card". */
+  type: "driver_license" | "identity_card";
+  /** Base64-encoded hash of the file with the reverse side
+
+  of the document. */
+  file_hash: string;
+  /** Error message. */
+  message: string;
+}
+
+/** Represents an issue with the selfie with a document. The error is considered resolved when the file with the selfie changes. */
+export interface PassportElementErrorSelfie {
+  /** Error source, must be "selfie". */
+  source: "selfie";
+  /** The section of the user's Telegram Passport that has the issue. Possible values are "passport", "driver_license", "identity_card", and "internal_passport". */
+  type: "passport" | "driver_license" | "identity_card" | "internal_passport";
+  /** Base64-encoded hash of the file with the selfie. */
+  file_hash: string;
+  /** Error message. */
+  message: string;
+}
+
+/** Represents an issue with a document scan. The error is considered resolved when the file with the document scan changes. */
+export interface PassportElementErrorFile {
+  /** Error source, must be "file". */
+  source: "file";
+  /** The section of the user's Telegram Passport that has the issue. Possible values are "utility_bill", "bank_statement", "rental_agreement", "passport_registration", and "temporary_registration". */
+  type: "utility_bill" | "bank_statement" | "rental_agreement" | "passport_registration" | "temporary_registration";
+  /** Base64-encoded file hash. */
+  file_hash: string;
+  /** Error message. */
+  message: string;
+}
+
+/** Represents an issue with a list of scans. The error is considered resolved when the list of files containing the scans changes. */
+export interface PassportElementErrorFiles {
+  /** Error source, must be "files". */
+  source: "files";
+  /** The section of the user's Telegram Passport that has the issue. Possible values are "utility_bill", "bank_statement", "rental_agreement", "passport_registration", and "temporary_registration". */
+  type: "utility_bill" | "bank_statement" | "rental_agreement" | "passport_registration" | "temporary_registration";
+  /** List of base64-encoded file hashes. */
+  file_hashes: string[];
+  /** Error message. */
+  message: string;
+}
+
+/** Represents an issue with one of the files that constitute the translation of a document. The error is considered resolved when the file changes. */
+export interface PassportElementErrorTranslationFile {
+  /** Error source, must be "translation_file". */
+  source: "translation_file";
+  /** Type of element of the user's Telegram Passport that has the issue. Possible values are "passport", "driver_license", "identity_card", "internal_passport", "utility_bill", "bank_statement", "rental_agreement", "passport_registration", and "temporary_registration". */
+  type: "passport" | "driver_license" | "identity_card" | "internal_passport" | "utility_bill" | "bank_statement" | "rental_agreement" | "passport_registration" | "temporary_registration";
+  /** Base64-encoded file hash. */
+  file_hash: string;
+  /** Error message. */
+  message: string;
+}
+
+/** Represents an issue with the translated version of a document. The error is considered resolved when a file with the document translation changes. */
+export interface PassportElementErrorTranslationFiles {
+  /** Error source, must be "translation_files". */
+  source: "translation_files";
+  /** Type of element of the user's Telegram Passport that has the issue. Possible values are "passport", "driver_license", "identity_card", "internal_passport", "utility_bill", "bank_statement", "rental_agreement", "passport_registration", and "temporary_registration". */
+  type: "passport" | "driver_license" | "identity_card" | "internal_passport" | "utility_bill" | "bank_statement" | "rental_agreement" | "passport_registration" | "temporary_registration";
+  /** List of base64-encoded file hashes. */
+  file_hashes: string[];
+  /** Error message. */
+  message: string;
+}
+
+/** Represents an issue in an unspecified element of the Telegram Passport. The error is considered resolved when new data is added. */
+export interface PassportElementErrorUnspecified {
+  /** Error source, must be "unspecified". */
+  source: "unspecified";
+  /** Type of element of the user's Telegram Passport that has the issue. Possible values are "personal_details", "passport", "driver_license", "identity_card", "internal_passport", "address", "utility_bill", "bank_statement", "rental_agreement", "passport_registration", "temporary_registration", "phone_number", and "email". */
+  type: "personal_details" | "passport" | "driver_license" | "identity_card" | "internal_passport" | "address" | "utility_bill" | "bank_statement" | "rental_agreement" | "passport_registration" | "temporary_registration" | "phone_number" | "email";
+  /** Base64-encoded element hash. */
+  element_hash: string;
+  /** Error message. */
+  message: string;
+}
+
+/** This object represents a user's Telegram Passport data. */
+export interface Passport {
+  /** Array with information about documents and other Telegram Passport elements that are shared with the bot. */
+  data: EncryptedPassportElement[];
+  /** Encrypted credentials required to decrypt and authenticate the data. */
+  credentials: EncryptedCredentials;
+}