@tma.js/sdk 1.4.3 → 1.4.6

package/README.md

@@ -6,7 +6,7 @@
 
 [sdk-code-link]: https://github.com/Telegram-Mini-Apps/tma.js/tree/master/packages/sdk
 
-[sdk-docs-link]: https://docs.telegram-mini-apps.com/packages/typescript/tma-js-sdk/about
+[sdk-docs-link]: https://docs.telegram-mini-apps.com/packages/tma-js-sdk
 
 [sdk-npm-link]: https://npmjs.com/package/@tma.js/sdk
 
@@ -27,5 +27,5 @@ Mini Apps. It consists of several individual components, each responsible for a
 the Telegram Mini Apps ecosystem.
 
 Before you begin using the SDK, we highly recommend familiarizing yourself with the Telegram Mini
-Apps [documentation](https://docs.telegram-mini-apps.com/platform/about-platform)
+Apps [documentation](https://docs.telegram-mini-apps.com/platform/about)
 to grasp the fundamental concepts of the platform.

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

@@ -3,69 +3,69 @@ import type { IsNever, Not } from '../../types/index.js';
 import type { ClipboardTextReceivedPayload, CustomMethodInvokedPayload, InvoiceClosedPayload, PhoneRequestedPayload, PopupClosedPayload, QrTextReceivedPayload, ThemeChangedPayload, ViewportChangedPayload, WriteAccessRequestedPayload } from './parsers/index.js';
 /**
  * Map where key is known event name, and value is its listener.
- * @see https://docs.telegram-mini-apps.com/platform/apps-communication/events
+ * @see https://docs.telegram-mini-apps.com/platform/events
  */
 export interface MiniAppsEvents {
     /**
      * User clicked back button.
      * @since v6.1
-     * @see https://docs.telegram-mini-apps.com/platform/apps-communication/events#back-button-pressed
+     * @see https://docs.telegram-mini-apps.com/platform/events#back-button-pressed
      */
     back_button_pressed: () => void;
     /**
      * Telegram application attempted to extract text from clipboard.
      * @param payload - event payload.
      * @since v6.4
-     * @see https://docs.telegram-mini-apps.com/platform/apps-communication/events#clipboard-text-received
+     * @see https://docs.telegram-mini-apps.com/platform/events#clipboard-text-received
      */
     clipboard_text_received: (payload: ClipboardTextReceivedPayload) => void;
     /**
      * Custom method invocation completed.
      * @param payload - event payload.
      * @since v6.9
-     * @see https://docs.telegram-mini-apps.com/platform/apps-communication/events#custom-method-invoked
+     * @see https://docs.telegram-mini-apps.com/platform/events#custom-method-invoked
      */
     custom_method_invoked: (payload: CustomMethodInvokedPayload) => void;
     /**
      * An invoice was closed.
      * @param payload - invoice close information.
-     * @see https://docs.telegram-mini-apps.com/platform/apps-communication/events#invoice-closed
+     * @see https://docs.telegram-mini-apps.com/platform/events#invoice-closed
      */
     invoice_closed: (payload: InvoiceClosedPayload) => void;
     /**
      * User clicked the Main Button.
-     * @see https://docs.telegram-mini-apps.com/platform/apps-communication/events#main-button-pressed
+     * @see https://docs.telegram-mini-apps.com/platform/events#main-button-pressed
      */
     main_button_pressed: () => void;
     /**
      * Application received phone access request status.
      * @param payload - event payload.
      * @since v6.9
-     * @see https://docs.telegram-mini-apps.com/platform/apps-communication/events#phone-requested
+     * @see https://docs.telegram-mini-apps.com/platform/events#phone-requested
      */
     phone_requested: (payload: PhoneRequestedPayload) => void;
     /**
      * Popup was closed.
      * @param payload - event payload.
-     * @see https://docs.telegram-mini-apps.com/platform/apps-communication/events#popup-closed
+     * @see https://docs.telegram-mini-apps.com/platform/events#popup-closed
      */
     popup_closed: (payload: PopupClosedPayload) => void;
     /**
      * Parent iframe requested current iframe reload.
-     * @see https://docs.telegram-mini-apps.com/platform/apps-communication/events#reload-iframe
+     * @see https://docs.telegram-mini-apps.com/platform/events#reload-iframe
      */
     reload_iframe: () => void;
     /**
      * The QR scanner scanned some QR and extracted its content.
      * @param payload - event payload.
      * @since v6.4
-     * @see https://docs.telegram-mini-apps.com/platform/apps-communication/events#qr-text-received
+     * @see https://docs.telegram-mini-apps.com/platform/events#qr-text-received
      */
     qr_text_received: (payload: QrTextReceivedPayload) => void;
     /**
      * QR scanner was closed.
      * @since v6.4
-     * @see https://docs.telegram-mini-apps.com/platform/apps-communication/events#scan-qr-popup-closed
+     * @see https://docs.telegram-mini-apps.com/platform/events#scan-qr-popup-closed
      */
     scan_qr_popup_closed: () => void;
     /**
@@ -73,34 +73,34 @@ export interface MiniAppsEvents {
      * `<style/>` tag html content, a developer could use. The stylesheet described in the payload
      * will help the developer to stylize the app scrollbar (but he is still able to do it himself).
      * @param html - `style` tag inner HTML.
-     * @see https://docs.telegram-mini-apps.com/platform/apps-communication/events#set-custom-style
+     * @see https://docs.telegram-mini-apps.com/platform/events#set-custom-style
      */
     set_custom_style: (html: string) => void;
     /**
      * Occurs when the Settings Button was pressed.
      * @since v6.1
-     * @see https://docs.telegram-mini-apps.com/platform/apps-communication/events#settings-button-pressed
+     * @see https://docs.telegram-mini-apps.com/platform/events#settings-button-pressed
      */
     settings_button_pressed: () => void;
     /**
      * Occurs whenever theme settings are changed in the user's Telegram app
      * (including switching to night mode).
      * @param payload - event payload.
-     * @see https://docs.telegram-mini-apps.com/platform/apps-communication/events#theme-changed
+     * @see https://docs.telegram-mini-apps.com/platform/events#theme-changed
      */
     theme_changed: (payload: ThemeChangedPayload) => void;
     /**
      * Occurs whenever the viewport has been changed. For example, when the user started
      * dragging the application or called the expansion method.
      * @param payload - event payload.
-     * @see https://docs.telegram-mini-apps.com/platform/apps-communication/events#viewport-changed
+     * @see https://docs.telegram-mini-apps.com/platform/events#viewport-changed
      */
     viewport_changed: (payload: ViewportChangedPayload) => void;
     /**
      * Application received write access request status.
      * @param payload - event payload.
      * @since v6.9
-     * @see https://docs.telegram-mini-apps.com/platform/apps-communication/events#write-access-requested
+     * @see https://docs.telegram-mini-apps.com/platform/events#write-access-requested
      */
     write_access_requested: (payload: WriteAccessRequestedPayload) => void;
 }

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

@@ -17,13 +17,13 @@ interface CreateParams<Params = undefined, VersionedParam extends UnionKeys<Para
 }
 /**
  * Describes list of events and their parameters that could be posted by Bridge.
- * @see https://docs.telegram-mini-apps.com/platform/apps-communication/methods
+ * @see https://docs.telegram-mini-apps.com/platform/methods
  */
 export interface MiniAppsMethods {
     /**
      * Notifies parent iframe about the current frame is ready. This method is only used in the Web
      * version of Telegram. As a result, Mini App will receive `set_custom_style` event.
-     * @see https://docs.telegram-mini-apps.com/platform/apps-communication/methods#iframe-ready
+     * @see https://docs.telegram-mini-apps.com/platform/methods#iframe-ready
      */
     iframe_ready: CreateParams<{
         /**
@@ -33,18 +33,18 @@ export interface MiniAppsMethods {
     } | undefined>;
     /**
      * Notifies parent iframe about the current iframe is going to reload.
-     * @see https://docs.telegram-mini-apps.com/platform/apps-communication/methods#iframe-will-reload
+     * @see https://docs.telegram-mini-apps.com/platform/methods#iframe-will-reload
      */
     iframe_will_reload: CreateParams;
     /**
      * Closes Mini App.
-     * @see https://docs.telegram-mini-apps.com/platform/apps-communication/methods#web-app-close
+     * @see https://docs.telegram-mini-apps.com/platform/methods#web-app-close
      */
     web_app_close: CreateParams;
     /**
      * Closes a QR scanner. The Telegram application creates `scan_qr_popup_closed` event.
      * @since v6.4
-     * @see https://docs.telegram-mini-apps.com/platform/apps-communication/methods#web-app-close-scan-qr-popup
+     * @see https://docs.telegram-mini-apps.com/platform/methods#web-app-close-scan-qr-popup
      */
     web_app_close_scan_qr_popup: CreateParams;
     /**
@@ -54,7 +54,7 @@ export interface MiniAppsMethods {
      * To get more information, take a look at `web_app_data` field in the
      * class [Message](https://core.telegram.org/bots/api#message).
      *
-     * @see https://docs.telegram-mini-apps.com/platform/apps-communication/methods#web-app-data-send
+     * @see https://docs.telegram-mini-apps.com/platform/methods#web-app-data-send
      */
     web_app_data_send: CreateParams<{
         /**
@@ -64,20 +64,20 @@ export interface MiniAppsMethods {
     }>;
     /**
      * Expands the Mini App.
-     * @see https://docs.telegram-mini-apps.com/platform/apps-communication/methods#web-app-expand
+     * @see https://docs.telegram-mini-apps.com/platform/methods#web-app-expand
      */
     web_app_expand: CreateParams;
     /**
      * Invokes custom method.
      * @since v6.9
-     * @see https://docs.telegram-mini-apps.com/platform/apps-communication/methods#web-app-invoke-custom-method
+     * @see https://docs.telegram-mini-apps.com/platform/methods#web-app-invoke-custom-method
      */
     web_app_invoke_custom_method: CreateParams<AnyInvokeCustomMethodParams>;
     /**
      * Opens an invoice by its specified slug. More information about invoices in
      * this [documentation](https://core.telegram.org/bots/payments).
      * @since v6.1
-     * @see https://docs.telegram-mini-apps.com/platform/apps-communication/methods#web-app-open-invoice
+     * @see https://docs.telegram-mini-apps.com/platform/methods#web-app-open-invoice
      */
     web_app_open_invoice: CreateParams<{
         /**
@@ -87,7 +87,7 @@ export interface MiniAppsMethods {
     }>;
     /**
      * Opens link in the default browser. Mini App will not be closed.
-     * @see https://docs.telegram-mini-apps.com/platform/apps-communication/methods#web-app-open-link
+     * @see https://docs.telegram-mini-apps.com/platform/methods#web-app-open-link
      */
     web_app_open_link: CreateParams<{
         /**
@@ -104,7 +104,7 @@ export interface MiniAppsMethods {
     /**
      * Opens a new popup. When user closes the popup, Telegram creates the `popup_closed` event.
      * @since v6.2
-     * @see https://docs.telegram-mini-apps.com/platform/apps-communication/methods#web-app-open-popup
+     * @see https://docs.telegram-mini-apps.com/platform/methods#web-app-open-popup
      */
     web_app_open_popup: CreateParams<PopupParams>;
     /**
@@ -112,7 +112,7 @@ export interface MiniAppsMethods {
      * the `scan_qr_popup_closed` event. When the scanner reads QR, Telegram creates the
      * `qr_text_received` event.
      * @since v6.4
-     * @see https://docs.telegram-mini-apps.com/platform/apps-communication/methods#web-app-open-scan-qr-popup
+     * @see https://docs.telegram-mini-apps.com/platform/methods#web-app-open-scan-qr-popup
      */
     web_app_open_scan_qr_popup: CreateParams<{
         /**
@@ -124,7 +124,7 @@ export interface MiniAppsMethods {
      * Opens the Telegram link by its pathname and query parameters. The link will be opened in the
      * Telegram app, Mini App will be closed.
      * @since v6.1
-     * @see https://docs.telegram-mini-apps.com/platform/apps-communication/methods#web-app-open-tg-link
+     * @see https://docs.telegram-mini-apps.com/platform/methods#web-app-open-tg-link
      */
     web_app_open_tg_link: CreateParams<{
         /**
@@ -137,7 +137,7 @@ export interface MiniAppsMethods {
      * Reads text from the clipboard. The method accepts a request identifier which is used to
      * appropriately retrieve the method execution result from the `clipboard_text_received` event.
      * @since v6.4
-     * @see https://docs.telegram-mini-apps.com/platform/apps-communication/methods#web-app-read-text-from-clipboard
+     * @see https://docs.telegram-mini-apps.com/platform/methods#web-app-read-text-from-clipboard
      */
     web_app_read_text_from_clipboard: CreateParams<{
         /**
@@ -149,36 +149,36 @@ export interface MiniAppsMethods {
     /**
      * Notifies Telegram about current application is ready to be shown. This method will make
      * Telegram to remove application loader and display Mini App.
-     * @see https://docs.telegram-mini-apps.com/platform/apps-communication/methods#web-app-ready
+     * @see https://docs.telegram-mini-apps.com/platform/methods#web-app-ready
      */
     web_app_ready: CreateParams;
     /**
      * Requests access to current user's phone.
      * @since v6.9
-     * @see https://docs.telegram-mini-apps.com/platform/apps-communication/methods#web-app-request-phone
+     * @see https://docs.telegram-mini-apps.com/platform/methods#web-app-request-phone
      */
     web_app_request_phone: CreateParams;
     /**
      * Requests current theme from Telegram. As a result, Telegram will create `theme_changed` event.
-     * @see https://docs.telegram-mini-apps.com/platform/apps-communication/methods#web-app-request-theme
+     * @see https://docs.telegram-mini-apps.com/platform/methods#web-app-request-theme
      */
     web_app_request_theme: CreateParams;
     /**
      * Requests current viewport information from Telegram. As a result, Telegram will create
      * `viewport_changed` event.
-     * @see https://docs.telegram-mini-apps.com/platform/apps-communication/methods#web-app-request-viewport
+     * @see https://docs.telegram-mini-apps.com/platform/methods#web-app-request-viewport
      */
     web_app_request_viewport: CreateParams;
     /**
      * Requests write message access to current user.
      * @since v6.9
-     * @see https://docs.telegram-mini-apps.com/platform/apps-communication/methods#web-app-rqeuest-write-access
+     * @see https://docs.telegram-mini-apps.com/platform/methods#web-app-rqeuest-write-access
      */
     web_app_request_write_access: CreateParams;
     /**
      * Updates the Mini App background color.
      * @since v6.1
-     * @see https://docs.telegram-mini-apps.com/platform/apps-communication/methods#web-app-set-background-color
+     * @see https://docs.telegram-mini-apps.com/platform/methods#web-app-set-background-color
      */
     web_app_set_background_color: CreateParams<{
         /**
@@ -189,7 +189,7 @@ export interface MiniAppsMethods {
     /**
      * Updates the Mini App header color.
      * @since v6.1
-     * @see https://docs.telegram-mini-apps.com/platform/apps-communication/methods#web-app-set-header-color
+     * @see https://docs.telegram-mini-apps.com/platform/methods#web-app-set-header-color
      */
     web_app_set_header_color: CreateParams<{
         /**
@@ -206,7 +206,7 @@ export interface MiniAppsMethods {
     /**
      * Updates the Back Button settings.
      * @since v6.1
-     * @see https://docs.telegram-mini-apps.com/platform/apps-communication/methods#web-app-setup-back-button
+     * @see https://docs.telegram-mini-apps.com/platform/methods#web-app-setup-back-button
      */
     web_app_setup_back_button: CreateParams<{
         /**
@@ -216,7 +216,7 @@ export interface MiniAppsMethods {
     }>;
     /**
      * Updates current closing behavior.
-     * @see https://docs.telegram-mini-apps.com/platform/apps-communication/methods#web-app-setup-closing-behavior
+     * @see https://docs.telegram-mini-apps.com/platform/methods#web-app-setup-closing-behavior
      */
     web_app_setup_closing_behavior: CreateParams<{
         /**
@@ -226,7 +226,7 @@ export interface MiniAppsMethods {
     }>;
     /**
      * Updates the Main Button settings.
-     * @see https://docs.telegram-mini-apps.com/platform/apps-communication/methods#web-app-setup-main-button
+     * @see https://docs.telegram-mini-apps.com/platform/methods#web-app-setup-main-button
      */
     web_app_setup_main_button: CreateParams<{
         /**
@@ -258,7 +258,7 @@ export interface MiniAppsMethods {
     /**
      * Updates current state of Settings Button.
      * @since v6.10
-     * @see https://docs.telegram-mini-apps.com/platform/apps-communication/methods#web-app-setup-settings-button
+     * @see https://docs.telegram-mini-apps.com/platform/methods#web-app-setup-settings-button
      */
     web_app_setup_settings_button: CreateParams<{
         /**
@@ -272,7 +272,7 @@ export interface MiniAppsMethods {
      * the user to choose a specific chat, then opens that chat and inserts the bot's username and
      * the specified inline query in the input field.
      * @since v6.7
-     * @see https://docs.telegram-mini-apps.com/platform/apps-communication/methods#web-app-switch-inline-query
+     * @see https://docs.telegram-mini-apps.com/platform/methods#web-app-switch-inline-query
      */
     web_app_switch_inline_query: CreateParams<{
         /**
@@ -288,7 +288,7 @@ export interface MiniAppsMethods {
     /**
      * Generates haptic feedback event.
      * @since v6.1
-     * @see https://docs.telegram-mini-apps.com/platform/apps-communication/methods#web-app-trigger-haptic-feedback
+     * @see https://docs.telegram-mini-apps.com/platform/methods#web-app-trigger-haptic-feedback
      */
     web_app_trigger_haptic_feedback: CreateParams<AnyHapticFeedbackParams>;
 }

package/dist/dts/bridge/methods/popup.d.ts

@@ -17,7 +17,7 @@ export interface PopupParams {
 }
 /**
  * Describes the native popup button.
- * @see https://docs.telegram-mini-apps.com/platform/apps-communication/methods#popupbutton
+ * @see https://docs.telegram-mini-apps.com/platform/methods#popupbutton
  */
 export type PopupButton = {
     /**

package/dist/dts/{init/css → css}/bindMiniAppCSSVars.d.ts

@@ -1,5 +1,5 @@
-import type { MiniApp } from '../../mini-app/index.js';
-import type { ThemeParams } from '../../theme-params/index.js';
+import type { MiniApp } from '../mini-app/index.js';
+import type { ThemeParams } from '../theme-params/index.js';
 /**
  * Creates CSS variables connected with WebApp background and header colors based on
  * passed WebApp and ThemeParams instances.

package/dist/dts/{init/css → css}/bindThemeCSSVars.d.ts

@@ -1,4 +1,4 @@
-import type { ThemeParams } from '../../theme-params/index.js';
+import type { ThemeParams } from '../theme-params/index.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

package/dist/dts/{init/css → css}/bindViewportCSSVars.d.ts

@@ -1,4 +1,4 @@
-import type { Viewport } from '../../viewport/index.js';
+import type { Viewport } from '../viewport/index.js';
 /**
  * Accepts Viewport instance and sets CSS variables connected with viewport
  * sizes.

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

@@ -0,0 +1,4 @@
+export * from './bindMiniAppCSSVars.js';
+export * from './bindThemeCSSVars.js';
+export * from './bindViewportCSSVars.js';
+export * from './setCSSVar.js';

package/dist/dts/index.d.ts

@@ -4,6 +4,7 @@ export { classNames, mergeClassNames } from './classnames/index.js';
 export { ClosingBehavior, type ClosingBehaviorEventListener, type ClosingBehaviorEventName, type ClosingBehaviorEvents, } from './closing-behavior/index.js';
 export { CloudStorage } from './cloud-storage/index.js';
 export { isRGB, isRGBShort, isColorDark, toRGB, type RGB, type RGBShort, } from './colors/index.js';
+export { setCSSVar, bindMiniAppCSSVars, bindThemeCSSVars, bindViewportCSSVars, } from './css/index.js';
 export { HapticFeedback } from './haptic-feedback/index.js';
 export { init, type InitOptions, type InitResult, } from './init/index.js';
 export { chatParser, InitData, initDataParser, parseInitData, userParser, type Chat, type ChatType, type InitDataParsed, type User, } from './init-data/index.js';

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

@@ -3,7 +3,7 @@
  */
 export type ChatType = 'sender' | 'private' | 'group' | 'supergroup' | 'channel' | string;
 /**
- * Describes Telegram Mini Apps [User](https://docs.telegram-mini-apps.com/platform/launch-parameters/init-data#user) type.
+ * Describes Telegram Mini Apps [User](https://docs.telegram-mini-apps.com/platform/init-data#user) type.
  */
 export interface User {
     /**
@@ -51,7 +51,7 @@ export interface User {
     username?: string;
 }
 /**
- * Describes Telegram Mini Apps [Chat](https://docs.telegram-mini-apps.com/platform/launch-parameters/init-data#chat) type.
+ * Describes Telegram Mini Apps [Chat](https://docs.telegram-mini-apps.com/platform/init-data#chat) type.
  */
 export interface Chat {
     /**
@@ -77,7 +77,7 @@ export interface Chat {
     username?: string;
 }
 /**
- * Describes Telegram Mini Apps [InitData](https://docs.telegram-mini-apps.com/platform/launch-parameters/init-data#parameters-list)
+ * Describes Telegram Mini Apps [InitData](https://docs.telegram-mini-apps.com/platform/init-data#parameters-list)
  * type.
  */
 export interface InitDataParsed {

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

@@ -3,7 +3,7 @@ import type { ThemeParamsParsed } from '../theme-params/index.js';
 import type { Platform } from '../types/index.js';
 /**
  * Telegram Mini Apps launch parameters.
- * @see https://docs.telegram-mini-apps.com/platform/launch-parameters/common-information
+ * @see https://docs.telegram-mini-apps.com/platform/launch-parameters
  */
 export interface LaunchParams {
     /**

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

@@ -2,7 +2,7 @@ import type { RGB } from '../colors/index.js';
 import type { StateEvents } from '../state/index.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/functionality/theming).
+ * Application [theme parameters](https://docs.telegram-mini-apps.com/platform/theming).
  * Defines palette used by the Telegram application.
  */
 export interface ThemeParamsParsed {