@tma.js/sdk 1.4.3 → 1.4.6

package/src/bridge/errors/ParameterUnsupportedError.ts

@@ -1,13 +0,0 @@
-import type { Version } from '~/version/index.js';
-
-import type { MiniAppsMethodName } from '../methods/index.js';
-
-/**
- * Error thrown in case, unsupported parameter was used.
- */
-export class ParameterUnsupportedError extends Error {
-  constructor(method: MiniAppsMethodName, param: string, version: Version) {
-    super(`Parameter "${param}" in method "${method}" is unsupported in the Mini Apps version ${version}.`);
-    Object.setPrototypeOf(this, ParameterUnsupportedError.prototype);
-  }
-}

package/src/bridge/errors/index.ts

@@ -1,2 +0,0 @@
-export * from './MethodUnsupportedError.js';
-export * from './ParameterUnsupportedError.js';

package/src/bridge/events/__tests__/createEmitter.ts

@@ -1,143 +0,0 @@
-import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';
-
-import { createWindow, type WindowSpy } from '../../../../test-utils/createWindow';
-import { dispatchWindowMessageEvent } from '../../../../test-utils/dispatchWindowMessageEvent';
-import { createEmitter } from '../createEmitter';
-import type { MiniAppsEventName, MiniAppsEventParams } from '../events';
-
-type TestCase<E extends MiniAppsEventName> =
-  | [input: any, expected: MiniAppsEventParams<E>]
-  | MiniAppsEventParams<E>;
-
-type TestCases = {
-  [E in MiniAppsEventName]: MiniAppsEventParams<E> extends undefined
-    ? [E]
-    : [E, TestCase<E> | TestCase<E>[]];
-}[MiniAppsEventName][];
-
-let windowSpy: WindowSpy;
-
-beforeEach(() => {
-  windowSpy = createWindow({
-    innerWidth: 1920,
-    innerHeight: 1080,
-  });
-});
-
-afterEach(() => {
-  windowSpy.mockRestore();
-});
-
-it('should emit "viewport_changed" event in case, window changed its size', () => {
-  const emitter = createEmitter();
-  const spy = vi.fn();
-
-  emitter.on('viewport_changed', spy);
-
-  window.dispatchEvent(new CustomEvent('resize'));
-
-  expect(spy).toHaveBeenCalledTimes(1);
-  expect(spy).toHaveBeenCalledWith({
-    width: 1920,
-    height: 1080,
-    is_state_stable: true,
-    is_expanded: true,
-  });
-});
-
-describe('events handling', () => {
-  const testCases: TestCases = [
-    ['viewport_changed', {
-      height: 120,
-      width: 300,
-      is_expanded: true,
-      is_state_stable: false,
-    }],
-    ['theme_changed', {
-      theme_params: {
-        bg_color: '#aabbdd',
-        text_color: '#113322',
-        hint_color: '#132245',
-        link_color: '#133322',
-        button_color: '#a23135',
-        button_text_color: '#aa213f',
-      },
-    }],
-    ['popup_closed', [
-      [{ button_id: 'ok' }, { button_id: 'ok' }],
-      [{ button_id: null }, {}],
-      [{ button_id: undefined }, {}],
-      [null, {}],
-      [undefined, {}],
-    ]],
-    ['set_custom_style', '.scroll {}'],
-    ['qr_text_received', { data: 'some QR data' }],
-    ['main_button_pressed'],
-    ['back_button_pressed'],
-    ['settings_button_pressed'],
-    ['scan_qr_popup_closed'],
-    ['clipboard_text_received', {
-      req_id: 'request id',
-      data: 'clipboard value',
-    }],
-    ['invoice_closed', { slug: '&&*Sh1j213kx', status: 'PAID' }],
-    ['phone_requested', { status: 'sent' }],
-    ['custom_method_invoked', [
-      [{ req_id: '1', result: 'My result' }],
-      [{ req_id: '2', error: 'Something is wrong' }],
-    ]],
-    ['write_access_requested', { status: 'allowed' }],
-    ['unknown_event', [
-      ['hello', 'hello'],
-      [{ there: true }, { there: true }],
-    ]] as any,
-  ];
-
-  testCases.forEach(([event, inputOrCaseOrCases]) => {
-    it(`should correctly handle "${event}" event data`, () => {
-      const spy = vi.fn();
-      const emitter = createEmitter();
-
-      emitter.on(event, spy);
-
-      // No expected data to be passed to listener.
-      if (inputOrCaseOrCases === undefined) {
-        dispatchWindowMessageEvent(event);
-        expect(spy).toBeCalledWith();
-        return;
-      }
-
-      // Input is equal to expected result.
-      if (!Array.isArray(inputOrCaseOrCases)) {
-        dispatchWindowMessageEvent(event, inputOrCaseOrCases);
-        expect(spy).toBeCalledWith(inputOrCaseOrCases);
-        return;
-      }
-
-      // Input differs from expected result.
-      if (!Array.isArray(inputOrCaseOrCases[0])) {
-        const [input, expected] = inputOrCaseOrCases;
-        dispatchWindowMessageEvent(event, input);
-        expect(spy).toBeCalledWith(expected);
-        return;
-      }
-
-      // List of cases.
-      inputOrCaseOrCases.forEach(([input, expected = input]) => {
-        dispatchWindowMessageEvent(event, input);
-        expect(spy).toBeCalledWith(expected);
-      });
-    });
-  });
-
-  it('should not emit event in case, it contains incorrect payload', () => {
-    const spy = vi.fn();
-    const emitter = createEmitter();
-
-    emitter.on('viewport_changed', spy);
-
-    dispatchWindowMessageEvent('viewport_changed', 'broken data');
-
-    expect(spy).not.toBeCalled();
-  });
-});

package/src/bridge/events/__tests__/off.ts

@@ -1,34 +0,0 @@
-import { afterEach, beforeEach, expect, it, vi } from 'vitest';
-
-import { createWindow, type WindowSpy } from '../../../../test-utils/createWindow';
-import { dispatchWindowMessageEvent } from '../../../../test-utils/dispatchWindowMessageEvent';
-import { off } from '../off';
-import { on } from '../on';
-
-let windowSpy: WindowSpy;
-
-beforeEach(() => {
-  windowSpy = createWindow();
-});
-
-afterEach(() => {
-  windowSpy.mockRestore();
-});
-
-it('should remove listener', () => {
-  const listener = vi.fn();
-  const emit = () => dispatchWindowMessageEvent('viewport_changed', {
-    height: 123,
-    width: 321,
-    is_expanded: false,
-    is_state_stable: false,
-  });
-
-  on('viewport_changed', listener);
-  emit();
-  expect(listener).toHaveBeenCalledTimes(1);
-
-  off('viewport_changed', listener);
-  emit();
-  expect(listener).toHaveBeenCalledTimes(1);
-});

package/src/bridge/events/__tests__/on.ts

@@ -1,49 +0,0 @@
-import { afterEach, beforeEach, expect, it, vi } from 'vitest';
-
-import { createWindow, type WindowSpy } from '../../../../test-utils/createWindow';
-import { dispatchWindowMessageEvent } from '../../../../test-utils/dispatchWindowMessageEvent';
-import { on } from '../on';
-
-let windowSpy: WindowSpy;
-
-beforeEach(() => {
-  windowSpy = createWindow();
-});
-
-afterEach(() => {
-  windowSpy.mockRestore();
-});
-
-it('should call listener in case, Telegram event was created', () => {
-  const listener = vi.fn();
-  on('viewport_changed', listener);
-
-  const eventData = {
-    height: 123,
-    width: 321,
-    is_expanded: false,
-    is_state_stable: false,
-  };
-  dispatchWindowMessageEvent('viewport_changed', eventData);
-
-  expect(listener).toHaveBeenCalledTimes(1);
-  expect(listener).toHaveBeenCalledWith(eventData);
-});
-
-it('should remove listener in case, returned callback was called', () => {
-  const listener = vi.fn();
-  const emit = () => dispatchWindowMessageEvent('viewport_changed', {
-    height: 123,
-    width: 321,
-    is_expanded: false,
-    is_state_stable: false,
-  });
-
-  const off = on('viewport_changed', listener);
-  emit();
-  expect(listener).toHaveBeenCalledTimes(1);
-
-  off();
-  emit();
-  expect(listener).toHaveBeenCalledTimes(1);
-});

package/src/bridge/events/__tests__/onTelegramEvent.ts

@@ -1,49 +0,0 @@
-import { afterEach, beforeEach, expect, it, vi } from 'vitest';
-
-import { createWindow, type WindowSpy } from '../../../../test-utils/createWindow';
-import { dispatchWindowMessageEvent } from '../../../../test-utils/dispatchWindowMessageEvent';
-import { onTelegramEvent } from '../onTelegramEvent';
-
-afterEach(() => {
-  vi.restoreAllMocks()
-});
-
-it('should call passed callback with event type and data in case, window generated "message" event with data, presented as object with properties "eventType" (string) and "eventData" (unknown). Object is converted to string.', () => {
-  createWindow({ env: 'iframe' });
-  const callback = vi.fn();
-  onTelegramEvent(callback);
-
-  dispatchWindowMessageEvent('qr_text_received', {});
-
-  expect(callback).toHaveBeenCalledTimes(1);
-  expect(callback).toHaveBeenCalledWith('qr_text_received', {});
-});
-
-it('should not define event handlers twice in case, window object contains "TelegramGameProxy_receiveEvent" property.', () => {
-  createWindow();
-  (window as any).TelegramGameProxy_receiveEvent = true;
-
-  onTelegramEvent(vi.fn());
-  expect(window).not.toHaveProperty('Telegram');
-});
-
-it('should call passed callback with event type and data in case, external environment generated event.', () => {
-  createWindow();
-  const callback = vi.fn();
-  onTelegramEvent(callback);
-
-  (window as any).TelegramGameProxy_receiveEvent('test', false);
-
-  expect(callback).toHaveBeenCalledTimes(1);
-  expect(callback).toHaveBeenCalledWith('test', false);
-});
-
-it('should ignore a message event with unexpected data', () => {
-  createWindow();
-  const callback = vi.fn();
-  onTelegramEvent(callback);
-
-  window.dispatchEvent(new MessageEvent('message', { data: null }));
-
-  expect(callback).toHaveBeenCalledTimes(0);
-});

package/src/bridge/events/__tests__/once.ts

@@ -1,64 +0,0 @@
-import { afterEach, beforeEach, expect, it, vi } from 'vitest';
-
-import { createWindow, type WindowSpy } from '../../../../test-utils/createWindow';
-import { dispatchWindowMessageEvent } from '../../../../test-utils/dispatchWindowMessageEvent';
-import { once } from '../once';
-
-let windowSpy: WindowSpy;
-
-beforeEach(() => {
-  windowSpy = createWindow();
-});
-
-afterEach(() => {
-  windowSpy.mockRestore();
-});
-
-it('should call listener in case, Telegram event was created', () => {
-  const listener = vi.fn();
-  once('viewport_changed', listener);
-
-  const eventData = {
-    height: 123,
-    width: 321,
-    is_expanded: false,
-    is_state_stable: false,
-  };
-  dispatchWindowMessageEvent('viewport_changed', eventData);
-
-  expect(listener).toHaveBeenCalledTimes(1);
-  expect(listener).toHaveBeenCalledWith(eventData);
-});
-
-it('should remove listener in case, returned callback was called', () => {
-  const listener = vi.fn();
-  const emit = () => dispatchWindowMessageEvent('viewport_changed', {
-    height: 123,
-    width: 321,
-    is_expanded: false,
-    is_state_stable: false,
-  });
-
-  const off = once('viewport_changed', listener);
-
-  off();
-  emit();
-  expect(listener).toHaveBeenCalledTimes(0);
-});
-
-it('should remove listener in case, listener was called', () => {
-  const listener = vi.fn();
-  const emit = () => dispatchWindowMessageEvent('viewport_changed', {
-    height: 123,
-    width: 321,
-    is_expanded: false,
-    is_state_stable: false,
-  });
-
-  once('viewport_changed', listener);
-  emit();
-  expect(listener).toHaveBeenCalledTimes(1);
-
-  emit();
-  expect(listener).toHaveBeenCalledTimes(1);
-});

package/src/bridge/events/__tests__/singletonEmitter.ts

@@ -1,22 +0,0 @@
-import { afterEach, beforeEach, expect, it } from 'vitest';
-
-import type { WindowSpy } from '../../../../test-utils/createWindow';
-import { createWindow } from '../../../../test-utils/createWindow';
-import { singletonEmitter } from '../singletonEmitter';
-
-let windowSpy: WindowSpy;
-
-beforeEach(() => {
-  windowSpy = createWindow({
-    innerWidth: 1920,
-    innerHeight: 1080,
-  });
-});
-
-afterEach(() => {
-  windowSpy.mockRestore();
-});
-
-it('should return the same instance of emitter', () => {
-  expect(singletonEmitter()).toEqual(singletonEmitter());
-});

package/src/bridge/events/__tests__/subscribe.ts

@@ -1,49 +0,0 @@
-import { afterEach, beforeEach, expect, it, vi } from 'vitest';
-
-import { createWindow, type WindowSpy } from '../../../../test-utils/createWindow';
-import { dispatchWindowMessageEvent } from '../../../../test-utils/dispatchWindowMessageEvent';
-import { subscribe } from '../subscribe';
-
-let windowSpy: WindowSpy;
-
-beforeEach(() => {
-  windowSpy = createWindow();
-});
-
-afterEach(() => {
-  windowSpy.mockRestore();
-});
-
-it('should call listener in case, Telegram event was created', () => {
-  const listener = vi.fn();
-  subscribe(listener);
-
-  const eventData = {
-    height: 123,
-    width: 321,
-    is_expanded: false,
-    is_state_stable: false,
-  };
-  dispatchWindowMessageEvent('viewport_changed', eventData);
-
-  expect(listener).toHaveBeenCalledTimes(1);
-  expect(listener).toHaveBeenCalledWith('viewport_changed', eventData);
-});
-
-it('should remove listener in case, returned callback was called', () => {
-  const listener = vi.fn();
-  const emit = () => dispatchWindowMessageEvent('viewport_changed', {
-    height: 123,
-    width: 321,
-    is_expanded: false,
-    is_state_stable: false,
-  });
-
-  const unsubscribe = subscribe(listener);
-  emit();
-  expect(listener).toHaveBeenCalledTimes(1);
-
-  unsubscribe();
-  emit();
-  expect(listener).toHaveBeenCalledTimes(1);
-});

package/src/bridge/events/__tests__/unsubscribe.ts

@@ -1,34 +0,0 @@
-import { afterEach, beforeEach, expect, it, vi } from 'vitest';
-
-import { createWindow, type WindowSpy } from '../../../../test-utils/createWindow';
-import { dispatchWindowMessageEvent } from '../../../../test-utils/dispatchWindowMessageEvent';
-import { subscribe } from '../subscribe';
-import { unsubscribe } from '../unsubscribe';
-
-let windowSpy: WindowSpy;
-
-beforeEach(() => {
-  windowSpy = createWindow();
-});
-
-afterEach(() => {
-  windowSpy.mockRestore();
-});
-
-it('should remove listener', () => {
-  const listener = vi.fn();
-  const emit = () => dispatchWindowMessageEvent('viewport_changed', {
-    height: 123,
-    width: 321,
-    is_expanded: false,
-    is_state_stable: false,
-  });
-
-  subscribe(listener);
-  emit();
-  expect(listener).toHaveBeenCalledTimes(1);
-
-  unsubscribe(listener);
-  emit();
-  expect(listener).toHaveBeenCalledTimes(1);
-});

package/src/bridge/events/createEmitter.ts

@@ -1,108 +0,0 @@
-import { EventEmitter } from '~/event-emitter/index.js';
-import { logger } from '~/globals.js';
-import { string } from '~/parsing/index.js';
-
-import type { MiniAppsEventEmitter, MiniAppsEventName } from './events.js';
-import { onTelegramEvent } from './onTelegramEvent.js';
-import {
-  clipboardTextReceived,
-  customMethodInvoked,
-  invoiceClosed,
-  phoneRequested,
-  popupClosed,
-  qrTextReceived,
-  themeChanged,
-  viewportChanged,
-  writeAccessRequested,
-} from './parsers/index.js';
-
-/**
- * Returns event emitter which could be safely used, to process events from
- * Telegram native application.
- */
-export function createEmitter(): MiniAppsEventEmitter {
-  const emitter: MiniAppsEventEmitter = new EventEmitter();
-  const emit: MiniAppsEventEmitter['emit'] = (event: any, ...data: any[]) => {
-    logger.log('Emitting processed event:', event, ...data);
-    emitter.emit(event, ...data);
-  };
-
-  // Desktop version of Telegram is sometimes not sending the viewport_changed
-  // event. For example, when main button is shown. That's why we should
-  // add our own listener to make sure, viewport information is always fresh.
-  // Issue: https://github.com/Telegram-Mini-Apps/tma.js/issues/10
-  window.addEventListener('resize', () => {
-    emit('viewport_changed', {
-      width: window.innerWidth,
-      height: window.innerHeight,
-      is_state_stable: true,
-      is_expanded: true,
-    });
-  });
-
-  // In case, any Telegram event was received, we should prepare data before
-  // passing it to emitter.
-  onTelegramEvent((eventType: MiniAppsEventName | string, eventData): void => {
-    logger.log('Received raw event:', eventType, eventData);
-
-    try {
-      switch (eventType) {
-        case 'viewport_changed':
-          return emit(eventType, viewportChanged().parse(eventData));
-
-        case 'theme_changed':
-          return emit(eventType, themeChanged().parse(eventData));
-
-        case 'popup_closed':
-          // FIXME: Payloads are different on different platforms.
-          //  Issue: https://github.com/Telegram-Mini-Apps/tma.js/issues/2
-          if (
-            // Sent on desktop.
-            eventData === undefined
-            // Sent on iOS.
-            || eventData === null
-          ) {
-            return emit(eventType, {});
-          }
-          return emit(eventType, popupClosed().parse(eventData));
-
-        case 'set_custom_style':
-          return emit(eventType, string().parse(eventData));
-
-        case 'qr_text_received':
-          return emit(eventType, qrTextReceived().parse(eventData));
-
-        case 'clipboard_text_received':
-          return emit(eventType, clipboardTextReceived().parse(eventData));
-
-        case 'invoice_closed':
-          return emit(eventType, invoiceClosed().parse(eventData));
-
-        case 'phone_requested':
-          return emit('phone_requested', phoneRequested().parse(eventData));
-
-        case 'custom_method_invoked':
-          return emit('custom_method_invoked', customMethodInvoked().parse(eventData));
-
-        case 'write_access_requested':
-          return emit('write_access_requested', writeAccessRequested().parse(eventData));
-
-        // Events which have no parameters.
-        case 'main_button_pressed':
-        case 'back_button_pressed':
-        case 'settings_button_pressed':
-        case 'scan_qr_popup_closed':
-        case 'reload_iframe':
-          return emit(eventType);
-
-        // All other event listeners will receive unknown type of data.
-        default:
-          return emit(eventType as any, eventData);
-      }
-    } catch (cause) {
-      logger.error('Error processing event:', cause);
-    }
-  });
-
-  return emitter;
-}