@tma.js/sdk 1.5.3 → 2.0.1

package/dist/dts/bridge/events/parsers/theme-changed.d.ts

@@ -1,42 +0,0 @@
-import type { RGB } from '../../../colors/types.js';
-export interface ThemeChangedPayload {
-    /**
-     * Map where the key is a theme stylesheet key and value is  the corresponding color in
-     * `#RRGGBB` format.
-     */
-    theme_params: {
-        /**
-         * @since v6.10
-         */
-        accent_text_color?: RGB;
-        bg_color?: RGB;
-        button_color?: RGB;
-        button_text_color?: RGB;
-        /**
-         * @since v6.10
-         */
-        destructive_text_color?: RGB;
-        /**
-         * @since v6.10
-         */
-        header_bg_color?: RGB;
-        hint_color?: RGB;
-        link_color?: RGB;
-        secondary_bg_color?: RGB;
-        /**
-         * @since v6.10
-         */
-        section_bg_color?: RGB;
-        /**
-         * @since v6.10
-         */
-        section_header_text_color?: RGB;
-        /**
-         * @since v6.10
-         */
-        subtitle_text_color?: RGB;
-        text_color?: RGB;
-        [key: string]: RGB | undefined;
-    };
-}
-export declare function themeChanged(): import("../../../parsing/ValueParser.js").ValueParser<ThemeChangedPayload, false>;

package/dist/dts/bridge/events/parsers/viewportChanged.d.ts

@@ -1,19 +0,0 @@
-export interface ViewportChangedPayload {
-    /**
-     * The viewport height.
-     */
-    height: number;
-    /**
-     * The viewport width.
-     */
-    width: number;
-    /**
-     * Is the viewport currently expanded.
-     */
-    is_expanded: boolean;
-    /**
-     * Is the viewport current state stable and not going to change in the next moment.
-     */
-    is_state_stable: boolean;
-}
-export declare function viewportChanged(): import("../../../parsing/ValueParser.js").ValueParser<ViewportChangedPayload, false>;

package/dist/dts/bridge/events/parsers/writeAccessRequested.d.ts

@@ -1,8 +0,0 @@
-export type WriteAccessRequestedStatus = 'allowed' | string;
-export interface WriteAccessRequestedPayload {
-    /**
-     * Request status.
-     */
-    status: WriteAccessRequestedStatus;
-}
-export declare function writeAccessRequested(): import("../../../parsing/ValueParser.js").ValueParser<WriteAccessRequestedPayload, false>;

package/dist/dts/bridge/events/singletonEmitter.d.ts

@@ -1,6 +0,0 @@
-import type { MiniAppsEventEmitter } from './events.js';
-/**
- * Returns singleton instance of bridge EventEmitter. Also, defines
- * Telegram event handlers.
- */
-export declare function singletonEmitter(): MiniAppsEventEmitter;

package/dist/dts/bridge/events/subscribe.d.ts

@@ -1,8 +0,0 @@
-import type { MiniAppsGlobalEventListener } from './events.js';
-import type { RemoveListenerFn } from './types.js';
-/**
- * Subscribes to all events sent from the native Telegram application.
- * Returns function used to remove added event listener.
- * @param listener - event listener.
- */
-export declare function subscribe(listener: MiniAppsGlobalEventListener): RemoveListenerFn;

package/dist/dts/bridge/events/unsubscribe.d.ts

@@ -1,6 +0,0 @@
-import type { MiniAppsGlobalEventListener } from './events.js';
-/**
- * Removes global event listener.
- * @param listener - event listener.
- */
-export declare function unsubscribe(listener: MiniAppsGlobalEventListener): void;

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

@@ -1,54 +0,0 @@
-import type { MiniAppsEventName, MiniAppsEventParams } from './events/events.js';
-import type { MiniAppsEmptyMethodName, MiniAppsMethodName, MiniAppsMethodParams, MiniAppsNonEmptyMethodName } from './methods/methods.js';
-import type { If } from '../types/logical.js';
-import type { ExecuteWithOptions } from '../types/methods.js';
-import type { IsNever } from '../types/utils.js';
-/**
- * Simple `request` method options.
- */
-export type RequestSimpleOptions<Method extends MiniAppsMethodName> = Omit<RequestCompleteOptions<Method, any>, 'method' | 'event'>;
-/**
- * Complete `request` method options.
- */
-export type RequestCompleteOptions<Method extends MiniAppsMethodName, Event extends MiniAppsEventName> = {
-    /**
-     * Mini Apps method name.
-     */
-    method: Method;
-    /**
-     * One or many tracked Mini Apps events.
-     */
-    event: Event | Event[];
-    /**
-     * Should return true in case, this event should be captured. If not specified,
-     * request is not skipping captured events.
-     */
-    capture?: If<IsNever<MiniAppsEventParams<Event>>, () => boolean, (payload: MiniAppsEventParams<Event>) => boolean>;
-} & ExecuteWithOptions & If<IsNever<MiniAppsMethodParams<Method>>, {}, {
-    /**
-     * List of method parameters.
-     */
-    params: MiniAppsMethodParams<Method>;
-}>;
-/**
- * Calls specified Mini Apps method and captures one of the specified events. Returns promise
- * which will be resolved in case, specified event was captured.
- * @param options - method options.
- */
-export declare function request<Method extends MiniAppsEmptyMethodName, Event extends MiniAppsEventName>(options: RequestCompleteOptions<Method, Event>): Promise<MiniAppsEventParams<Event>>;
-/**
- * Calls specified Mini Apps method and captures one of the specified events. Returns promise
- * which will be resolved in case, specified event was captured.
- * @param method - method name.
- * @param eventOrEvents - tracked event or events.
- * @param options - method options.
- */
-export declare function request<Method extends MiniAppsNonEmptyMethodName, Event extends MiniAppsEventName>(method: Method, eventOrEvents: Event | Event[], options: RequestSimpleOptions<Method>): Promise<MiniAppsEventParams<Event>>;
-/**
- * Calls specified Mini Apps method and captures one of the specified events. Returns promise
- * which will be resolved in case, specified event was captured.
- * @param method - method name.
- * @param eventOrEvents - tracked event or events.
- * @param options - method options.
- */
-export declare function request<Method extends MiniAppsEmptyMethodName, Event extends MiniAppsEventName>(method: Method, eventOrEvents: Event | Event[], options?: RequestSimpleOptions<Method>): Promise<MiniAppsEventParams<Event>>;

package/dist/dts/components/back-button/BackButton.d.ts

@@ -1,47 +0,0 @@
-import type { BackButtonEvents } from './types.js';
-import type { PostEvent } from '../../bridge/methods/postEvent.js';
-import { EventEmitter } from '../../event-emitter/EventEmitter.js';
-import type { SupportsFunc } from '../../supports/types.js';
-import type { Version } from '../../version/types.js';
-type Emitter = EventEmitter<BackButtonEvents>;
-/**
- * Class which controls the back button displayed in the header of the Mini App in the Telegram
- * interface. It is mostly used in case, when you want to provide a way to go bach in routing
- * history or "rollback" some action.
- */
-export declare class BackButton {
-    private readonly postEvent;
-    private readonly ee;
-    private readonly state;
-    constructor(isVisible: boolean, version: Version, postEvent?: PostEvent);
-    private set isVisible(value);
-    /**
-     * True if BackButton is currently visible.
-     */
-    get isVisible(): boolean;
-    /**
-     * Hides the BackButton.
-     */
-    hide(): void;
-    /**
-     * Adds event listener.
-     * @param event - event name.
-     * @param listener - event listener.
-     */
-    on: Emitter['on'];
-    /**
-     * Removes event listener.
-     * @param event - event name.
-     * @param listener - event listener.
-     */
-    off: Emitter['off'];
-    /**
-     * Shows the BackButton.
-     */
-    show(): void;
-    /**
-     * Checks if specified method is supported by current component.
-     */
-    supports: SupportsFunc<'show' | 'hide'>;
-}
-export {};

package/dist/dts/components/back-button/types.d.ts

@@ -1,10 +0,0 @@
-import type { MiniAppsEventListener } from '../../bridge/events/events.js';
-import type { StateEvents } from '../../state/types.js';
-export interface BackButtonState {
-    isVisible: boolean;
-}
-export interface BackButtonEvents extends StateEvents<BackButtonState> {
-    click: MiniAppsEventListener<'main_button_pressed'>;
-}
-export type BackButtonEventName = keyof BackButtonEvents;
-export type BackButtonEventListener<E extends BackButtonEventName> = BackButtonEvents[E];

package/dist/dts/components/closing-behavior/ClosingBehavior.d.ts

@@ -1,39 +0,0 @@
-import type { ClosingBehaviorEvents } from './types.js';
-import type { PostEvent } from '../../bridge/methods/postEvent.js';
-import { EventEmitter } from '../../event-emitter/EventEmitter.js';
-type Emitter = EventEmitter<ClosingBehaviorEvents>;
-/**
- * Component responsible for controlling current closing confirmation
- * status.
- */
-export declare class ClosingBehavior {
-    private readonly postEvent;
-    private readonly ee;
-    private readonly state;
-    constructor(isConfirmationNeeded: boolean, postEvent?: PostEvent);
-    private set isConfirmationNeeded(value);
-    /**
-     * Returns true, if the confirmation dialog enabled while the user is trying
-     * to close the Mini App.
-     */
-    get isConfirmationNeeded(): boolean;
-    /**
-     * Disables the confirmation dialog while the user is trying to close the
-     * Mini App.
-     */
-    disableConfirmation(): void;
-    /**
-     * Enables the confirmation dialog while the user is trying to close the
-     * Mini App.
-     */
-    enableConfirmation(): void;
-    /**
-     * Adds new event listener.
-     */
-    on: Emitter['on'];
-    /**
-     * Removes event listener.
-     */
-    off: Emitter['off'];
-}
-export {};

package/dist/dts/components/init-data/chatParser.d.ts

@@ -1,6 +0,0 @@
-import type { Chat } from './types.js';
-import type { ValueParser } from '../../parsing/ValueParser.js';
-/**
- * Returns parser used to parse chat data.
- */
-export declare function chatParser(): ValueParser<Chat, false>;

package/dist/dts/components/init-data/initDataParser.d.ts

@@ -1,6 +0,0 @@
-import type { InitDataParsed } from './types.js';
-import type { ValueParser } from '../../parsing/ValueParser.js';
-/**
- * Returns parser used to parse init data, presented as search params.
- */
-export declare function initDataParser(): ValueParser<InitDataParsed, false>;

package/dist/dts/components/init-data/userParser.d.ts

@@ -1,6 +0,0 @@
-import type { User } from './types.js';
-import type { ValueParser } from '../../parsing/ValueParser.js';
-/**
- * Returns parser used to parse user data.
- */
-export declare function userParser(): ValueParser<User, false>;

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

@@ -1,47 +0,0 @@
-import type { InvoiceEvents } from './types.js';
-import type { InvoiceStatus } from '../../bridge/events/parsers/invoiceClosed.js';
-import type { PostEvent } from '../../bridge/methods/postEvent.js';
-import { EventEmitter } from '../../event-emitter/EventEmitter.js';
-import type { SupportsFunc } from '../../supports/types.js';
-import type { Version } from '../../version/types.js';
-type Emitter = EventEmitter<InvoiceEvents>;
-/**
- * Controls currently displayed invoice.
- */
-export declare class Invoice {
-    private readonly postEvent;
-    private readonly ee;
-    private readonly state;
-    constructor(version: Version, postEvent?: PostEvent);
-    private set isOpened(value);
-    /**
-     * True if invoice is currently opened.
-     */
-    get isOpened(): boolean;
-    /**
-     * Adds new event listener.
-     */
-    on: Emitter['on'];
-    /**
-     * Removes event listener.
-     */
-    off: Emitter['off'];
-    /**
-     * 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>;
-    /**
-     * Checks if specified method is supported by current component.
-     */
-    supports: SupportsFunc<'open'>;
-}
-export {};

package/dist/dts/components/main-button/MainButton.d.ts

@@ -1,104 +0,0 @@
-import type { MainButtonEvents, MainButtonParams, MainButtonProps } from './types.js';
-import type { RGB } from '../../colors/types.js';
-import { EventEmitter } from '../../event-emitter/EventEmitter.js';
-type Emitter = EventEmitter<MainButtonEvents>;
-/**
- * Controls the main button, which is displayed at the bottom
- * of the Mini App in the Telegram interface.
- */
-export declare class MainButton {
-    private readonly ee;
-    private readonly state;
-    private readonly postEvent;
-    constructor(props: MainButtonProps);
-    /**
-     * Sends current local state to Telegram application.
-     */
-    private commit;
-    private set isEnabled(value);
-    /**
-     * True if the Main Button is currently enabled.
-     */
-    get isEnabled(): boolean;
-    private set isLoaderVisible(value);
-    /**
-     * True if the Main Button loader is currently visible.
-     */
-    get isLoaderVisible(): boolean;
-    private set isVisible(value);
-    /**
-     * True if the Main Button is currently visible.
-     */
-    get isVisible(): boolean;
-    /**
-     * The Main Button background color.
-     */
-    get backgroundColor(): RGB;
-    /**
-     * The Main Button text.
-     */
-    get text(): string;
-    /**
-     * The Main Button text color.
-     */
-    get textColor(): RGB;
-    /**
-     * Disables the Main Button.
-     */
-    disable(): this;
-    /**
-     * Enables the Main Button.
-     */
-    enable(): this;
-    /**
-     * Hides the Main Button.
-     */
-    hide(): this;
-    /**
-     * Hides the Main Button loader.
-     */
-    hideLoader(): this;
-    /**
-     * Adds new event listener.
-     * @param event - event name.
-     * @param listener - event listener.
-     */
-    on: Emitter['on'];
-    /**
-     * Removes event listener.
-     * @param event - event name.
-     * @param listener - event listener.
-     */
-    off: Emitter['off'];
-    /**
-     * Shows the Main Button. 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;
-    /**
-     * A method to show a loading indicator on the Main Button. It is recommended to display
-     * loader if the action tied to the button may take a long time.
-     */
-    showLoader(): this;
-    /**
-     * Sets new Main Button text. Minimal length for text is 1 symbol, and maximum is 64 symbols.
-     * @param text - new text.
-     */
-    setText(text: string): this;
-    /**
-     * Sets new Main Button text color.
-     * @param textColor - new text color.
-     */
-    setTextColor(textColor: RGB): this;
-    /**
-     * Updates current Main Button color.
-     * @param backgroundColor - color to set.
-     */
-    setBackgroundColor(backgroundColor: RGB): this;
-    /**
-     * Allows setting multiple Main Button parameters.
-     * @param params - Main Button parameters.
-     */
-    setParams(params: MainButtonParams): this;
-}
-export {};

package/dist/dts/components/main-button/types.d.ts

@@ -1,20 +0,0 @@
-import type { PostEvent } from '../../bridge/methods/postEvent.js';
-import type { RGB } from '../../colors/types.js';
-import type { StateEvents } from '../../state/types.js';
-export interface MainButtonParams {
-    backgroundColor?: RGB;
-    isEnabled?: boolean;
-    isLoaderVisible?: boolean;
-    isVisible?: boolean;
-    text?: string;
-    textColor?: RGB;
-}
-export interface MainButtonProps extends Required<MainButtonParams> {
-    postEvent?: PostEvent;
-}
-export type MainButtonState = Required<MainButtonParams>;
-export interface MainButtonEvents extends StateEvents<MainButtonState> {
-    click: () => void;
-}
-export type MainButtonEventName = keyof MainButtonEvents;
-export type MainButtonEventListener<E extends MainButtonEventName> = MainButtonEvents[E];

package/dist/dts/components/mini-app/contactParser.d.ts

@@ -1,2 +0,0 @@
-import type { RequestedContact } from './types.js';
-export declare const contactParser: import("../../parsing/ValueParser.js").ValueParser<RequestedContact, false>;

package/dist/dts/components/mini-app/types.d.ts

@@ -1,32 +0,0 @@
-import type { HeaderColorKey } from '../../bridge/methods/methods.js';
-import type { PostEvent } from '../../bridge/methods/postEvent.js';
-import type { RGB } from '../../colors/types.js';
-import type { StateEvents } from '../../state/types.js';
-import type { CreateRequestIdFunc } from '../../types/request-id.js';
-import type { Version } from '../../version/types.js';
-export interface MiniAppProps {
-    headerColor: MiniAppHeaderColor;
-    backgroundColor: RGB;
-    version: Version;
-    botInline: boolean;
-    createRequestId: CreateRequestIdFunc;
-    postEvent?: PostEvent;
-}
-export type MiniAppHeaderColor = HeaderColorKey | RGB;
-export interface MiniAppState {
-    backgroundColor: RGB;
-    headerColor: MiniAppHeaderColor;
-}
-export type MiniAppEvents = StateEvents<MiniAppState>;
-export type MiniAppEventName = keyof MiniAppEvents;
-export type MiniAppEventListener<E extends MiniAppEventName> = MiniAppEvents[E];
-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,48 +0,0 @@
-import type { OpenPopupOptions, PopupEvents } from './types.js';
-import type { PostEvent } from '../../bridge/methods/postEvent.js';
-import { EventEmitter } from '../../event-emitter/EventEmitter.js';
-import type { SupportsFunc } from '../../supports/types.js';
-import type { Version } from '../../version/types.js';
-type Emitter = EventEmitter<PopupEvents>;
-/**
- * Controls currently displayed application popup. It allows developers to
- * open new custom popups and detect popup-connected events.
- */
-export declare class Popup {
-    private readonly postEvent;
-    private readonly ee;
-    private readonly state;
-    constructor(version: Version, postEvent?: PostEvent);
-    private set isOpened(value);
-    /**
-     * True if popup is currently opened.
-     */
-    get isOpened(): boolean;
-    /**
-     * Adds new event listener.
-     */
-    on: Emitter['on'];
-    /**
-     * Removes event listener.
-     */
-    off: Emitter['off'];
-    /**
-     * 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.
-     *
-     * FIXME: In desktop, this function may work incorrectly.
-     *  Issue: https://github.com/Telegram-Mini-Apps/tma.js/issues/7
-     * @param options - popup parameters.
-     * @throws {Error} Popup is already opened.
-     */
-    open(options: OpenPopupOptions): Promise<string | null>;
-    /**
-     * Checks if specified method is supported by current component.
-     */
-    supports: SupportsFunc<'open'>;
-}
-export {};

package/dist/dts/components/qr-scanner/QRScanner.d.ts

@@ -1,44 +0,0 @@
-import type { QRScannerEvents } from './types.js';
-import type { PostEvent } from '../../bridge/methods/postEvent.js';
-import { EventEmitter } from '../../event-emitter/EventEmitter.js';
-import type { SupportsFunc } from '../../supports/types.js';
-import type { Version } from '../../version/types.js';
-type Emitter = EventEmitter<QRScannerEvents>;
-/**
- * Provides QR scanner functionality.
- */
-export declare class QRScanner {
-    private readonly postEvent;
-    private readonly ee;
-    private readonly state;
-    constructor(version: Version, postEvent?: PostEvent);
-    /**
-     * Closes scanner.
-     */
-    close(): void;
-    private set isOpened(value);
-    /**
-     * Returns true in case, QR scanner is currently opened.
-     */
-    get isOpened(): boolean;
-    /**
-     * Opens scanner with specified title shown to user. Method returns promise
-     * with scanned QR content in case, it was scanned. It will contain null in
-     * case, scanner was closed.
-     * @param text - title to display.
-     */
-    open(text?: string): Promise<string | null>;
-    /**
-     * Adds new event listener.
-     */
-    on: Emitter['on'];
-    /**
-     * Removes event listener.
-     */
-    off: Emitter['off'];
-    /**
-     * Checks if specified method is supported by current component.
-     */
-    supports: SupportsFunc<'open' | 'close'>;
-}
-export {};

package/dist/dts/components/settings-button/SettingsButton.d.ts

@@ -1,42 +0,0 @@
-import type { SettingsButtonEvents } from './types.js';
-import type { PostEvent } from '../../bridge/methods/postEvent.js';
-import { EventEmitter } from '../../event-emitter/EventEmitter.js';
-import type { SupportsFunc } from '../../supports/types.js';
-import type { Version } from '../../version/types.js';
-type Emitter = EventEmitter<SettingsButtonEvents>;
-export declare class SettingsButton {
-    private readonly postEvent;
-    private readonly ee;
-    private readonly state;
-    constructor(isVisible: boolean, version: Version, postEvent?: PostEvent);
-    private set isVisible(value);
-    /**
-     * True if SettingsButton is currently visible.
-     */
-    get isVisible(): boolean;
-    /**
-     * Hides the SettingsButton.
-     */
-    hide(): void;
-    /**
-     * Adds event listener.
-     * @param event - event name.
-     * @param listener - event listener.
-     */
-    on: Emitter['on'];
-    /**
-     * Removes event listener.
-     * @param event - event name.
-     * @param listener - event listener.
-     */
-    off: Emitter['off'];
-    /**
-     * Shows the SettingsButton.
-     */
-    show(): void;
-    /**
-     * Checks if specified method is supported by current component.
-     */
-    supports: SupportsFunc<'show' | 'hide'>;
-}
-export {};