@types/telegram-web-app 6.4.0 → 6.7.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: Wed, 25 Jan 2023 19:32:42 GMT
+ * Last updated: Tue, 12 Sep 2023 12:34:33 GMT
  * Dependencies: none
  * Global values: `Telegram`
 
 # Credits
-These definitions were written by [KnorpelSenf](https://github.com/KnorpelSenf), and [MKRhere](https://github.com/MKRhere).
+These definitions were written by [KnorpelSenf](https://github.com/KnorpelSenf), [MKRhere](https://github.com/MKRhere), and [deptyped](https://github.com/deptyped).

telegram-web-app/index.d.ts

@@ -1,6 +1,8 @@
-// Type definitions for non-npm package telegram-web-app 6.4
+// Type definitions for non-npm package telegram-web-app 6.7
 // Project: https://telegram.org/js/telegram-web-app.js
-// Definitions by: KnorpelSenf <https://github.com/KnorpelSenf>, MKRhere <https://github.com/MKRhere>
+// Definitions by: KnorpelSenf <https://github.com/KnorpelSenf>
+//                 MKRhere <https://github.com/MKRhere>
+//                 deptyped <https://github.com/deptyped>
 // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
 
 declare var Telegram: Telegram;
@@ -36,7 +38,7 @@ interface WebApp {
      * The color scheme currently used in the Telegram app. Either “light” or
      * “dark”. Also available as the CSS variable var(--tg-color-scheme).
      */
-    colorScheme: 'light' | 'dark';
+    colorScheme: "light" | "dark";
     /**
      * An object containing the current theme settings used in the Telegram app.
      */
@@ -120,12 +122,12 @@ interface WebApp {
      * 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;
+    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;
+    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.
      */
@@ -139,25 +141,31 @@ interface WebApp {
      * events.
      */
     onEvent(
-        eventType: 'themeChanged' | 'mainButtonClicked' | 'backButtonClicked' | 'settingsButtonClicked',
+        eventType: "themeChanged" | "mainButtonClicked" | "backButtonClicked" | "settingsButtonClicked",
         eventHandler: () => void,
     ): void;
-    onEvent(eventType: 'popupClosed', eventHandler: (eventData: { button_id: string | null }) => void): void;
-    onEvent(eventType: 'viewportChanged', eventHandler: (eventData: { isStateStable: boolean }) => void): void;
-    onEvent(eventType: 'invoiceClosed', eventHandler: (eventData: { url: string, status: 'paid' | 'cancelled' | 'failed' | 'pending' }) => void): void;
-    onEvent(eventType: 'qrTextReceived', eventHandler: (eventData: { data: string }) => void): void;
-    onEvent(eventType: 'clipboardTextReceived', eventHandler: (eventData: { data: string | null }) => void): void;
+    onEvent(eventType: "popupClosed", eventHandler: (eventData: { button_id: string | null }) => void): void;
+    onEvent(eventType: "viewportChanged", eventHandler: (eventData: { isStateStable: boolean }) => void): void;
+    onEvent(
+        eventType: "invoiceClosed",
+        eventHandler: (eventData: { url: string; status: "paid" | "cancelled" | "failed" | "pending" }) => void,
+    ): void;
+    onEvent(eventType: "qrTextReceived", eventHandler: (eventData: { data: string }) => void): void;
+    onEvent(eventType: "clipboardTextReceived", eventHandler: (eventData: { data: string | null }) => void): void;
 
     /** A method that deletes a previously set event handler. */
     offEvent(
-        eventType: 'themeChanged' | 'mainButtonClicked' | 'backButtonClicked' | 'settingsButtonClicked',
+        eventType: "themeChanged" | "mainButtonClicked" | "backButtonClicked" | "settingsButtonClicked",
         eventHandler: () => void,
     ): void;
-    offEvent(eventType: 'popupClosed', eventHandler: (eventData: { button_id: string | null }) => void): void;
-    offEvent(eventType: 'viewportChanged', eventHandler: (eventData: { isStateStable: boolean }) => void): void;
-    offEvent(eventType: 'invoiceClosed', eventHandler: (eventData: { url: string, status: 'paid' | 'cancelled' | 'failed' | 'pending' }) => void): void;
-    offEvent(eventType: 'qrTextReceived', eventHandler: (eventData: { data: string }) => void): void;
-    offEvent(eventType: 'clipboardTextReceived', eventHandler: (eventData: { data: string | null }) => void): void;
+    offEvent(eventType: "popupClosed", eventHandler: (eventData: { button_id: string | null }) => void): void;
+    offEvent(eventType: "viewportChanged", eventHandler: (eventData: { isStateStable: boolean }) => void): void;
+    offEvent(
+        eventType: "invoiceClosed",
+        eventHandler: (eventData: { url: string; status: "paid" | "cancelled" | "failed" | "pending" }) => void,
+    ): void;
+    offEvent(eventType: "qrTextReceived", eventHandler: (eventData: { data: string }) => void): void;
+    offEvent(eventType: "clipboardTextReceived", eventHandler: (eventData: { data: string | null }) => void): void;
 
     /**
      * A method used to send data to the bot. When this method is called, a
@@ -168,6 +176,15 @@ interface WebApp {
      * This method is only available for Web Apps launched via a 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.
+     */
+    switchInlineQuery(query: string, choose_chat_types?: Array<"users" | "bots" | "groups" | "channels">): void;
     /**
      * A method that opens a link in an external browser.
      * The Web App will not be closed.
@@ -189,7 +206,10 @@ interface WebApp {
      *  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: (url: string, status: 'paid' | 'cancelled' | 'failed' | 'pending') => void): void;
+    openInvoice(
+        url: string,
+        callback: (url: string, status: "paid" | "cancelled" | "failed" | "pending") => 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
@@ -313,37 +333,39 @@ interface PopupParams {
 /**
  * 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;
-      }
-);
+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
@@ -463,7 +485,7 @@ interface HapticFeedback {
      * - 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;
+    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
@@ -472,7 +494,7 @@ interface HapticFeedback {
      * - 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;
+    notificationOccurred(type: "error" | "success" | "warning"): () => void;
     /**
      * A method tells that the user has changed a selection. The Telegram app
      * may play the appropriate haptics.
@@ -507,6 +529,18 @@ interface WebAppInitData {
      * only for Web Apps launched via the attachment menu.
      */
     chat?: WebAppChat;
+    /**
+     * Type of the chat from which the Web App was opened.
+     * Can be either “sender” for a private chat with the user opening the link,
+     * “private”, “group”, “supergroup”, or “channel”.
+     * Returned only for Web Apps launched from direct links.
+     */
+    chat_type?: "sender" | "private" | "group" | "supergroup" | "channel";
+    /**
+     * Global identifier, uniquely corresponding to the chat from which the Web App was opened.
+     * Returned only for Web Apps launched from a direct link.
+     */
+    chat_instance?: string;
     /**
      * 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
@@ -573,7 +607,7 @@ interface WebAppChat {
     /**
      * Type of chat, can be either “group”, “supergroup” or “channel”
      */
-    type: 'group' | 'supergroup' | 'channel';
+    type: "group" | "supergroup" | "channel";
     /**
      * Title of the chat
      */

telegram-web-app/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@types/telegram-web-app",
-    "version": "6.4.0",
+    "version": "6.7.1",
     "description": "TypeScript definitions for telegram-web-app",
     "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/telegram-web-app",
     "license": "MIT",
@@ -14,6 +14,11 @@
             "name": "MKRhere",
             "url": "https://github.com/MKRhere",
             "githubUsername": "MKRhere"
+        },
+        {
+            "name": "deptyped",
+            "url": "https://github.com/deptyped",
+            "githubUsername": "deptyped"
         }
     ],
     "main": "",
@@ -25,6 +30,6 @@
     },
     "scripts": {},
     "dependencies": {},
-    "typesPublisherContentHash": "4ff79fa77e93a0da90fae05afa269bbe6e8aadb86c1e717120da7975cb8b7d06",
-    "typeScriptVersion": "4.2"
+    "typesPublisherContentHash": "121c0c4b99c08541e5f9b652ced6919485d51a54f491b4c08c9e73099e80e2b6",
+    "typeScriptVersion": "4.3"
 }