@tma.js/sdk 2.7.0 → 3.0.1

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

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

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

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

@@ -1,25 +0,0 @@
-import { StateEvents } from '../../classes/State/types.js';
-
-/**
- * SettingsButton internal state.
- */
-export interface SettingsButtonState {
-    isVisible: boolean;
-}
-/**
- * SettingsButton trackable events.
- */
-export interface SettingsButtonEvents extends StateEvents<SettingsButtonState> {
-    /**
-     * 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];

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

@@ -1,57 +0,0 @@
-import { WithTrackableState } from '../../classes/WithTrackableState.js';
-import { RGB } from '../../colors/types.js';
-import { RemoveEventListenerFn } from '../../events/types.js';
-import { ThemeParamsParsed, ThemeParamsState } from './types.js';
-
-/**
- * @see Usage: https://docs.telegram-mini-apps.com/platform/theming
- * @see API: https://docs.telegram-mini-apps.com/packages/tma-js-sdk/components/theme-params
- */
-export declare class ThemeParams extends WithTrackableState<ThemeParamsState> {
-    /**
-     * @since v6.10
-     */
-    get accentTextColor(): RGB | undefined;
-    get bgColor(): RGB | undefined;
-    get buttonColor(): RGB | undefined;
-    get buttonTextColor(): RGB | undefined;
-    get destructiveTextColor(): RGB | undefined;
-    /**
-     * Returns the copy of the internal state of the current component instance.
-     */
-    getState(): ThemeParamsParsed;
-    /**
-     * @since v6.10
-     */
-    get headerBgColor(): RGB | undefined;
-    get hintColor(): RGB | undefined;
-    /**
-     * @returns True in case, current color scheme is recognized as dark. This
-     * value is calculated according to theme bg color.
-     */
-    get isDark(): boolean;
-    get linkColor(): RGB | undefined;
-    get secondaryBgColor(): RGB | undefined;
-    /**
-     * @since v6.10
-     */
-    get sectionBgColor(): RGB | undefined;
-    /**
-     * @since v6.10
-     */
-    get sectionHeaderTextColor(): RGB | undefined;
-    /**
-     * @since v7.6
-     */
-    get sectionSeparatorColor(): RGB | undefined;
-    /**
-     * Starts listening to the external theme changes and applies them.
-     * @returns Function to stop listening.
-     */
-    listen(): RemoveEventListenerFn;
-    /**
-     * @since v6.10
-     */
-    get subtitleTextColor(): RGB | undefined;
-    get textColor(): RGB | undefined;
-}

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

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

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

@@ -1,11 +0,0 @@
-/**
- * Converts a palette key from the Telegram application to the representation used by the package.
- * @param key - palette key.
- */
-export declare function keyToLocal(key: string): string;
-/**
- * Converts palette key from the local representation to the representation sent from the
- * Telegram application.
- * @param key - palette key.
- */
-export declare function keyToExternal(key: string): string;

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

@@ -1,7 +0,0 @@
-import { ThemeParamsParsed } from '../types.js';
-
-/**
- * Parses incoming value as theme parameters.
- * @param value - value to parse.
- */
-export declare function parseThemeParams(value: unknown): ThemeParamsParsed;

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

@@ -1,6 +0,0 @@
-import { ThemeParamsParsed } from '../types.js';
-
-/**
- * Serializes theme parameters to representation sent from the Telegram application.
- */
-export declare function serializeThemeParams(themeParams: ThemeParamsParsed): string;

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

@@ -1,4 +0,0 @@
-import { ValueParserGenerator } from '../../../parsing/createValueParserGenerator.js';
-import { ThemeParamsParsed } from '../types.js';
-
-export declare const themeParams: ValueParserGenerator<ThemeParamsParsed>;

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

@@ -1,8 +0,0 @@
-import { ExecuteWithOptions } from '../../types/index.js';
-import { ThemeParamsParsed } from './types.js';
-
-/**
- * Requests current theme parameters from the Telegram application.
- * @param options - request options.
- */
-export declare function requestThemeParams(options?: ExecuteWithOptions): Promise<ThemeParamsParsed>;

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

@@ -1,29 +0,0 @@
-import { StateEvents } from '../../classes/State/types.js';
-import { RGB } from '../../colors/types.js';
-
-export type ThemeParamsKey = 'accentTextColor' | 'bgColor' | 'buttonColor' | 'buttonTextColor' | 'destructiveTextColor' | 'headerBgColor' | 'hintColor' | 'linkColor' | 'secondaryBgColor' | 'sectionBgColor' | 'sectionHeaderTextColor' | 'sectionSeparatorColor' | 'subtitleTextColor' | 'textColor';
-/**
- * Application [theme parameters](https://docs.telegram-mini-apps.com/platform/theming).
- * Defines palette used by the Telegram application.
- */
-export interface ThemeParamsParsed {
-    [key: ThemeParamsKey | string]: RGB | undefined;
-}
-/**
- * ThemeParams internal state.
- */
-export interface ThemeParamsState extends ThemeParamsParsed {
-}
-/**
- * ThemeParams trackable events.
- */
-export interface ThemeParamsEvents extends StateEvents<ThemeParamsState> {
-}
-/**
- * ThemeParams event name.
- */
-export type ThemeParamsEventName = keyof ThemeParamsEvents;
-/**
- * ThemeParams event listener.
- */
-export type ThemeParamsEventListener<E extends ThemeParamsEventName> = ThemeParamsEvents[E];

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

@@ -1,77 +0,0 @@
-import { WithSupports } from '../../classes/WithSupports.js';
-import { PostEvent } from '../../bridge/methods/postEvent.js';
-import { CreateRequestIdFn } from '../../request-id/types.js';
-import { SupportsFn } from '../../supports/types.js';
-import { Version } from '../../version/types.js';
-
-export interface UtilsOpenLinkOptions {
-    /**
-     * Attempts to use the instant view mode.
-     */
-    tryInstantView?: boolean;
-    /**
-     * Attempts to use user preferred browser.
-     */
-    tryBrowser?: boolean;
-}
-/**
- * @see API: https://docs.telegram-mini-apps.com/packages/tma-js-sdk/components/utils
- */
-export declare class Utils extends WithSupports<'readTextFromClipboard'> {
-    private readonly version;
-    private readonly createRequestId;
-    private readonly postEvent;
-    constructor(version: Version, createRequestId: CreateRequestIdFn, postEvent: PostEvent);
-    /**
-     * Opens a link.
-     *
-     * 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 options - additional options.
-     */
-    openLink(url: string, options?: UtilsOpenLinkOptions): void;
-    /**
-     * Opens a link.
-     *
-     * 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 - try to use the instant view.
-     * @deprecated Use the second argument as an object.
-     */
-    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;
-    /**
-     * 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>;
-    /**
-     * Shares specified URL with the passed to the chats, selected by user. After being called,
-     * it closes the mini application.
-     *
-     * This method uses Telegram's Share Links.
-     * @param url - URL to share.
-     * @param text - text to append after the URL.
-     * @see https://core.telegram.org/api/links#share-links
-     * @see https://core.telegram.org/widgets/share#custom-buttons
-     */
-    shareURL(url: string, text?: string): void;
-    /**
-     * Checks if specified method parameter is supported by current component.
-     */
-    supportsParam: SupportsFn<'openLink.tryInstantView'>;
-}

package/dist/dts/components/Utils/initUtils.d.ts

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

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

@@ -1,77 +0,0 @@
-import { WithTrackableState } from '../../classes/WithTrackableState.js';
-import { RemoveEventListenerFn } from '../../events/types.js';
-import { ExecuteWithOptions } from '../../types/index.js';
-import { ViewportProps, ViewportState } from './types.js';
-
-/**
- * @see Usage: https://docs.telegram-mini-apps.com/platform/viewport
- * @see API: https://docs.telegram-mini-apps.com/packages/tma-js-sdk/components/viewport
- */
-export declare class Viewport extends WithTrackableState<ViewportState> {
-    private readonly postEvent;
-    constructor({ postEvent, stableHeight, height, width, isExpanded }: ViewportProps);
-    /**
-     * Requests viewport information from the Telegram application and updates current Viewport
-     * instance.
-     * @param options - options to request fresh data.
-     */
-    sync(options?: ExecuteWithOptions): Promise<void>;
-    /**
-     * The current height of the **visible area** of the Mini App.
-     *
-     * The application can display just the top part of the Mini App, with its lower part remaining
-     * outside the screen area. From this position, the user can "pull" the Mini App to its
-     * maximum height, while the bot can do the same by calling `expand` method. As the position of
-     * the Mini App changes, the current height value of the visible area will be updated  in real
-     * time.
-     *
-     * Please note that the refresh rate of this value is not sufficient to smoothly follow the
-     * lower border of the window. It should not be used to pin interface elements to the bottom
-     * of the visible area. It's more appropriate to use the value of the `stableHeight`
-     * field for this purpose.
-     *
-     * @see stableHeight
-     */
-    get height(): number;
-    /**
-     * The height of the visible area of the Mini App in its last stable state.
-     *
-     * The application can display just the top part of the Mini App, with its lower part remaining
-     * outside the screen area. From this position, the user can "pull" the Mini App to its
-     * maximum height, while the application can do the same by calling `expand` method.
-     *
-     * Unlike the value of `height`, the value of `stableHeight` does not change as the position
-     * of the Mini App changes with user gestures or during animations. The value of `stableHeight`
-     * will be updated after all gestures and animations are completed and
-     * the Mini App reaches its final size.
-     *
-     * @see height
-     */
-    get stableHeight(): number;
-    /**
-     * Starts listening to viewport changes and applies them.
-     * @returns Function to stop listening.
-     */
-    listen(): RemoveEventListenerFn;
-    /**
-     * True if the Mini App is expanded to the maximum available height. Otherwise, if
-     * the Mini App occupies part of the screen and can be expanded to the full height using
-     * `expand` method.
-     * @see expand
-     */
-    get isExpanded(): boolean;
-    /**
-     * Current visible area width.
-     */
-    get width(): number;
-    /**
-     * A method that expands the Mini App to the maximum available height. To find out if the Mini
-     * App is expanded to the maximum height, refer to the value of the `isExpanded`.
-     * @see isExpanded
-     */
-    expand(): void;
-    /**
-     * True if the current viewport height is stable and is not going to change in the next moment.
-     */
-    get isStable(): boolean;
-}

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

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

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

@@ -1,13 +0,0 @@
-import { ExecuteWithOptions } from '../../types/index.js';
-
-export interface RequestViewportResult {
-    height: number;
-    isStateStable: boolean;
-    isExpanded: boolean;
-    width: number;
-}
-/**
- * Requests viewport actual information from the Telegram application.
- * @param options - request options.
- */
-export declare function requestViewport(options?: ExecuteWithOptions): Promise<RequestViewportResult>;

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

@@ -1,35 +0,0 @@
-import { PostEvent } from '../../bridge/methods/postEvent.js';
-import { StateEvents } from '../../classes/State/types.js';
-
-/**
- * Viewport constructor properties.
- */
-export interface ViewportProps {
-    height: number;
-    width: number;
-    stableHeight: number;
-    isExpanded: boolean;
-    postEvent: PostEvent;
-}
-/**
- * Viewport internal state.
- */
-export interface ViewportState {
-    height: number;
-    isExpanded: boolean;
-    stableHeight: number;
-    width: number;
-}
-/**
- * Viewport trackable events.
- */
-export interface ViewportEvents extends StateEvents<ViewportState> {
-}
-/**
- * Viewport event name.
- */
-export type ViewportEventName = keyof ViewportEvents;
-/**
- * Viewport event listener.
- */
-export type ViewportEventListener<E extends ViewportEventName> = ViewportEvents[E];

package/dist/dts/css-vars/bindMiniAppCSSVars.d.ts

@@ -1,29 +0,0 @@
-import { ThemeParams } from '../components/ThemeParams/ThemeParams.js';
-import { MiniApp } from '../components/MiniApp/MiniApp.js';
-import { CleanupFn } from '../types/index.js';
-
-export interface GetMiniAppCSSVarNameFn {
-    /**
-     * @param property - MiniApp property.
-     * @returns Computed complete CSS variable name.
-     */
-    (property: 'bg' | 'header'): string;
-}
-/**
- * Creates CSS variables connected with the MiniApps class instance background and header colors
- * based on the passed MiniApp and ThemeParams instances.
- *
- * Created variables by default:
- * - `--tg-bg-color`
- * - `--tg-header-color`
- *
- * Variables are being automatically updated in case, corresponding MiniApp and ThemeParams
- * properties were updated.
- *
- * @param miniApp - MiniApp instance.
- * @param themeParams - ThemeParams instance.
- * @param getVarName - function, returning complete CSS variable name for the specified
- * MiniApp property.
- * @returns Function to stop updating variables.
- */
-export declare function bindMiniAppCSSVars(miniApp: MiniApp, themeParams: ThemeParams, getVarName?: GetMiniAppCSSVarNameFn): CleanupFn;

package/dist/dts/css-vars/bindThemeParamsCSSVars.d.ts

@@ -1,29 +0,0 @@
-import { ThemeParams } from '../components/ThemeParams/ThemeParams.js';
-import { CleanupFn } from '../types/index.js';
-
-export interface GetThemeParamsCSSVarNameFn {
-    /**
-     * @param property - ThemeParams property.
-     * @returns Computed complete CSS variable name.
-     */
-    (property: string): string;
-}
-/**
- * Creates CSS variables connected with the passed instance of the ThemeParams class.
- *
- * By default, created CSS variables names are following the pattern "--tg-theme-{name}", where
- * {name} is a theme parameters key name converted from camel case to kebab case.
- *
- * Example:
- * --tg-theme-bg-color
- * --tg-theme-secondary-text-color
- *
- * Variables are being automatically updated in case, corresponding properties updated in
- * the passed ThemeParams instance.
- *
- * @param themeParams - ThemeParams instance.
- * @param getCSSVarName - function, returning complete CSS variable name for the specified
- * ThemeParams property.
- * @returns Function to stop updating variables.
- */
-export declare function bindThemeParamsCSSVars(themeParams: ThemeParams, getCSSVarName?: GetThemeParamsCSSVarNameFn): CleanupFn;

package/dist/dts/css-vars/bindViewportCSSVars.d.ts

@@ -1,32 +0,0 @@
-import { Viewport } from '../components/Viewport/Viewport.js';
-import { CleanupFn } from '../types/index.js';
-
-export interface GetViewportCSSVarNameFn {
-    /**
-     * @param property - Viewport property.
-     * @returns Computed complete CSS variable name.
-     */
-    (property: 'width' | 'height' | 'stable-height'): string;
-}
-/**
- * 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-width`
- * - `--tg-viewport-stable-height`
- *
- * Variables are being automatically updated in case, corresponding properties
- * updated in passed Viewport instance.
- *
- * @param viewport - Viewport instance.
- * @param getCSSVarName - function, returning complete CSS variable name for the specified
- * Viewport property.
- * @returns Function to stop updating variables.
- */
-export declare function bindViewportCSSVars(viewport: Viewport, getCSSVarName?: GetViewportCSSVarNameFn): CleanupFn;

package/dist/dts/css-vars/setCSSVar.d.ts

@@ -1,6 +0,0 @@
-/**
- * Sets CSS variable globally.
- * @param name - variable name.
- * @param value - variable value.
- */
-export declare function setCSSVar(name: string, value: string): void;

package/dist/dts/debug/debug.d.ts

@@ -1,14 +0,0 @@
-import { Logger } from '../logger/Logger.js';
-
-export declare const logger: Logger;
-/**
- * Sets new debug mode. Enabling debug mode leads to printing additional messages in the console,
- * related to the processes inside the package.
- * @param enable - should debug be enabled.
- */
-export declare function setDebug(enable: boolean): void;
-/**
- * Logs info message into the console.
- * @param args - additional arguments.
- */
-export declare function log(...args: any[]): void;

package/dist/dts/env/hasExternalNotify.d.ts

@@ -1,10 +0,0 @@
-/**
- * Returns true in case, passed value contains path `external.notify` property and `notify` is a
- * function.
- * @param value - value to check.
- */
-export declare function hasExternalNotify<T extends object>(value: T): value is (T & {
-    external: {
-        notify: (...args: any) => any;
-    };
-});

package/dist/dts/env/hasWebviewProxy.d.ts

@@ -1,10 +0,0 @@
-/**
- * Returns true in case, passed value contains path `TelegramWebviewProxy.postEvent` property and
- * `postEvent` is a function.
- * @param value - value to check.
- */
-export declare function hasWebviewProxy<T extends {}>(value: T): value is (T & {
-    TelegramWebviewProxy: {
-        postEvent: (...args: unknown[]) => unknown;
-    };
-});

package/dist/dts/env/initWeb.d.ts

@@ -1,11 +0,0 @@
-interface CleanupFn {
-    (): void;
-}
-/**
- * Performs initialization process in the web version of Telegram.
- * @returns Function, which performs cleanup removing all created elements and listeners.
- * @param acceptCustomStyles - true if SDK should accept styles sent from the Telegram web
- * application. This option is only used in web versions of Telegram. Default: false.
- */
-export declare function initWeb(acceptCustomStyles?: boolean): CleanupFn;
-export {};

package/dist/dts/env/isIframe.d.ts

@@ -1,5 +0,0 @@
-/**
- * @see https://stackoverflow.com/a/326076
- * @returns True, if current environment is iframe.
- */
-export declare function isIframe(): boolean;

package/dist/dts/env/isSSR.d.ts

@@ -1,4 +0,0 @@
-/**
- * @returns True, if current environment is server.
- */
-export declare function isSSR(): boolean;

package/dist/dts/env/isTMA.d.ts

@@ -1,4 +0,0 @@
-/**
- * Returns true in case, current environment is Telegram Mini Apps.
- */
-export declare function isTMA(): Promise<boolean>;

package/dist/dts/env/mockTelegramEnv.d.ts

@@ -1,7 +0,0 @@
-import { LaunchParams } from '../launch-params/types.js';
-
-/**
- * Mocks a Telegram application environment.
- * @param launchParamsRaw - launch parameters presented as a string or query parameters.
- */
-export declare function mockTelegramEnv(launchParamsRaw: LaunchParams | string): void;

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

@@ -1,9 +0,0 @@
-import { ErrorType } from './errors.js';
-
-/**
- * Error used across the SDK.
- */
-export declare class SDKError extends Error {
-    readonly type: ErrorType;
-    constructor(type: ErrorType, message?: string, cause?: unknown);
-}

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

@@ -1,10 +0,0 @@
-import { SDKError } from './SDKError.js';
-import { ErrorType } from './errors.js';
-
-/**
- * Creates new error using specified type and message.
- * @param type - error code.
- * @param message - error message.
- * @param cause - original error.
- */
-export declare function createError(type: ErrorType, message: string, cause?: unknown): SDKError;