@types/telegram-web-app 9.1.0 → 9.1.1

telegram-web-app/README.md

@@ -8,7 +8,7 @@ This package contains type definitions for telegram-web-app (https://telegram.or
 Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/telegram-web-app.
 
 ### Additional Details
- * Last updated: Tue, 25 Nov 2025 10:39:08 GMT
+ * Last updated: Mon, 01 Dec 2025 21:01:57 GMT
  * Dependencies: none
 
 # Credits

telegram-web-app/index.d.ts

@@ -12,208 +12,338 @@ export interface Telegram {
 
 export interface WebApp {
     /**
-     * A string with raw data transferred to the Web App, convenient for
-     * validating data. WARNING: Validate data from this field before using it
-     * on the bot's server.
+     * A string with raw data transferred to the Web App,
+     * convenient for {@link https://core.telegram.org/bots/webapps#validating-data-received-via-the-mini-app| validating data}.
+     *
+     * **WARNING:** {@link https://core.telegram.org/bots/webapps#validating-data-received-via-the-mini-app| Validate data} from this field before using it on the bot's server.
      */
     initData: string;
+
     /**
-     * An object with input data transferred to the Web App. WARNING: Data from
-     * this field should not be trusted. You should only use data from initData
-     * on the bot's server and only after it has been validated.
+     * An object with input data transferred to the Mini App.
+     *
+     * **WARNING:** Data from this field should not be trusted.
+     * You should only use data from {@link initData} on the bot's server and only after it has been {@link https://core.telegram.org/bots/webapps#validating-data-received-via-the-mini-app| validated}.
      */
     initDataUnsafe: WebAppInitData;
+
     /**
      * The version of the Bot API available in the user's Telegram app.
      */
     version: string;
+
     /**
      * The name of the platform of the user's Telegram app.
      */
     platform: string;
+
     /**
-     * The color scheme currently used in the Telegram app. Either “light” or
-     * “dark”. Also available as the CSS variable var(--tg-color-scheme).
+     * The color scheme currently used in the Telegram app.
+     * Either “light” or “dark”.
+     *
+     * @see available as the CSS variable `var(--tg-color-scheme)`.
      */
     colorScheme: "light" | "dark";
+
     /**
      * An object containing the current theme settings used in the Telegram app.
      */
     themeParams: ThemeParams;
+
     /**
-     *  **Bot API 8.0+**
+     * *True*, if the Mini App is currently active.
+     * *False*, if the Mini App is minimized.
      *
-     *  True, if the Mini App is currently active.
-     *  False, if the Mini App is minimized.
+     * @since Bot API 8.0+
      */
     isActive: boolean;
+
     /**
-     *  True if the Web App is expanded to the maximum available height.
-     *  False, if the Web App occupies part of the screen and can be expanded to the
-     *  full height using the expand() method.
+     * *True*, if the Mini App is expanded to the maximum available height.
+     * (False*, if the Mini App occupies part of the screen and can be expanded to the full height using the {@link expand| expand()} method.
      */
     isExpanded: boolean;
+
     /**
-     * The current height of the visible area of the Web App.
-     * Also available in CSS as the variable var(--tg-viewport-height).
+     * The current height of the visible area of the Mini App.
+     *
+     * The application can display just the top part of the Mini App,
+     * with its lower part remaining outside the screen area.
+     * From this position, the user can “pull” the Mini App to its maximum height,
+     * while the bot can do the same by calling the {@link expand| expand()} method.
+     * As the position of the Mini App changes,
+     * the current height value of the visible area will be updated in real time.
      *
-     * The application can display just the top part of the Web App, with its
-     * lower part remaining outside the screen area. From this position, the
-     * user can “pull” the Web App to its maximum height, while the bot can do
-     * the same by calling the expand() method. As the position of the Web App
-     * changes, the current height value of the visible area will be updated in
-     * real time.
+     * Please note that the refresh rate of this value is not sufficient to smoothly follow the lower border of the window.
+     * It should not be used to pin interface elements to the bottom of the visible area.
+     * It's more appropriate to use the value of the {@link viewportStableHeight} field for this purpose.
      *
-     * Please note that the refresh rate of this value is not sufficient to
-     * smoothly follow the lower border of the window. It should not be used to
-     * pin interface elements to the bottom of the visible area. It's more
-     * appropriate to use the value of the viewportStableHeight field for this
-     * purpose.
+     * @see Available in CSS as the variable `var(--tg-viewport-height)`.
      */
     viewportHeight: number;
+
     /**
-     * The height of the visible area of the Web App in its last stable state.
-     * Also available in CSS as a variable var(--tg-viewport-stable-height).
+     * The height of the visible area of the Mini App in its last stable state.
+     *
+     * The application can display just the top part of the Mini App,
+     * with its lower part remaining outside the screen area.
+     * From this position, the user can “pull” the Mini App to its maximum height,
+     * while the bot can do the same by calling the {@link expand| expand()} method.
+     * Unlike the value of {@link viewportHeight}, the value of {@link viewportStableHeight} does not change as the position of the Mini App changes with user gestures or during animations.
+     * The value of {@link viewportStableHeight} will be updated after all gestures and animations are completed and the Mini App reaches its final size.
      *
-     * The application can display just the top part of the Web App, with its
-     * lower part remaining outside the screen area. From this position, the
-     * user can “pull” the Web App to its maximum height, while the bot can do
-     * the same by calling the expand() method. Unlike the value of
-     * viewportHeight, the value of viewportStableHeight does not change as the
-     * position of the Web App changes with user gestures or during animations.
-     * The value of viewportStableHeight will be updated after all gestures and
-     * animations are completed and the Web App reaches its final size.
+     * @remarks The event viewportChanged with the passed parameter `isStateStable=true`,
+     * which will allow you to track when the stable state of the height of the visible area changes.
      *
-     * Note the event viewportChanged with the passed parameter
-     * isStateStable=true, which will allow you to track when the stable state
-     * of the height of the visible area changes.
+     * @see Available in CSS as a variable `var(--tg-viewport-stable-height)`.
      */
     viewportStableHeight: number;
+
     /**
-     * Current header color in the #RRGGBB format.
+     * Current header color in the `#RRGGBB` format.
      */
     headerColor: string;
+
     /**
-     * Current background color in the #RRGGBB format.
+     * Current background color in the `#RRGGBB` format.
      */
     backgroundColor: string;
+
     /**
-     * Current bottom bar color in the #RRGGBB format.
+     * Current bottom bar color in the `#RRGGBB` format.
      */
     bottomBarColor: string;
+
     /**
-     * True, if the confirmation dialog is enabled while the user is trying to
-     * close the Web App. False, if the confirmation dialog is disabled.
+     * *True*, if the confirmation dialog is enabled while the user is trying to close the Mini App.
+     * *False*, if the confirmation dialog is disabled.
      */
     isClosingConfirmationEnabled: boolean;
+
+    /**
+     * 	*True*, if vertical swipes to close or minimize the Mini App are enabled.
+     * 	*False*, if vertical swipes to close or minimize the Mini App are disabled.
+     * 	In any case, the user will still be able to minimize and close the Mini App by swiping the Mini App's header.
+     */
+    isVerticalSwipesEnabled: boolean;
+
     /**
-     * True, if the Mini App is currently being displayed in fullscreen mode.
+     * *True*, if the Mini App is currently being displayed in fullscreen mode.
      */
     isFullscreen: boolean;
+
     /**
-     * True, if the Mini App’s orientation is currently locked.
-     * False, if orientation changes freely based on the device’s rotation.
+     * *True*, if the Mini App’s orientation is currently locked.
+     * *False*, if orientation changes freely based on the device’s rotation.
      */
     isOrientationLocked: boolean;
+
     /**
      * An object representing the device's safe area insets,
      * accounting for system UI elements like notches or navigation bars.
      */
     safeAreaInset: SafeAreaInset;
+
     /**
      * An object representing the safe area for displaying content within the app,
      * free from overlapping Telegram UI elements.
      */
     contentSafeAreaInset: ContentSafeAreaInset;
+
     /**
-     * An object for controlling the back button which can be displayed in the
-     * header of the Web App in the Telegram interface.
+     * An object for controlling the back button,
+     * which can be displayed in the header of the Mini App in the Telegram interface.
      */
     BackButton: BackButton;
+
     /**
-     * An object for controlling the main button, which is displayed at the
-     * bottom of the Web App in the Telegram interface.
+     * An object for controlling the main button,
+     * which is displayed at the bottom of the Mini App in the Telegram interface.
      */
     MainButton: BottomButton;
+
     /**
      * An object for controlling the secondary button,
      * which is displayed at the bottom of the Mini App in the Telegram interface.
      */
     SecondaryButton: BottomButton;
+
     /**
-     * An object for controlling the Settings item in the context menu of the
-     * Mini App in the Telegram interface.
+     * An object for controlling the Settings item in the context menu of the Mini App in the Telegram interface.
      */
     SettingsButton: SettingsButton;
+
     /**
      * An object for controlling haptic feedback.
      */
     HapticFeedback: HapticFeedback;
+
     /**
      * An object for controlling cloud storage.
      */
     CloudStorage: CloudStorage;
+
     /**
      * An object for controlling biometrics on the device.
      */
     BiometricManager: BiometricManager;
+
     /**
-     * An object for accessing device orientation data on the device.
+     * An object for accessing accelerometer data on the device.
      */
     Accelerometer: Accelerometer;
+
     /**
      * An object for accessing device orientation data on the device.
      */
     DeviceOrientation: DeviceOrientation;
+
     /**
      * An object for accessing gyroscope data on the device.
      */
     Gyroscope: Gyroscope;
+
     /**
      * An object for controlling location on the device.
      */
     LocationManager: LocationManager;
+
     /**
      * An object for storing and retrieving data from the device's local storage.
      */
     DeviceStorage: DeviceStorage;
+
     /**
      * An object for storing and retrieving data from the device's secure storage.
      */
     SecureStorage: SecureStorage;
+
     /**
-     * Returns true if the user's app supports a version of the Bot API that is
-     * equal to or higher than the version passed as the parameter.
+     * Returns true if the user's app supports a version of the Bot API
+     * that is equal to or higher than the version passed as the parameter.
      */
     isVersionAtLeast(version: string): boolean;
+
     /**
      * A method that sets the app header color in the `#RRGGBB` format.
-     * You can also use keywords bg_color and secondary_bg_color.
+     * You can also use keywords `bg_color` and `secondary_bg_color`.
+     *
+     * Up to Bot API 6.9 You can only pass Telegram.WebApp.themeParams.bg_color
+     * or Telegram.WebApp.themeParams.secondary_bg_color as a color
+     * or bg_color, secondary_bg_color keywords.
+     *
+     * @since Bot API 6.1+
      */
     setHeaderColor(color: "bg_color" | "secondary_bg_color" | (string & {})): void;
+
     /**
-     * A method that sets the app background color in the `#RRGGBB` format
-     * or you can use keywords bg_color, secondary_bg_color instead.
+     * A method that sets the app background color in the `#RRGGBB` format.
+     * You can also use keywords `bg_color` and `secondary_bg_color`.
+     *
+     * @since Bot API 6.1+
      */
     setBackgroundColor(color: "bg_color" | "secondary_bg_color" | "bottom_bar_bg_color" | (string & {})): void;
+
     /**
-     * A method that sets the app's bottom bar color in the #RRGGBB format.
-     * You can also use the keywords bg_color, secondary_bg_color and bottom_bar_bg_color.
+     * A method that sets the app's bottom bar color in the `#RRGGBB` format.
+     * You can also use the keywords `bg_color`, `secondary_bg_color`, and `bottom_bar_bg_color`.
+     * This color is also applied to the navigation bar on Android.
+     *
+     * @since Bot API 7.10+
      */
     setBottomBarColor(color: "bg_color" | "secondary_bg_color" | (string & {})): void;
+
     /**
-     * A method that enables a confirmation dialog while the user is trying to
-     * close the Web App.
+     * A method that enables a confirmation dialog while the user is trying to close the Mini App.
+     *
+     * @since Bot API 6.2+
      */
     enableClosingConfirmation(): void;
+
     /**
-     * A method that disables the confirmation dialog while the user is trying
-     * to close the Web App.
+     * A method that disables the confirmation dialog while the user is trying to close the Mini App.
+     *
+     * @since Bot API 6.2+
      */
     disableClosingConfirmation(): void;
+
+    /**
+     * A method that enables vertical swipes to close or minimize the Mini App.
+     * For user convenience, it is recommended to always enable swipes unless they conflict with the Mini App's own gestures.
+     *
+     * @since Bot API 7.7+
+     */
+    enableVerticalSwipes(): void;
+
+    /**
+     * A method that disables vertical swipes to close or minimize the Mini App.
+     * This method is useful if your Mini App uses swipe gestures that may conflict with the gestures for minimizing and closing the app.
+     *
+     * @since Bot API 7.7+
+     */
+    disableVerticalSwipes(): void;
+
+    /**
+     * A method that requests opening the Mini App in fullscreen mode.
+     * Although the header is transparent in fullscreen mode,
+     * it is recommended that the Mini App sets the header color using the setHeaderColor method.
+     * This color helps determine a contrasting color for the status bar and other UI controls.
+     *
+     * @since Bot API 8.0+
+     */
+    requestFullscreen(): void;
+
+    /**
+     * A method that requests exiting fullscreen mode.
+     *
+     * @since Bot API 8.0+
+     */
+    exitFullscreen(): void;
+
     /**
-     * A method that sets the app event handler. Check the list of available
-     * events.
+     * A method that locks the Mini App’s orientation to its current mode (either portrait or landscape).
+     * Once locked, the orientation remains fixed, regardless of device rotation.
+     * This is useful if a stable orientation is needed during specific interactions.
+     *
+     * @since Bot API 8.0+
+     */
+    lockOrientation(): void;
+
+    /**
+     * A method that unlocks the Mini App’s orientation, allowing it to follow the device's rotation freely.
+     * Use this to restore automatic orientation adjustments based on the device orientation.
+     *
+     * @since Bot API 8.0+
+     */
+    unlockOrientation(): void;
+
+    /**
+     * A method that prompts the user to add the Mini App to the home screen.
+     * After successfully adding the icon, the homeScreenAdded event will be triggered if supported by the device.
+     *
+     * @remarks That if the device cannot determine the installation status, the event may not be received even if the icon has been added.
+     *
+     * @since Bot API 8.0+
+     */
+    addToHomeScreen(): void;
+
+    /**
+     * A method that checks if adding to the home screen is supported and if the Mini App has already been added.
+     * If an optional callback parameter is provided, the callback function will be called with a single argument status,
+     * which is a string indicating the home screen status.
+     *
+     * Possible values for status are:
+     * - **unsupported** – the feature is not supported, and it is not possible to add the icon to the home screen,
+     * - **unknown** – the feature is supported, and the icon can be added, but it is not possible to determine if the icon has already been added,
+     * - **added** – the icon has already been added to the home screen,
+     * - **missed** – the icon has not been added to the home screen.
+     *
+     * @since Bot API 8.0+
+     */
+    checkHomeScreenStatus(callback?: (status: "unsupported" | "unknown" | "added" | "missed") => void): void;
+
+    /**
+     * 	A method that sets the app event handler. Check the list of available events.
      */
     onEvent(eventType: "activated", eventHandler: ActivatedCallback): void;
     onEvent(eventType: "deactivated", eventHandler: DeactivatedCallback): void;
@@ -260,7 +390,9 @@ export interface WebApp {
     onEvent(eventType: "emojiStatusAccessRequested", eventHandler: EmojiStatusAccessRequestedCallback): void;
     onEvent(eventType: "fileDownloadRequested", eventHandler: FileDownloadRequestedCallback): void;
 
-    /** A method that deletes a previously set event handler. */
+    /**
+     * A method that deletes a previously set event handler.
+     */
     offEvent(eventType: "activated", eventHandler: ActivatedCallback): void;
     offEvent(eventType: "deactivated", eventHandler: DeactivatedCallback): void;
     offEvent(eventType: "themeChanged", eventHandler: ThemeChangedCallback): void;
@@ -307,260 +439,202 @@ export interface WebApp {
     offEvent(eventType: "fileDownloadRequested", eventHandler: FileDownloadRequestedCallback): void;
 
     /**
-     * A method used to send data to the bot. When this method is called, a
-     * service message is sent to the bot containing the data data of the length
-     * up to 4096 bytes, and the Web App is closed. See the field web_app_data
-     * in the class Message.
+     * A method used to send data to the bot.
+     * When this method is called, a service message is sent to the bot containing the data *data* of the length up to 4096 bytes, and the Mini App is closed. See the field web_app_data in the class Message.
      *
-     * This method is only available for Web Apps launched via a Keyboard
-     * button.
+     * *This method is only available for Mini Apps launched via a {@link https://core.telegram.org/bots/webapps#keyboard-button-mini-apps| Keyboard button}.*
      */
     sendData(data: string): void;
+
     /**
-     * A method that inserts the bot's username and the specified inline query
-     * in the current chat's input field. Query may be empty, in which case only
-     * the bot's username will be inserted. If an optional choose_chat_types
-     * parameter was passed, the client prompts the user to choose a specific
-     * chat, then opens that chat and inserts the bot's username and the
-     * specified inline query in the input field. You can specify which types of
-     * chats the user will be able to choose from. It can be one or more of the
-     * following types: users, bots, groups, channels.
+     * A method that inserts the bot's username and the specified inline query in the current chat's input field.
+     * Query may be empty, in which case only the bot's username will be inserted.
+     * If an optional choose_chat_types parameter was passed, the client prompts the user to choose a specific chat,
+     * then opens that chat and inserts the bot's username and the specified inline query in the input field.
+     * You can specify which types of chats the user will be able to choose from.
+     * It can be one or more of the following types: users, bots, groups, channels.
+     *
+     * @since Bot API 6.7+
      */
-    switchInlineQuery(query: string, choose_chat_types?: Array<"users" | "bots" | "groups" | "channels">): void;
+    switchInlineQuery(query: string, choose_chat_types?: ("users" | "bots" | "groups" | "channels")[]): void;
+
     /**
-     * A method that opens a link in an external browser. The Web App will not
-     * be closed. If the optional options parameter is passed with the field
-     * @param try_instant_view the link will be opened in Instant View mode if
-     * possible.
+     * A method that opens a link in an external browser. The Mini App will not be closed.
+     * Bot API 6.4+ If the optional options parameter is passed with the field try_instant_view=true, the link will be opened in Instant View mode if possible.
      *
-     * Note that this method can be called only in response to user interaction
-     * with the Web App interface (e.g. a click inside the Web App or on the
-     * main button)
+     * @remarks That this method can be called only in response to user interaction with the Mini App interface (e.g. a click inside the Mini App or on the main button)
      */
     openLink(url: string, options?: { try_instant_view?: boolean }): void;
+
     /**
-     * A method that opens a telegram link inside Telegram app. The Web App will
-     * be closed.
+     * A method that opens a telegram link inside the Telegram app. The Mini App will not be closed after this method is called.
+     *
+     * Up to Bot API 7.0 The Mini App will be closed after this method is called.
      */
     openTelegramLink(url: string): void;
+
     /**
-     * A method that opens an invoice using the link url. The Web App will
-     *  receive the event invoiceClosed when the invoice is closed. If an
-     *  optional callback parameter was passed, the callback function will be
-     *  called and the invoice status will be passed as the first argument.
+     * A method that opens an invoice using the link url.
+     * The Mini App will receive the event invoiceClosed when the invoice is closed.
+     * If an optional callback parameter was passed,
+     * the callback function will be called and the invoice status will be passed as the first argument.
+     *
+     * @since Bot API 6.1+
      */
     openInvoice(url: string, callback: (status: "paid" | "cancelled" | "failed" | "pending") => void): void;
+
     /**
-     * **Bot API 9.1+**
+     * A method that opens the native story editor with the media specified in the media_url parameter as an HTTPS URL.
+     * An optional params argument of the type StoryShareParams describes additional sharing settings.
      *
-     * A method that hides the on-screen keyboard, if it is currently visible.
-     * Does nothing if the keyboard is not active.
-     */
-    hideKeyboard(): void;
-    /**
-     * A method that shows a native popup described by the params argument of
-     * the type PopupParams. The Web App will receive the event popupClosed when
-     * the popup is closed. If an optional callback parameter was passed, the
-     * callback function will be called and the field id of the pressed button
-     * will be passed as the first argument.
-     */
-    showPopup(params: PopupParams, callback?: (button_id: string) => void): void;
-    /**
-     * A method that shows message in a simple alert with a 'Close' button. If
-     * an optional callback parameter was passed, the callback function will be
-     * called when the popup is closed.
-     */
-    showAlert(message: string, callback?: () => void): void;
-    /**
-     * A method that shows message in a simple confirmation window with 'OK' and
-     * 'Cancel' buttons. If an optional callback parameter was passed, the
-     * callback function will be called when the popup is closed and the first
-     * argument will be a boolean indicating whether the user pressed the 'OK'
-     * button.
-     */
-    showConfirm(message: string, callback?: (ok: boolean) => void): void;
-    /**
-     * A method that shows a native popup for scanning a QR code described by
-     * the params argument of the type ScanQrPopupParams. The Web App will
-     * receive the event qrTextReceived every time the scanner catches a code
-     * with text data. If an optional callback parameter was passed, the
-     * callback function will be called and the text from the QR code will be
-     * passed as the first argument. Returning true inside this callback
-     * function causes the popup to be closed. Starting from **Bot API 7.7**,
-     * the Mini App will receive the scanQrPopupClosed event if the user closes
-     * the native popup for scanning a QR code.
-     */
-    showScanQrPopup(params: ScanQrPopupParams, callback?: (data: string) => void): void;
-    /**
-     * A method that closes the native popup for scanning a QR code opened with
-     * the showScanQrPopup method. Run it if you received valid data in the
-     * event qrTextReceived.
+     * @since Bot API 7.8+
      */
-    closeScanQrPopup(): void;
-    /** A method that opens the native story editor with the media specified in
-     * the media_url parameter as an HTTPS URL. An optional params argument of
-     * the type StoryShareParams describes additional sharing settings. */
     shareToStory(media_url: string, params?: StoryShareParams): void;
+
     /**
-     *  **Bot API 8.0+**
+     * A method that opens a dialog allowing the user to share a message provided by the bot.
+     * If an optional callback parameter is provided,
+     * the callback function will be called with a boolean as the first argument,
+     * indicating whether the message was successfully sent.
+     * The message id passed to this method must belong to a PreparedInlineMessage previously obtained via the Bot API method savePreparedInlineMessage.
      *
-     *  A method that opens a dialog allowing the user to share a message provided by the bot.
-     *  If an optional callback parameter is provided,
-     *  the callback function will be called with a boolean as the first argument,
-     *  indicating whether the message was successfully sent.
+     * @since Bot API 8.0+
      */
     shareMessage(msg_id: number, callback?: (success: boolean) => void): void;
+
     /**
-     *  **Bot API 8.0+**
+     * A method that opens a dialog allowing the user to set the specified custom emoji as their status.
+     * An optional params argument of type EmojiStatusParams specifies additional settings, such as duration.
+     * If an optional callback parameter is provided,
+     * the callback function will be called with a boolean as the first argument,
+     * indicating whether the status was set.
      *
-     *  A method that opens a dialog allowing the user to set the specified custom emoji as their status.
-     *  An optional params argument of type EmojiStatusParams specifies additional settings,such as duration.
-     *  If an optional callback parameter is provided,
-     *  the callback function will be called with a boolean as the first argument,
-     *  indicating whether the status was set.
+     * Note: this method opens a native dialog and cannot be used to set the emoji status without manual user interaction.
+     * For fully programmatic changes, you should instead use the Bot API method setUserEmojiStatus after obtaining authorization to do so via the Mini App method requestEmojiStatusAccess.
      *
-     *  Note: this method opens a native dialog and cannot be used to set the emoji status without manual user interaction.
-     *  For fully programmatic changes, you should instead use the Bot API method setUserEmojiStatus
-     *  after obtaining authorization to do so via the Mini App method requestEmojiStatusAccess.
+     * @since Bot API 8.0+
      */
     setEmojiStatus(custom_emoji_id: string, params?: EmojiStatusParams, callback?: (success: boolean) => void): void;
+
     /**
-     *  **Bot API 8.0+**
+     * A method that shows a native popup requesting permission for the bot to manage user's emoji status.
+     * If an optional callback parameter was passed, the callback function will be called when the popup is closed and the first argument will be a boolean indicating whether the user granted this access.
      *
-     *  A method that shows a native popup requesting permission for the bot to manage user's emoji status.
-     *  If an optional callback parameter was passed,
-     *  the callback function will be called when the popup is closed
-     *  and the first argument will be a boolean indicating whether the user granted this access.
+     * @since Bot API 8.0+
      */
     requestEmojiStatusAccess(callback?: (success: boolean) => void): void;
+
     /**
-     *  **Bot API 8.0+**
+     * A method that displays a native popup prompting the user to download a file specified by the params argument of type DownloadFileParams. If an optional callback parameter is provided, the callback function will be called when the popup is closed, with the first argument as a boolean indicating whether the user accepted the download request.
      *
-     *  A method that displays a native popup prompting the user to download a file
-     *  specified by the params argument of type DownloadFileParams.
-     *  If an optional callback parameter is provided,
-     *  the callback function will be called when the popup is closed,
-     *  with the first argument as a boolean indicating whether the user accepted the download request.
+     * @since Bot API 8.0+
      */
     downloadFile(params: DownloadFileParams, callback?: (success: boolean) => void): void;
+
     /**
-     * A method that requests text from the clipboard.
-     * The Web App will receive the event clipboardTextReceived.
-     * If an optional callback parameter was passed,
-     * the callback function will be called and the text from the clipboard will be passed as the first argument.
+     * A method that hides the on-screen keyboard, if it is currently visible. Does nothing if the keyboard is not active.
      *
-     * Note: this method can be called only for Web Apps launched from the
-     * attachment menu and only in response to a user interaction with the Web
-     * App interface (e.g. a click inside the Web App or on the main button).
+     * @since Bot API 9.1+
      */
-    readTextFromClipboard(callback?: (data: string | null) => void): void;
+    hideKeyboard(): void;
+
     /**
-     * A method that shows a native popup requesting permission for the bot to
-     * send messages to the user.
+     * A method that shows a native popup described by the params argument of the type PopupParams.
+     * The Mini App will receive the event popupClosed when the popup is closed.
+     * If an optional callback parameter was passed, the callback function will be called
+     * and the field id of the pressed button will be passed as the first argument.
      *
-     * @param callback If an optional callback parameter was passed, the
-     * callback function will be called when the popup is closed and the first
-     * argument will be a boolean indicating whether the user granted this
-     * access.
+     * @since Bot API 6.2+
      */
-    requestWriteAccess(callback?: (success: boolean) => void): void;
+    showPopup(params: PopupParams, callback?: (button_id: string) => void): void;
+
     /**
-     * A method that shows a native popup prompting the user for their phone
-     * number.
+     * A method that shows message in a simple confirmation window with 'OK' and 'Cancel' buttons.
+     * If an optional callback parameter was passed, the callback function will be called when the popup is closed and the first argument will be a boolean indicating whether the user pressed the 'OK' button.
      *
-     * @param callback If an optional callback parameter was passed, the
-     * callback function will be called when the popup is closed and the first
-     * argument will be a boolean indicating whether the user shared its phone
-     * number. The second argument, contingent upon success, will be an object
-     * detailing the shared contact information or a cancellation response.
-     */
-    requestContact(callback?: (success: boolean, response: RequestContactResponse) => void): void;
-    /**
-     * A method that informs the Telegram app that the Web App is ready to be
-     * displayed. It is recommended to call this method as early as possible, as
-     * soon as all essential interface elements are loaded. Once this method is
-     * called, the loading placeholder is hidden and the Web App is shown. If
-     * the method is not called, the placeholder will be hidden only when the
-     * page is fully loaded.
-     */
-    ready(): void;
-    /**
-     * A method that expands the Web App to the maximum available height. To
-     * find out if the Web App is expanded to the maximum height, refer to the
-     * value of the Telegram.WebApp.isExpanded parameter
+     * @since Bot API 6.2+
      */
-    expand(): void;
-    /** A method that closes the Web App. */
-    close(): void;
+    showAlert(message: string, callback?: () => void): void;
+
     /**
-     * `True`, if vertical swipes to close or minimize the Mini App are enabled.
-     * `False`, if vertical swipes to close or minimize the Mini App are
-     * disabled. In any case, the user will still be able to minimize and close
-     * the Mini App by swiping the Mini App's header.
+     * A method that shows message in a simple confirmation window with 'OK' and 'Cancel' buttons.
+     * If an optional callback parameter was passed, the callback function will be called when the popup is closed and the first argument will be a boolean indicating whether the user pressed the 'OK' button.
+     *
+     * @since Bot API 6.2+
      */
-    isVerticalSwipesEnabled: boolean;
+    showConfirm(message: string, callback?: (success: boolean) => void): void;
+
     /**
-     * **Bot API 7.7+**
-     * A method that enables vertical swipes to close or minimize the Mini App.
-     * For user convenience, it is recommended to always enable swipes unless they conflict
-     * with the Mini App's own gestures.
+     * A method that shows a native popup for scanning a QR code described by the params argument of the type ScanQrPopupParams.
+     * The Mini App will receive the event qrTextReceived every time the scanner catches a code with text data.
+     * If an optional callback parameter was passed,
+     * the callback function will be called and the text from the QR code will be passed as the first argument.
+     * Returning true inside this callback function causes the popup to be closed.
+     * Starting from Bot API 7.7, the Mini App will receive the scanQrPopupClosed event if the user closes the native popup for scanning a QR code.
+     *
+     * @since Bot API 6.4+
      */
-    enableVerticalSwipes(): void;
+    showScanQrPopup(params: ScanQrPopupParams, callback?: (data: string) => void): void;
+
     /**
-     * **Bot API 7.7+**
-     * A method that disables vertical swipes to close or minimize the Mini App.
-     * This method is useful if your Mini App uses swipe gestures that may conflict
-     * with the gestures for minimizing and closing the app.
+     * A method that closes the native popup for scanning a QR code opened with the showScanQrPopup method.
+     * Run it if you received valid data in the event qrTextReceived.
+     *
+     * @since Bot API 6.4+
      */
-    disableVerticalSwipes(): void;
+    closeScanQrPopup(): void;
+
     /**
-     * **Bot API 8.0+**
+     * A method that requests text from the clipboard.
+     * The Mini App will receive the event clipboardTextReceived.
+     * If an optional callback parameter was passed,
+     * the callback function will be called and the text from the clipboard will be passed as the first argument.
      *
-     * A method that requests opening the Mini App in fullscreen mode.
-     * Although the header is transparent in fullscreen mode,
-     * it is recommended that the Mini App sets the header color using the setHeaderColor method.
-     * This color helps determine a contrasting color for the status bar and other UI controls.
+     * @remarks This method can be called only for Mini Apps launched from the attachment menu
+     * and only in response to a user interaction with the Mini App interface
+     * (e.g. a click inside the Mini App or on the main button).
+     *
+     * @since Bot API 6.4+
      */
-    requestFullscreen(): void;
+    readTextFromClipboard(callback?: (data: string | null) => void): void;
+
     /**
-     * **Bot API 8.0+**
+     * A method that shows a native popup requesting permission for the bot to send messages to the user.
+     * If an optional callback parameter was passed,
+     * the callback function will be called when the popup is closed and the first argument will be a boolean indicating whether the user granted this access.
      *
-     * A method that requests exiting fullscreen mode.
+     * @since Bot API 6.9+
      */
-    exitFullscreen(): void;
+    requestWriteAccess(callback?: (success: boolean) => void): void;
+
     /**
-     * **Bot API 8.0+**
+     * A method that shows a native popup prompting the user for their phone number.
+     * If an optional callback parameter was passed,
+     * the callback function will be called when the popup is closed and the first argument will be a boolean indicating whether the user shared its phone number.
      *
-     * A method that locks the Mini App’s orientation to its current mode (either portrait or landscape).
-     * Once locked, the orientation remains fixed, regardless of device rotation.
-     * This is useful if a stable orientation is needed during specific interactions.
+     * @since Bot API 6.9+
      */
-    lockOrientation(): void;
+    requestContact(callback?: (success: boolean, response: RequestContactResponse) => void): void;
+
     /**
-     * **Bot API 8.0+**
-     *
-     * A method that unlocks the Mini App’s orientation, allowing it to follow the device's rotation freely.
-     * Use this to restore automatic orientation adjustments based on the device orientation.
+     * A method that informs the Telegram app that the Mini App is ready to be displayed.
+     * It is recommended to call this method as early as possible, as soon as all essential interface elements are loaded.
+     * Once this method is called, the loading placeholder is hidden and the Mini App is shown.
+     * If the method is not called, the placeholder will be hidden only when the page is fully loaded.
      */
-    unlockOrientation(): void;
+    ready(): void;
+
     /**
-     * **Bot API 8.0+**
-     *
-     * A method that prompts the user to add the Mini App to the home screen.
-     * After successfully adding the icon, the homeScreenAdded event will be triggered if supported by the device.
-     * Note that if the device cannot determine the installation status,
-     * the event may not be received even if the icon has been added.
+     * A method that expands the Mini App to the maximum available height.
+     * To find out if the Mini App is expanded to the maximum height,
+     * refer to the value of the {@link isExpanded| Telegram.WebApp.isExpanded} parameter
      */
-    addToHomeScreen(): void;
+    expand(): void;
+
     /**
-     * **Bot API 8.0+**
-     *
-     * A method that checks if adding to the home screen is supported and if the Mini App has already been added.
-     * If an optional callback parameter is provided,
-     * the callback function will be called with a single argument status,
-     * which is a string indicating the home screen status.
+     * A method that closes the Mini App.
      */
-    checkHomeScreenStatus(callback?: (status: "unsupported" | "unknown" | "added" | "missed") => void): void;
+    close(): void;
 }
 
 export type ActivatedCallback = () => void;
@@ -635,103 +709,130 @@ export type FileDownloadRequestedCallback = (eventData: {
 }) => void;
 
 /**
- * Web Apps can adjust the appearance of the interface to match the Telegram
- * user's app in real time. This object contains the user's current theme
- * settings:
+ * Mini Apps can adjust the appearance of the interface to match the Telegram user's app in real time.
+ * This object contains the user's current theme setting
  */
 export interface ThemeParams {
     /**
      * Background color in the `#RRGGBB` format.
-     * Also available as the CSS variable `var(--tg-theme-bg-color)`.
+     *
+     * @see Available as the CSS variable `var(--tg-theme-bg-color)`.
      */
     bg_color?: string;
+
     /**
      * Main text color in the `#RRGGBB` format.
-     * Also available as the CSS variable `var(--tg-theme-text-color)`.
+     *
+     * @see Available as the CSS variable `var(--tg-theme-text-color)`.
      */
     text_color?: string;
+
     /**
      * Hint text color in the `#RRGGBB` format.
-     * Also available as the CSS variable `var(--tg-theme-hint-color)`.
+     *
+     * @see Available as the CSS variable `var(--tg-theme-hint-color)`.
      */
     hint_color?: string;
+
     /**
      * Link color in the `#RRGGBB` format.
-     * Also available as the CSS variable `var(--tg-theme-link-color)`.
+     *
+     * @see Available as the CSS variable `var(--tg-theme-link-color)`.
      */
     link_color?: string;
+
     /**
      * Button color in the `#RRGGBB` format.
-     * Also available as the CSS variable `var(--tg-theme-button-color)`.
+     *
+     * @see Available as the CSS variable `var(--tg-theme-button-color)`.
      */
     button_color?: string;
+
     /**
      * Button text color in the `#RRGGBB` format.
-     * Also available as the CSS variable `var(--tg-theme-button-text-color)`.
+     *
+     * @see Available as the CSS variable `var(--tg-theme-button-text-color)`.
      */
     button_text_color?: string;
+
     /**
-     * **Bot API 6.1+**
-     *
      * Secondary background color in the `#RRGGBB` format.
-     * Also available as the CSS variable `var(--tg-theme-secondary-bg-color)`.
+     *
+     * @since Bot API 6.1+
+     *
+     * @see Available as the CSS variable `var(--tg-theme-secondary-bg-color)`.
      */
     secondary_bg_color?: string;
+
     /**
-     * **Bot API 7.0+**
-     *
      * Header background color in the `#RRGGBB` format.
-     * Also available as the CSS variable `var(--tg-theme-header-bg-color)`.
+     *
+     * @since Bot API 7.0+
+     *
+     * @see Available as the CSS variable `var(--tg-theme-header-bg-color)`.
      */
     header_bg_color?: string;
+
     /**
-     * **Bot API 7.10+**
+     * Bottom background color in the `#RRGGBB` format.
+     *
+     * @since Bot API 7.10+
      *
-     * Bottom background color in the #RRGGBB format.
-     * Also available as the CSS variable var(--tg-theme-bottom-bar-bg-color).
+     * @see Available as the CSS variable `var(--tg-theme-bottom-bar-bg-color)`.
      */
     bottom_bar_bg_color?: string;
+
     /**
-     * **Bot API 7.0+**
-     *
      * Accent text color in the `#RRGGBB` format.
-     * Also available as the CSS variable `var(--tg-theme-accent-text-color)`.
+     *
+     * @since Bot API 7.0+
+     *
+     * @see Available as the CSS variable `var(--tg-theme-accent-text-color)`.
      */
     accent_text_color?: string;
+
     /**
-     * **Bot API 7.0+**
+     * Section background color in the `#RRGGBB` format.
+     *
+     * @since Bot API 7.0+
      *
-     * Background color for the section in the `#RRGGBB` format.
-     * It is recommended to use this in conjunction with *secondary_bg_color*.
-     * Also available as the CSS variable `var(--tg-theme-section-bg-color)`.
+     * @see Available as the CSS variable `var(--tg-theme-section-bg-color)`.
      */
     section_bg_color?: string;
+
     /**
-     * **Bot API 7.0+**
+     * Section header text color in the `#RRGGBB` format.
+     *
+     * @since Bot API 7.0+
      *
-     * Header text color for the section in the `#RRGGBB` format.
-     * Also available as the CSS variable `var(--tg-theme-section-header-text-color)`.
+     * @see Available as the CSS variable `var(--tg-theme-section-header-text-color)`.
      */
-    section_header_text_color?: `#${string}`;
+    section_header_text_color?: string;
+
     /**
-     * **Bot API 7.6+**
-     *
      * Section separator color in the `#RRGGBB` format.
-     * Also available as the CSS variable `var(--tg-theme-section-separator-color)`.
+     *
+     * @since Bot API 7.6+
+     *
+     * @see Available as the CSS variable `var(--tg-theme-section-separator-color)`.
      */
     section_separator_color?: string;
+
     /**
-     * **Bot API 7.0+**
-     *
      * Subtitle text color in the `#RRGGBB` format.
-     *  Also available as the CSS variable `var(--tg-theme-subtitle-text-color)`.
+     *
+     * @since Bot API 7.0+
+     *
+     * @see Available as the CSS variable `var(--tg-theme-subtitle-text-color)`.
      */
     subtitle_text_color?: string;
+
     /**
-     * **Bot API 7.0+**
+     * Destructive text color in the `#RRGGBB` format.
+     *
+     * @since Bot API 7.0+
      *
-     * Text color for destructive actions in the `#RRGGBB` format.
-     * Also available as the CSS variable `var(--tg-theme-destructive-text-color)`.
+     * @see Available as the CSS variable `var(--tg-theme-destructive-text-color)`.
      */
     destructive_text_color?: string;
 }

telegram-web-app/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@types/telegram-web-app",
-    "version": "9.1.0",
+    "version": "9.1.1",
     "description": "TypeScript definitions for telegram-web-app",
     "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/telegram-web-app",
     "license": "MIT",
@@ -36,6 +36,6 @@
     "scripts": {},
     "dependencies": {},
     "peerDependencies": {},
-    "typesPublisherContentHash": "f446f17f32fcc8ca83f3118a6a869a8e164f6b95797cbd6b80fbddab18adedfe",
+    "typesPublisherContentHash": "c942da54059cdd792567429adafb556da1f1b2be1b66b00c2f2bcfada4b04578",
     "typeScriptVersion": "5.2"
 }