@telegram.ts/types 1.15.0 → 1.16.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@telegram.ts/types",
-  "version": "1.15.0",
+  "version": "1.16.0",
   "description": "Comprehensive Type Declarations for Telegram Bot API with telegramsjs",
   "main": "./src/index.js",
   "types": "./src/index.d.ts",
@@ -11,7 +11,7 @@
     "api",
     "types"
   ],
-  "homepage": "https://telegramsjs.vercel.app/",
+  "homepage": "https://docs-telegramsjs.vercel.app/",
   "license": "MIT",
   "bugs": {
     "url": "https://github.com/telegramsjs/types/issues"

package/src/apiMethodsTypes.d.ts

@@ -1,9 +1,10 @@
 import type { ReadStream } from "node:fs";
 import type { Buffer } from "node:buffer";
+import type { LanguageCode } from "./languageTypes";
 import type {
   InlineQueryResult,
   InlineQueryResultsButton,
-} from "./inlineTypes.ts";
+} from "./inlineTypes";
 import type {
   BotCommand,
   BusinessConnection,
@@ -19,13 +20,13 @@ import type {
   UserFromGetMe,
   UserProfilePhotos,
   WebhookInfo,
-} from "./manageTypes.ts";
+} from "./manageTypes";
 import type {
   ForceReply,
   InlineKeyboardMarkup,
   ReplyKeyboardMarkup,
   ReplyKeyboardRemove,
-} from "./markupTypes.ts";
+} from "./markupTypes";
 import type {
   File,
   GameHighScore,
@@ -42,21 +43,21 @@ import type {
   SentWebAppMessage,
   Sticker,
   StickerSet,
-} from "./messageTypes.ts";
-import type { PassportElementError } from "./passportTypes.ts";
+} from "./messageTypes";
+import type { PassportElementError } from "./passportTypes";
 import type {
   LabeledPrice,
   ShippingOption,
   StarTransactions,
-} from "./invoiceTypes.ts";
+} from "./invoiceTypes";
 import type {
   BotCommandScope,
   BotDescription,
   BotName,
   BotShortDescription,
   MenuButton,
-} from "./botCommandTypes.ts";
-import type { Update } from "./updateTypes.ts";
+} from "./botCommandTypes";
+import type { Update } from "./updateTypes";
 
 /** Wrapper type to bundle all methods of the Telegram Bot API */
 export type ApiMethods = {
@@ -1296,7 +1297,7 @@ export type ApiMethods = {
     /** An object, describing scope of users for which the commands are relevant. Defaults to BotCommandScopeDefault. */
     scope?: BotCommandScope;
     /** A two-letter ISO 639-1 language code. If empty, commands will be applied to all users from the given scope, for whose language there are no dedicated commands */
-    language_code?: string;
+    language_code?: LanguageCode;
   }): true;
 
   /** Use this method to delete the list of the bot's commands for the given scope and user language. After deletion, higher level commands will be shown to affected users. Returns True on success. */
@@ -1304,7 +1305,7 @@ export type ApiMethods = {
     /** An object, describing scope of users for which the commands are relevant. Defaults to BotCommandScopeDefault. */
     scope?: BotCommandScope;
     /** A two-letter ISO 639-1 language code. If empty, commands will be applied to all users from the given scope, for whose language there are no dedicated commands */
-    language_code?: string;
+    language_code?: LanguageCode;
   }): true;
 
   /** Use this method to get the current list of the bot's commands for the given scope and user language. Returns an Array of BotCommand objects. If commands aren't set, an empty list is returned. */
@@ -1312,7 +1313,7 @@ export type ApiMethods = {
     /** An object, describing scope of users. Defaults to BotCommandScopeDefault. */
     scope?: BotCommandScope;
     /** A two-letter ISO 639-1 language code or an empty string */
-    language_code?: string;
+    language_code?: LanguageCode;
   }): BotCommand[];
 
   /** Use this method to change the bot's name. Returns True on success. */
@@ -1320,13 +1321,13 @@ export type ApiMethods = {
     /** New bot name; 0-64 characters. Pass an empty string to remove the dedicated name for the given language. */
     name?: string;
     /** A two-letter ISO 639-1 language code. If empty, the name will be shown to all users for whose language there is no dedicated name. */
-    language_code?: string;
+    language_code?: LanguageCode;
   }): true;
 
   /** Use this method to get the current bot name for the given user language. Returns BotName on success. */
   getMyName(args: {
     /** A two-letter ISO 639-1 language code or an empty string */
-    language_code?: string;
+    language_code?: LanguageCode;
   }): BotName;
 
   /** Use this method to change the bot's description, which is shown in the chat with the bot if the chat is empty. Returns True on success. */
@@ -1334,13 +1335,13 @@ export type ApiMethods = {
     /** New bot description; 0-512 characters. Pass an empty string to remove the dedicated description for the given language. */
     description?: string;
     /** A two-letter ISO 639-1 language code. If empty, the description will be applied to all users for whose language there is no dedicated description. */
-    language_code?: string;
+    language_code?: LanguageCode;
   }): true;
 
   /** Use this method to get the current bot description for the given user language. Returns BotDescription on success. */
   getMyDescription(args: {
     /** A two-letter ISO 639-1 language code or an empty string */
-    language_code?: string;
+    language_code?: LanguageCode;
   }): BotDescription;
 
   /** Use this method to change the bot's short description, which is shown on the bot's profile page and is sent together with the link when users share the bot. Returns True on success. */
@@ -1348,13 +1349,13 @@ export type ApiMethods = {
     /** New short description for the bot; 0-120 characters. Pass an empty string to remove the dedicated short description for the given language. */
     short_description?: string;
     /** A two-letter ISO 639-1 language code. If empty, the short description will be applied to all users for whose language there is no dedicated short description. */
-    language_code?: string;
+    language_code?: LanguageCode;
   }): true;
 
   /** Use this method to get the current bot short description for the given user language. Returns BotShortDescription on success. */
   getMyShortDescription(args: {
     /** A two-letter ISO 639-1 language code or an empty string */
-    language_code?: string;
+    language_code?: LanguageCode;
   }): BotShortDescription;
 
   /** Use this method to change the bot's menu button in a private chat, or the default menu button. Returns True on success. */

package/src/botCommandTypes.d.ts

@@ -1,4 +1,4 @@
-import type { WebAppInfo } from "./markupTypes.js";
+import type { WebAppInfo } from "./markupTypes";
 
 /**
  * This interface represents the name of the bot.

package/src/index.d.ts

@@ -6,5 +6,6 @@ export * from "./messageTypes";
 export * from "./apiMethodsTypes";
 export * from "./passportTypes";
 export * from "./invoiceTypes";
+export * from "./languageTypes";
 export * from "./botCommandTypes";
 export * from "./updateTypes";

package/src/languageTypes.d.ts

@@ -0,0 +1,194 @@
+/** A two-letter ISO 639-1 language code.
+ * @see https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes
+ * @see https://www.loc.gov/standards/iso639-2/php/code_list.php
+ */
+export type LanguageCode = (typeof LanguageCodes)[keyof typeof LanguageCodes];
+
+/**
+ * @see {@link LanguageCode}
+ */
+export declare const LanguageCodes: {
+  Abkhazian: "ab";
+  Afar: "aa";
+  Afrikaans: "af";
+  Akan: "ak";
+  Albanian: "sq";
+  Amharic: "am";
+  Arabic: "ar";
+  Aragonese: "an";
+  Armenian: "hy";
+  Assamese: "as";
+  Avaric: "av";
+  Avestan: "ae";
+  Aymara: "ay";
+  Azerbaijani: "az";
+  Bambara: "bm";
+  Bashkir: "ba";
+  Basque: "eu";
+  Belarusian: "be";
+  Bengali: "bn";
+  Bislama: "bi";
+  Bosnian: "bs";
+  Breton: "br";
+  Bulgarian: "bg";
+  Burmese: "my";
+  Catalan: "ca";
+  Chamorro: "ch";
+  Chechen: "ce";
+  Chichewa: "ny";
+  Chinese: "zh";
+  ChurchSlavonic: "cu";
+  Chuvash: "cv";
+  Cornish: "kw";
+  Corsican: "co";
+  Cree: "cr";
+  Croatian: "hr";
+  Czech: "cs";
+  Danish: "da";
+  Divehi: "dv";
+  Dutch: "nl";
+  Dzongkha: "dz";
+  English: "en";
+  Esperanto: "eo";
+  Estonian: "et";
+  Ewe: "ee";
+  Faroese: "fo";
+  Fijian: "fj";
+  Finnish: "fi";
+  French: "fr";
+  WesternFrisian: "fy";
+  Fulah: "ff";
+  Gaelic: "gd";
+  Galician: "gl";
+  Ganda: "lg";
+  Georgian: "ka";
+  German: "de";
+  Greek: "el";
+  Kalaallisut: "kl";
+  Guarani: "gn";
+  Gujarati: "gu";
+  Haitian: "ht";
+  Hausa: "ha";
+  Hebrew: "he";
+  Herero: "hz";
+  Hindi: "hi";
+  HiriMotu: "ho";
+  Hungarian: "hu";
+  Icelandic: "is";
+  Ido: "io";
+  Igbo: "ig";
+  Indonesian: "id";
+  Interlingua: "ia";
+  Interlingue: "ie";
+  Inuktitut: "iu";
+  Inupiaq: "ik";
+  Irish: "ga";
+  Italian: "it";
+  Japanese: "ja";
+  Javanese: "jv";
+  Kannada: "kn";
+  Kanuri: "kr";
+  Kashmiri: "ks";
+  Kazakh: "kk";
+  CentralKhmer: "km";
+  Kikuyu: "ki";
+  Kinyarwanda: "rw";
+  Kirghiz: "ky";
+  Komi: "kv";
+  Kongo: "kg";
+  Korean: "ko";
+  Kuanyama: "kj";
+  Kurdish: "ku";
+  Lao: "lo";
+  Latin: "la";
+  Latvian: "lv";
+  Limburgan: "li";
+  Lingala: "ln";
+  Lithuanian: "lt";
+  LubaKatanga: "lu";
+  Luxembourgish: "lb";
+  Macedonian: "mk";
+  Malagasy: "mg";
+  Malay: "ms";
+  Malayalam: "ml";
+  Maltese: "mt";
+  Manx: "gv";
+  Maori: "mi";
+  Marathi: "mr";
+  Marshallese: "mh";
+  Mongolian: "mn";
+  Nauru: "na";
+  Navajo: "nv";
+  NorthNdebele: "nd";
+  SouthNdebele: "nr";
+  Ndonga: "ng";
+  Nepali: "ne";
+  Norwegian: "no";
+  NorwegianBokmål: "nb";
+  NorwegianNynorsk: "nn";
+  SichuanYi: "ii";
+  Occitan: "oc";
+  Ojibwa: "oj";
+  Oriya: "or";
+  Oromo: "om";
+  Ossetian: "os";
+  Pali: "pi";
+  Pashto: "ps";
+  Persian: "fa";
+  Polish: "pl";
+  Portuguese: "pt";
+  Punjabi: "pa";
+  Quechua: "qu";
+  Romanian: "ro";
+  Romansh: "rm";
+  Rundi: "rn";
+  Russian: "ru";
+  NorthernSami: "se";
+  Samoan: "sm";
+  Sango: "sg";
+  Sanskrit: "sa";
+  Sardinian: "sc";
+  Serbian: "sr";
+  Shona: "sn";
+  Sindhi: "sd";
+  Sinhala: "si";
+  Slovak: "sk";
+  Slovenian: "sl";
+  Somali: "so";
+  SouthernSotho: "st";
+  Spanish: "es";
+  Sundanese: "su";
+  Swahili: "sw";
+  Swati: "ss";
+  Swedish: "sv";
+  Tagalog: "tl";
+  Tahitian: "ty";
+  Tajik: "tg";
+  Tamil: "ta";
+  Tatar: "tt";
+  Telugu: "te";
+  Thai: "th";
+  Tibetan: "bo";
+  Tigrinya: "ti";
+  Tonga: "to";
+  Tsonga: "ts";
+  Tswana: "tn";
+  Turkish: "tr";
+  Turkmen: "tk";
+  Twi: "tw";
+  Uighur: "ug";
+  Ukrainian: "uk";
+  Urdu: "ur";
+  Uzbek: "uz";
+  Venda: "ve";
+  Vietnamese: "vi";
+  Volapük: "vo";
+  Walloon: "wa";
+  Welsh: "cy";
+  Wolof: "wo";
+  Xhosa: "xh";
+  Yiddish: "yi";
+  Yoruba: "yo";
+  Zhuang: "za";
+  Zulu: "zu";
+};

package/src/manageTypes.d.ts

@@ -5,6 +5,7 @@ import type {
   ReactionType,
   Sticker,
 } from "./messageTypes";
+import type { LanguageCode } from "./languageTypes";
 import type { Update } from "./updateTypes";
 
 /** Describes the current status of a webhook. */
@@ -42,7 +43,7 @@ export interface User {
   /** User's or bot's username */
   username?: string;
   /** IETF language tag of the user's language */
-  language_code?: string;
+  language_code?: LanguageCode;
   /** True, if this user is a Telegram Premium user */
   is_premium?: true;
   /** True, if this user added the bot to the attachment menu */
@@ -559,6 +560,10 @@ export interface ChatInviteLink {
   member_limit?: number;
   /** Number of pending join requests created using this link */
   pending_join_request_count?: number;
+  /** The number of seconds the subscription will be active for before the next payment */
+  subscription_period?: number;
+  /** The amount of Telegram Stars a user must pay initially and after each subsequent subscription period to be a member of the chat using the link */
+  subscription_price?: number;
 }
 
 /** Represents the rights of an administrator in a chat. */

package/src/messageTypes.d.ts

@@ -1,4 +1,5 @@
 import type { Chat, User } from "./manageTypes";
+import type { LanguageCode } from "./languageTypes";
 import type { InlineKeyboardMarkup } from "./markupTypes";
 import type { PassportData } from "./passportTypes";
 import type {
@@ -458,7 +459,7 @@ export declare namespace MessageEntity {
   export interface PreMessageEntity extends AbstractMessageEntity {
     type: "pre";
     /** For “pre” only, the programming language of the entity text */
-    language?: string;
+    language?: LanguageCode;
   }
   export interface TextLinkMessageEntity extends AbstractMessageEntity {
     type: "text_link";