@tma.js/sdk 1.5.3 → 2.0.1

package/dist/dts/components/InitData/parsers/chat.d.ts

@@ -0,0 +1,3 @@
+import { Chat } from '../types.js';
+
+export declare const chat: import('../../../parsing/ValueParser/types.js').ValueParserOptionalResult<import('../../../parsing/ValueParser/ValueParser.js').ValueParser<Chat, false>, Chat>;

package/dist/dts/components/InitData/parsers/initData.d.ts

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

package/dist/dts/components/InitData/parsers/user.d.ts

@@ -0,0 +1,3 @@
+import { User } from '../types.js';
+
+export declare const user: import('../../../parsing/ValueParser/types.js').ValueParserOptionalResult<import('../../../parsing/ValueParser/ValueParser.js').ValueParser<User, false>, User>;

package/dist/dts/components/{init-data → InitData}/types.d.ts

@@ -64,7 +64,7 @@ export interface Chat {
      */
     photoUrl?: string;
     /**
-     * Type of chat.
+     * Type of the chat.
      */
     type: 'group' | 'supergroup' | 'channel' | string;
     /**
@@ -122,8 +122,7 @@ export interface InitDataParsed {
      */
     receiver?: User;
     /**
-     * The value of the `startattach` parameter, passed via link. Only returned for
-     * Mini Apps when launched from the attachment menu via link.
+     * The value of the `startattach` or `startapp` parameter, passed via link.
      */
     startParam?: string;
     /**

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

@@ -0,0 +1,31 @@
+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

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

package/dist/dts/components/{invoice → Invoice}/types.d.ts

@@ -1,7 +1,20 @@
-import type { StateEvents } from '../../state/types.js';
+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

@@ -0,0 +1,106 @@
+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);
+    /**
+     * Sends current local state to the Telegram application.
+     */
+    private commit;
+    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;
+    /**
+     * The MainButton background color.
+     */
+    get backgroundColor(): RGB;
+    /**
+     * The MainButton text.
+     */
+    get text(): string;
+    /**
+     * The MainButton text color.
+     */
+    get textColor(): RGB;
+    /**
+     * 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;
+    /**
+     * 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 backgroundColor - color to set.
+     */
+    setBackgroundColor(backgroundColor: RGB): this;
+    /**
+     * Allows setting multiple Main Button parameters.
+     * @param params - Main Button parameters.
+     */
+    setParams(params: Partial<MainButtonParams>): this;
+}
+export {};

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

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

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

@@ -0,0 +1,40 @@
+import { PostEvent } from '../../bridge/methods/postEvent.js';
+import { StateEvents } from '../../classes/State/types.js';
+import { RGB } from '../../colors/types.js';
+
+export interface MainButtonParams {
+    backgroundColor: 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/{mini-app → MiniApp}/MiniApp.d.ts

@@ -1,64 +1,49 @@
-import type { MiniAppEvents, MiniAppHeaderColor, MiniAppProps, RequestedContact } from './types.js';
-import type { PhoneRequestedStatus } from '../../bridge/events/parsers/phoneRequested.js';
-import type { WriteAccessRequestedStatus } from '../../bridge/events/parsers/writeAccessRequested.js';
-import type { SwitchInlineQueryChatType } from '../../bridge/methods/methods.js';
-import type { RGB } from '../../colors/types.js';
-import { EventEmitter } from '../../event-emitter/EventEmitter.js';
-import type { SupportsFunc } from '../../supports/types.js';
-import type { ExecuteWithTimeout } from '../../types/methods.js';
-type Emitter = EventEmitter<MiniAppEvents>;
+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 {
-    private readonly ee;
-    private readonly state;
+export declare class MiniApp extends WithSupportsAndTrackableState<MiniAppState, 'requestPhoneAccess' | 'requestWriteAccess' | 'switchInlineQuery' | 'setHeaderColor' | 'setBackgroundColor'> {
     private readonly botInline;
     private readonly postEvent;
     private readonly createRequestId;
-    private requestingPhoneAccess;
-    private requestingWriteAccess;
-    constructor(props: MiniAppProps);
+    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 backgroundColor(): RGB;
+    get bgColor(): RGB;
     /**
      * Closes the Mini App.
      */
     close(): void;
     /**
-     * The Mini App header color. Could either be a header color key or RGB color.
+     * The Mini App header color.
+     * @example "#ffaabb"
+     * @example "bg_color"
      */
     get headerColor(): MiniAppHeaderColor;
     /**
-     * True if Mini App is currently launched in bot inline mode.
+     * True if the Mini App is currently launched in bot inline mode.
      */
     get isBotInline(): boolean;
     /**
-     * True if current Mini App background color recognized as dark.
+     * True if current Mini App background color is recognized as dark.
      */
     get isDark(): boolean;
-    /**
-     * True if phone access is currently being requested.
-     */
-    get isRequestingPhoneAccess(): boolean;
-    /**
-     * True if write access is currently being requested.
-     */
-    get isRequestingWriteAccess(): boolean;
-    /**
-     * Adds new event listener.
-     */
-    on: Emitter['on'];
-    /**
-     * Removes event listener.
-     */
-    off: Emitter['off'];
     /**
      * Informs the Telegram app that the Mini App is ready to be displayed.
      *
@@ -81,7 +66,7 @@ export declare class MiniApp {
      * 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.
+     * To obtain the retrieved information instead, utilize the `requestContact` method.
      * @param options - additional options.
      * @see requestContact
      */
@@ -103,22 +88,24 @@ export declare class MiniApp {
     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.
      */
-    setBackgroundColor(color: RGB): void;
-    /**
-     * Checks if specified method is supported by current component.
-     */
-    supports: SupportsFunc<'requestWriteAccess' | 'requestPhoneAccess' | 'switchInlineQuery' | 'setHeaderColor' | 'setBackgroundColor'>;
+    setBgColor(color: RGB): void;
     /**
      * Checks if specified method parameter is supported by current component.
      */
-    supportsParam: SupportsFunc<'setHeaderColor.color'>;
+    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
@@ -131,4 +118,3 @@ export declare class MiniApp {
      */
     switchInlineQuery(text: string, chatTypes?: SwitchInlineQueryChatType[]): void;
 }
-export {};

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

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

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

@@ -0,0 +1,7 @@
+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

@@ -0,0 +1,53 @@
+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

@@ -0,0 +1,30 @@
+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

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

package/dist/dts/components/{popup → Popup}/preparePopupParams.d.ts

@@ -1,5 +1,6 @@
-import type { OpenPopupOptions } from './types.js';
-import type { PopupParams as BridgePopupParams } from '../../bridge/methods/popup.js';
+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.

package/dist/dts/components/{popup → Popup}/types.d.ts

@@ -1,4 +1,5 @@
-import type { StateEvents } from '../../state/types.js';
+import { StateEvents } from '../../classes/State/types.js';
+
 export interface PopupState {
     isOpened: boolean;
 }

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

@@ -0,0 +1,28 @@
+import { WithSupportsAndTrackableState } from '../../classes/WithSupportsAndTrackableState.js';
+import { PostEvent } from '../../bridge/methods/postEvent.js';
+import { Version } from '../../version/types.js';
+import { 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 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>;
+}

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

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

package/dist/dts/components/{qr-scanner → QRScanner}/types.d.ts

@@ -1,7 +1,20 @@
-import type { StateEvents } from '../../state/types.js';
+import { StateEvents } from '../../classes/State/types.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];

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

@@ -0,0 +1,37 @@
+import { WithSupportsAndStateUtils } from '../../classes/WithSupportsAndStateUtils.js';
+import { PostEvent } from '../../bridge/methods/postEvent.js';
+import { SettingsButtonEvents, SettingsButtonState } from './types.js';
+import { EventEmitter } from '../../events/event-emitter/EventEmitter.js';
+import { Version } from '../../version/types.js';
+
+type Emitter = EventEmitter<SettingsButtonEvents>;
+export declare class SettingsButton extends WithSupportsAndStateUtils<SettingsButtonState, 'show' | 'hide'> {
+    private readonly postEvent;
+    constructor(isVisible: boolean, version: Version, postEvent: PostEvent);
+    private set isVisible(value);
+    /**
+     * True if the SettingsButton is visible.
+     */
+    get isVisible(): boolean;
+    /**
+     * Hides the SettingsButton.
+     */
+    hide(): void;
+    /**
+     * 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 SettingsButton.
+     */
+    show(): void;
+}
+export {};

package/dist/dts/components/SettingsButton/initSettingsButton.d.ts

@@ -0,0 +1,7 @@
+import { SettingsButton } from './SettingsButton.js';
+
+/**
+ * @returns A new initialized instance of the `SettingsButton` class.
+ * @see SettingsButton
+ */
+export declare const initSettingsButton: import('../../index.js').InitComponentFn<"version", SettingsButton, import('./types.js').SettingsButtonState>;

package/dist/dts/components/{settings-button → SettingsButton}/types.d.ts

@@ -1,10 +1,25 @@
-import type { MiniAppsEventListener } from '../../bridge/events/events.js';
-import type { StateEvents } from '../../state/types.js';
+import { StateEvents } from '../../classes/State/types.js';
+
+/**
+ * SettingsButton internal state.
+ */
 export interface SettingsButtonState {
     isVisible: boolean;
 }
+/**
+ * SettingsButton trackable events.
+ */
 export interface SettingsButtonEvents extends StateEvents<SettingsButtonState> {
-    click: MiniAppsEventListener<'settings_button_pressed'>;
+    /**
+     * The SettingsButton was clicked.
+     */
+    click: () => void;
 }
+/**
+ * SettingsButton event name.
+ */
 export type SettingsButtonEventName = keyof SettingsButtonEvents;
+/**
+ * SettingsButton event listener.
+ */
 export type SettingsButtonEventListener<E extends SettingsButtonEventName> = SettingsButtonEvents[E];