@tma.js/sdk 0.13.2 → 1.0.0

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

@@ -1,114 +0,0 @@
-import { type PostEvent } from '@tma.js/bridge';
-import type { RGB } from '@tma.js/colors';
-/**
- * Controls the main button, which is displayed at the bottom
- * of the Mini App in the Telegram interface.
- */
-export declare class MainButton {
-    private readonly postEvent;
-    private readonly ee;
-    private readonly state;
-    constructor(backgroundColor: RGB, isEnabled: boolean, isVisible: boolean, isProgressVisible: boolean, text: string, textColor: RGB, postEvent?: PostEvent);
-    private set isEnabled(value);
-    /**
-     * Returns true in case, MainButton is currently enabled.
-     */
-    get isEnabled(): boolean;
-    private set isProgressVisible(value);
-    /**
-     * Returns true in case, MainButton loading progress is currently visible.
-     */
-    get isProgressVisible(): boolean;
-    private set isVisible(value);
-    /**
-     * Returns true in case, MainButton is currently visible.
-     */
-    get isVisible(): boolean;
-    /**
-     * Sends current local button state to Telegram application.
-     */
-    private commit;
-    /**
-     * Returns current main button background color.
-     */
-    get backgroundColor(): RGB;
-    /**
-     * Returns current main button text.
-     */
-    get text(): string;
-    /**
-     * Returns current main button text color.
-     */
-    get textColor(): RGB;
-    /**
-     * Disables button. Returns current button instance for chaining.
-     */
-    disable(): this;
-    /**
-     * Enables button. Returns current button instance for chaining.
-     */
-    enable(): this;
-    /**
-     * Hides button. Returns current button instance for chaining.
-     */
-    hide(): this;
-    /**
-     * Hides button progress. Returns current button instance for chaining.
-     */
-    hideProgress(): this;
-    /**
-     * Adds new event listener.
-     * FIXME: Event 'main_button_pressed' is still being received on Android
-     *  even if the main button is disabled.
-     *  Issue: https://github.com/Telegram-Mini-Apps/tma.js/issues/3
-     * @param event - event name.
-     * @param listener - event listener.
-     */
-    on: typeof this.ee.on;
-    /**
-     * Removes event listener.
-     * @param event - event name.
-     * @param listener - event listener.
-     */
-    off: typeof this.ee.off;
-    /**
-     * Shows the button. Note that opening the Mini App from the attachment
-     * menu hides the main button until the user interacts with the Mini App
-     * interface.
-     *
-     * Returns current button instance for chaining.
-     */
-    show(): this;
-    /**
-     * A method to show a loading indicator on the button.
-     * It is recommended to display loading progress if the action tied to the
-     * button may take a long time.
-     *
-     * Returns current button instance for chaining.
-     */
-    showProgress(): this;
-    /**
-     * Sets new main button text. Returns current button instance for chaining.
-     * Minimal length for text is 1 symbol, and maximum is 64 symbols.
-     *
-     * Returns current button instance for chaining.
-     * @param value - new text.
-     */
-    setText(value: string): this;
-    /**
-     * Sets new main button text color. Returns current button instance for
-     * chaining.
-     *
-     * Returns current button instance for chaining.
-     * @param value - new text color.
-     */
-    setTextColor(value: RGB): this;
-    /**
-     * Updates current button color. Returns current button instance for
-     * chaining.
-     *
-     * Returns current button instance for chaining.
-     * @param value - color to set.
-     */
-    setBackgroundColor(value: RGB): this;
-}

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

@@ -1,2 +0,0 @@
-export * from './MainButton.js';
-export type { MainButtonEvents, MainButtonEventListener, MainButtonEventName } from './types.js';

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

@@ -1,15 +0,0 @@
-import type { RGB } from '@tma.js/colors';
-import type { StateEvents } from '../../state/index.js';
-export interface MainButtonState {
-    backgroundColor: RGB;
-    isEnabled: boolean;
-    isVisible: boolean;
-    isProgressVisible: boolean;
-    text: string;
-    textColor: RGB;
-}
-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/Popup/index.d.ts

@@ -1,2 +0,0 @@
-export * from './Popup.js';
-export type { PopupParams, PopupEvents, PopupEventListener, PopupEventName, PopupButton, } from './types.js';

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

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

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

@@ -1,2 +0,0 @@
-export * from './QRScanner.js';
-export type { QRScannerEvents, QRScannerEventName, QRScannerEventListener } from './types.js';

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

@@ -1,73 +0,0 @@
-import { type ThemeParams as ThemeParamsType } from '@tma.js/theme-params';
-import { type RequestOptions } from '@tma.js/bridge';
-import type { RGB } from '@tma.js/colors';
-import type { ThemeParamsEvents } from './types.js';
-/**
- * Contains information about currently used theme by application.
- * @see https://core.telegram.org/bots/webapps#themeparams
- */
-export declare class ThemeParams {
-    /**
-     * Requests fresh information about current theme.
-     * FIXME: Be careful using this function in desktop version of Telegram as
-     *  long as method web_app_request_theme does not work on `macos` platform.
-     * @param options - method options.
-     */
-    static request(options?: RequestOptions): Promise<ThemeParamsType>;
-    /**
-     * Synchronizes specified instance of ThemeParams with the actual value in the native
-     * application.
-     * @param themeParams - ThemeParams instance.
-     */
-    static sync(themeParams: ThemeParams): void;
-    /**
-     * Returns instance of ThemeParams which is synchronized with external
-     * environment.
-     * @param options - method options.
-     */
-    static synced(options?: RequestOptions): Promise<ThemeParams>;
-    private readonly ee;
-    private readonly state;
-    constructor(params: ThemeParamsType);
-    /**
-     * Returns background color.
-     */
-    get backgroundColor(): RGB | null;
-    /**
-     * Returns button color.
-     */
-    get buttonColor(): RGB | null;
-    /**
-     * Returns button text color.
-     */
-    get buttonTextColor(): RGB | null;
-    /**
-     * Returns hint color.
-     */
-    get hintColor(): RGB | null;
-    /**
-     * Returns true in case, current color scheme is recognized as dark. This
-     * value is calculated according to theme background color.
-     */
-    get isDark(): boolean;
-    /**
-     * Returns current link color.
-     */
-    get linkColor(): RGB | null;
-    /**
-     * Adds new event listener.
-     */
-    on: <E extends "changed" | "backgroundColorChanged" | "textColorChanged" | "accentTextColorChanged" | "buttonColorChanged" | "buttonTextColorChanged" | "destructiveTextColorChanged" | "headerBackgroundColorChanged" | "hintColorChanged" | "linkColorChanged" | "secondaryBackgroundColorChanged" | "sectionBackgroundColorChanged" | "sectionHeaderTextColorChanged" | "subtitleTextColorChanged">(event: E, listener: import("@tma.js/event-emitter").EventListener<ThemeParamsEvents[E]>) => import("@tma.js/event-emitter").RemoveEventListener;
-    /**
-     * Removes event listener.
-     */
-    off: <E extends "changed" | "backgroundColorChanged" | "textColorChanged" | "accentTextColorChanged" | "buttonColorChanged" | "buttonTextColorChanged" | "destructiveTextColorChanged" | "headerBackgroundColorChanged" | "hintColorChanged" | "linkColorChanged" | "secondaryBackgroundColorChanged" | "sectionBackgroundColorChanged" | "sectionHeaderTextColorChanged" | "subtitleTextColorChanged">(event: E, listener: import("@tma.js/event-emitter").EventListener<ThemeParamsEvents[E]>) => void;
-    /**
-     * Returns secondary background color.
-     */
-    get secondaryBackgroundColor(): RGB | null;
-    /**
-     * Returns text color.
-     */
-    get textColor(): RGB | null;
-}

package/dist/dts/components/ThemeParams/index.d.ts

@@ -1,2 +0,0 @@
-export * from './ThemeParams.js';
-export * from './types.js';

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

@@ -1,9 +0,0 @@
-import type { HasUndefined, If } from '@tma.js/util-types';
-import type { ThemeParams } from '@tma.js/theme-params';
-import type { StateEvents } from '../../state/index.js';
-export type ThemeParamsState = {
-    [K in keyof ThemeParams]-?: If<HasUndefined<ThemeParams[K]>, Exclude<ThemeParams[K], undefined> | null, ThemeParams[K]>;
-};
-export type ThemeParamsEvents = StateEvents<ThemeParamsState>;
-export type ThemeParamsEventName = keyof ThemeParamsEvents;
-export type ThemeParamsEventListener<E extends ThemeParamsEventName> = ThemeParamsEvents[E];

package/dist/dts/components/Viewport/index.d.ts

@@ -1,2 +0,0 @@
-export * from './Viewport.js';
-export type { ViewportEvents, ViewportEventListener, ViewportEventName } from './types.js';

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

@@ -1,146 +0,0 @@
-import { type Version } from '@tma.js/utils';
-import { type RGB } from '@tma.js/colors';
-import { type PhoneRequestedStatus, type WriteAccessRequestedStatus, type InvoiceStatus, type PostEvent } from '@tma.js/bridge';
-import type { Platform } from '@tma.js/launch-params';
-import { type SupportsFunc } from '../../supports.js';
-import type { ColorScheme } from '../../types.js';
-import type { WebAppEvents, WebAppHeaderColor } from './types.js';
-/**
- * Provides common Mini Apps functionality not covered by other system
- * components.
- */
-export declare class WebApp {
-    private readonly currentVersion;
-    private readonly currentPlatform;
-    private readonly createRequestId;
-    private readonly postEvent;
-    private readonly ee;
-    private readonly state;
-    constructor(headerColor: WebAppHeaderColor, backgroundColor: RGB, currentVersion: Version, currentPlatform: Platform, createRequestId: () => string, postEvent?: PostEvent);
-    /**
-     * Returns current application background color.
-     */
-    get backgroundColor(): RGB;
-    /**
-     * Returns current application color scheme. This value is
-     * computed based on the current background color.
-     */
-    get colorScheme(): ColorScheme;
-    /**
-     * Closes the Mini App.
-     */
-    close(): void;
-    /**
-     * Returns current application header color.
-     */
-    get headerColor(): WebAppHeaderColor;
-    /**
-     * Returns true if passed version is more than or equal to current
-     * Mini App version.
-     * @param version - compared version.
-     */
-    isVersionAtLeast(version: Version): boolean;
-    /**
-     * Opens a link in an external browser. The Mini App will not be closed.
-     *
-     * Note that this method can be called only in response to the user
-     * interaction with the Mini App interface (e.g. click inside the Mini App
-     * or on the main button).
-     * @param url - URL to be opened.
-     * @param tryInstantView
-     */
-    openLink(url: string, tryInstantView?: boolean): void;
-    /**
-     * Opens a Telegram link inside Telegram app. The Mini App will be closed.
-     * It expects passing link in full format, with hostname "t.me".
-     * @param url - URL to be opened.
-     * @throws {Error} URL has not allowed hostname.
-     */
-    openTelegramLink(url: string): void;
-    /**
-     * Opens an invoice using its url. It expects passing link in full format,
-     * with hostname "t.me".
-     * @param url - invoice URL.
-     */
-    openInvoice(url: string): Promise<InvoiceStatus>;
-    /**
-     * Adds new event listener.
-     */
-    on: <E extends "changed" | "backgroundColorChanged" | "headerColorChanged">(event: E, listener: import("@tma.js/event-emitter").EventListener<WebAppEvents[E]>) => import("@tma.js/event-emitter").RemoveEventListener;
-    /**
-     * Removes event listener.
-     */
-    off: <E extends "changed" | "backgroundColorChanged" | "headerColorChanged">(event: E, listener: import("@tma.js/event-emitter").EventListener<WebAppEvents[E]>) => void;
-    /**
-     * Returns current Mini App platform.
-     */
-    get platform(): Platform;
-    /**
-     * 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;
-    /**
-     * Reads text from clipboard and returns string or null. null is returned
-     * in cases:
-     * - Value in clipboard is not text
-     * - Access to clipboard is not allowed
-     */
-    readTextFromClipboard(): Promise<string | null>;
-    /**
-     * Requests current user phone access.
-     */
-    requestPhoneAccess(): Promise<PhoneRequestedStatus>;
-    /**
-     * Requests write message access to current user.
-     */
-    requestWriteAccess(): 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.
-     *
-     * 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 application header color.
-     * FIXME: Has no effect on desktop, works incorrectly on Android.
-     *  Issues:
-     *  https://github.com/Telegram-Mini-Apps/tma.js/issues/9
-     *  https://github.com/Telegram-Mini-Apps/tma.js/issues/8
-     * @param color - color key or RGB color.
-     */
-    setHeaderColor(color: WebAppHeaderColor): void;
-    /**
-     * Updates current application background color.
-     * FIXME: Has no effect on desktop, works incorrectly in Android.
-     *  Issues:
-     *  https://github.com/Telegram-Mini-Apps/tma.js/issues/9
-     *  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<'openInvoice' | 'readTextFromClipboard' | 'setHeaderColor' | 'setBackgroundColor' | 'requestWriteAccess' | 'requestPhoneAccess'>;
-    /**
-     * Checks if specified method parameter is supported by current component.
-     */
-    supportsParam: SupportsFunc<'setHeaderColor.color' | 'openLink.tryInstantView'>;
-    /**
-     * Current Mini App version. This property is used by other components to check if
-     * some functionality is available on current device.
-     */
-    get version(): Version;
-}

package/dist/dts/components/WebApp/index.d.ts

@@ -1,2 +0,0 @@
-export * from './types.js';
-export * from './WebApp.js';

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

@@ -1,11 +0,0 @@
-import type { RGB } from '@tma.js/colors';
-import type { HeaderColorKey } from '@tma.js/bridge';
-import type { StateEvents } from '../../state/index.js';
-export type WebAppHeaderColor = HeaderColorKey | RGB;
-export interface WebAppState {
-    backgroundColor: RGB;
-    headerColor: WebAppHeaderColor;
-}
-export type WebAppEvents = StateEvents<WebAppState>;
-export type WebAppEventName = keyof WebAppEvents;
-export type WebAppEventListener<E extends WebAppEventName> = WebAppEvents[E];

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

@@ -1,11 +0,0 @@
-export * from './BackButton/index.js';
-export * from './ClosingBehaviour/index.js';
-export * from './CloudStorage/index.js';
-export * from './HapticFeedback/index.js';
-export * from './InitData/index.js';
-export * from './MainButton/index.js';
-export * from './Popup/index.js';
-export * from './QRScanner/index.js';
-export * from './ThemeParams/index.js';
-export * from './Viewport/index.js';
-export * from './WebApp/index.js';

package/dist/dts/env.d.ts

@@ -1,10 +0,0 @@
-/**
- * Returns true in case, current environment is Telegram Mini Apps.
- */
-export declare function isTMA(): boolean;
-/**
- * Returns true in case, current environment is Telegram Mini Apps.
- * @see computeLaunchData
- * @deprecated Use `isTMA`
- */
-export declare function isTWA(): boolean;

package/dist/dts/errors/MethodNotSupportedError.d.ts

@@ -1,6 +0,0 @@
-/**
- * Error thrown in case, unsupported method was called.
- */
-export declare class MethodNotSupportedError extends Error {
-    constructor(method: string, version: string);
-}

package/dist/dts/errors/ParameterNotSupportedError.d.ts

@@ -1,6 +0,0 @@
-/**
- * Error thrown in case, unsupported parameter was used.
- */
-export declare class ParameterUnsupportedError extends Error {
-    constructor(method: string, param: string, version: string);
-}

package/dist/dts/errors/index.d.ts

@@ -1,2 +0,0 @@
-export * from './MethodNotSupportedError.js';
-export * from './ParameterNotSupportedError.js';

package/dist/dts/init/creators/createWebApp.d.ts

@@ -1,16 +0,0 @@
-import type { RGB } from '@tma.js/colors';
-import type { PostEvent } from '@tma.js/bridge';
-import type { Platform } from '@tma.js/launch-params';
-import { WebApp } from '../../components/index.js';
-import type { CreateRequestIdFunc } from '../../types.js';
-/**
- * Creates WebApp instance using last locally saved data also saving each state in
- * the storage.
- * @param isPageReload - was current page reloaded.
- * @param backgroundColor - web app background color.
- * @param version - platform version.
- * @param platform - Telegram Mini Apps platform name.
- * @param createRequestId - function which generates request identifiers.
- * @param postEvent - Bridge postEvent function
- */
-export declare function createWebApp(isPageReload: boolean, backgroundColor: RGB, version: string, platform: Platform, createRequestId: CreateRequestIdFunc, postEvent: PostEvent): WebApp;

package/dist/dts/init/css.d.ts

@@ -1,57 +0,0 @@
-import type { ThemeParams, WebApp, Viewport } from '../components/index.js';
-import type { InitCSSVarsOption, InitCSSVarsSpecificOption } from './types.js';
-/**
- * Creates CSS variables connected with theme parameters.
- *
- * Created variables:
- * - `--tg-theme-bg-color`
- * - `--tg-theme-button-color`
- * - `--tg-theme-button-text-color`
- * - `--tg-theme-hint-color`
- * - `--tg-theme-link-color`
- * - `--tg-theme-secondary-bg-color`
- * - `--tg-theme-text-color`
- *
- * Variables are being automatically updated in case, corresponding properties
- * updated in passed ThemeParams instance.
- *
- * @param themeParams - ThemeParams instance.
- */
-export declare function bindThemeCSSVariables(themeParams: ThemeParams): void;
-/**
- * Creates CSS variables connected with WebApp background and header colors based on
- * passed WebApp and ThemeParams instances.
- *
- * Created variables:
- * - `--tg-bg-color`
- * - `--tg-header-color`
- *
- * Variables are being automatically updated in case, corresponding properties are updating.
- *
- * @param webApp - WebApp instance.
- * @param themeParams - ThemeParams instance.
- */
-export declare function bindWebAppVariables(webApp: WebApp, themeParams: ThemeParams): void;
-/**
- * Accepts Viewport instance and sets CSS variables connected with viewport
- * sizes.
- *
- * Be careful using this function as long as it can impact application
- * performance. Viewport size is changing rather often, this makes CSS
- * variables update, which leads to possible layout redraw.
- *
- * Variables:
- * - `--tg-viewport-height`
- * - `--tg-viewport-stable-height`
- *
- * Variables are being automatically updated in case, corresponding properties
- * updated in passed Viewport instance.
- *
- * @param viewport - Viewport instance.
- */
-export declare function bindViewportCSSVariables(viewport: Viewport): void;
-/**
- * Converts init cssVars option to more narrow type.
- * @param option - option value.
- */
-export declare function parseCSSVarsOptions(option: InitCSSVarsOption): InitCSSVarsSpecificOption;

package/dist/dts/supports.d.ts

@@ -1,22 +0,0 @@
-import type { Version } from '@tma.js/utils';
-import { type MethodName, type MethodVersionedParams, type MethodWithVersionedParams } from '@tma.js/bridge';
-export type SupportsFunc<M extends string> = (method: M) => boolean;
-type HasCheckSupportMethodTuple = {
-    [M in MethodWithVersionedParams]: [M, MethodVersionedParams<M>];
-}[MethodWithVersionedParams];
-/**
- * Returns function, which accepts predefined method name and checks if it is supported
- * via passed schema and version.
- * @param schema - object which contains methods names and TWA method as a dependency.
- * @param version - platform version.
- */
-export declare function createSupportsFunc<M extends string>(version: Version, schema: Record<M, MethodName>): SupportsFunc<M>;
-/**
- * Returns function, which accepts predefined method name and checks if it is supported
- * via passed schema and version.
- * @param schema - object which contains methods names and TWA methods with specified parameter
- * as a dependency.
- * @param version - platform version.
- */
-export declare function createSupportsParamFunc<P extends string>(version: Version, schema: Record<P, HasCheckSupportMethodTuple>): SupportsFunc<P>;
-export {};

package/dist/dts/types.d.ts

@@ -1,10 +0,0 @@
-import type { PostEvent as BridgePostEvent } from '@tma.js/bridge';
-export type PostEvent = BridgePostEvent;
-/**
- * Color scheme.
- */
-export type ColorScheme = 'dark' | 'light';
-/**
- * Function which generates unique request identifiers.
- */
-export type CreateRequestIdFunc = () => string;

package/dist/dts/url.d.ts

@@ -1,7 +0,0 @@
-/**
- * Converts passed URL to its full form.
- * @param url - URL to format.
- * @throws {Error} URL protocol is not supported by OS, or link has not allowed
- * protocol.
- */
-export declare function formatURL(url: string): string;

package/src/components/BackButton/index.ts

@@ -1,2 +0,0 @@
-export * from './BackButton.js';
-export type { BackButtonEventListener, BackButtonEventName, BackButtonEvents } from './types.js';

package/src/components/ClosingBehaviour/index.ts

@@ -1,6 +0,0 @@
-export * from './ClosingBehaviour.js';
-export type {
-  ClosingBehaviourEventName,
-  ClosingBehaviourEventListener,
-  ClosingBehaviourEvents,
-} from './types.js';

package/src/components/ClosingBehaviour/types.ts

@@ -1,12 +0,0 @@
-import type { StateEvents } from '../../state/index.js';
-
-export interface ClosingBehaviourState {
-  isConfirmationNeeded: boolean;
-}
-
-export type ClosingBehaviourEvents = StateEvents<ClosingBehaviourState>;
-
-export type ClosingBehaviourEventName = keyof ClosingBehaviourEvents;
-
-export type ClosingBehaviourEventListener<E extends ClosingBehaviourEventName> =
-  ClosingBehaviourEvents[E];