@types/telegram-web-app 6.9.4 → 7.1.0

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, 30 Jan 2024 21:35:45 GMT
+ * Last updated: Wed, 06 Mar 2024 06:35:45 GMT
  * Dependencies: none
 
 # Credits

telegram-web-app/index.d.ts

@@ -100,6 +100,11 @@ interface WebApp {
      * bottom of the Web App in the Telegram interface.
      */
     MainButton: MainButton;
+    /**
+     * 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.
      */
@@ -152,7 +157,7 @@ interface WebApp {
         eventType: "writeAccessRequested",
         eventHandler: (eventData: { status: "allowed" | "cancelled" }) => void,
     ): void;
-    onEvent(eventType: "contactRequested", eventHandler: (eventData: { status: "sent" | "cancelled" }) => void): void;
+    onEvent(eventType: "contactRequested", eventHandler: (eventData: RequestContactResponse) => void): void;
 
     /** A method that deletes a previously set event handler. */
     offEvent(
@@ -171,7 +176,7 @@ interface WebApp {
         eventType: "writeAccessRequested",
         eventHandler: (eventData: { status: "allowed" | "cancelled" }) => void,
     ): void;
-    offEvent(eventType: "contactRequested", eventHandler: (eventData: { status: "sent" | "cancelled" }) => void): void;
+    offEvent(eventType: "contactRequested", eventHandler: (eventData: RequestContactResponse) => void): void;
 
     /**
      * A method used to send data to the bot. When this method is called, a
@@ -234,7 +239,7 @@ interface WebApp {
      * 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;
+    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.
@@ -273,9 +278,12 @@ interface WebApp {
      * @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.
+     * 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) => void): void;
+    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
@@ -302,40 +310,71 @@ interface WebApp {
  */
 interface ThemeParams {
     /**
-     * Background color in the #RRGGBB format. Also available as the CSS variable
-     * var(--tg-theme-bg-color).
+     * Background color in the `#RRGGBB` format.
+     * Also 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)`.
+     */
+    text_color?: string;
+    /**
+     * Hint text color in the `#RRGGBB` format.
+     * Also 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)`.
+     */
+    link_color?: string;
+    /**
+     * Button color in the `#RRGGBB` format.
+     * Also 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)`.
+     */
+    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)`.
      */
-    bg_color: string;
+    secondary_bg_color?: string;
     /**
-     * Main text color in the #RRGGBB format. Also available as the CSS variable
-     * var(--tg-theme-text-color).
+     * **Bot API 7.0+** Header background color in the `#RRGGBB` format.
+     * Also available as the CSS variable `var(--tg-theme-header-bg-color)`.
      */
-    text_color: string;
+    header_bg_color?: string;
     /**
-     * Hint text color in the #RRGGBB format. Also available as the CSS variable
-     * var(--tg-theme-hint-color).
+     * **Bot API 7.0+** Accent text color in the `#RRGGBB` format.
+     * Also available as the CSS variable `var(--tg-theme-accent-text-color)`.
      */
-    hint_color: string;
+    accent_text_color?: string;
     /**
-     * Link color in the #RRGGBB format. Also available as the CSS variable
-     * var(--tg-theme-link-color).
+     * **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)`.
      */
-    link_color: string;
+    section_bg_color?: string;
     /**
-     * Button color in the #RRGGBB format. Also available as the CSS variable
-     * var(--tg-theme-button-color).
+     * **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)`.
      */
-    button_color: string;
+    section_header_text_color?: `#${string}`;
     /**
-     * Button text color in the #RRGGBB format. Also available as the CSS variable
-     * var(--tg-theme-button-text-color).
+     * **Bot API 7.0+** Subtitle text color in the `#RRGGBB` format.
+     * Also available as the CSS variable `var(--tg-theme-subtitle-text-color)`.
      */
-    button_text_color: string;
+    subtitle_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).
+     * **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)`.
      */
-    secondary_bg_color: string;
+    destructive_text_color?: string;
 }
 
 /**
@@ -496,6 +535,37 @@ interface MainButtonParams {
     is_visible?: boolean;
 }
 
+/**
+ * This object controls the Settings item in the context menu of the Mini App in the
+ * Telegram interface.
+ */
+interface SettingsButton {
+    /**
+     * Shows whether the context menu item is visible. Set to false by default.
+     */
+    isVisible: boolean;
+    /**
+     * **Bot API 7.0+** A method that sets the press event handler for the Settings item in
+     * the context menu. An alias for
+     * `Telegram.WebApp.onEvent('settingsButtonClicked', callback)`
+     */
+    onClick(callback: () => void): SettingsButton;
+    /**
+     * **Bot API 7.0+** A method that removes the press event handler from the Settings item
+     * in the context menu. An alias for
+     * `Telegram.WebApp.offEvent('settingsButtonClicked', callback)`
+     */
+    offClick(callback: () => void): SettingsButton;
+    /**
+     * **Bot API 7.0+** A method to make the Settings item in the context menu visible.
+     */
+    show(): SettingsButton;
+    /**
+     * **Bot API 7.0+** A method to hide the Settings item in the context menu.
+     */
+    hide(): SettingsButton;
+}
+
 /**
  *  This object controls haptic feedback.
  */
@@ -742,3 +812,43 @@ interface ScanQrPopupParams {
      */
     text?: string;
 }
+
+/**
+ * This object describes contact information shared when requestContact was approved by the user.
+ */
+interface RequestContactResponseSent {
+    /** Status 'sent' indicates that contact information has been shared. */
+    status: "sent";
+    /** A status message or result as a string. */
+    response: string;
+    /** Contains sensitive information shared upon user consent. WARNING: Data from
+     * this field should not be trusted. You should only use data from `response` on
+     * the bot's server and only after it has been validated. */
+    responseUnsafe: {
+        /** Authorization date for sharing contact information. */
+        auth_date: string;
+        /** Object holding user's contact details. */
+        contact: {
+            /** User's first name. */
+            first_name: string;
+            /** Optional. User's last name. */
+            last_name?: string;
+            /** User's phone number. */
+            phone_number: string;
+            /** Unique identifier of the user. */
+            user_id: number;
+        };
+        /** Hash to verify data authenticity. */
+        hash: string;
+    };
+}
+
+/**
+ * This object only contains a status to indicate the cancellation.
+ */
+interface RequestContactResponseCancelled {
+    /** Status 'cancelled', indicates that user cancelled the contact share request. */
+    status: "cancelled";
+}
+
+type RequestContactResponse = RequestContactResponseSent | RequestContactResponseCancelled;

telegram-web-app/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@types/telegram-web-app",
-    "version": "6.9.4",
+    "version": "7.1.0",
     "description": "TypeScript definitions for telegram-web-app",
     "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/telegram-web-app",
     "license": "MIT",
@@ -30,6 +30,6 @@
     },
     "scripts": {},
     "dependencies": {},
-    "typesPublisherContentHash": "f70f23a3b990dc2c535e121fd523ee59fc5f4bdbb0a14704a789480711a9a8ed",
+    "typesPublisherContentHash": "e60f7c8652216a4904f9dec0fa735f121014abd943bd6a19bb9c430198c076b6",
     "typeScriptVersion": "4.6"
 }