@types/telegram-web-app 7.0.0 → 7.2.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: Sun, 04 Feb 2024 10:07:03 GMT
+ * Last updated: Mon, 01 Apr 2024 17:35:38 GMT
  * Dependencies: none
 
 # Credits

telegram-web-app/index.d.ts

@@ -113,6 +113,10 @@ interface WebApp {
      * An object for controlling cloud storage.
      */
     CloudStorage: CloudStorage;
+    /**
+     * An object for controlling biometrics on the device.
+     */
+    BiometricManager: BiometricManager;
     /**
      * 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.
@@ -142,7 +146,12 @@ interface WebApp {
      * events.
      */
     onEvent(
-        eventType: "themeChanged" | "mainButtonClicked" | "backButtonClicked" | "settingsButtonClicked",
+        eventType:
+            | "themeChanged"
+            | "mainButtonClicked"
+            | "backButtonClicked"
+            | "settingsButtonClicked"
+            | "biometricManagerUpdated",
         eventHandler: () => void,
     ): void;
     onEvent(eventType: "popupClosed", eventHandler: (eventData: { button_id: string | null }) => void): void;
@@ -157,11 +166,21 @@ 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;
+    onEvent(
+        eventType: "biometricAuthRequested",
+        eventHandler: (eventData: { isAuthenticated: boolean; biometricToken?: string }) => void,
+    ): void;
+    onEvent(eventType: "biometricTokenUpdated", eventHandler: (eventData: { isUpdated: boolean }) => void): void;
 
     /** A method that deletes a previously set event handler. */
     offEvent(
-        eventType: "themeChanged" | "mainButtonClicked" | "backButtonClicked" | "settingsButtonClicked",
+        eventType:
+            | "themeChanged"
+            | "mainButtonClicked"
+            | "backButtonClicked"
+            | "settingsButtonClicked"
+            | "biometricManagerUpdated",
         eventHandler: () => void,
     ): void;
     offEvent(eventType: "popupClosed", eventHandler: (eventData: { button_id: string | null }) => void): void;
@@ -176,7 +195,12 @@ 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;
+    offEvent(
+        eventType: "biometricAuthRequested",
+        eventHandler: (eventData: { isAuthenticated: boolean; biometricToken?: string }) => void,
+    ): void;
+    offEvent(eventType: "biometricTokenUpdated", eventHandler: (eventData: { isUpdated: boolean }) => void): void;
 
     /**
      * A method used to send data to the bot. When this method is called, a
@@ -278,9 +302,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
@@ -678,6 +705,110 @@ interface CloudStorage {
     getKeys(callback?: (error: string | null, keys: null | string[]) => void): CloudStorage;
 }
 
+/**
+ * This object controls biometrics on the device. Before the first use
+ * of this object, it needs to be initialized using the init method.
+ */
+interface BiometricManager {
+    /**
+     * Shows whether biometrics object is initialized.
+     */
+    isInited: boolean;
+    /**
+     * Shows whether biometrics is available on the current device.
+     */
+    isBiometricAvailable: boolean;
+    /**
+     * The type of biometrics currently available on the device. Can be one of these values:
+     * - finger, fingerprint-based biometrics,
+     * - face, face-based biometrics,
+     * - unknown, biometrics of an unknown type.
+     */
+    biometricType: "finger" | "face" | "unkown";
+    /**
+     * Shows whether permission to use biometrics has been requested.
+     */
+    isAccessRequested: boolean;
+    /**
+     * Shows whether permission to use biometrics has been granted.
+     */
+    isAccessGranted: boolean;
+    /**
+     * Shows whether the token is saved in secure storage on the device.
+     */
+    isBiometricTokenSaved: boolean;
+    /**
+     * A unique device identifier that can be used to match the token to the device.
+     */
+    deviceId: string;
+    /**
+     * A method that initializes the BiometricManager object. It should be called before
+     * the object's first use. If an optional callback parameter was passed, the callback
+     * function will be called when the object is initialized.
+     */
+    init: (callback?: (isAccessGranted: boolean) => void) => BiometricManager;
+    /**
+     * A method that requests permission to use biometrics according to the params
+     * argument of type BiometricRequestAccessParams. If an optional callback
+     * parameter was passed, the callback function will be called and the first argument
+     * will be a boolean indicating whether the user granted access.
+     */
+    requestAccess: (
+        params: BiometricRequestAccessParams,
+        callback?: (isAccessGranted: boolean) => void,
+    ) => BiometricManager;
+    /**
+     * A method that authenticates the user using biometrics according to the params
+     * argument of type BiometricAuthenticateParams. If an optional callback parameter
+     * was passed, the callback function will be called and the first argument will be
+     * a boolean indicating whether the user authenticated successfully.
+     *
+     * If so, the second argument will be a biometric token.
+     */
+    authenticate: (
+        params: BiometricAuthenticateParams,
+        callback?: (isAuthenticated: boolean, biometricToken?: string) => void,
+    ) => BiometricManager;
+    /**
+     * A method that updates the biometric token in secure storage on the device.
+     * To remove the token, pass an empty string. If an optional callback parameter
+     * was passed, the callback function will be called and the first argument will be
+     * a boolean indicating whether the token was updated.
+     */
+    updateBiometricToken: (token: string, callback?: (applied: boolean) => void) => BiometricManager;
+    /**
+     * A method that opens the biometric access settings for bots. Useful when you
+     * need to request biometrics access to users who haven't granted it yet.
+     *
+     * Note 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)
+     */
+    openSettings: () => BiometricManager;
+}
+
+/**
+ * This object describes the native popup for requesting permission to use biometrics.
+ */
+interface BiometricRequestAccessParams {
+    /**
+     * The text to be displayed to a user in the popup describing why the bot needs
+     * access to biometrics, 0-128 characters.
+     */
+    reason?: string;
+}
+
+/**
+ * This object describes the native popup for authenticating the user using biometrics.
+ */
+interface BiometricAuthenticateParams {
+    /**
+     * The text to be displayed to a user in the popup describing why you are asking them
+     * to authenticate and what action you will be taking based on that authentication,
+     * 0-128 characters.
+     */
+    reason?: string;
+}
+
 /**
  * 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.
@@ -809,3 +940,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": "7.0.0",
+    "version": "7.2.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": "268c74054d2f36d843d570017d3e167f71be94be3621b7ad5e6ec33c95bd93be",
-    "typeScriptVersion": "4.6"
+    "typesPublisherContentHash": "9b6c2ed98451f412f06d422b59f9c79f95aeedab280ed7756fb647e3b90c76fc",
+    "typeScriptVersion": "4.7"
 }