@tma.js/sdk 2.7.0 → 3.0.0

package/dist/dts/components/InitData/types.d.ts

@@ -1,132 +0,0 @@
-/**
- * Known type of chat.
- */
-export type ChatType = 'sender' | 'private' | 'group' | 'supergroup' | 'channel' | string;
-/**
- * Describes Telegram Mini Apps [User](https://docs.telegram-mini-apps.com/platform/init-data#user) type.
- */
-export interface User {
-    /**
-     * True, if this user added the bot to the attachment menu.
-     */
-    addedToAttachmentMenu?: boolean;
-    /**
-     * True, if this user allowed the bot to message them.
-     */
-    allowsWriteToPm?: boolean;
-    /**
-     * First name of the user or bot.
-     */
-    firstName: string;
-    /**
-     * A unique identifier for the user or bot.
-     */
-    id: number;
-    /**
-     * True, if this user is a bot. Returned in the `receiver` field only.
-     * @see InitDataParsed.receiver
-     */
-    isBot?: boolean;
-    /**
-     * True, if this user is a Telegram Premium user.
-     */
-    isPremium?: boolean;
-    /**
-     * Last name of the user or bot.
-     */
-    lastName?: string;
-    /**
-     * [IETF language tag](https://en.wikipedia.org/wiki/IETF_language_tag) of the user's language.
-     * Returns in user field only.
-     */
-    languageCode?: string;
-    /**
-     * URL of the user’s profile photo. The photo can be in .jpeg or .svg
-     * formats. Only returned for Mini Apps launched from the attachment menu.
-     */
-    photoUrl?: string;
-    /**
-     * Username of the user or bot.
-     */
-    username?: string;
-}
-/**
- * Describes Telegram Mini Apps [Chat](https://docs.telegram-mini-apps.com/platform/init-data#chat) type.
- */
-export interface Chat {
-    /**
-     * Unique identifier for this chat.
-     */
-    id: number;
-    /**
-     * URL of the chat’s photo. The photo can be in .jpeg or .svg formats.
-     * Only returned for Mini Apps launched from the attachment menu.
-     */
-    photoUrl?: string;
-    /**
-     * Type of the chat.
-     */
-    type: 'group' | 'supergroup' | 'channel' | string;
-    /**
-     * Title of the chat.
-     */
-    title: string;
-    /**
-     * Username of the chat.
-     */
-    username?: string;
-}
-/**
- * Describes Telegram Mini Apps [InitData](https://docs.telegram-mini-apps.com/platform/init-data#parameters-list)
- * type.
- */
-export interface InitDataParsed {
-    /**
-     * Init data generation date.
-     */
-    authDate: Date;
-    /**
-     * The number of seconds after which a message can be sent via the method [answerWebAppQuery](https://core.telegram.org/bots/api#answerwebappquery).
-     */
-    canSendAfter?: number;
-    /**
-     * An object containing data about the chat where the bot was launched via
-     * the attachment menu. Returned for supergroups, channels and group
-     * chats – only for Mini Apps launched via the attachment menu.
-     */
-    chat?: Chat;
-    /**
-     * The type of chat from which Mini App was opened.
-     */
-    chatType?: ChatType;
-    /**
-     * A global identifier indicating the chat from which Mini App was opened. Returned only for
-     * applications opened by direct link.
-     */
-    chatInstance?: string;
-    /**
-     * A hash of all passed parameters, which the bot server can use to
-     * check their [validity](https://core.telegram.org/bots/webapps#validating-data-received-via-the-web-app).
-     */
-    hash: string;
-    /**
-     * A unique identifier for the Mini App session, required for sending
-     * messages via the [answerWebAppQuery](https://core.telegram.org/bots/api#answerwebappquery) method.
-     */
-    queryId?: string;
-    /**
-     * An object containing data about the chat partner of the current user in
-     * the chat where the bot was launched via the attachment menu.
-     * Returned only for private chats and only for Mini Apps launched
-     * via the attachment menu.
-     */
-    receiver?: User;
-    /**
-     * The value of the `startattach` or `startapp` parameter, passed via link.
-     */
-    startParam?: string;
-    /**
-     * An object containing data about the current user.
-     */
-    user?: User;
-}

package/dist/dts/components/Invoice/Invoice.d.ts

@@ -1,31 +0,0 @@
-import { WithSupportsAndTrackableState } from '../../classes/WithSupportsAndTrackableState.js';
-import { InvoiceStatus } from '../../bridge/events/types.js';
-import { PostEvent } from '../../bridge/methods/postEvent.js';
-import { Version } from '../../version/types.js';
-import { InvoiceState } from './types.js';
-
-/**
- * @see API: https://docs.telegram-mini-apps.com/packages/tma-js-sdk/components/invoice
- */
-export declare class Invoice extends WithSupportsAndTrackableState<InvoiceState, 'open'> {
-    private readonly postEvent;
-    constructor(isOpened: boolean, version: Version, postEvent: PostEvent);
-    private set isOpened(value);
-    /**
-     * True if invoice is currently opened.
-     */
-    get isOpened(): boolean;
-    /**
-     * Opens an invoice using its slug.
-     * @param slug - invoice slug.
-     * @throws {Error} Invoice is already opened.
-     */
-    open(slug: string): Promise<InvoiceStatus>;
-    /**
-     * Opens an invoice using its url. It expects passing link in full format, with hostname "t.me".
-     * @param url - invoice URL.
-     * @param type - value type.
-     * @throws {Error} Invoice is already opened.
-     */
-    open(url: string, type: 'url'): Promise<InvoiceStatus>;
-}

package/dist/dts/components/Invoice/initInvoice.d.ts

@@ -1,7 +0,0 @@
-import { Invoice } from './Invoice.js';
-
-/**
- * @returns A new initialized instance of the `Invoice` class.
- * @see Invoice
- */
-export declare const initInvoice: import('../../index.js').InitStaticComponentFn<Invoice>;

package/dist/dts/components/Invoice/types.d.ts

@@ -1,20 +0,0 @@
-import { StateEvents } from '../../classes/State/types.js';
-
-/**
- * Invoice internal state.
- */
-export interface InvoiceState {
-    isOpened: boolean;
-}
-/**
- * Invoice events.
- */
-export type InvoiceEvents = StateEvents<InvoiceState>;
-/**
- * Invoice event name.
- */
-export type InvoiceEventName = keyof InvoiceEvents;
-/**
- * Invoice event listener.
- */
-export type InvoiceEventListener<E extends InvoiceEventName> = InvoiceEvents[E];

package/dist/dts/components/MainButton/MainButton.d.ts

@@ -1,106 +0,0 @@
-import { WithStateUtils } from '../../classes/WithStateUtils.js';
-import { RGB } from '../../colors/types.js';
-import { MainButtonEvents, MainButtonParams, MainButtonProps, MainButtonState } from './types.js';
-import { EventEmitter } from '../../events/event-emitter/EventEmitter.js';
-
-type Emitter = EventEmitter<MainButtonEvents>;
-/**
- * @see Usage: https://docs.telegram-mini-apps.com/platform/main-button
- * @see API: https://docs.telegram-mini-apps.com/packages/tma-js-sdk/components/main-button
- */
-export declare class MainButton extends WithStateUtils<MainButtonState> {
-    private readonly postEvent;
-    constructor({ postEvent, ...rest }: MainButtonProps);
-    /**
-     * The MainButton background color.
-     */
-    get bgColor(): RGB;
-    /**
-     * Sends current local state to the Telegram application.
-     */
-    private commit;
-    /**
-     * Disables the MainButton.
-     * @see Does not work on Android: https://github.com/Telegram-Mini-Apps/issues/issues/1
-     */
-    disable(): this;
-    /**
-     * Enables the MainButton.
-     */
-    enable(): this;
-    /**
-     * Hides the MainButton.
-     */
-    hide(): this;
-    /**
-     * Hides the MainButton loading indicator.
-     */
-    hideLoader(): this;
-    private set isEnabled(value);
-    /**
-     * True if the MainButton is enabled.
-     */
-    get isEnabled(): boolean;
-    private set isLoaderVisible(value);
-    /**
-     * True if the MainButton loader is visible.
-     */
-    get isLoaderVisible(): boolean;
-    private set isVisible(value);
-    /**
-     * True if the MainButton is visible.
-     */
-    get isVisible(): boolean;
-    /**
-     * Adds a new event listener.
-     * @param event - event to listen.
-     * @param listener - listener to add.
-     */
-    on: Emitter['on'];
-    /**
-     * Removes the event listener.
-     * @param event - event to listen.
-     * @param listener - listener to remove.
-     */
-    off: Emitter['off'];
-    /**
-     * Shows the MainButton.
-     *
-     * Note that opening the Mini App from the attachment menu hides the main button until the
-     * user interacts with the Mini App interface.
-     */
-    show(): this;
-    /**
-     * Shows a loading indicator on the Main Button.
-     */
-    showLoader(): this;
-    /**
-     * Sets a new MainButton text. Minimal length for the text is 1 symbol, and maximum is 64 symbols.
-     * @param text - a new text.
-     */
-    setText(text: string): this;
-    /**
-     * Sets a new Main Button text color.
-     * @param textColor - new text color.
-     */
-    setTextColor(textColor: RGB): this;
-    /**
-     * Updates current Main Button color.
-     * @param bgColor - color to set.
-     */
-    setBgColor(bgColor: RGB): this;
-    /**
-     * Allows setting multiple Main Button parameters.
-     * @param params - Main Button parameters.
-     */
-    setParams(params: Partial<MainButtonParams>): this;
-    /**
-     * The MainButton text.
-     */
-    get text(): string;
-    /**
-     * The MainButton text color.
-     */
-    get textColor(): RGB;
-}
-export {};

package/dist/dts/components/MainButton/initMainButton.d.ts

@@ -1,7 +0,0 @@
-import { MainButton } from './MainButton.js';
-
-/**
- * @returns A new initialized instance of the `MainButton` class.
- * @see MainButton
- */
-export declare const initMainButton: import('../../index.js').InitDynamicComponentFn<MainButton>;

package/dist/dts/components/MainButton/types.d.ts

@@ -1,40 +0,0 @@
-import { PostEvent } from '../../bridge/methods/postEvent.js';
-import { StateEvents } from '../../classes/State/types.js';
-import { RGB } from '../../colors/types.js';
-
-export interface MainButtonParams {
-    bgColor: RGB;
-    isEnabled: boolean;
-    isLoaderVisible: boolean;
-    isVisible: boolean;
-    text: string;
-    textColor: RGB;
-}
-/**
- * MainButton constructor properties.
- */
-export interface MainButtonProps extends MainButtonParams {
-    postEvent: PostEvent;
-}
-/**
- * MainButton internal state.
- */
-export interface MainButtonState extends MainButtonParams {
-}
-/**
- * MainButton trackable events.
- */
-export interface MainButtonEvents extends StateEvents<MainButtonState> {
-    /**
-     * The MainButton was clicked.
-     */
-    click: () => void;
-}
-/**
- * MainButton event name.
- */
-export type MainButtonEventName = keyof MainButtonEvents;
-/**
- * MainButton event listener.
- */
-export type MainButtonEventListener<E extends MainButtonEventName> = MainButtonEvents[E];

package/dist/dts/components/MiniApp/MiniApp.d.ts

@@ -1,121 +0,0 @@
-import { WithSupportsAndTrackableState } from '../../classes/WithSupportsAndTrackableState.js';
-import { PhoneRequestedStatus, WriteAccessRequestedStatus } from '../../bridge/events/types.js';
-import { SwitchInlineQueryChatType } from '../../bridge/methods/types/methods.js';
-import { RGB } from '../../colors/types.js';
-import { MiniAppHeaderColor, MiniAppProps, MiniAppState, RequestedContact } from './types.js';
-import { SupportsFn } from '../../supports/types.js';
-import { ExecuteWithTimeout } from '../../types/methods.js';
-
-/**
- * Provides common Mini Apps functionality not covered by other system components.
- */
-export declare class MiniApp extends WithSupportsAndTrackableState<MiniAppState, 'requestPhoneAccess' | 'requestWriteAccess' | 'switchInlineQuery' | 'setHeaderColor' | 'setBackgroundColor'> {
-    private readonly botInline;
-    private readonly postEvent;
-    private readonly createRequestId;
-    private requestPhoneAccessPromise;
-    private requestWriteAccessPromise;
-    constructor({ postEvent, createRequestId, version, botInline, ...rest }: MiniAppProps);
-    /**
-     * Attempts to get requested contact.
-     * @param timeout - request timeout.
-     */
-    private getRequestedContact;
-    /**
-     * The Mini App background color.
-     * @example "#ffaabb"
-     */
-    get bgColor(): RGB;
-    /**
-     * Closes the Mini App.
-     * @param returnBack - should the application be wrapped into the bottom bar.
-     */
-    close(returnBack?: boolean): void;
-    /**
-     * The Mini App header color.
-     * @example "#ffaabb"
-     * @example "bg_color"
-     */
-    get headerColor(): MiniAppHeaderColor;
-    /**
-     * True if the Mini App is currently launched in bot inline mode.
-     */
-    get isBotInline(): boolean;
-    /**
-     * True if the current Mini App background color is recognized as dark.
-     */
-    get isDark(): boolean;
-    /**
-     * Informs the Telegram app that the Mini App is ready to be displayed.
-     *
-     * It is recommended to call this method as early as possible, as soon as all essential
-     * interface elements loaded. Once this method called, the loading placeholder is hidden
-     * and the Mini App shown.
-     *
-     * If the method not called, the placeholder will be hidden only when the page fully loaded.
-     */
-    ready(): void;
-    /**
-     * Requests current user contact information. In contrary to requestPhoneAccess, this method
-     * returns promise with contact information that rejects in case, user denied access, or request
-     * failed.
-     * @param options - additional options.
-     */
-    requestContact({ timeout }?: ExecuteWithTimeout): Promise<RequestedContact>;
-    /**
-     * Requests current user phone access. Method returns promise, which resolves
-     * status of the request. In case, user accepted the request, Mini App bot will receive
-     * the according notification.
-     *
-     * To obtain the retrieved information instead, utilize the `requestContact` method.
-     * @param options - additional options.
-     * @see requestContact
-     */
-    requestPhoneAccess(options?: ExecuteWithTimeout): Promise<PhoneRequestedStatus>;
-    /**
-     * Requests write message access to current user.
-     * @param options - additional options.
-     */
-    requestWriteAccess(options?: ExecuteWithTimeout): Promise<WriteAccessRequestedStatus>;
-    /**
-     * A method used to send data to the bot. When this method called, a service message sent to
-     * the bot containing the data of the length up to 4096 bytes, and the Mini App closed. See the
-     * field `web_app_data` in the class [Message](https://core.telegram.org/bots/api#message).
-     *
-     * This method is only available for Mini Apps launched via a Keyboard button.
-     * @param data - data to send to bot.
-     * @throws {Error} data has incorrect size.
-     */
-    sendData(data: string): void;
-    /**
-     * Updates current Mini App header color.
-     *
-     * @see No effect on desktop: https://github.com/Telegram-Mini-Apps/tma.js/issues/9
-     * @see Works incorrectly in Android: https://github.com/Telegram-Mini-Apps/tma.js/issues/8
-     * @param color - color key or RGB color.
-     */
-    setHeaderColor(color: MiniAppHeaderColor): void;
-    /**
-     * Updates current Mini App background color.
-     *
-     * @see No effect on desktop: https://github.com/Telegram-Mini-Apps/tma.js/issues/9
-     * @see Works incorrectly in Android: https://github.com/Telegram-Mini-Apps/tma.js/issues/8
-     * @param color - RGB color.
-     */
-    setBgColor(color: RGB): void;
-    /**
-     * Checks if specified method parameter is supported by current component.
-     */
-    supportsParam: SupportsFn<'setHeaderColor.color'>;
-    /**
-     * 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. 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.
-     * @param text - text which should be inserted in the input after the current bot name. Max
-     * length is 256 symbols.
-     * @param chatTypes - List of chat types which could be chosen to send the message. Could be
-     * empty list.
-     */
-    switchInlineQuery(text: string, chatTypes?: SwitchInlineQueryChatType[]): void;
-}

package/dist/dts/components/MiniApp/initMiniApp.d.ts

@@ -1,7 +0,0 @@
-import { MiniApp } from './MiniApp.js';
-
-/**
- * @returns A new initialized instance of the `MiniApp` class.
- * @see MiniApp
- */
-export declare const initMiniApp: import('../../index.js').InitDynamicComponentFn<MiniApp>;

package/dist/dts/components/MiniApp/parsing/contact.d.ts

@@ -1,7 +0,0 @@
-import { ValueParser } from '../../../parsing/ValueParser/ValueParser.js';
-import { RequestedContact } from '../types.js';
-
-/**
- * Returns function which parses incoming value as a contact information.
- */
-export declare function contact(): ValueParser<RequestedContact, false>;

package/dist/dts/components/MiniApp/types.d.ts

@@ -1,53 +0,0 @@
-import { PostEvent } from '../../bridge/methods/postEvent.js';
-import { HeaderColorKey } from '../../bridge/methods/types/methods.js';
-import { StateEvents } from '../../classes/State/types.js';
-import { RGB } from '../../colors/types.js';
-import { CreateRequestIdFn } from '../../request-id/types.js';
-import { Version } from '../../version/types.js';
-
-/**
- * MiniApp constructor properties.
- */
-export interface MiniAppProps extends MiniAppState {
-    version: Version;
-    botInline: boolean;
-    createRequestId: CreateRequestIdFn;
-    postEvent: PostEvent;
-}
-/**
- * MiniApp header color.
- */
-export type MiniAppHeaderColor = HeaderColorKey | RGB;
-/**
- * MiniApp internal state.
- */
-export interface MiniAppState {
-    bgColor: RGB;
-    headerColor: MiniAppHeaderColor;
-}
-/**
- * MiniApp trackable events.
- */
-export interface MiniAppEvents extends StateEvents<MiniAppState> {
-}
-/**
- * MiniApp event name.
- */
-export type MiniAppEventName = keyof MiniAppEvents;
-/**
- * MiniApp event listener.
- */
-export type MiniAppEventListener<E extends MiniAppEventName> = MiniAppEvents[E];
-/**
- * Requested contact information.
- */
-export interface RequestedContact {
-    contact: {
-        userId: number;
-        phoneNumber: string;
-        firstName: string;
-        lastName?: string;
-    };
-    authDate: Date;
-    hash: string;
-}

package/dist/dts/components/Popup/Popup.d.ts

@@ -1,30 +0,0 @@
-import { WithSupportsAndTrackableState } from '../../classes/WithSupportsAndTrackableState.js';
-import { PostEvent } from '../../bridge/methods/postEvent.js';
-import { OpenPopupOptions, PopupState } from './types.js';
-import { Version } from '../../version/types.js';
-
-/**
- * @see Usage: https://docs.telegram-mini-apps.com/platform/popup
- * @see API: https://docs.telegram-mini-apps.com/packages/tma-js-sdk/components/popup
- */
-export declare class Popup extends WithSupportsAndTrackableState<PopupState, 'open'> {
-    private readonly postEvent;
-    constructor(isOpened: boolean, version: Version, postEvent: PostEvent);
-    private set isOpened(value);
-    /**
-     * True if the Popup is opened.
-     */
-    get isOpened(): boolean;
-    /**
-     * A method that shows a native popup described by the `params` argument.
-     * Promise will be resolved when popup is closed. Resolved value will have
-     * an identifier of pressed button.
-     *
-     * In case, user clicked outside the popup or clicked top right popup close
-     * button, null will be returned.
-     *
-     * @param options - popup parameters.
-     * @throws {Error} Popup is already opened.
-     */
-    open(options: OpenPopupOptions): Promise<string | null>;
-}

package/dist/dts/components/Popup/initPopup.d.ts

@@ -1,7 +0,0 @@
-import { Popup } from './Popup.js';
-
-/**
- * @returns A new initialized instance of the `Popup` class.
- * @see Popup
- */
-export declare const initPopup: import('../../index.js').InitStaticComponentFn<Popup>;

package/dist/dts/components/Popup/preparePopupParams.d.ts

@@ -1,8 +0,0 @@
-import { PopupParams as BridgePopupParams } from '../../bridge/methods/types/popup.js';
-import { OpenPopupOptions } from './types.js';
-
-/**
- * Prepares popup parameters before sending them to native app.
- * @param params - popup parameters.
- */
-export declare function preparePopupParams(params: OpenPopupOptions): BridgePopupParams;

package/dist/dts/components/QRScanner/QRScanner.d.ts

@@ -1,33 +0,0 @@
-import { WithSupportsAndTrackableState } from '../../classes/WithSupportsAndTrackableState.js';
-import { PostEvent } from '../../bridge/methods/postEvent.js';
-import { Version } from '../../version/types.js';
-import { QRScannerOpenOptions, QRScannerState } from './types.js';
-
-/**
- * @see API: https://docs.telegram-mini-apps.com/packages/tma-js-sdk/components/qr-scanner
- */
-export declare class QRScanner extends WithSupportsAndTrackableState<QRScannerState, 'close' | 'open'> {
-    private readonly postEvent;
-    constructor(isOpened: boolean, version: Version, postEvent: PostEvent);
-    /**
-     * Closes the scanner.
-     */
-    close(): void;
-    private set isOpened(value);
-    /**
-     * Returns true if the scanner is currently opened.
-     */
-    get isOpened(): boolean;
-    /**
-     * Opens the scanner with the specified title shown to user.
-     * The method returns a promise with a scanned QR content and null if the scanner was closed.
-     * @param options - method options.
-     */
-    open(options?: QRScannerOpenOptions): Promise<string | null>;
-    /**
-     * Opens the scanner with the specified title shown to user.
-     * The method returns a promise with a scanned QR content and null if the scanner was closed.
-     * @param text - title to display.
-     */
-    open(text?: string): Promise<string | null>;
-}

package/dist/dts/components/QRScanner/initQRScanner.d.ts

@@ -1,7 +0,0 @@
-import { QRScanner } from './QRScanner.js';
-
-/**
- * @returns A new initialized instance of the `QRScanner` class.
- * @see QRScanner
- */
-export declare const initQRScanner: import('../../index.js').InitStaticComponentFn<QRScanner>;

package/dist/dts/components/QRScanner/types.d.ts

@@ -1,31 +0,0 @@
-import { StateEvents } from '../../classes/State/types.js';
-import { RequestCaptureEventFn } from '../../bridge/request.js';
-
-/**
- * QRScanner internal state.
- */
-export interface QRScannerState {
-    isOpened: boolean;
-}
-/**
- * QRScanner trackable events.
- */
-export type QRScannerEvents = StateEvents<QRScannerState>;
-/**
- * QRScanner event name.
- */
-export type QRScannerEventName = keyof QRScannerEvents;
-/**
- * QRScanner event listener.
- */
-export type QRScannerEventListener<E extends QRScannerEventName> = QRScannerEvents[E];
-export interface QRScannerOpenOptions {
-    /**
-     * Title to be displayed.
-     */
-    text?: string;
-    /**
-     * Function, which should return true, if QR should be captured.
-     */
-    capture?: RequestCaptureEventFn<'qr_text_received'>;
-}