@types/telegram-web-app 1.0.0 → 6.2.1

telegram-web-app/README.md

@@ -8,9 +8,9 @@ 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: Mon, 25 Apr 2022 13:31:36 GMT
+ * Last updated: Fri, 02 Sep 2022 10:02:40 GMT
  * Dependencies: none
  * Global values: `Telegram`
 
 # Credits
-These definitions were written by [KnorpelSenf](https://github.com/KnorpelSenf).
+These definitions were written by [KnorpelSenf](https://github.com/KnorpelSenf), and [MKRhere](https://github.com/MKRhere).

telegram-web-app/index.d.ts

@@ -1,6 +1,6 @@
-// Type definitions for non-npm package telegram-web-app 1.0
+// Type definitions for non-npm package telegram-web-app 6.2
 // Project: https://telegram.org/js/telegram-web-app.js
-// Definitions by: KnorpelSenf <https://github.com/KnorpelSenf>
+// Definitions by: KnorpelSenf <https://github.com/KnorpelSenf>, MKRhere <https://github.com/MKRhere>
 // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
 
 declare var Telegram: Telegram;
@@ -24,6 +24,10 @@ interface WebApp {
      * the bot's server and only after it has been validated.
      */
     initDataUnsafe: WebAppInitData;
+    /**
+     * The version of the Bot API available in the user's Telegram app.
+     */
+    version: string;
     /**
      * The color scheme currently used in the Telegram app. Either “light” or
      * “dark”. Also available as the CSS variable var(--tg-color-scheme).
@@ -75,19 +79,72 @@ interface WebApp {
      */
     viewportStableHeight: number;
     /**
-     * An object for controlling the main button, which is displayed at the bottom
-     * of the Web App in the Telegram interface.
+     * Current header color in the #RRGGBB format.
+     */
+    headerColor: string;
+    /**
+     * Current background color in the #RRGGBB format.
+     */
+    backgroundColor: 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.
+     */
+    isClosingConfirmationEnabled: boolean;
+    /**
+     * An object for controlling the back button which can be displayed in the
+     * header of the Web 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.
      */
     MainButton: MainButton;
+    /**
+     * An object for controlling haptic feedback.
+     */
+    HapticFeedback: HapticFeedback;
+    /**
+     * 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. You can only pass
+     * Telegram.WebApp.themeParams.bg_color or
+     * Telegram.WebApp.themeParams.secondary_bg_colo as a color or you can use
+     * keywords bg_color, secondary_bg_color instead.
+     */
+    setHeaderColor(color: 'bg_color' | 'secondary_bg_color'): void;
+    /**
+     * A method that sets the app background color in the #RRGGBB format or you
+     * can use keywords bg_color, secondary_bg_color instead.
+     */
+    setBackgroundColor(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.
+     */
+    enableClosingConfirmation(): void;
+    /**
+     * A method that disables the confirmation dialog while the user is trying to close the Web App.
+     */
+    disableClosingConfirmation(): void;
     /**
      * A method that sets the app event handler. Check the list of available
      * events.
      */
-    onEvent(eventType: 'themeChanged' | 'mainButtonClicked', eventHandler: () => void): void;
-    onEvent(eventType: 'viewPortChanged', eventHandler: (eventData: { isStateStable: boolean }) => void): void;
+    onEvent(
+        eventType: 'themeChanged' | 'mainButtonClicked' | 'backButtonClicked' | 'settingsButtonClicked' | 'popupClosed',
+        eventHandler: () => void,
+    ): void;
+    onEvent(eventType: 'viewportChanged', eventHandler: (eventData: { isStateStable: boolean }) => void): void;
     /** A method that deletes a previously set event handler. */
-    offEvent(eventType: 'themeChanged' | 'mainButtonClicked', eventHandler: () => void): void;
-    offEvent(eventType: 'viewPortChanged', eventHandler: (eventData: { isStateStable: boolean }) => void): void;
+    offEvent(
+        eventType: 'themeChanged' | 'mainButtonClicked' | 'backButtonClicked' | 'settingsButtonClicked' | 'popupClosed',
+        eventHandler: () => void,
+    ): void;
+    offEvent(eventType: 'viewportChanged', eventHandler: (eventData: { isStateStable: boolean }) => void): 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
@@ -97,6 +154,44 @@ interface WebApp {
      * This method is only available for Web Apps launched via a Keyboard button.
      */
     sendData(data: string): void;
+    /**
+     * A method that opens a link in an external browser. The Web App will not
+     * be closed. Note that this method can be called only in response to the
+     * user interaction with the Web App interface (e.g. click inside the Web
+     * App or on the main button)
+     */
+    openLink(url: string): void;
+    /**
+     * A method that opens a telegram link inside Telegram app. The Web App will
+     * be closed.
+     */
+    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.
+     */
+    openInvoice(url: string, callback: () => void): 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 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
@@ -152,6 +247,93 @@ interface ThemeParams {
      * var(--tg-theme-button-text-color).
      */
     button_text_color: string;
+    /**
+     * Optional. Bot API 6.1+ Secondary background color in the #RRGGBB format.
+     * Also available as the CSS variable var(--tg-theme-secondary-bg-color).
+     */
+    secondary_bg_color: string;
+}
+
+/**
+ * This object describes the native popup.
+ */
+interface PopupParams {
+    /**
+     * The text to be displayed in the popup title, 0-64 characters.
+     */
+    title?: string;
+    /**
+     * The message to be displayed in the body of the popup, 1-256 characters.
+     */
+    message: string;
+    /**
+     * List of buttons to be displayed in the popup, 1-3 buttons. Set to [{“type”:“close”}] by default.
+     */
+    buttons?: PopupButton[];
+}
+
+/**
+ * This object describes the native popup button.
+ */
+type PopupButton = {
+    /**
+     * Identifier of the button, 0-64 characters. Set to empty string by default.
+     * If the button is pressed, its id is returned in the callback and the popupClosed event.
+     */
+    id?: string;
+    /**
+     * Type of the button. Set to default by default.
+     * Can be one of these values:
+     * - `default`, a button with the default style,
+     * - `ok`, a button with the localized text “OK”,
+     * - `close`, a button with the localized text “Close”,
+     * - `cancel`, a button with the localized text “Cancel”,
+     * - `destructive`, a button with a style that indicates a destructive action (e.g. “Remove”, “Delete”, etc.).
+     */
+    type?: 'default' | 'ok' | 'close' | 'cancel' | 'destructive';
+    /**
+     * The text to be displayed on the button, 0-64 characters.
+     * Required if type is default or destructive. Irrelevant for other types.
+     */
+    text?: string;
+} & (
+    | {
+          type: 'default' | 'destructive';
+          text: string;
+      }
+    | {
+          type: 'ok' | 'close' | 'cancel';
+          text?: string;
+      }
+);
+
+/**
+ * This object controls the back button, which can be displayed in the header of
+ * the Web App in the Telegram interface.
+ */
+interface BackButton {
+    /**
+     * Shows whether the button is visible. Set to false by default.
+     */
+    isVisible: boolean;
+    /**
+     * A method that sets the button press event handler. An alias for
+     * Telegram.WebApp.onEvent('backButtonClicked', callback)
+     */
+    onClick(callback: () => void): BackButton;
+    /**
+     *  A method that removes the button press event handler. An alias for
+     *  Telegram.WebApp.offEvent('backButtonClicked', callback)
+     */
+    offClick(callback: () => void): BackButton;
+    /**
+     * A method to make the button active and visible.
+     */
+    show(): void;
+    /**
+     * A method to hide the button.
+     */
+    hide(): void;
 }
 
 /**
@@ -228,6 +410,41 @@ interface MainButtonParams {
     is_visible?: boolean;
 }
 
+/**
+ *  This object controls haptic feedback.
+ */
+interface HapticFeedback {
+    /**
+     * A method tells that an impact occurred. The Telegram app may play the
+     * appropriate haptics based on style value passed. Style can be one of
+     * these values:
+     * - light, indicates a collision between small or lightweight UI objects,
+     * - medium, indicates a collision between medium-sized or medium-weight UI
+     *   objects,
+     * - heavy, indicates a collision between large or heavyweight UI objects,
+     * - rigid, indicates a collision between hard or inflexible UI objects,
+     * - soft, indicates a collision between soft or flexible UI objects.
+     */
+    impactOccurred(style: 'light' | 'medium' | 'heavy' | 'rigid' | 'soft'): () => void;
+    /**
+     * A method tells that a task or action has succeeded, failed, or produced a
+     * warning. The Telegram app may play the appropriate haptics based on type
+     * value passed. Type can be one of these values:
+     * - error, indicates that a task or action has failed,
+     * - success, indicates that a task or action has completed successfully,
+     * - warning, indicates that a task or action produced a warning.
+     */
+    notificationOccurred(type: 'error' | 'success' | 'warning'): () => void;
+    /**
+     * A method tells that the user has changed a selection. The Telegram app
+     * may play the appropriate haptics.
+     *
+     * Do not use this feedback when the user makes or confirms a selection; use
+     * it only when the selection changes.
+     */
+    selectionChanged(): void;
+}
+
 /**
  * This object contains data that is transferred to the Web App when it is
  * opened. It is empty if the Web App was launched from a keyboard button.
@@ -246,6 +463,12 @@ interface WebAppInitData {
      * Web Apps launched via the attachment menu.
      */
     receiver?: WebAppUser;
+    /**
+     * An object containing data about the chat where the bot was launched via
+     * the attachment menu. Returned for supergroups, channels and group chats –
+     * only for Web Apps launched via the attachment menu.
+     */
+    chat?: WebAppChat;
     /**
      * The value of the startattach parameter, passed via link. Only returned for
      * Web Apps when launched from the attachment menu via link. The value of the
@@ -254,6 +477,11 @@ interface WebAppInitData {
      * away.
      */
     start_param?: string;
+    /**
+     * Time in seconds, after which a message can be sent via the
+     * answerWebAppQuery method.
+     */
+    can_send_after?: number;
     /** Unix time when the form was opened. */
     auth_date: number;
     /**
@@ -283,9 +511,42 @@ interface WebAppUser {
     username?: string;
     /** IETF language tag of the user's language. Returns in user field only. */
     language_code?: string;
+    /** True, if this user is a Telegram Premium user. */
+    is_premium?: true;
     /**
      * URL of the user’s profile photo. The photo can be in .jpeg or .svg formats.
      * Only returned for Web Apps launched from the attachment menu.
      */
     photo_url?: string;
 }
+
+/**
+ * This object represents a chat.
+ */
+interface WebAppChat {
+    /**
+     * Unique identifier for this chat. This number may have more than 32
+     * significant bits and some programming languages may have
+     * difficulty/silent defects in interpreting it. But it has at most 52
+     * significant bits, so a signed 64-bit integer or double-precision float
+     * type are safe for storing this identifier.
+     */
+    id: number;
+    /**
+     * Type of chat, can be either “group”, “supergroup” or “channel”
+     */
+    type: 'group' | 'supergroup' | 'channel';
+    /**
+     * Title of the chat
+     */
+    title: string;
+    /**
+     * Username of the chat
+     */
+    username?: string;
+    /**
+     * URL of the chat’s photo. The photo can be in .jpeg or .svg formats. Only
+     * returned for Web Apps launched from the attachment menu.
+     */
+    photo_url?: string;
+}

telegram-web-app/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@types/telegram-web-app",
-    "version": "1.0.0",
+    "version": "6.2.1",
     "description": "TypeScript definitions for telegram-web-app",
     "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/telegram-web-app",
     "license": "MIT",
@@ -9,6 +9,11 @@
             "name": "KnorpelSenf",
             "url": "https://github.com/KnorpelSenf",
             "githubUsername": "KnorpelSenf"
+        },
+        {
+            "name": "MKRhere",
+            "url": "https://github.com/MKRhere",
+            "githubUsername": "MKRhere"
         }
     ],
     "main": "",
@@ -20,6 +25,6 @@
     },
     "scripts": {},
     "dependencies": {},
-    "typesPublisherContentHash": "8d62315952a0efc30b1381ab61d025d615e9df2751d319c732ab50c2125be5d1",
-    "typeScriptVersion": "3.9"
+    "typesPublisherContentHash": "8de5d205746171b3f8012f70c1006dc3f6a9b848a056d449623b1ec0315600fa",
+    "typeScriptVersion": "4.1"
 }