@tma.js/sdk 1.4.4 → 1.4.7

package/src/bridge/events/events.ts

@@ -1,170 +0,0 @@
-import type {
-  AnySubscribeListener,
-  EventEmitter,
-  EventListener,
-  EventParams,
-} from '~/event-emitter/index.js';
-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
- */
-export interface MiniAppsEvents {
-  /**
-   * User clicked back button.
-   * @since v6.1
-   * @see https://docs.telegram-mini-apps.com/platform/apps-communication/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
-   */
-  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
-   */
-  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
-   */
-  invoice_closed: (payload: InvoiceClosedPayload) => void;
-
-  /**
-   * User clicked the Main Button.
-   * @see https://docs.telegram-mini-apps.com/platform/apps-communication/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
-   */
-  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
-   */
-  popup_closed: (payload: PopupClosedPayload) => void;
-
-  /**
-   * Parent iframe requested current iframe reload.
-   * @see https://docs.telegram-mini-apps.com/platform/apps-communication/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
-   */
-  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
-   */
-  scan_qr_popup_closed: () => void;
-
-  /**
-   * The event which is usually sent by the Telegram web application. Its payload represents
-   * `<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
-   */
-  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
-   */
-  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
-   */
-  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
-   */
-  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
-   */
-  write_access_requested: (payload: WriteAccessRequestedPayload) => void;
-}
-
-/**
- * Any known event name.
- */
-export type MiniAppsEventName = keyof MiniAppsEvents;
-
-/**
- * Parameters of specified event.
- */
-export type MiniAppsEventParams<E extends MiniAppsEventName> = EventParams<MiniAppsEvents[E]>[0];
-
-/**
- * Returns event listener for specified event name.
- */
-export type MiniAppsEventListener<E extends MiniAppsEventName> = EventListener<MiniAppsEvents[E]>;
-
-/**
- * Event emitter, based describe events map.
- */
-export type MiniAppsEventEmitter = EventEmitter<MiniAppsEvents>;
-
-/**
- * Returns true in case, event has parameters.
- */
-export type MiniAppsEventHasParams<E extends MiniAppsEventName> =
-  Not<IsNever<MiniAppsEventParams<E>>>;
-
-/**
- * Event listener used in `subscribe` and `unsubscribe` functions.
- */
-export type MiniAppsGlobalEventListener =
-  | AnySubscribeListener<MiniAppsEvents>
-  | ((event: string, data: unknown) => void);

package/src/bridge/events/index.ts

@@ -1,9 +0,0 @@
-export * from './createEmitter.js';
-export * from './events.js';
-export * from './off.js';
-export * from './on.js';
-export * from './once.js';
-export * from './parsers/index.js';
-export * from './singletonEmitter.js';
-export * from './subscribe.js';
-export * from './unsubscribe.js';

package/src/bridge/events/off.ts

@@ -1,14 +0,0 @@
-import type { MiniAppsEventListener, MiniAppsEventName } from './events.js';
-import { singletonEmitter } from './singletonEmitter.js';
-
-/**
- * Removes listener from specified event.
- * @param event - event to listen.
- * @param listener - event listener.
- */
-export function off<E extends MiniAppsEventName>(
-  event: E,
-  listener: MiniAppsEventListener<E>,
-): void {
-  singletonEmitter().off(event, listener);
-}

package/src/bridge/events/on.ts

@@ -1,19 +0,0 @@
-import type { MiniAppsEventListener, MiniAppsEventName } from './events.js';
-import { off } from './off.js';
-import { singletonEmitter } from './singletonEmitter.js';
-
-type StopListening = () => void;
-
-/**
- * Adds new listener to the specified event. Returns handler
- * which allows to stop listening to event.
- * @param event - event name.
- * @param listener - event listener.
- */
-export function on<E extends MiniAppsEventName>(
-  event: E,
-  listener: MiniAppsEventListener<E>,
-): StopListening {
-  singletonEmitter().on(event, listener);
-  return () => off(event, listener);
-}

package/src/bridge/events/onTelegramEvent.ts

@@ -1,81 +0,0 @@
-import { parseMessage } from '~/bridge/parseMessage.js';
-
-/**
- * Emits event sent from Telegram native application like it was sent in
- * default web environment between 2 iframes. It dispatches new MessageEvent
- * and expects it to be handled via `window.addEventListener('message', ...)`
- * as developer would do it to handle messages sent from the parent iframe.
- * @param eventType - event name.
- * @param eventData - event payload.
- */
-function emitEvent(eventType: string, eventData: unknown): void {
-  window.dispatchEvent(new MessageEvent('message', {
-    data: JSON.stringify({ eventType, eventData }),
-    // We specify window.parent to imitate the case, it sent us this event.
-    source: window.parent,
-  }));
-}
-
-/**
- * Defines special handlers by known paths, which are recognized by
- * Telegram as ports to receive events. This function also sets special
- * function in global window object to prevent duplicate declaration.
- */
-function defineEventHandlers(): void {
-  const wnd: any = window;
-
-  // Prevent from duplicate event handlers definition.
-  if ('TelegramGameProxy_receiveEvent' in wnd) {
-    return;
-  }
-
-  // Iterate over each path, where "receiveEvent" function should be
-  // defined. This function is called by external environment in case,
-  // it wants to emit some event.
-  [
-    ['TelegramGameProxy_receiveEvent'], // Windows Phone.
-    ['TelegramGameProxy', 'receiveEvent'], // Desktop.
-    ['Telegram', 'WebView', 'receiveEvent'], // Android and iOS.
-  ].forEach((path) => {
-    // Path starts from "window" object.
-    let pointer = wnd;
-
-    path.forEach((item, idx, arr) => {
-      // We are on the last iteration, where function property name is passed.
-      if (idx === arr.length - 1) {
-        pointer[item] = emitEvent;
-        return;
-      }
-
-      if (!(item in pointer)) {
-        pointer[item] = {};
-      }
-      pointer = pointer[item];
-    });
-  });
-}
-
-/**
- * Adds listener to window "message" event assuming, that this event could
- * be sent by Telegram native application. Calls passed callback with event
- * type and data.
- * @param cb - callback to call.
- */
-export function onTelegramEvent(cb: (eventType: string, eventData: unknown) => void): void {
-  // Define event handlers to make sure, message handler will work correctly.
-  defineEventHandlers();
-
-  // We expect Telegram to send us new event through "message" event.
-  window.addEventListener('message', (event) => {
-    if (event.source !== window.parent) {
-      return;
-    }
-
-    try {
-      const { eventType, eventData } = parseMessage(event.data);
-      cb(eventType, eventData);
-    } catch {
-      // We ignore incorrect messages as they could be generated by any other code.
-    }
-  });
-}

package/src/bridge/events/once.ts

@@ -1,18 +0,0 @@
-import type { MiniAppsEventListener, MiniAppsEventName } from './events.js';
-import { off } from './off.js';
-import { singletonEmitter } from './singletonEmitter.js';
-
-type StopListening = () => void;
-
-/**
- * Works the same as "on" method, but after catching the event, will remove event listener.
- * @param event - event name.
- * @param listener - event listener.
- */
-export function once<E extends MiniAppsEventName>(
-  event: E,
-  listener: MiniAppsEventListener<E>,
-): StopListening {
-  singletonEmitter().once(event, listener);
-  return () => off(event, listener);
-}

package/src/bridge/events/parsers/__tests__/clipboardTextReceived.ts

@@ -1,21 +0,0 @@
-import { expect, it } from 'vitest';
-
-import { clipboardTextReceived } from '../clipboardTextReceived';
-
-it('should return parsed value in case, passed value satisfies schema', () => {
-  const cases = [
-    { req_id: 'abc', data: 'ok' },
-    { req_id: 'abc' },
-    { req_id: 'abc', data: null },
-  ];
-
-  cases.forEach((value) => {
-    expect(clipboardTextReceived().parse(value)).toStrictEqual(value);
-    expect(clipboardTextReceived().parse(JSON.stringify(value)))
-      .toStrictEqual(value);
-  });
-});
-
-it('should throw an error in case, passed value does not satisfy schema', () => {
-  expect(() => clipboardTextReceived().parse({})).toThrow();
-});

package/src/bridge/events/parsers/__tests__/invoiceClosed.ts

@@ -1,12 +0,0 @@
-import { expect, it } from 'vitest';
-
-import { invoiceClosed } from '../invoiceClosed';
-
-it('should return parsed value in case, passed value satisfies schema', () => {
-  const value = { slug: 'abc', status: 'def' };
-  expect(invoiceClosed().parse(value)).toStrictEqual(value);
-});
-
-it('should throw an error in case, passed value does not satisfy schema', () => {
-  expect(() => invoiceClosed().parse({})).toThrow();
-});

package/src/bridge/events/parsers/__tests__/popupClosed.ts

@@ -1,10 +0,0 @@
-import { expect, it } from 'vitest';
-
-import { popupClosed } from '../popupClosed';
-
-it('should return parsed value in case, passed value satisfies schema', () => {
-  expect(popupClosed().parse({ button_id: 'ok' })).toStrictEqual({ button_id: 'ok' });
-  expect(popupClosed().parse({})).toStrictEqual({});
-  expect(popupClosed().parse({ button_id: null })).toStrictEqual({});
-  expect(popupClosed().parse({ button_id: 100 })).toStrictEqual({ button_id: '100' });
-});

package/src/bridge/events/parsers/__tests__/qrTextReceived.ts

@@ -1,9 +0,0 @@
-import { expect, it } from 'vitest';
-
-import { qrTextReceived } from '../qrTextReceived';
-
-it('should return parsed value in case, passed value satisfies schema', () => {
-  expect(qrTextReceived().parse({ data: 'ok' })).toStrictEqual({ data: 'ok' });
-  expect(qrTextReceived().parse({})).toStrictEqual({});
-  expect(qrTextReceived().parse({ data: 100 })).toStrictEqual({ data: '100' });
-});

package/src/bridge/events/parsers/__tests__/theme-changed.ts

@@ -1,42 +0,0 @@
-import { expect, it } from 'vitest';
-
-import { themeChanged } from '../theme-changed';
-
-it('should return parsed value in case, passed value satisfies schema', () => {
-  const values = [
-    {
-      theme_params: {
-        accent_text_color: '#aaccbb',
-        bg_color: '#ffaabb',
-        button_color: '#faaafa',
-        button_text_color: '#666271',
-        destructive_text_color: '#111332',
-        header_bg_color: '#aab133',
-        hint_color: '#113322',
-        link_color: '#882133',
-        secondary_bg_color: '#2231aa',
-        section_bg_color: '#111332',
-        section_header_text_color: '#111332',
-        subtitle_text_color: '#111332',
-        text_color: '#bbaadd',
-      },
-    },
-    {
-      theme_params: {},
-    },
-  ];
-
-  values.forEach((value) => {
-    expect(themeChanged().parse(value)).toStrictEqual(value);
-    expect(themeChanged().parse(JSON.stringify(value))).toStrictEqual(value);
-  });
-});
-
-it('should throw an error in case, passed value does not satisfy schema', () => {
-  expect(() => themeChanged().parse({})).toThrow();
-  expect(() => themeChanged().parse({
-    theme_params: {
-      bg_color: 'Hello there!',
-    },
-  })).toThrow();
-});

package/src/bridge/events/parsers/__tests__/viewportChanged.ts

@@ -1,49 +0,0 @@
-import { afterEach, beforeEach, expect, it, vi } from 'vitest';
-
-import { viewportChanged } from '../viewportChanged';
-
-const windowSpy = vi.spyOn(window, 'window', 'get');
-// const innerWidth = 2000;
-
-beforeEach(() => {
-  windowSpy.mockImplementation(() => ({ innerWidth: 2000 }) as any);
-});
-
-afterEach(() => {
-  windowSpy.mockRestore();
-});
-
-it('should return parsed value in case, passed value satisfies schema', () => {
-  const values = [
-    {
-      height: 900,
-      is_state_stable: true,
-      is_expanded: true,
-    },
-    {
-      width: null,
-      height: 900,
-      is_state_stable: true,
-      is_expanded: true,
-    },
-    {
-      height: 900,
-      width: 100,
-      is_state_stable: true,
-      is_expanded: true,
-    },
-  ];
-
-  values.forEach((value) => {
-    const width = !value.width ? window.innerWidth : value.width;
-    expect(viewportChanged().parse(value)).toStrictEqual({ ...value, width });
-    expect(viewportChanged().parse(JSON.stringify(value))).toStrictEqual({
-      ...value,
-      width,
-    });
-  });
-});
-
-it('should throw an error in case, passed value does not satisfy schema', () => {
-  expect(() => viewportChanged().parse({})).toThrow();
-});

package/src/bridge/events/parsers/clipboardTextReceived.ts

@@ -1,26 +0,0 @@
-import { json, string } from '~/parsing/index.js';
-import type { RequestId } from '~/types/index.js';
-
-export interface ClipboardTextReceivedPayload {
-  /**
-   * Passed during the `web_app_read_text_from_clipboard` method invocation `req_id` value.
-   */
-  req_id: RequestId;
-
-  /**
-   * Data extracted from the clipboard. The returned value will have the type `string` only in
-   * the case, application has access to the clipboard.
-   */
-  data?: string | null;
-}
-
-export function clipboardTextReceived() {
-  return json<ClipboardTextReceivedPayload>({
-    req_id: string(),
-    data: (value) => (
-      value === null
-        ? value
-        : string().optional().parse(value)
-    ),
-  });
-}

package/src/bridge/events/parsers/customMethodInvoked.ts

@@ -1,25 +0,0 @@
-import { json, string } from '~/parsing/index.js';
-import type { RequestId } from '~/types/index.js';
-
-export interface CustomMethodInvokedPayload<R = unknown> {
-  /**
-   * Unique identifier of this invocation.
-   */
-  req_id: RequestId;
-  /**
-   * Method invocation successful result.
-   */
-  result?: R;
-  /**
-   * Method invocation error code.
-   */
-  error?: string;
-}
-
-export function customMethodInvoked() {
-  return json<CustomMethodInvokedPayload>({
-    req_id: string(),
-    result: (value) => value,
-    error: string().optional(),
-  });
-}

package/src/bridge/events/parsers/index.ts

@@ -1,9 +0,0 @@
-export * from './clipboardTextReceived.js';
-export * from './customMethodInvoked.js';
-export * from './invoiceClosed.js';
-export * from './phoneRequested.js';
-export * from './popupClosed.js';
-export * from './qrTextReceived.js';
-export * from './theme-changed.js';
-export * from './viewportChanged.js';
-export * from './writeAccessRequested.js';

package/src/bridge/events/parsers/invoiceClosed.ts

@@ -1,26 +0,0 @@
-import { json, string } from '~/parsing/index.js';
-
-export type InvoiceStatus =
-  | 'paid'
-  | 'failed'
-  | 'pending'
-  | 'cancelled'
-  | string;
-
-export interface InvoiceClosedPayload {
-  /**
-   * Passed during the `web_app_open_invoice` method invocation `slug` value.
-   */
-  slug: string;
-  /**
-   * Invoice status
-   */
-  status: InvoiceStatus;
-}
-
-export function invoiceClosed() {
-  return json<InvoiceClosedPayload>({
-    slug: string(),
-    status: string(),
-  });
-}

package/src/bridge/events/parsers/phoneRequested.ts

@@ -1,14 +0,0 @@
-import { json, string } from '~/parsing/index.js';
-
-export type PhoneRequestedStatus = 'sent' | 'cancelled' | string;
-
-export interface PhoneRequestedPayload {
-  /**
-   * Request status.
-   */
-  status: PhoneRequestedStatus;
-}
-
-export function phoneRequested() {
-  return json<PhoneRequestedPayload>({ status: string() });
-}

package/src/bridge/events/parsers/popupClosed.ts

@@ -1,19 +0,0 @@
-import { json, string } from '~/parsing/index.js';
-
-export interface PopupClosedPayload {
-  /**
-   * Identifier of the clicked button. In case, the popup was closed without clicking any button,
-   * this property will be omitted.
-   */
-  button_id?: string;
-}
-
-export function popupClosed() {
-  return json<PopupClosedPayload>({
-    button_id: (value) => (
-      value === null || value === undefined
-        ? undefined
-        : string().parse(value)
-    ),
-  });
-}

package/src/bridge/events/parsers/qrTextReceived.ts

@@ -1,14 +0,0 @@
-import { json, string } from '~/parsing/index.js';
-
-export interface QrTextReceivedPayload {
-  /**
-   * Data extracted from the QR.
-   */
-  data?: string;
-}
-
-export function qrTextReceived() {
-  return json<QrTextReceivedPayload>({
-    data: string().optional(),
-  });
-}

package/src/bridge/events/parsers/theme-changed.ts

@@ -1,58 +0,0 @@
-import { json, rgb, toRecord } from '~/parsing/index.js';
-import type { RGB } from '~/colors/index.js';
-
-export interface ThemeChangedPayload {
-  /**
-   * Map where the key is a theme stylesheet key and value is  the corresponding color in
-   * `#RRGGBB` format.
-   */
-  theme_params: {
-    /**
-     * @since v6.10
-     */
-    accent_text_color?: RGB;
-    bg_color?: RGB;
-    button_color?: RGB;
-    button_text_color?: RGB;
-    /**
-     * @since v6.10
-     */
-    destructive_text_color?: RGB;
-    /**
-     * @since v6.10
-     */
-    header_bg_color?: RGB;
-    hint_color?: RGB;
-    link_color?: RGB;
-    secondary_bg_color?: RGB;
-    /**
-     * @since v6.10
-     */
-    section_bg_color?: RGB;
-    /**
-     * @since v6.10
-     */
-    section_header_text_color?: RGB;
-    /**
-     * @since v6.10
-     */
-    subtitle_text_color?: RGB;
-    text_color?: RGB;
-    [key: string]: RGB | undefined; // Future unknown palette keys.
-  };
-}
-
-export function themeChanged() {
-  return json<ThemeChangedPayload>({
-    theme_params: (value) => {
-      const parser = rgb().optional();
-
-      return Object
-        .entries(toRecord(value))
-        .reduce<Partial<Record<string, RGB>>>((acc, [k, v]) => {
-        acc[k] = parser.parse(v);
-        return acc;
-      }, {});
-    },
-  });
-}