telegram-sdk/dist/index.d.ts

Telegram Web App - (Uses July 7, 2024, Bot API 7.7)

type Telegram = {
    WebApp: WebAppType;
    WebView: WebViewType;
};
type WebAppType = {
    initData: string;
    initDataUnsafe: WebAppInitData;
    version: string;
    platform: string;
    colorScheme: DefaultColorSchemeTypes;
    themeParams: ThemeParams;
    isExpanded: boolean;
    viewportHeight: number;
    viewportStableHeight: number;
    headerColor: ColorHexType;
    backgroundColor: ColorHexType;
    isClosingConfirmationEnabled: boolean;
    isVerticalSwipesEnabled: boolean;
    BackButton: BackButton;
    MainButton: MainButton;
    SettingsButton: SettingsButton;
    HapticFeedback: HapticFeedback;
    CloudStorage: CloudStorage;
    BiometricManager: BiometricManager;
    isVersionAtLeast(version: string): (version: string) => boolean;
    setHeaderColor(color: "bg_color" | "secondary_bg_color"): (color: "bg_color" | "secondary_bg_color") => void;
    setBackgroundColor(color: ColorThemeTypes | ColorHexType): (color: ColorThemeTypes | ColorHexType) => void;
    enableClosingConfirmation(): Function;
    disableClosingConfirmation(): Function;
    enableVerticalSwipes(): Function;
    disableVerticalSwipes(): Function;
    onEvent<T extends EventTypes>(eventType: T, eventHandler: (params: EventHandlers[T]) => unknown): <T extends EventTypes>(eventType: T, eventHandler: (params: EventHandlers[T]) => unknown) => void;
    offEvent<T extends EventTypes>(eventType: T, eventHandler: (params: EventHandlers[T]) => unknown): <T extends EventTypes>(eventType: T, eventHandler: (params: EventHandlers[T]) => unknown) => void;
    sendData(data: unknown): (data: unknown) => void;
    switchInlineQuery(query: string, choose_chat_types?: Array<"users" | "bots" | "groups" | "channels">): (query: string, choose_chat_types?: Array<"users" | "bots" | "groups" | "channels">) => void;
    openLink(url: string, options?: {
        try_instant_view: boolean;
    }): (url: string, options?: {
        try_instant_view: boolean;
    }) => void;
    openTelegramLink(url: string): (url: string) => void;
    openInvoice(url: string, callback?: (status: InvoiceStatus) => unknown): (url: string, callback?: (status: InvoiceStatus) => unknown) => void;
    showPopup(params: PopupParams, callback?: (id?: string) => unknown): (params: PopupParams, callback?: (id?: string) => unknown) => void;
    showAlert(message: string, callback?: () => unknown): (message: string, callback?: () => unknown) => void;
    showConfirm(message: string, callback?: (confirmed: boolean) => void): (message: string, callback?: (confirmed: boolean) => void) => void;
    showScanQrPopup(params: ScanQrPopupParams, callback?: (text: string) => void | true): (params: ScanQrPopupParams, callback?: (text: string) => void | true) => void;
    closeScanQrPopup(): () => void;
    readTextFromClipboard(callback?: (text: string) => unknown): (callback?: (text: string) => unknown) => void;
    requestWriteAccess(callback?: (access: boolean) => unknown): (callback?: (access: boolean) => unknown) => void;
    requestContact(callback?: (access: boolean) => unknown): (callback?: (access: boolean) => unknown) => void;
    ready(): Function;
    expand(): Function;
    close(): Function;
    shareToStory(): (media_url: string, params: any) => void;
};
type WebViewType = {
    callEventCallbacks: (eventType: EventTypes, func: Function) => void;
    initParams: any;
    isIframe: boolean;
    onEvent<T extends EventTypes>(eventType: T, eventHandler: (params: EventHandlers[T]) => unknown): <T extends EventTypes>(eventType: T, eventHandler: (params: EventHandlers[T]) => unknown) => void;
    offEvent<T extends EventTypes>(eventType: T, eventHandler: (params: EventHandlers[T]) => unknown): <T extends EventTypes>(eventType: T, eventHandler: (params: EventHandlers[T]) => unknown) => void;
    postEvent: (eventType: PostEventTypes, callback: Function, eventData: any) => void;
    receiveEvent: (eventType: PostEventTypes, eventData: any) => void;
};
type WebAppInitData = {
    query_id?: string;
    user?: WebAppUser;
    receiver?: WebAppUser;
    chat?: WebAppChat;
    chat_type: DefaultCategoryTypes;
    chat_instance?: string;
    start_param?: string;
    can_send_after?: number;
    auth_date: number;
    hash: string;
};
type WebAppUser = {
    id: number;
    is_bot?: boolean;
    first_name: string;
    last_name?: string;
    username?: string;
    language_code?: string;
    is_premium?: boolean;
    added_to_attachment_menu?: boolean;
    allows_write_to_pm?: boolean;
    photo_url?: string;
};
type WebAppChat = {
    id: number;
    type: GroupChannelCategoryTypes;
    title: string;
    username?: string;
    photo_url?: string;
};
type ThemeParams = {
    bg_color: ColorHexType;
    text_color: ColorHexType;
    hint_color: ColorHexType;
    link_color: ColorHexType;
    button_color: ColorHexType;
    button_text_color: ColorHexType;
    secondary_bg_color: ColorHexType;
    header_bg_color: ColorHexType;
    accent_text_color: ColorHexType;
    section_bg_color: ColorHexType;
    section_header_text_color: ColorHexType;
    subtitle_text_color: ColorHexType;
    destructive_text_color: ColorHexType;
};
type BackButton = {
    isVisible: boolean;
    onClick(callback: Function): (callback: Function) => void;
    offClick(callback: Function): (callback: Function) => void;
    show(): Function;
    hide(): Function;
};
type MainButton = {
    text: string;
    color: ColorHexType;
    textColor: ColorHexType;
    isVisible: boolean;
    isActive: boolean;
    isProgressVisible: boolean;
    setText(text: string): (text: string) => void;
    onClick(callback: Function): (callback: Function) => void;
    offClick(callback: Function): (callback: Function) => void;
    show(): Function;
    hide(): Function;
    enable(): Function;
    disable(): Function;
    showProgress(leaveActive?: boolean): (leaveActive?: boolean) => void;
    hideProgress(): Function;
    setParams(params: {
        color?: string;
        text?: string;
        text_color?: string;
        is_active?: boolean;
        is_visible?: boolean;
    }): (params: {
        color?: string;
        text?: string;
        text_color?: string;
        is_active?: boolean;
        is_visible?: boolean;
    }) => void;
};
type SettingsButton = {
    isVisible: boolean;
    onClick(callback: Function): (callback: Function) => SettingsButton;
    offClick(callback: Function): (callback: Function) => SettingsButton;
    show(): () => SettingsButton;
    hide(): () => SettingsButton;
};
type HapticFeedback = {
    impactOccurred(style: ImpactOccurredStyleType): (style: ImpactOccurredStyleType) => HapticFeedback;
    notificationOccurred(type: StatusType): (type: StatusType) => HapticFeedback;
    selectionChanged(): () => HapticFeedback;
};
type CloudStorage = {
    setItem(key: CloudStorageKey, value: CloudStorageValue, callback?: (error: string | null, result?: boolean) => void): (key: CloudStorageKey, value: CloudStorageValue, callback?: (error: string | null, result?: boolean) => void) => void;
    getItem(key: CloudStorageKey, callback?: (error: string | null, result?: CloudStorageValue) => void): (key: CloudStorageKey, callback?: (error: string | null, result?: CloudStorageValue) => void) => void;
    getItems(keys: Array<CloudStorageKey>, callback?: (error: string | null, result?: CloudStorageItems) => void): (keys: Array<CloudStorageKey>, callback?: (error: string | null, result?: CloudStorageItems) => void) => void;
    getKeys(callback?: (error: string | null, result?: Array<CloudStorageKey>) => void): (callback?: (error: string | null, result?: Array<CloudStorageKey>) => void) => void;
    removeItem(key: CloudStorageKey, callback?: (error: string | null, result?: boolean) => void): (key: CloudStorageKey, callback?: (error: string | null, result?: boolean) => void) => void;
    removeItems(key: Array<CloudStorageKey>, callback?: (error: string | null, result?: boolean) => void): (key: Array<CloudStorageKey>, callback?: (error: string | null, result?: boolean) => void) => void;
};
type BiometricManager = {
    isInited: boolean;
    isBiometricAvailable: boolean;
    biometricType: BiometricType;
    isAccessRequested: boolean;
    isAccessGranted: boolean;
    isBiometricTokenSaved: boolean;
    deviceId: string;
    init(callback?: () => unknown): (callback?: () => unknown) => unknown;
    requestAccess(params: BiometricRequestAccessParams, callback?: (access: string) => unknown): (params: BiometricRequestAccessParams, callback?: (access: string) => unknown) => void;
    authenticate(params: BiometricAuthenticateParams, callback?: (authenticated: boolean, token: string) => unknown): (params: BiometricAuthenticateParams, callback?: (authenticated: boolean, token: string) => unknown) => void;
    updateBiometricToken(token: string, callback?: (updated: boolean) => unknown): (token: string, callback?: (updated: boolean) => unknown) => unknown;
    openSettings(): Function;
};
type GroupChannelCategoryTypes = 'group' | 'supergroup' | 'channel';
type DefaultCategoryTypes = "sender" | "private" | "group" | "supergroup" | "channel";
type DefaultColorSchemeTypes = "light" | "dark";
type ColorHexType = `#${string}`;
type ColorThemeTypes = "bg_color" | "secondary_bg_color";
type ImpactOccurredStyleType = "light" | "medium" | "heavy" | "rigid" | "soft";
type StatusType = "error" | "success" | "warning";
type CloudStorageKey = string;
type CloudStorageValue = string;
type CloudStorageItems = Record<CloudStorageKey, CloudStorageValue>;
type BiometricType = 'finger' | 'face' | 'unknown';
type BiometricRequestAccessParams = {
    reason?: string;
};
type BiometricAuthenticateParams = {
    reason?: string;
};
type EventTypes = "themeChanged" | "viewportChanged" | "mainButtonClicked" | "backButtonClicked" | "settingsButtonClicked" | "invoiceClosed" | "popupClosed" | "qrTextReceived" | "clipboardTextReceived" | "writeAccessRequested" | "contactRequested" | "biometricManagerUpdated" | "biometricAuthRequested" | "biometricTokenUpdated";
type PostEventTypes = "web_app_setup_closing_behavior" | "web_app_setup_swipe_behavior" | "web_app_set_header_color" | "web_app_set_background_color" | "web_app_setup_back_button" | "web_app_setup_main_button" | "web_app_setup_settings_button" | "web_app_trigger_haptic_feedback" | "web_app_biometry_get_info" | "web_app_biometry_request_access" | "web_app_biometry_request_auth" | "web_app_biometry_update_token" | "web_app_biometry_open_settings" | "web_app_close_scan_qr_popup" | "web_app_invoke_custom_method" | "web_app_data_send" | "web_app_switch_inline_query" | "web_app_open_link" | "web_app_open_tg_link" | "web_app_open_invoice" | "web_app_open_popup" | "web_app_open_scan_qr_popup" | "web_app_close_scan_qr_popup" | "web_app_read_text_from_clipboard" | "web_app_request_write_access" | "web_app_request_phone" | "web_app_share_to_story" | "web_app_ready" | "web_app_expand" | "web_app_close" | "web_app_request_theme" | "web_app_request_viewport";
type EventHandlers = {
    themeChanged: void;
    viewportChanged: {
        isStateStable: boolean;
    };
    mainButtonClicked: void;
    backButtonClicked: void;
    settingsButtonClicked: void;
    invoiceClosed: {
        url: string;
        status: InvoiceStatus;
    };
    popupClosed: {
        button_id: string | null;
    };
    qrTextReceived: {
        data: string;
    };
    clipboardTextReceived: {
        data: string;
    };
    writeAccessRequested: {
        status: "allowed" | "cancelled";
    };
    contactRequested: {
        status: "sent" | "cancelled";
    };
    biometricManagerUpdated: void;
    biometricAuthRequested: {
        isAuthenticated: boolean;
        biometricToken?: string;
    };
    biometricTokenUpdated: {
        isUpdated: boolean;
    };
};
type PopupParams = {
    title?: string;
    message: string;
    buttons?: PopupButton[];
};
type PopupButton = {
    id?: string;
} & ({
    type: "default" | "destructive";
    text: string;
} | {
    type: "ok" | "close" | "cancel";
});
type ScanQrPopupParams = {
    text?: string;
};
type InvoiceStatus = "paid" | "cancelled" | "failed" | "pending";

declare const WebApp: WebAppType;
declare const WebView: WebViewType;

export { type BackButton, type BiometricAuthenticateParams, type BiometricManager, type BiometricRequestAccessParams, type BiometricType, type CloudStorage, type CloudStorageItems, type CloudStorageKey, type CloudStorageValue, type ColorHexType, type ColorThemeTypes, type DefaultCategoryTypes, type DefaultColorSchemeTypes, type EventHandlers, type EventTypes, type GroupChannelCategoryTypes, type HapticFeedback, type ImpactOccurredStyleType, type InvoiceStatus, type MainButton, type PopupButton, type PopupParams, type PostEventTypes, type ScanQrPopupParams, type SettingsButton, type StatusType, type Telegram, type ThemeParams, WebApp, type WebAppChat, type WebAppInitData, type WebAppType, type WebAppUser, WebView, type WebViewType };