@tma.js/bridge 1.4.0 → 2.0.0

package/src/methods/haptic.ts

@@ -1,52 +0,0 @@
-/**
- * Generic type which creates new types of haptic feedback.
- */
-type CreateHapticFeedbackParams<T extends string, P> = { type: T } & P;
-
-/**
- * Style of impact occurred haptic event.
- * - `light`, indicates a collision between small or lightweight UI objects,
- * - `medium`, indicates a collision between medium-sized or medium-weight UI objects,
- * - `heavy`, indicates a collision between large or heavyweight UI objects,
- * - `rigid`, indicates a collision between hard or inflexible UI objects,
- * - `soft`, indicates a collision between soft or flexible UI objects.
- */
-export type ImpactHapticFeedbackStyle =
-  | 'light'
-  | 'medium'
-  | 'heavy'
-  | 'rigid'
-  | 'soft';
-
-/**
- * Type of notification occurred type event.
- * - `error`, indicates that a task or action has failed,
- * - `success`, indicates that a task or action has completed successfully,
- * - `warning`, indicates that a task or action produced a warning.
- */
-export type NotificationHapticFeedbackType = 'error' | 'success' | 'warning';
-
-/**
- * `impactOccurred` haptic feedback.
- */
-export type ImpactHapticFeedbackParams = CreateHapticFeedbackParams<'impact', {
-  impact_style: ImpactHapticFeedbackStyle;
-}>;
-
-/**
- * `notificationOccurred` haptic feedback.
- */
-export type NotificationHapticFeedbackParams = CreateHapticFeedbackParams<'notification', {
-  notification_type: NotificationHapticFeedbackType;
-}>;
-
-/**
- * `selectionChanged` haptic feedback.
- */
-// eslint-disable-next-line @typescript-eslint/ban-types
-export type SelectionHapticFeedbackParams = CreateHapticFeedbackParams<'selection_change', {}>;
-
-export type AnyHapticFeedbackParams =
-  | ImpactHapticFeedbackParams
-  | NotificationHapticFeedbackParams
-  | SelectionHapticFeedbackParams;

package/src/methods/index.ts

@@ -1,6 +0,0 @@
-export * from './createPostEvent.js';
-export * from './haptic.js';
-export * from './invoke-custom-method.js';
-export * from './methods.js';
-export * from './popup.js';
-export * from './postEvent.js';

package/src/methods/invoke-custom-method.ts

@@ -1,25 +0,0 @@
-import type { RequestId } from '../shared.js';
-
-interface CreateInvokeCustomMethodParams<M extends string, Params extends object> {
-  /**
-   * Unique request identifier.
-   */
-  req_id: RequestId;
-
-  /**
-   * Method name.
-   */
-  method: M;
-
-  /**
-   * Method specific parameters.
-   */
-  params: Params;
-}
-
-export type AnyInvokeCustomMethodParams =
-  | CreateInvokeCustomMethodParams<'deleteStorageValues', { keys: string | string[] }>
-  | CreateInvokeCustomMethodParams<'getStorageValues', { keys: string | string[] }>
-  | CreateInvokeCustomMethodParams<'getStorageKeys', {}>
-  | CreateInvokeCustomMethodParams<'saveStorageValue', { key: string, value: string }>
-  | CreateInvokeCustomMethodParams<string, any>;

package/src/methods/methods.ts

@@ -1,373 +0,0 @@
-import type { RGB } from '@tma.js/colors';
-import type { IsNever, Not, UnionKeys } from '@tma.js/util-types';
-
-import type { PopupParams } from './popup.js';
-import type { AnyHapticFeedbackParams } from './haptic.js';
-import type { RequestId } from '../shared.js';
-import type { AnyInvokeCustomMethodParams } from './invoke-custom-method.js';
-
-/**
- * Color key which could be used to update header color.
- */
-export type HeaderColorKey = 'bg_color' | 'secondary_bg_color';
-
-/**
- * Chat type which could be used when calling `web_app_switch_inline_query` method.
- */
-export type SwitchInlineQueryChatType = 'users' | 'bots' | 'groups' | 'channels';
-
-interface CreateParams<Params = undefined, VersionedParam extends UnionKeys<Params> = never> {
-  params: Params;
-  versionedParams: VersionedParam;
-}
-
-/**
- * Describes list of events and their parameters that could be posted by Bridge.
- * @see https://docs.telegram-mini-apps.com/apps-communication/methods
- */
-export interface Methods {
-  /**
-   * 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/apps-communication/methods#iframe-ready
-   */
-  iframe_ready: CreateParams<{
-    /**
-     * True, if current Mini App supports native reloading.
-     */
-    reload_supported?: boolean;
-  } | undefined>;
-
-  /**
-   * Notifies parent iframe about the current iframe is going to reload.
-   * @see https://docs.telegram-mini-apps.com/apps-communication/methods#iframe-will-reload
-   */
-  iframe_will_reload: CreateParams;
-
-  /**
-   * Closes Mini App.
-   * @see https://docs.telegram-mini-apps.com/apps-communication/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/apps-communication/methods#web-app-close-scan-qr-popup
-   */
-  web_app_close_scan_qr_popup: CreateParams;
-
-  /**
-   * Sends data to the bot. When this method is called, a service message is sent to the bot
-   * containing the data of the length up to 4096 bytes. Then, Mini App will be closed.
-   *
-   * 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/apps-communication/methods#web-app-data-send
-   */
-  web_app_data_send: CreateParams<{
-    /**
-     * Data to send to a bot. Should not have size of more than 4096 bytes.
-     */
-    data: string;
-  }>;
-
-  /**
-   * Expands the Mini App.
-   * @see https://docs.telegram-mini-apps.com/apps-communication/methods#web-app-expand
-   */
-  web_app_expand: CreateParams;
-
-  // TODO: 'getRequestedContact'. https://telegram.org/js/telegram-web-app.js
-  /**
-   * Invokes custom method.
-   * @since v6.9
-   * @see https://docs.telegram-mini-apps.com/apps-communication/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/apps-communication/methods#web-app-open-invoice
-   */
-  web_app_open_invoice: CreateParams<{
-    /**
-     * Invoice unique identifier.
-     */
-    slug: string;
-  }>;
-
-  /**
-   * Opens link in the default browser. Mini App will not be closed.
-   * @see https://docs.telegram-mini-apps.com/apps-communication/methods#web-app-open-link
-   */
-  web_app_open_link: CreateParams<{
-    /**
-     * URL to be opened by Telegram application. Should be a full path with `https` protocol.
-     */
-    url: string;
-
-    /**
-     * Link will be opened in Instant View mode if possible.
-     * @since v6.4
-     * @see https://instantview.telegram.org/
-     */
-    try_instant_view?: boolean;
-  }, 'try_instant_view'>;
-
-  /**
-   * 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/apps-communication/methods#web-app-open-popup
-   */
-  web_app_open_popup: CreateParams<PopupParams>;
-
-  /**
-   * Opens a QR scanner. When the scanner was closed, the Telegram application creates
-   * 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/apps-communication/methods#web-app-open-scan-qr-popup
-   */
-  web_app_open_scan_qr_popup: CreateParams<{
-    /**
-     * Text to be displayed in the QR scanner.
-     */
-    text?: string;
-  }>;
-
-  /**
-   * 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/apps-communication/methods#web-app-open-tg-link
-   */
-  web_app_open_tg_link: CreateParams<{
-    /**
-     * Should be a value taken from the link of this format: `https://t.me/{path_full}`. Can
-     * additionally contain query parameters.
-     */
-    path_full: string;
-  }>;
-
-  /**
-   * 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/apps-communication/methods#web-app-read-text-from-clipboard
-   */
-  web_app_read_text_from_clipboard: CreateParams<{
-    /**
-     * Unique request identifier. Should be any unique string to handle the generated event
-     * appropriately.
-     */
-    req_id: RequestId;
-  }>;
-
-  /**
-   * 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/apps-communication/methods#web-app-ready
-   */
-  web_app_ready: CreateParams;
-
-  // TODO: Check if it is right. It probably requests other user phone.
-  /**
-   * Requests access to current user's phone.
-   * @since v6.9
-   * @see https://docs.telegram-mini-apps.com/apps-communication/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/apps-communication/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/apps-communication/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/apps-communication/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/apps-communication/methods#web-app-set-background-color
-   */
-  web_app_set_background_color: CreateParams<{
-    /**
-     * The Mini App background color in `#RRGGBB` format.
-     */
-    color: RGB;
-  }>;
-
-  /**
-   * Updates the Mini App header color.
-   * @since v6.1
-   * @see https://docs.telegram-mini-apps.com/apps-communication/methods#web-app-set-header-color
-   */
-  web_app_set_header_color: CreateParams<
-    | {
-    /**
-     * The Mini App header color key.
-     */
-    color_key: HeaderColorKey
-  }
-    | {
-    /**
-     * Color in RGB format.
-     * @since v6.9
-     */
-    color: RGB;
-  }, 'color'>;
-
-  /**
-   * Updates the Back Button settings.
-   * @since v6.1
-   * @see https://docs.telegram-mini-apps.com/apps-communication/methods#web-app-setup-back-button
-   */
-  web_app_setup_back_button: CreateParams<{
-    /**
-     * Should the Back Button be visible.
-     */
-    is_visible: boolean;
-  }>;
-
-  /**
-   * Updates current closing behavior.
-   * @see https://docs.telegram-mini-apps.com/apps-communication/methods#web-app-setup-closing-behavior
-   */
-  web_app_setup_closing_behavior: CreateParams<{
-    /**
-     * Will user be prompted in case, an application is going to be closed.
-     */
-    need_confirmation: boolean;
-  }>;
-
-  /**
-   * Updates the Main Button settings.
-   * @see https://docs.telegram-mini-apps.com/apps-communication/methods#web-app-setup-main-button
-   */
-  web_app_setup_main_button: CreateParams<{
-    /**
-     * Should the Main Button be displayed.
-     */
-    is_visible?: boolean;
-    /**
-     * Should the Main Button be enabled.
-     */
-    is_active?: boolean;
-    /**
-     * Should loader inside the Main Button be displayed. Use this property in case, some
-     * operation takes time. This loader will make user notified about it.
-     */
-    is_progress_visible?: boolean;
-    /**
-     * Text inside the Main Button.
-     */
-    text?: string;
-    /**
-     * The Main Button background color in `#RRGGBB` format.
-     */
-    color?: string;
-    /**
-     * The Main Button text color in `#RRGGBB` format.
-     */
-    text_color?: string;
-  }>;
-
-  /**
-   * Updates current state of Settings Button.
-   * @since v6.10
-   * @see https://docs.telegram-mini-apps.com/apps-communication/methods#web-app-setup-settings-button
-   */
-  web_app_setup_settings_button: CreateParams<{
-    /**
-     * Should the Settings Button be displayed.
-     */
-    is_visible: boolean;
-  }>;
-
-  /**
-   * Inserts the bot's username and the specified inline query in the current chat's input field.
-   * Query may be empty, in which case only the bot's username will be inserted. The client prompts
-   * 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/apps-communication/methods#web-app-switch-inline-query
-   */
-  web_app_switch_inline_query: CreateParams<{
-    /**
-     * Text which should be inserted in the input after the current bot name. Max length is
-     * 256 symbols.
-     */
-    query: string;
-    /**
-     * List of chat types which could be chosen to send the message. Could be empty list.
-     */
-    chat_types: SwitchInlineQueryChatType[];
-  }>;
-
-  /**
-   * Generates haptic feedback event.
-   * @since v6.1
-   * @see https://docs.telegram-mini-apps.com/apps-communication/methods#web-app-trigger-haptic-feedback
-   */
-  web_app_trigger_haptic_feedback: CreateParams<AnyHapticFeedbackParams>;
-}
-
-/**
- * Any Telegram Mini Apps known method name.
- */
-export type MethodName = keyof Methods;
-
-/**
- * Returns parameters for specified post-available event.
- */
-export type MethodParams<M extends MethodName> = Methods[M]['params'];
-
-/**
- * True if specified method accepts parameters.
- */
-export type MethodAcceptParams<M extends MethodName> =
-  Not<IsNever<Exclude<MethodParams<M>, undefined>>>;
-
-/**
- * Any post-available event name which does not require arguments.
- */
-export type EmptyMethodName = {
-  [M in MethodName]: undefined extends MethodParams<M> ? M : never;
-}[MethodName];
-
-/**
- * Any post-available event name which require arguments.
- */
-export type NonEmptyMethodName = {
-  [M in MethodName]: MethodAcceptParams<M> extends true ? M : never;
-}[MethodName];
-
-/**
- * Method names which have versioned params.
- */
-export type MethodWithVersionedParams = {
-  [M in MethodName]: IsNever<Methods[M]['versionedParams']> extends true ? never : M;
-}[MethodName];
-
-/**
- * Method parameters which appear only in the specific Telegram Mini Apps version.
- */
-export type MethodVersionedParams<M extends MethodWithVersionedParams> =
-  Methods[M]['versionedParams'];

package/src/methods/popup.ts

@@ -1,53 +0,0 @@
-/**
- * Describes the native popup.
- */
-export interface PopupParams {
-  /**
-   * The text to be displayed in the popup title, 0-64 characters.
-   */
-  title: string;
-
-  /**
-   * The message to be displayed in the body of the popup, 1-256 characters.
-   */
-  message: string;
-
-  /**
-   * List of buttons to be displayed in the popup, 1-3 buttons.
-   */
-  buttons: PopupButton[];
-}
-
-/**
- * Describes the native popup button.
- * @see https://docs.telegram-mini-apps.com/apps-communication/methods#popupbutton
- */
-export type PopupButton = {
-  /**
-   * Identifier of the button, 0-64 characters.
-   */
-  id: string;
-} & ({
-  /**
-   * Type of the button:
-   * - `default`, a button with the default style;
-   * - `destructive`, a button with a style that indicates a destructive
-   * action (e.g. "Remove", "Delete", etc.).
-   *
-   * @default "default"
-   */
-  type?: 'default' | 'destructive';
-
-  /**
-   * The text to be displayed on the button, 0-64 characters.
-   */
-  text: string;
-} | {
-  /**
-   * Type of the button:
-   * - `ok`, a button with the localized text "OK";
-   * - `close`, a button with the localized text "Close";
-   * - `cancel`, a button with the localized text "Cancel".
-   */
-  type: 'ok' | 'close' | 'cancel';
-});

package/src/methods/postEvent.ts

@@ -1,101 +0,0 @@
-import {
-  isIframe,
-  hasExternalNotify,
-  hasWebviewProxy,
-} from '../env.js';
-import { logger, targetOrigin as globalTargetOrigin } from '../globals.js';
-import type {
-  EmptyMethodName,
-  MethodName,
-  MethodParams,
-  NonEmptyMethodName,
-} from './methods.js';
-
-interface PostEventOptions {
-  /**
-   * Origin used while posting message. This option is only used in case,
-   * current environment is browser (Web version of Telegram) and could
-   * be used for test purposes.
-   * @default 'https://web.telegram.org'
-   */
-  targetOrigin?: string;
-}
-
-export type PostEvent = typeof postEvent;
-
-/**
- * Sends event to native application which launched Mini App. This function
- * accepts only events, which require arguments.
- * @param eventType - event name.
- * @param params - event parameters.
- * @param options - posting options.
- * @throws {Error} Bridge could not determine current environment and possible way to send event.
- */
-export function postEvent<E extends NonEmptyMethodName>(
-  eventType: E,
-  params: MethodParams<E>,
-  options?: PostEventOptions,
-): void;
-
-/**
- * Sends event to native application which launched Mini App. This function
- * accepts only events, which require arguments.
- * @param eventType - event name.
- * @param options - posting options.
- * @throws {Error} Bridge could not determine current environment and possible way to send event.
- */
-export function postEvent(eventType: EmptyMethodName, options?: PostEventOptions): void;
-
-export function postEvent(
-  eventType: MethodName,
-  paramsOrOptions?: MethodParams<MethodName> | PostEventOptions,
-  options?: PostEventOptions,
-): void {
-  let postOptions: PostEventOptions = {};
-  let eventData: any;
-
-  if (paramsOrOptions === undefined && options === undefined) {
-    // Parameters and options were not passed.
-    postOptions = {};
-  } else if (paramsOrOptions !== undefined && options !== undefined) {
-    // Both parameters and options passed.
-    postOptions = options;
-    eventData = paramsOrOptions;
-  } else if (paramsOrOptions !== undefined) {
-    // Only parameters were passed.
-    if ('targetOrigin' in paramsOrOptions) {
-      postOptions = paramsOrOptions;
-    } else {
-      eventData = paramsOrOptions;
-    }
-  }
-  const { targetOrigin = globalTargetOrigin() } = postOptions;
-
-  logger.log(`Calling method "${eventType}"`, eventData);
-
-  // Telegram Web.
-  if (isIframe()) {
-    window.parent.postMessage(JSON.stringify({
-      eventType,
-      eventData,
-    }), targetOrigin);
-    return;
-  }
-
-  // Telegram for Windows Phone or Android.
-  if (hasExternalNotify(window)) {
-    window.external.notify(JSON.stringify({ eventType, eventData }));
-    return;
-  }
-
-  // Telegram for iOS and macOS.
-  if (hasWebviewProxy(window)) {
-    window.TelegramWebviewProxy.postEvent(eventType, JSON.stringify(eventData));
-    return;
-  }
-
-  // Otherwise current environment is unknown, and we are not able to send event.
-  throw new Error(
-    'Unable to determine current environment and possible way to send event.',
-  );
-}