@tma.js/sdk 2.7.0 → 3.0.1

package/dist/dts/bridge/methods/types/methods.d.ts

@@ -1,392 +0,0 @@
-import { RGB } from '../../../colors/types.js';
-import { RequestId } from '../../../request-id/types.js';
-import { If, IsNever, UnionKeys } from '../../../types/index.js';
-import { AnyInvokeCustomMethodParams } from './custom-methods.js';
-import { AnyHapticFeedbackParams } from './haptic.js';
-import { PopupParams } from './popup.js';
-
-/**
- * Color key which could be used to update header color.
- */
-export type HeaderColorKey = 'bg_color' | 'secondary_bg_color';
-/**
- * Chat type which could be used when calling `web_app_switch_inline_query` method.
- */
-export type SwitchInlineQueryChatType = 'users' | 'bots' | 'groups' | 'channels';
-interface CreateParams<Params = never, VersionedParam extends UnionKeys<Params> = never> {
-    params: Params;
-    versionedParams: VersionedParam;
-}
-/**
- * Describes list of events and their parameters that could be posted by Bridge.
- * @see https://docs.telegram-mini-apps.com/platform/methods
- */
-export interface MiniAppsMethods {
-    /**
-     * Notifies parent iframe about the current frame is ready. This method is only used in the Web
-     * version of Telegram. As a result, Mini App will receive `set_custom_style` event.
-     * @see https://docs.telegram-mini-apps.com/platform/methods#iframe-ready
-     */
-    iframe_ready: CreateParams<{
-        /**
-         * True, if current Mini App supports native reloading.
-         */
-        reload_supported?: boolean;
-    } | undefined>;
-    /**
-     * Notifies parent iframe about the current iframe is going to reload.
-     * @see https://docs.telegram-mini-apps.com/platform/methods#iframe-will-reload
-     */
-    iframe_will_reload: CreateParams;
-    /**
-     * Request current biometry settings.
-     * @since v7.2
-     * @see https://docs.telegram-mini-apps.com/platform/methods#web-app-biometry-get-info
-     */
-    web_app_biometry_get_info: CreateParams;
-    /**
-     * 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)_.
-     * @since v7.2
-     * @see https://docs.telegram-mini-apps.com/platform/methods#web-app-biometry-open-settings
-     */
-    web_app_biometry_open_settings: CreateParams;
-    /**
-     * Requests access to use biometrics.
-     * @since v7.2
-     * @see https://docs.telegram-mini-apps.com/platform/methods#web-app-biometry-request-access
-     */
-    web_app_biometry_request_access: CreateParams<{
-        /**
-         * Reason to request biometry access. Should be at least 1 symbol length, but not
-         * more than 128 symbols.
-         */
-        reason?: string;
-    }>;
-    /**
-     * Authenticates the user using biometrics.
-     * @since v7.2
-     * @see https://docs.telegram-mini-apps.com/platform/methods#web-app-biometry-request-auth
-     */
-    web_app_biometry_request_auth: CreateParams<{
-        /**
-         * Reason to request biometry data. Should be at least 1 symbol length, but not more than
-         * 128 symbols.
-         */
-        reason?: string;
-    }>;
-    /**
-     * Updates the biometric token in secure storage on the device. To remove the token, pass
-     * an empty string.
-     * @since v7.2
-     * @see https://docs.telegram-mini-apps.com/platform/methods#web-app-biometry-update-token
-     */
-    web_app_biometry_update_token: CreateParams<{
-        /**
-         * Token to store. Has max length of 1024 symbols.
-         */
-        token: string;
-    }>;
-    /**
-     * Closes Mini App.
-     * @see https://docs.telegram-mini-apps.com/platform/methods#web-app-close
-     */
-    web_app_close: CreateParams<{
-        /**
-         * @since v7.6
-         */
-        return_back?: boolean;
-    } | undefined, 'return_back'>;
-    /**
-     * Closes a QR scanner. The Telegram application creates `scan_qr_popup_closed` event.
-     * @since v6.4
-     * @see https://docs.telegram-mini-apps.com/platform/methods#web-app-close-scan-qr-popup
-     */
-    web_app_close_scan_qr_popup: CreateParams;
-    /**
-     * Sends data to the bot. When this method is called, a service message is sent to the bot
-     * containing the data of the length up to 4096 bytes. Then, Mini App will be closed.
-     *
-     * To get more information, take a look at `web_app_data` field in the
-     * class [Message](https://core.telegram.org/bots/api#message).
-     *
-     * @see https://docs.telegram-mini-apps.com/platform/methods#web-app-data-send
-     */
-    web_app_data_send: CreateParams<{
-        /**
-         * Data to send to a bot. Should not have size of more than 4096 bytes.
-         */
-        data: string;
-    }>;
-    /**
-     * Expands the Mini App.
-     * @see https://docs.telegram-mini-apps.com/platform/methods#web-app-expand
-     */
-    web_app_expand: CreateParams;
-    /**
-     * Invokes custom method.
-     * @since v6.9
-     * @see https://docs.telegram-mini-apps.com/platform/methods#web-app-invoke-custom-method
-     */
-    web_app_invoke_custom_method: CreateParams<AnyInvokeCustomMethodParams>;
-    /**
-     * Opens an invoice by its specified slug. More information about invoices in
-     * this [documentation](https://core.telegram.org/bots/payments).
-     * @since v6.1
-     * @see https://docs.telegram-mini-apps.com/platform/methods#web-app-open-invoice
-     */
-    web_app_open_invoice: CreateParams<{
-        /**
-         * Invoice unique identifier.
-         */
-        slug: string;
-    }>;
-    /**
-     * Opens link in the default browser. Mini App will not be closed.
-     * @see https://docs.telegram-mini-apps.com/platform/methods#web-app-open-link
-     */
-    web_app_open_link: CreateParams<{
-        /**
-         * URL to be opened by Telegram application. Should be a full path with `https` protocol.
-         */
-        url: string;
-        /**
-         * Link will be opened in Instant View mode if possible.
-         * @since v6.4
-         * @see https://instantview.telegram.org/
-         */
-        try_instant_view?: boolean;
-        /**
-         * @since v7.6
-         */
-        try_browser?: boolean;
-    }, 'try_instant_view' | 'try_browser'>;
-    /**
-     * Opens a new popup. When user closes the popup, Telegram creates the `popup_closed` event.
-     * @since v6.2
-     * @see https://docs.telegram-mini-apps.com/platform/methods#web-app-open-popup
-     */
-    web_app_open_popup: CreateParams<PopupParams>;
-    /**
-     * Opens a QR scanner. When the scanner was closed, the Telegram application creates
-     * the `scan_qr_popup_closed` event. When the scanner reads QR, Telegram creates the
-     * `qr_text_received` event.
-     * @since v6.4
-     * @see https://docs.telegram-mini-apps.com/platform/methods#web-app-open-scan-qr-popup
-     */
-    web_app_open_scan_qr_popup: CreateParams<{
-        /**
-         * Text to be displayed in the QR scanner.
-         */
-        text?: string;
-    }>;
-    /**
-     * Opens the Telegram link by its pathname and query parameters. The link will be opened in the
-     * Telegram app, Mini App will be closed.
-     * @since v6.1
-     * @see https://docs.telegram-mini-apps.com/platform/methods#web-app-open-tg-link
-     */
-    web_app_open_tg_link: CreateParams<{
-        /**
-         * Should be a value taken from the link of this format: `https://t.me/{path_full}`. Can
-         * additionally contain query parameters.
-         */
-        path_full: string;
-    }>;
-    /**
-     * Reads text from the clipboard. The method accepts a request identifier which is used to
-     * appropriately retrieve the method execution result from the `clipboard_text_received` event.
-     * @since v6.4
-     * @see https://docs.telegram-mini-apps.com/platform/methods#web-app-read-text-from-clipboard
-     */
-    web_app_read_text_from_clipboard: CreateParams<{
-        /**
-         * Unique request identifier. Should be any unique string to handle the generated event
-         * appropriately.
-         */
-        req_id: RequestId;
-    }>;
-    /**
-     * Notifies Telegram about current application is ready to be shown. This method will make
-     * Telegram to remove application loader and display Mini App.
-     * @see https://docs.telegram-mini-apps.com/platform/methods#web-app-ready
-     */
-    web_app_ready: CreateParams;
-    /**
-     * Requests access to current user's phone.
-     * @since v6.9
-     * @see https://docs.telegram-mini-apps.com/platform/methods#web-app-request-phone
-     */
-    web_app_request_phone: CreateParams;
-    /**
-     * Requests current theme from Telegram. As a result, Telegram will create `theme_changed` event.
-     * @see https://docs.telegram-mini-apps.com/platform/methods#web-app-request-theme
-     */
-    web_app_request_theme: CreateParams;
-    /**
-     * Requests current viewport information from Telegram. As a result, Telegram will create
-     * `viewport_changed` event.
-     * @see https://docs.telegram-mini-apps.com/platform/methods#web-app-request-viewport
-     */
-    web_app_request_viewport: CreateParams;
-    /**
-     * Requests write message access to current user.
-     * @since v6.9
-     * @see https://docs.telegram-mini-apps.com/platform/methods#web-app-rqeuest-write-access
-     */
-    web_app_request_write_access: CreateParams;
-    /**
-     * Updates the Mini App background color.
-     * @since v6.1
-     * @see https://docs.telegram-mini-apps.com/platform/methods#web-app-set-background-color
-     */
-    web_app_set_background_color: CreateParams<{
-        /**
-         * The Mini App background color in `#RRGGBB` format.
-         */
-        color: RGB;
-    }>;
-    /**
-     * Updates the Mini App header color.
-     * @since v6.1
-     * @see https://docs.telegram-mini-apps.com/platform/methods#web-app-set-header-color
-     */
-    web_app_set_header_color: CreateParams<{
-        /**
-         * The Mini App header color key.
-         */
-        color_key: HeaderColorKey;
-    } | {
-        /**
-         * Color in RGB format.
-         * @since v6.9
-         */
-        color: RGB;
-    }, 'color'>;
-    /**
-     * Updates the Back Button settings.
-     * @since v6.1
-     * @see https://docs.telegram-mini-apps.com/platform/methods#web-app-setup-back-button
-     */
-    web_app_setup_back_button: CreateParams<{
-        /**
-         * Should the Back Button be visible.
-         */
-        is_visible: boolean;
-    }>;
-    /**
-     * Updates current closing behavior.
-     * @see https://docs.telegram-mini-apps.com/platform/methods#web-app-setup-closing-behavior
-     */
-    web_app_setup_closing_behavior: CreateParams<{
-        /**
-         * Will user be prompted in case, an application is going to be closed.
-         */
-        need_confirmation: boolean;
-    }>;
-    /**
-     * Updates the Main Button settings.
-     * @see https://docs.telegram-mini-apps.com/platform/methods#web-app-setup-main-button
-     */
-    web_app_setup_main_button: CreateParams<{
-        /**
-         * Should the Main Button be displayed.
-         */
-        is_visible?: boolean;
-        /**
-         * Should the Main Button be enabled.
-         */
-        is_active?: boolean;
-        /**
-         * Should loader inside the Main Button be displayed. Use this property in case, some
-         * operation takes time. This loader will make user notified about it.
-         */
-        is_progress_visible?: boolean;
-        /**
-         * Text inside the Main Button.
-         */
-        text?: string;
-        /**
-         * The Main Button background color in `#RRGGBB` format.
-         */
-        color?: string;
-        /**
-         * The Main Button text color in `#RRGGBB` format.
-         */
-        text_color?: string;
-    }>;
-    /**
-     * Updates current state of Settings Button.
-     * @since v6.10
-     * @see https://docs.telegram-mini-apps.com/platform/methods#web-app-setup-settings-button
-     */
-    web_app_setup_settings_button: CreateParams<{
-        /**
-         * Should the Settings Button be displayed.
-         */
-        is_visible: boolean;
-    }>;
-    /**
-     * 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.
-     * @since v6.7
-     * @see https://docs.telegram-mini-apps.com/platform/methods#web-app-switch-inline-query
-     */
-    web_app_switch_inline_query: CreateParams<{
-        /**
-         * Text which should be inserted in the input after the current bot name. Max length is
-         * 256 symbols.
-         */
-        query: string;
-        /**
-         * List of chat types which could be chosen to send the message. Could be empty list.
-         */
-        chat_types: SwitchInlineQueryChatType[];
-    }>;
-    /**
-     * Generates haptic feedback event.
-     * @since v6.1
-     * @see https://docs.telegram-mini-apps.com/platform/methods#web-app-trigger-haptic-feedback
-     */
-    web_app_trigger_haptic_feedback: CreateParams<AnyHapticFeedbackParams>;
-}
-/**
- * Mini Apps method name.
- */
-export type MiniAppsMethodName = keyof MiniAppsMethods;
-/**
- * Parameters of the specified Mini Apps method.
- */
-export type MiniAppsMethodParams<M extends MiniAppsMethodName> = MiniAppsMethods[M]['params'];
-/**
- * Methods with optional parameters.
- */
-export type MiniAppsMethodWithOptionalParams = {
-    [Method in MiniAppsMethodName]: undefined extends MiniAppsMethodParams<Method> ? Method : never;
-}[MiniAppsMethodName];
-/**
- * Methods without parameters.
- */
-export type MiniAppsMethodWithoutParams = {
-    [Method in MiniAppsMethodName]: If<IsNever<MiniAppsMethodParams<Method>>, Method, never>;
-}[MiniAppsMethodName];
-/**
- * Methods with parameters.
- */
-export type MiniAppsMethodWithRequiredParams = Exclude<MiniAppsMethodName, MiniAppsMethodWithoutParams | MiniAppsMethodWithOptionalParams>;
-/**
- * Method names which have versioned params.
- */
-export type MiniAppsMethodWithVersionedParams = {
-    [M in MiniAppsMethodName]: IsNever<MiniAppsMethods[M]['versionedParams']> extends true ? never : M;
-}[MiniAppsMethodName];
-/**
- * Method parameters which appear only in the specific Telegram Mini Apps version.
- */
-export type MiniAppsMethodVersionedParams<M extends MiniAppsMethodWithVersionedParams> = MiniAppsMethods[M]['versionedParams'];
-export {};

package/dist/dts/bridge/methods/types/popup.d.ts

@@ -1,49 +0,0 @@
-/**
- * Describes the native popup.
- */
-export interface PopupParams {
-    /**
-     * The text to be displayed in the popup title, 0-64 characters.
-     */
-    title: string;
-    /**
-     * The message to be displayed in the body of the popup, 1-256 characters.
-     */
-    message: string;
-    /**
-     * List of buttons to be displayed in the popup, 1-3 buttons.
-     */
-    buttons: PopupButton[];
-}
-/**
- * Describes the native popup button.
- * @see https://docs.telegram-mini-apps.com/platform/methods#popupbutton
- */
-export type PopupButton = {
-    /**
-     * Identifier of the button, 0-64 characters.
-     */
-    id: string;
-} & ({
-    /**
-     * Type of the button:
-     * - `default`, a button with the default style;
-     * - `destructive`, a button with a style that indicates a destructive
-     * action (e.g. "Remove", "Delete", etc.).
-     *
-     * @default "default"
-     */
-    type?: 'default' | 'destructive';
-    /**
-     * The text to be displayed on the button, 0-64 characters.
-     */
-    text: string;
-} | {
-    /**
-     * Type of the button:
-     * - `ok`, a button with the localized text "OK";
-     * - `close`, a button with the localized text "Close";
-     * - `cancel`, a button with the localized text "Cancel".
-     */
-    type: 'ok' | 'close' | 'cancel';
-});

package/dist/dts/bridge/parseMessage.d.ts

@@ -1,18 +0,0 @@
-/**
- * Message format used in communication between client and Telegram applications.
- */
-export interface MiniAppsMessage {
-    /**
-     * Event name.
-     */
-    eventType: string;
-    /**
-     * Event parameters.
-     */
-    eventData?: unknown;
-}
-/**
- * Parses value as a message between client and Telegram applications.
- * @param value - value to parse.
- */
-export declare function parseMessage(value: unknown): MiniAppsMessage;

package/dist/dts/bridge/request.d.ts

@@ -1,53 +0,0 @@
-import { ExecuteWithOptions, If, IsNever } from '../types/index.js';
-import { MiniAppsEventName, MiniAppsEventPayload } from './events/types.js';
-import { MiniAppsMethodName, MiniAppsMethodParams } from './methods/types/index.js';
-
-/**
- * Returns all possible payloads for the specified events array.
- */
-export type RequestEventsPayloads<E extends MiniAppsEventName[]> = E extends (infer U extends MiniAppsEventName)[] ? MiniAppsEventPayload<U> : never;
-export type RequestCaptureEventsFn<E extends MiniAppsEventName[]> = E extends (infer U extends MiniAppsEventName)[] ? (payload: {
-    [K in U]: If<IsNever<MiniAppsEventPayload<K>>, {
-        event: K;
-    }, {
-        event: K;
-        payload: MiniAppsEventPayload<K>;
-    }>;
-}[U]) => boolean : never;
-export type RequestCaptureEventFn<E extends MiniAppsEventName> = If<IsNever<MiniAppsEventPayload<E>>, () => boolean, (payload: MiniAppsEventPayload<E>) => boolean>;
-/**
- * `request` method options.
- * @see request
- */
-export type RequestOptions<M extends MiniAppsMethodName, E, C> = {
-    /**
-     * Mini Apps method name.
-     */
-    method: M;
-    /**
-     * Tracked Mini Apps events.
-     */
-    event: E;
-    /**
-     * Should return true if this event should be captured.
-     * A request will be captured if this property is omitted.
-     */
-    capture?: C;
-} & ExecuteWithOptions & If<IsNever<MiniAppsMethodParams<M>>, {}, {
-    /**
-     * List of method parameters.
-     */
-    params: MiniAppsMethodParams<M>;
-}>;
-/**
- * Calls specified Mini Apps method and captures specified event.
- * @param options - method options.
- * @returns Promise which will be resolved with data of the captured event.
- */
-export declare function request<M extends MiniAppsMethodName, E extends MiniAppsEventName>(options: RequestOptions<M, E, RequestCaptureEventFn<E>>): Promise<MiniAppsEventPayload<E>>;
-/**
- * Calls specified Mini Apps method and captures one of the specified events.
- * @param options - method options.
- * @returns Promise which will be resolved with data of the first captured event.
- */
-export declare function request<M extends MiniAppsMethodName, E extends MiniAppsEventName[]>(options: RequestOptions<M, E, RequestCaptureEventsFn<E>>): Promise<RequestEventsPayloads<E>>;

package/dist/dts/bridge/target-origin.d.ts

@@ -1,18 +0,0 @@
-/**
- * Sets a new global targetOrigin, used by the `postEvent` method.
- * The default value is "https://web.telegram.org".
- * You don't need to use this method until you know what you are doing.
- *
- * This method could be used for test purposes.
- * @param value - new target origin.
- * @see postEvent
- */
-export declare function setTargetOrigin(value: string): void;
-/**
- * Sets the initial target origin.
- */
-export declare function resetTargetOrigin(): void;
-/**
- * Returns current global target origin.
- */
-export declare function targetOrigin(): string;

package/dist/dts/classes/State/State.d.ts

@@ -1,46 +0,0 @@
-import { EventEmitter } from '../../events/event-emitter/EventEmitter.js';
-import { StateEvents } from './types.js';
-import { StringKeys } from '../../types/utils.js';
-
-type Emitter<State extends object> = EventEmitter<StateEvents<State>>;
-export declare class State<State extends object> {
-    /**
-     * Initial state.
-     */
-    private readonly state;
-    private readonly ee;
-    constructor(
-    /**
-     * Initial state.
-     */
-    state: State);
-    /**
-     * Clones current state and returns its copy.
-     */
-    clone(): State;
-    /**
-     * Sets value by key.
-     * @param key - state key.
-     * @param value - value to set.
-     */
-    set<K extends StringKeys<State>>(key: K, value: State[K]): void;
-    /**
-     * Sets several values simultaneously.
-     * @param state - partial state.
-     */
-    set(state: Partial<State>): void;
-    /**
-     * Returns value by specified key.
-     * @param key - state key.
-     */
-    get<K extends StringKeys<State>>(key: K): State[K];
-    /**
-     * Adds new event listener.
-     */
-    on: Emitter<State>['on'];
-    /**
-     * Removes event listener.
-     */
-    off: Emitter<State>['off'];
-}
-export {};

package/dist/dts/classes/State/types.d.ts

@@ -1,29 +0,0 @@
-import { StringKeys } from '../../types/utils.js';
-
-/**
- * Creates a map with all events emitted by BaseComponent.
- * @example
- * ```ts
- * type A = StateEvents<{
- *   name: string;
- *   age: number;
- *   isRegistered: boolean;
- * }>;
- *
- * // Will be:
- * {
- *   "change:name": (currentValue: string) => void;
- *   "change:age": (currentValue: number) => void;
- *   "change:isRegistered": (currentValue: boolean) => void;
- *   "change": () => void;
- * }
- * ```
- */
-export type StateEvents<State extends object> = {
-    [Event in `change:${StringKeys<State>}`]: (currentValue: Event extends `change:${infer T extends StringKeys<State>}` ? State[T] : never) => void;
-} & {
-    /**
-     * Something has changed in the state.
-     */
-    change: (currentState: State) => void;
-};

package/dist/dts/classes/WithStateUtils.d.ts

@@ -1,18 +0,0 @@
-import { State } from './State/State.js';
-
-export declare class WithStateUtils<Shape extends object> {
-    protected state: State<Shape>;
-    constructor(shape: Shape);
-    /**
-     * Gets the state value.
-     */
-    protected get: State<Shape>['get'];
-    /**
-     * Sets the state value.
-     */
-    protected set: State<Shape>['set'];
-    /**
-     * Clones the current state.
-     */
-    protected clone: State<Shape>['clone'];
-}

package/dist/dts/classes/WithSupports.d.ts

@@ -1,19 +0,0 @@
-import { MiniAppsMethodName } from '../bridge/methods/types/methods.js';
-import { SupportsFn } from '../supports/types.js';
-import { Version } from '../version/types.js';
-
-export declare class WithSupports<SupportsMethod extends string> {
-    constructor(
-    /**
-     * Mini Apps version.
-     */
-    version: Version, 
-    /**
-     * Supports method schema.
-     */
-    supportsSchema: Record<SupportsMethod, MiniAppsMethodName>);
-    /**
-     * @returns True, if specified method is supported by the current component.
-     */
-    supports: SupportsFn<SupportsMethod>;
-}

package/dist/dts/classes/WithSupportsAndStateUtils.d.ts

@@ -1,24 +0,0 @@
-import { WithStateUtils } from './WithStateUtils.js';
-import { MiniAppsMethodName } from '../bridge/methods/types/methods.js';
-import { SupportsFn } from '../supports/types.js';
-import { Version } from '../version/types.js';
-
-export declare class WithSupportsAndStateUtils<StateShape extends object, SupportsMethod extends string> extends WithStateUtils<StateShape> {
-    constructor(
-    /**
-     * Initial state.
-     */
-    stateShape: StateShape, 
-    /**
-     * Mini Apps version.
-     */
-    version: Version, 
-    /**
-     * Supports method schema.
-     */
-    supportsSchema: Record<SupportsMethod, MiniAppsMethodName>);
-    /**
-     * @returns True, if specified method is supported by the current component.
-     */
-    supports: SupportsFn<SupportsMethod>;
-}