@types/telegram-web-app 6.7.0 → 6.9.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: Wed, 26 Apr 2023 21:02:48 GMT
+ * Last updated: Tue, 26 Sep 2023 22:35:04 GMT
  * Dependencies: none
  * Global values: `Telegram`
 

telegram-web-app/index.d.ts

@@ -1,4 +1,4 @@
-// Type definitions for non-npm package telegram-web-app 6.7
+// Type definitions for non-npm package telegram-web-app 6.9
 // Project: https://telegram.org/js/telegram-web-app.js
 // Definitions by: KnorpelSenf <https://github.com/KnorpelSenf>
 //                 MKRhere <https://github.com/MKRhere>
@@ -111,23 +111,25 @@ interface WebApp {
      * An object for controlling haptic feedback.
      */
     HapticFeedback: HapticFeedback;
+    /**
+     * An object for controlling cloud storage.
+     */
+    CloudStorage: CloudStorage;
     /**
      * 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 header color in the `#RRGGBB` format.
+     * You can also use keywords bg_color and secondary_bg_color.
+     */ // string & {} prevents this from eagerly collapsing into just string
+    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 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.
      */
@@ -146,9 +148,17 @@ interface WebApp {
     ): 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: '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: 'writeAccessRequested',
+        eventHandler: (eventData: { status: 'allowed' | 'cancelled' }) => void,
+    ): void;
+    onEvent(eventType: 'contactRequested', eventHandler: (eventData: { status: 'sent' | 'cancelled' }) => void): void;
 
     /** A method that deletes a previously set event handler. */
     offEvent(
@@ -157,9 +167,17 @@ interface WebApp {
     ): 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: '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: 'writeAccessRequested',
+        eventHandler: (eventData: { status: 'allowed' | 'cancelled' }) => void,
+    ): void;
+    offEvent(eventType: 'contactRequested', eventHandler: (eventData: { status: 'sent' | 'cancelled' }) => void): void;
 
     /**
      * A method used to send data to the bot. When this method is called, a
@@ -200,7 +218,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
@@ -241,6 +262,26 @@ interface WebApp {
      * in response to a user interaction with the Web App interface (e.g. a click inside the Web App or on the main button).
      */
     readTextFromClipboard(callback?: (data: string | null) => void): void;
+    /**
+     * A method that shows a native popup requesting permission for the bot to
+     * send messages to the user.
+     *
+     * @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.
+     */
+    requestWriteAccess(callback?: (success: boolean) => void): void;
+    /**
+     * A method that shows a native popup prompting the user for their phone
+     * number.
+     *
+     * @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.
+     */
+    requestContact(callback?: (success: 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
@@ -494,6 +535,86 @@ interface HapticFeedback {
     selectionChanged(): void;
 }
 
+interface CloudStorage {
+    /**
+     * A method that stores a value in the cloud storage using the
+     * specified key.
+     *
+     * @param key The key should contain 1-128 characters, only A-Z, a-z, 0-9,
+     * _ and - are allowed.
+     * @param value The value should contain 0-4096 characters. You can store
+     * up to 1024 keys in the cloud storage.
+     * @param callback If an optional callback parameter was passed, the
+     * callback function will be called. In case of an error, the first argument
+     * will contain the error. In case of success, the first argument will be
+     * null and the second argument will be a boolean indicating whether the
+     * value was stored.
+     */
+    setItem(key: string, value: string, callback?: (error: string | null, success: null | true) => void): CloudStorage;
+    /**
+     * A method that receives a value from the cloud storage using
+     * the specified key.
+     *
+     * @param key The key should contain 1-128 characters, only A-Z, a-z, 0-9,
+     * _ and - are allowed.
+     * @param callback In case of an error, the callback function will
+     * be called and the first argument will contain the error. In case of
+     * success, the first argument will be null and the value will be passed
+     * as the second argument.
+     */
+    getItem(key: string, callback?: (error: string | null, value: null | string) => void): CloudStorage;
+    /**
+     * A method that receives values from the cloud storage using the specified
+     * keys.
+     *
+     * @param key The keys should contain 1-128 characters, only A-Z, a-z, 0-9,
+     * _ and - are allowed.
+     * @param callback In case of an error, the callback? function will be
+     * called and the first argument will contain the error. In case of
+     * success, the first argument will be null and the values will be passed
+     * as the second argument.
+     */
+    getItems(
+        keys: string[],
+        callback?: (error: string | null, values: null | Record<string, string>) => void,
+    ): CloudStorage;
+    /**
+     * A method that removes a value from the cloud storage using the specified
+     * key.
+     *
+     * @param key The key should contain 1-128 characters, only A-Z, a-z, 0-9,
+     * _ and - are allowed.
+     * @param callback If an optional callback parameter was passed, the
+     * callback function will be called. In case of an error, the first
+     * argument will contain the error. In case of success, the first
+     * argument will be null and the second argument will be a boolean
+     * indicating whether the value was removed.
+     */
+    removeItem(key: string, callback?: (error: string | null, success: null | true) => void): CloudStorage;
+    /**
+     * A method that removes values from the cloud storage using the specified
+     * keys.
+     *
+     * @param key The keys should contain 1-128 characters, only A-Z, a-z, 0-9,
+     * _ and - are allowed.
+     * @param callback If an optional callback parameter was passed, the
+     * callback function will be called. In case of an error, the first
+     * argument will contain the error. In case of success, the first
+     * argument will be null and the second argument will be a boolean
+     * indicating whether the values were removed.
+     */
+    removeItems(keys: string[], callback?: (error: string | null, success: null | true) => void): CloudStorage;
+    /**
+     * A method that receives the list of all keys stored in the cloud storage.
+     *
+     * @param callback In case of an error, the callback function will be called
+     * and the first argument will contain the error. In case of success, the
+     * first argument will be null and the list of keys will be passed as the
+     * second argument.
+     */
+    getKeys(callback?: (error: string | null, keys: null | string[]) => void): CloudStorage;
+}
+
 /**
  * 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.
@@ -574,6 +695,10 @@ interface WebAppUser {
     language_code?: string;
     /** True, if this user is a Telegram Premium user. */
     is_premium?: true;
+    /** True, if this user added the bot to the attachment menu. */
+    added_to_attachment_menu?: true;
+    /** True, if this user allowed the bot to message them. */
+    allows_write_to_pm?: 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.

telegram-web-app/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@types/telegram-web-app",
-    "version": "6.7.0",
+    "version": "6.9.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": "087c84405ec21f5ea2663c05b6ff92799f58e740cd633c419e95f197342d36bc",
-    "typeScriptVersion": "4.3"
+    "typesPublisherContentHash": "2f5a5fcf817fe0bf0a0e10016c001674a72d56fe50e45e2ee126f9db11c37afb",
+    "typeScriptVersion": "4.5"
 }