@tma.js/sdk 1.5.3 → 2.0.0

package/dist/dts/components/theme-params/ThemeParams.d.ts

@@ -1,66 +0,0 @@
-import type { ThemeParamsEvents, ThemeParamsParsed } from './types.js';
-import type { RemoveListenerFn } from '../../bridge/events/types.js';
-import type { RGB } from '../../colors/types.js';
-import { EventEmitter } from '../../event-emitter/EventEmitter.js';
-type Emitter = EventEmitter<ThemeParamsEvents>;
-export declare class ThemeParams {
-    private readonly ee;
-    private readonly state;
-    constructor(params: ThemeParamsParsed);
-    /**
-     * @since v6.10
-     */
-    get accentTextColor(): RGB | undefined;
-    get backgroundColor(): RGB | undefined;
-    get buttonColor(): RGB | undefined;
-    get buttonTextColor(): RGB | undefined;
-    get destructiveTextColor(): RGB | undefined;
-    /**
-     * Retrieves palette color value by its name.
-     * @param key - palette key name.
-     */
-    get(key: Extract<keyof ThemeParamsParsed, string>): RGB | undefined;
-    /**
-     * Returns the copy of the internal state of the current component instance.
-     */
-    getState(): ThemeParamsParsed;
-    /**
-     * @since v6.10
-     */
-    get headerBackgroundColor(): RGB | undefined;
-    get hintColor(): RGB | undefined;
-    /**
-     * Returns true in case, current color scheme is recognized as dark. This
-     * value is calculated according to theme background color.
-     */
-    get isDark(): boolean;
-    get linkColor(): RGB | undefined;
-    /**
-     * Adds new event listener.
-     */
-    on: Emitter['on'];
-    /**
-     * Removes event listener.
-     */
-    off: Emitter['off'];
-    get secondaryBackgroundColor(): RGB | undefined;
-    /**
-     * @since v6.10
-     */
-    get sectionBackgroundColor(): RGB | undefined;
-    /**
-     * @since v6.10
-     */
-    get sectionHeaderTextColor(): RGB | undefined;
-    /**
-     * Starts listening to theme changes and applies them.
-     * @returns Function to stop listening.
-     */
-    listen(): RemoveListenerFn;
-    /**
-     * @since v6.10
-     */
-    get subtitleTextColor(): RGB | undefined;
-    get textColor(): RGB | undefined;
-}
-export {};

package/dist/dts/components/theme-params/keys.d.ts

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

package/dist/dts/components/theme-params/requestThemeParams.d.ts

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

package/dist/dts/components/theme-params/themeParamsParser.d.ts

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

package/dist/dts/components/theme-params/types.d.ts

@@ -1,14 +0,0 @@
-import type { RGB } from '../../colors/types.js';
-import type { StateEvents } from '../../state/types.js';
-export type ThemeParamsKey = 'accentTextColor' | 'backgroundColor' | 'buttonColor' | 'buttonTextColor' | 'destructiveTextColor' | 'headerBackgroundColor' | 'hintColor' | 'linkColor' | 'secondaryBackgroundColor' | 'sectionBackgroundColor' | 'sectionHeaderTextColor' | '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;
-}
-export type ThemeParamsState = ThemeParamsParsed;
-export type ThemeParamsEvents = StateEvents<ThemeParamsState>;
-export type ThemeParamsEventName = keyof ThemeParamsEvents;
-export type ThemeParamsEventListener<E extends ThemeParamsEventName> = ThemeParamsEvents[E];

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

@@ -1,90 +0,0 @@
-import type { ViewportEvents, ViewportProps } from './types.js';
-import type { RemoveListenerFn } from '../../bridge/events/types.js';
-import type { RequestSimpleOptions } from '../../bridge/request.js';
-import { EventEmitter } from '../../event-emitter/EventEmitter.js';
-type Emitter = EventEmitter<ViewportEvents>;
-/**
- * Contains information about current WebApp device viewport, its dimensions
- * and state.
- */
-export declare class Viewport {
-    private readonly ee;
-    private readonly state;
-    private readonly postEvent;
-    constructor(props: ViewportProps);
-    /**
-     * Request viewport information from the Telegram application and updates current Viewport
-     * instance.
-     * @param options - options to request fresh data.
-     */
-    sync(options?: RequestSimpleOptions<'web_app_request_viewport'>): 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.
-     */
-    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 bot 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.
-     */
-    get stableHeight(): number;
-    /**
-     * Starts listening to viewport changes and applies them.
-     * @returns Function to stop listening.
-     */
-    listen(): RemoveListenerFn;
-    /**
-     * Returns 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 viewport 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;
-    /**
-     * Returns true in case current viewport height is stable and is not going to
-     * change in the next moment.
-     */
-    get isStable(): boolean;
-    /**
-     * Adds new event listener.
-     */
-    on: Emitter['on'];
-    /**
-     * Removes event listener.
-     */
-    off: Emitter['off'];
-}
-export {};

package/dist/dts/components/viewport/isStableViewportPlatform.d.ts

@@ -1,7 +0,0 @@
-import type { Platform } from '../../types/platform.js';
-/**
- * Returns true if specified platform has stable viewport. Stable means not changing from time to
- * time.
- * @param platform - platform identifier.
- */
-export declare function isStableViewportPlatform(platform: Platform): boolean;

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

@@ -1,18 +0,0 @@
-import type { PostEvent } from '../../bridge/methods/postEvent.js';
-import type { StateEvents } from '../../state/types.js';
-export interface ViewportProps {
-    height: number;
-    width: number;
-    stableHeight: number;
-    isExpanded: boolean;
-    postEvent?: PostEvent;
-}
-export interface ViewportState {
-    height: number;
-    isExpanded: boolean;
-    stableHeight: number;
-    width: number;
-}
-export type ViewportEvents = StateEvents<ViewportState>;
-export type ViewportEventName = keyof ViewportEvents;
-export type ViewportEventListener<E extends ViewportEventName> = ViewportEvents[E];

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

@@ -1,5 +0,0 @@
-/**
- * Formats value to make it stay in bounds [0, +Inf).
- * @param value - value to format.
- */
-export declare function truncate(value: number): number;

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

@@ -1,16 +0,0 @@
-import type { MiniApp } from '../components/mini-app/MiniApp.js';
-import type { ThemeParams } from '../components/theme-params/ThemeParams.js';
-/**
- * Creates CSS variables connected with WebApp background and header colors based on
- * passed WebApp and ThemeParams instances.
- *
- * Created variables:
- * - `--tg-background-color`
- * - `--tg-header-color`
- *
- * Variables are being automatically updated in case, corresponding properties are updating.
- *
- * @param miniApp - MiniApp instance.
- * @param themeParams - ThemeParams instance.
- */
-export declare function bindMiniAppCSSVars(miniApp: MiniApp, themeParams: ThemeParams): void;

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

@@ -1,12 +0,0 @@
-import type { ThemeParams } from '../components/theme-params/ThemeParams.js';
-/**
- * Creates CSS variables connected with theme parameters. Created CSS variables names are
- * following the pattern "--tg-theme-{name}". {name} is a theme parameters key name converted
- * from snake to kebab case.
- *
- * Variables are being automatically updated in case, corresponding properties
- * updated in passed ThemeParams instance.
- *
- * @param themeParams - ThemeParams instance.
- */
-export declare function bindThemeCSSVars(themeParams: ThemeParams): void;

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

@@ -1,20 +0,0 @@
-import type { Viewport } from '../components/viewport/Viewport.js';
-/**
- * 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.
- */
-export declare function bindViewportCSSVars(viewport: Viewport): void;

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

@@ -1,4 +0,0 @@
-/**
- * Creates style html element which contains styles sent from the Telegram application.
- */
-export declare function catchCustomStyles(): void;

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

@@ -1,10 +0,0 @@
-import type { PostEvent } from '../../bridge/methods/postEvent.js';
-import { BackButton } from '../../components/back-button/BackButton.js';
-/**
- * Creates BackButton instance using last locally saved data also saving each state in
- * the storage.
- * @param isPageReload - was current page reloaded.
- * @param version - platform version.
- * @param postEvent - Bridge postEvent function
- */
-export declare function createBackButton(isPageReload: boolean, version: string, postEvent: PostEvent): BackButton;

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

@@ -1,9 +0,0 @@
-import type { PostEvent } from '../../bridge/methods/postEvent.js';
-import { ClosingBehavior } from '../../components/closing-behavior/ClosingBehavior.js';
-/**
- * Creates ClosingBehaviour instance using last locally saved data also saving each state in
- * the storage.
- * @param isPageReload - was current page reloaded.
- * @param postEvent - Bridge postEvent function
- */
-export declare function createClosingBehavior(isPageReload: boolean, postEvent: PostEvent): ClosingBehavior;

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

@@ -1,12 +0,0 @@
-import type { PostEvent } from '../../bridge/methods/postEvent.js';
-import type { RGB } from '../../colors/types.js';
-import { MainButton } from '../../components/main-button/MainButton.js';
-/**
- * Creates MainButton instance using last locally saved data also saving each state in
- * the storage.
- * @param isPageReload - was current page reloaded.
- * @param backgroundColor - background color.
- * @param textColor - text color.
- * @param postEvent - Bridge postEvent function
- */
-export declare function createMainButton(isPageReload: boolean, backgroundColor: RGB, textColor: RGB, postEvent: PostEvent): MainButton;

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

@@ -1,16 +0,0 @@
-import type { PostEvent } from '../../bridge/methods/postEvent.js';
-import type { RGB } from '../../colors/types.js';
-import { MiniApp } from '../../components/mini-app/MiniApp.js';
-import type { CreateRequestIdFunc } from '../../types/request-id.js';
-import type { Version } from '../../version/types.js';
-/**
- * Creates MiniApp 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 botInline - is Mini App launched in inline mode.
- * @param createRequestId - function which generates request identifiers.
- * @param postEvent - Bridge postEvent function
- */
-export declare function createMiniApp(isPageReload: boolean, backgroundColor: RGB, version: Version, botInline: boolean, createRequestId: CreateRequestIdFunc, postEvent: PostEvent): MiniApp;

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

@@ -1,10 +0,0 @@
-import type { PostEvent } from '../../bridge/methods/postEvent.js';
-import { SettingsButton } from '../../components/settings-button/SettingsButton.js';
-/**
- * Creates SettingsButton instance using last locally saved data also saving each state in
- * the storage.
- * @param isPageReload - was current page reloaded.
- * @param version - platform version.
- * @param postEvent - Bridge postEvent function
- */
-export declare function createSettingsButton(isPageReload: boolean, version: string, postEvent: PostEvent): SettingsButton;

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

@@ -1,7 +0,0 @@
-import { ThemeParams } from '../../components/theme-params/ThemeParams.js';
-import type { ThemeParamsParsed } from '../../components/theme-params/types.js';
-/**
- * Creates synced instance of ThemeParams.
- * @param params - theme parameters.
- */
-export declare function createThemeParams(params: ThemeParamsParsed): ThemeParams;

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

@@ -1,11 +0,0 @@
-import type { PostEvent } from '../../bridge/methods/postEvent.js';
-import { Viewport } from '../../components/viewport/Viewport.js';
-import type { Platform } from '../../types/platform.js';
-/**
- * Creates Viewport instance using its actual state from the Telegram application.
- * @param isPageReload - was page reloaded.
- * @param platform - platform identifier.
- * @param postEvent - Bridge postEvent function.
- * @param complete - is initialization complete.
- */
-export declare function createViewport(isPageReload: boolean, platform: Platform, postEvent: PostEvent, complete: boolean): Viewport | Promise<Viewport>;

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

@@ -1,12 +0,0 @@
-import type { MiniApp } from '../../components/mini-app/MiniApp.js';
-import type { ThemeParams } from '../../components/theme-params/ThemeParams.js';
-import type { Viewport } from '../../components/viewport/Viewport.js';
-import type { InitCSSVarsOption } from '../types.js';
-/**
- * Process initialization CSS vars option.
- * @param option - option value.
- * @param miniApp - MiniApp instance.
- * @param themeParams - ThemeParams instance.
- * @param viewportOrPromise - Viewport instance or promise resolving it.
- */
-export declare function processCSSVars(option: InitCSSVarsOption, miniApp: MiniApp, themeParams: ThemeParams, viewportOrPromise: Viewport | Promise<Viewport>): void;

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

@@ -1,9 +0,0 @@
-import type { InitOptions, InitResult } from './types.js';
-type ComputedInitResult<O> = O extends {
-    async: true;
-} | {
-    complete: true;
-} ? Promise<InitResult> : InitResult;
-export declare function init(): InitResult;
-export declare function init<O extends InitOptions>(options: O): ComputedInitResult<O>;
-export {};

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

@@ -1,85 +0,0 @@
-import type { PostEvent } from '../bridge/methods/postEvent.js';
-import type { BackButton } from '../components/back-button/BackButton.js';
-import type { ClosingBehavior } from '../components/closing-behavior/ClosingBehavior.js';
-import type { CloudStorage } from '../components/cloud-storage/CloudStorage.js';
-import type { HapticFeedback } from '../components/haptic-feedback/HapticFeedback.js';
-import type { InitData } from '../components/init-data/InitData.js';
-import type { Invoice } from '../components/invoice/Invoice.js';
-import type { MainButton } from '../components/main-button/MainButton.js';
-import type { MiniApp } from '../components/mini-app/MiniApp.js';
-import type { Popup } from '../components/popup/Popup.js';
-import type { QRScanner } from '../components/qr-scanner/QRScanner.js';
-import type { SettingsButton } from '../components/settings-button/SettingsButton.js';
-import type { ThemeParams } from '../components/theme-params/ThemeParams.js';
-import type { Utils } from '../components/utils/Utils.js';
-import type { Viewport } from '../components/viewport/Viewport.js';
-import type { CreateRequestIdFunc } from '../types/request-id.js';
-export interface InitResult {
-    backButton: BackButton;
-    closingBehavior: ClosingBehavior;
-    cloudStorage: CloudStorage;
-    createRequestId: CreateRequestIdFunc;
-    hapticFeedback: HapticFeedback;
-    initData?: InitData;
-    initDataRaw?: string;
-    invoice: Invoice;
-    mainButton: MainButton;
-    miniApp: MiniApp;
-    popup: Popup;
-    postEvent: PostEvent;
-    qrScanner: QRScanner;
-    settingsButton: SettingsButton;
-    themeParams: ThemeParams;
-    utils: Utils;
-    viewport: Viewport;
-}
-export interface InitCSSVarsSpecificOption {
-    /**
-     * Enables theme parameters CSS variables.
-     * @see bindThemeCSSVars
-     * @default false
-     */
-    themeParams?: boolean;
-    /**
-     * Enables viewport CSS variables.
-     * @see bindViewportCSSVars
-     * @default false
-     */
-    viewport?: boolean;
-    /**
-     * Enables mini app CSS variables.
-     * @see bindMiniAppCSSVars
-     * @default false
-     */
-    miniApp?: boolean;
-}
-export type InitCSSVarsOption = boolean | InitCSSVarsSpecificOption;
-export interface InitOptions {
-    /**
-     * @deprecated This option name was considered inappropriate. Use `complete` instead.
-     */
-    async?: boolean;
-    /**
-     * True if SDK should accept styles sent from the Telegram web application. This option is only
-     * used in web versions of Telegram.
-     * @default false
-     */
-    acceptCustomStyles?: boolean;
-    /**
-     * Should SDK create global CSS variables related to current Telegram application colors.
-     *
-     * Possible values:
-     * - `false` - no CSS variables will be created.
-     * - `true` - all CSS variables will be created.
-     * - object - applies specific CSS variables.
-     *
-     * @default false
-     */
-    cssVars?: InitCSSVarsOption;
-    /**
-     * True if initialization must be performed completely. This includes retrieving some components
-     * state from the Telegram application, and as a result, this makes initialization asynchronous.
-     * @default false
-     */
-    complete?: boolean;
-}

package/dist/dts/launch-params/launchParamsParser.d.ts

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

package/dist/dts/launch-params/retrieveLaunchData.d.ts

@@ -1,7 +0,0 @@
-import type { LaunchData } from './types.js';
-/**
- * Returns launch data information. Function ignores passed options in case, it was already
- * called. It caches the last returned value.
- * @deprecated Use `retrieveLaunchParams` and `isPageReload` functions separately where required.
- */
-export declare function retrieveLaunchData(): LaunchData;

package/dist/dts/navigation/HashNavigator/HashNavigator.d.ts

@@ -1,46 +0,0 @@
-import type { HashNavigatorEventsMap, HashNavigatorOptions } from './types.js';
-import { EventEmitter } from '../../event-emitter/EventEmitter.js';
-import { Navigator } from '../Navigator/Navigator.js';
-import type { NavigatorConEntry, PerformGoOptions, PerformPushOptions, PerformReplaceOptions } from '../Navigator/types.js';
-type HashNavigatorEventEmitter = EventEmitter<HashNavigatorEventsMap>;
-export declare class HashNavigator extends Navigator<Promise<void>> {
-    /**
-     * Creates navigator from current window location hash.
-     * @param options - options passed to constructor.
-     */
-    static fromLocation(options?: HashNavigatorOptions): HashNavigator;
-    private readonly ee;
-    private attached;
-    constructor(entries: NavigatorConEntry[], entriesCursor: number, options?: HashNavigatorOptions);
-    /**
-     * Handles window "popstate" event.
-     * @param state - event state.
-     */
-    private onPopState;
-    protected performGo(options: PerformGoOptions): Promise<void>;
-    protected performPush({ before, after }: PerformPushOptions): Promise<void>;
-    protected performReplace(options: PerformReplaceOptions): Promise<void>;
-    /**
-     * Synchronizes current navigator state with browser history.
-     */
-    private syncHistory;
-    private emitChanged;
-    /**
-     * Attaches current navigator to the browser history allowing navigator to manipulate it.
-     */
-    attach(): Promise<void>;
-    back: () => Promise<void>;
-    /**
-     * Detaches current navigator from the browser history.
-     */
-    detach(): void;
-    /**
-     * Adds new event listener.
-     */
-    on: HashNavigatorEventEmitter['on'];
-    /**
-     * Removes event listener.
-     */
-    off: HashNavigatorEventEmitter['off'];
-}
-export {};

package/dist/dts/navigation/HashNavigator/types.d.ts

@@ -1,33 +0,0 @@
-import type { HashNavigator } from './HashNavigator.js';
-import type { NavigationEntry, NavigatorOptions } from '../Navigator/types.js';
-export type HashNavigatorOptions = Omit<NavigatorOptions, 'loggerPrefix'>;
-interface ChangeEventPayload {
-    /**
-     * Navigator instance.
-     */
-    navigator: HashNavigator;
-    /**
-     * Previous navigation state.
-     */
-    from: NavigationEntry;
-    /**
-     * Current navigation state.
-     */
-    to: NavigationEntry;
-}
-export interface HashNavigatorEventsMap {
-    /**
-     * Being called whenever current history changes.
-     * @param event - generated event.
-     */
-    change: (event: ChangeEventPayload) => void;
-}
-/**
- * Navigator event name.
- */
-export type HashNavigatorEventName = keyof HashNavigatorEventsMap;
-/**
- * Navigator event listener.
- */
-export type HashNavigatorEventListener<E extends HashNavigatorEventName> = HashNavigatorEventsMap[E];
-export {};