@tma.js/sdk 1.4.3 → 1.4.6

package/src/__tests__/globals.ts

@@ -1,39 +0,0 @@
-import { afterEach, describe, expect, it, vi } from 'vitest';
-
-import {
-  logger,
-  setDebug,
-  setTargetOrigin,
-  targetOrigin,
-} from '../globals';
-
-afterEach(() => {
-  vi.restoreAllMocks();
-});
-
-describe('logger', () => {
-  it('should log message in case, debug mode is enabled. Otherwise no output should be shown', () => {
-    const spy = vi
-      .spyOn(console, 'log')
-      .mockImplementation(() => {
-      });
-
-    logger.log(123);
-    expect(spy).not.toHaveBeenCalled();
-
-    setDebug(true);
-    logger.log('Some log');
-    expect(spy).toHaveBeenCalledTimes(1);
-
-    setDebug(false);
-    logger.log('Another log');
-    expect(spy).toHaveBeenCalledTimes(1);
-  });
-});
-
-describe('setTargetOrigin', () => {
-  it('should return set value via targetOrigin() function', () => {
-    setTargetOrigin('my test');
-    expect(targetOrigin()).toEqual('my test');
-  });
-});

package/src/back-button/BackButton.ts

@@ -1,90 +0,0 @@
-import {
-  off,
-  on,
-  type PostEvent,
-  postEvent as defaultPostEvent,
-} from '~/bridge/index.js';
-import { EventEmitter } from '~/event-emitter/index.js';
-import { State } from '~/state/index.js';
-import { createSupportsFunc, type SupportsFunc } from '~/supports/index.js';
-import type { Version } from '~/version/index.js';
-
-import type { BackButtonEvents, BackButtonState } from './types.js';
-
-type Emitter = EventEmitter<BackButtonEvents>;
-
-/**
- * Class which controls the back button displayed in the header of the Mini App in the Telegram
- * interface. It is mostly used in case, when you want to provide a way to go bach in routing
- * history or "rollback" some action.
- */
-export class BackButton {
-  private readonly ee: Emitter = new EventEmitter();
-
-  private readonly state: State<BackButtonState>;
-
-  constructor(
-    isVisible: boolean,
-    version: Version,
-    private readonly postEvent: PostEvent = defaultPostEvent,
-  ) {
-    this.state = new State({ isVisible }, this.ee);
-    this.supports = createSupportsFunc(version, {
-      show: 'web_app_setup_back_button',
-      hide: 'web_app_setup_back_button',
-    });
-  }
-
-  private set isVisible(visible: boolean) {
-    this.state.set('isVisible', visible);
-    this.postEvent('web_app_setup_back_button', { is_visible: visible });
-  }
-
-  /**
-   * True if BackButton is currently visible.
-   */
-  get isVisible(): boolean {
-    return this.state.get('isVisible');
-  }
-
-  /**
-   * Hides the BackButton.
-   */
-  hide(): void {
-    this.isVisible = false;
-  }
-
-  /**
-   * Adds event listener.
-   * @param event - event name.
-   * @param listener - event listener.
-   */
-  on: Emitter['on'] = (event, listener) => (
-    event === 'click'
-      ? on('back_button_pressed', listener)
-      : this.ee.on(event, listener)
-  );
-
-  /**
-   * Removes event listener.
-   * @param event - event name.
-   * @param listener - event listener.
-   */
-  off: Emitter['off'] = (event, listener) => (
-    event === 'click'
-      ? off('back_button_pressed', listener)
-      : this.ee.off(event, listener)
-  );
-
-  /**
-   * Shows the BackButton.
-   */
-  show(): void {
-    this.isVisible = true;
-  }
-
-  /**
-   * Checks if specified method is supported by current component.
-   */
-  supports: SupportsFunc<'show' | 'hide'>;
-}

package/src/back-button/__tests__/BackButton.ts

@@ -1,129 +0,0 @@
-import { describe, expect, it, vi } from 'vitest';
-
-import { BackButton } from '../BackButton';
-
-describe('hide', () => {
-  it('should call "web_app_setup_back_button" method with "is_visible" equal to false', () => {
-    const postEvent = vi.fn();
-    const backButton = new BackButton(false, '', postEvent);
-
-    expect(postEvent).toHaveBeenCalledTimes(0);
-    backButton.hide();
-    expect(postEvent).toHaveBeenCalledTimes(1);
-    expect(postEvent).toHaveBeenCalledWith('web_app_setup_back_button', { is_visible: false });
-  });
-
-  it('should emit "isVisibleChanged" event with false value', () => {
-    const backButton = new BackButton(true, '', vi.fn());
-    const listener = vi.fn();
-
-    backButton.on('change:isVisible', listener);
-    expect(listener).toHaveBeenCalledTimes(0);
-    backButton.hide();
-    expect(listener).toHaveBeenCalledTimes(1);
-    expect(listener).toHaveBeenCalledWith(false);
-  });
-});
-
-describe('show', () => {
-  it('should call "web_app_setup_back_button" method with "is_visible" equal to true', () => {
-    const postEvent = vi.fn();
-    const backButton = new BackButton(false, '', postEvent);
-
-    expect(postEvent).toHaveBeenCalledTimes(0);
-    backButton.show();
-    expect(postEvent).toHaveBeenCalledTimes(1);
-    expect(postEvent).toHaveBeenCalledWith('web_app_setup_back_button', { is_visible: true });
-  });
-
-  it('should emit "isVisibleChanged" event with true value', () => {
-    const backButton = new BackButton(false, '', vi.fn());
-    const listener = vi.fn();
-
-    backButton.on('change:isVisible', listener);
-    expect(listener).toHaveBeenCalledTimes(0);
-    backButton.show();
-    expect(listener).toHaveBeenCalledTimes(1);
-    expect(listener).toHaveBeenCalledWith(true);
-  });
-});
-
-// FIXME
-// it('on', () => {
-//   it('"click" event', () => {
-//    it('should add event listener to bridge\'s '
-//       + '"back_button_pressed" event', () => {
-//       const on = vi.fn();
-//       const backButton = new BackButton({ on } as any, '');
-//       const listener = vi.fn();
-//
-//       expect(on).toHaveBeenCalledTimes(0);
-//       backButton.on('click', listener);
-//       expect(on).toHaveBeenCalledTimes(1);
-//       expect(on).toHaveBeenCalledWith('back_button_pressed', listener);
-//     });
-//   });
-// });
-
-describe('off', () => {
-  // FIXME
-  // it('"click" event', () => {
-  //  it('should remove event listener from bridge\'s '
-  //     + '"back_button_pressed" event', () => {
-  //     const on = vi.fn();
-  //     const off = vi.fn();
-  //     const backButton = new BackButton({ on, off } as any, '');
-  //     const listener = vi.fn();
-  //
-  //     expect(on).toHaveBeenCalledTimes(0);
-  //     backButton.on('click', listener);
-  //     expect(on).toHaveBeenCalledTimes(1);
-  //     expect(on).toHaveBeenCalledWith('back_button_pressed', listener);
-  //
-  //     // TODO: We should probably emit back_button_pressed event to
-  //     //  make sure, listener was removed.
-  //
-  //     expect(off).toHaveBeenCalledTimes(0);
-  //     backButton.off('click', listener);
-  //     expect(off).toHaveBeenCalledTimes(1);
-  //     expect(off).toHaveBeenCalledWith('back_button_pressed', listener);
-  //   });
-  // });
-
-  describe('"isVisibleChanged" event', () => {
-    it('should remove event listener from event', () => {
-      const listener = vi.fn();
-      const backButton = new BackButton(false, '', vi.fn());
-
-      backButton.on('change:isVisible', listener);
-
-      expect(listener).toHaveBeenCalledTimes(0);
-      backButton.show();
-      expect(listener).toHaveBeenCalledTimes(1);
-
-      backButton.off('change:isVisible', listener);
-
-      expect(listener).toHaveBeenCalledTimes(1);
-      backButton.hide();
-      expect(listener).toHaveBeenCalledTimes(1);
-    });
-  });
-});
-
-describe('supports', () => {
-  describe('show / hide', () => {
-    it('should return true in case, BackButton version is 6.1 or higher. False, otherwise', () => {
-      const backButton1 = new BackButton(false, '6.0');
-      expect(backButton1.supports('show')).toBe(false);
-      expect(backButton1.supports('hide')).toBe(false);
-
-      const backButton2 = new BackButton(false, '6.1');
-      expect(backButton2.supports('show')).toBe(true);
-      expect(backButton2.supports('hide')).toBe(true);
-
-      const backButton3 = new BackButton(false, '6.2');
-      expect(backButton3.supports('show')).toBe(true);
-      expect(backButton3.supports('hide')).toBe(true);
-    });
-  });
-});

package/src/back-button/index.ts

@@ -1,2 +0,0 @@
-export * from './BackButton.js';
-export * from './types.js';

package/src/back-button/types.ts

@@ -1,14 +0,0 @@
-import type { MiniAppsEventListener } from '~/bridge/index.js';
-import type { StateEvents } from '~/state/index.js';
-
-export interface BackButtonState {
-  isVisible: boolean;
-}
-
-export interface BackButtonEvents extends StateEvents<BackButtonState> {
-  click: MiniAppsEventListener<'main_button_pressed'>;
-}
-
-export type BackButtonEventName = keyof BackButtonEvents;
-
-export type BackButtonEventListener<E extends BackButtonEventName> = BackButtonEvents[E];

package/src/bridge/__tests__/parseMessage.ts

@@ -1,23 +0,0 @@
-import { it, expect } from 'vitest';
-
-import { parseMessage } from '../parseMessage';
-
-it('should parse value as JSON with properties { eventType: string; eventData?: unknown }', () => {
-  expect(parseMessage({ eventType: 1 })).toEqual({ eventType: '1' });
-  expect(parseMessage({ eventType: 'test' })).toEqual({ eventType: 'test' });
-  expect(parseMessage({ eventType: 'test', eventData: 123 })).toEqual({
-    eventType: 'test',
-    eventData: 123,
-  });
-
-  expect(parseMessage('{"eventType":1}')).toEqual({ eventType: '1' });
-  expect(parseMessage('{"eventType":"test"}')).toEqual({ eventType: 'test' });
-  expect(parseMessage('{"eventType":"test","eventData":123}')).toEqual({
-    eventType: 'test',
-    eventData: 123,
-  });
-});
-
-it('should throw if eventType property is missing', () => {
-  expect(() => parseMessage({})).toThrow();
-});

package/src/bridge/__tests__/request.ts

@@ -1,236 +0,0 @@
-/* eslint-disable */
-import {
-  expect,
-  it,
-  vi,
-  SpyInstance,
-  beforeEach,
-  afterEach,
-  describe,
-  beforeAll,
-  afterAll,
-} from 'vitest';
-
-import { request } from '../request';
-import { type PostEvent, postEvent as globalPostEvent } from '../methods/postEvent';
-import { createWindow } from '../../../test-utils/createWindow';
-import { dispatchWindowMessageEvent } from '../../../test-utils/dispatchWindowMessageEvent';
-
-vi.mock('../methods/postEvent.js', async () => {
-  const { postEvent: actualPostEvent } = await vi
-    .importActual('../methods/postEvent.js') as { postEvent: PostEvent };
-
-  return {
-    postEvent: vi.fn(actualPostEvent),
-  };
-});
-
-let windowSpy: SpyInstance<[], Window & typeof globalThis>;
-
-beforeAll(() => {
-  vi.useFakeTimers();
-});
-
-afterAll(() => {
-  vi.useRealTimers();
-});
-
-beforeEach(() => {
-  windowSpy = createWindow({ env: 'iframe' });
-});
-
-afterEach(() => {
-  windowSpy.mockRestore();
-});
-
-function emptyCatch() {
-
-}
-
-describe('options', () => {
-  describe('timeout', () => {
-    it('should throw an error in case, timeout was reached', () => {
-      const promise = request('web_app_request_phone', 'phone_requested', {
-        timeout: 1000,
-      });
-
-      vi.advanceTimersByTime(1500);
-
-      return promise.catch(emptyCatch).finally(() => {
-        expect(promise).rejects.toEqual(new Error('Async call timeout exceeded. Timeout: 1000'));
-      });
-    });
-
-    it('should not throw an error in case, data was received before timeout', () => {
-      const promise = request('web_app_request_phone', 'phone_requested', {
-        timeout: 1000,
-      });
-
-      vi.advanceTimersByTime(500);
-      dispatchWindowMessageEvent('phone_requested', { status: 'allowed' });
-      vi.advanceTimersByTime(1000);
-
-      return promise.catch(emptyCatch).finally(() => {
-        expect(promise).resolves.toStrictEqual({ status: 'allowed' });
-      });
-    });
-  });
-
-  describe('postEvent', () => {
-    it('should use specified postEvent property', () => {
-      const postEvent = vi.fn();
-      request('web_app_request_phone', 'phone_requested', { postEvent });
-      expect(postEvent).toHaveBeenCalledWith('web_app_request_phone', undefined);
-    });
-
-    it('should use global postEvent function if according property was not specified', () => {
-      request('web_app_request_phone', 'phone_requested');
-      expect(globalPostEvent).toHaveBeenCalledWith('web_app_request_phone', undefined);
-    });
-
-    it('should reject promise in case, postEvent threw an error', () => {
-      const promise = request('web_app_request_phone', 'phone_requested', {
-        postEvent: () => {
-          throw new Error('Nope!');
-        },
-      });
-      expect(promise).rejects.toStrictEqual(Error('Nope!'));
-    });
-  });
-
-  describe('capture', () => {
-    it('should capture an event in case, capture method returned true', () => {
-      const promise = request('web_app_request_phone', 'phone_requested', {
-        timeout: 1000,
-        capture: ({ status }) => status === 'allowed',
-      });
-
-      vi.advanceTimersByTime(500);
-      dispatchWindowMessageEvent('phone_requested', { status: 'allowed' });
-      vi.advanceTimersByTime(1000);
-
-      return promise.catch(emptyCatch).finally(() => {
-        expect(promise).resolves.toStrictEqual({ status: 'allowed' });
-      });
-    });
-
-    it('should not capture an event in case, capture method returned false', () => {
-      const promise = request('web_app_request_phone', 'phone_requested', {
-        timeout: 500,
-        capture: ({ status }) => status === 'allowed',
-      });
-
-      dispatchWindowMessageEvent('phone_requested', { status: 'declined' });
-      vi.advanceTimersByTime(1000);
-
-      return promise.catch(emptyCatch).finally(() => {
-        expect(promise).rejects.toEqual(new Error('Async call timeout exceeded. Timeout: 500'));
-      });
-    });
-  });
-});
-
-describe('with request id', () => {
-  it('should ignore event with the different request id', () => {
-    const promise = request('web_app_read_text_from_clipboard', { req_id: 'a' }, 'clipboard_text_received', {
-      timeout: 1000,
-    });
-
-    dispatchWindowMessageEvent('clipboard_text_received', { req_id: 'b' });
-    vi.advanceTimersByTime(1500);
-
-    return promise.catch(emptyCatch).finally(() => {
-      expect(promise).rejects.toEqual(new Error('Async call timeout exceeded. Timeout: 1000'));
-    });
-  });
-
-  it('should capture event with the same request id', () => {
-    const promise = request('web_app_read_text_from_clipboard', { req_id: 'a' }, 'clipboard_text_received', {
-      timeout: 1000,
-    });
-
-    dispatchWindowMessageEvent('clipboard_text_received', {
-      req_id: 'a',
-      data: 'from clipboard',
-    });
-    vi.advanceTimersByTime(1500);
-
-    return promise.catch(emptyCatch).finally(() => {
-      expect(promise).resolves.toStrictEqual({
-        req_id: 'a',
-        data: 'from clipboard',
-      });
-    });
-  });
-});
-
-describe('multiple events', () => {
-  describe('no params', () => {
-    it('should handle any of the specified events', () => {
-      const promise = request(
-        'web_app_request_phone',
-        ['phone_requested', 'write_access_requested'],
-        { timeout: 1000 },
-      );
-      const promise2 = request(
-        'web_app_request_phone',
-        ['phone_requested', 'write_access_requested'],
-        { timeout: 1000 },
-      );
-
-      dispatchWindowMessageEvent('phone_requested', { status: 'allowed' });
-      dispatchWindowMessageEvent('write_access_requested', { status: 'declined' });
-      vi.advanceTimersByTime(1500);
-
-      return Promise
-        .all([promise, promise2])
-        .catch(emptyCatch)
-        .finally(() => {
-          expect(promise).resolves.toStrictEqual({ status: 'allowed' });
-          expect(promise2).resolves.toStrictEqual({ status: 'declined' });
-        });
-    });
-  });
-
-  describe('with params', () => {
-    it('should handle any of the specified events', () => {
-      const promise = request(
-        'web_app_data_send',
-        { data: 'abc' },
-        ['phone_requested', 'write_access_requested'],
-        { timeout: 1000 },
-      );
-      const promise2 = request(
-        'web_app_data_send',
-        { data: 'abc' },
-        ['phone_requested', 'write_access_requested'],
-        { timeout: 1000 },
-      );
-
-      dispatchWindowMessageEvent('phone_requested', { status: 'allowed' });
-      dispatchWindowMessageEvent('write_access_requested', { status: 'declined' });
-      vi.advanceTimersByTime(1500);
-
-      return Promise
-        .all([promise, promise2])
-        .catch(emptyCatch)
-        .finally(() => {
-          expect(promise).resolves.toStrictEqual({ status: 'allowed' });
-          expect(promise2).resolves.toStrictEqual({ status: 'declined' });
-        });
-    });
-  });
-});
-
-// it('no params methods', () => {
-//  it('should properly handle ')
-// });
-
-// it('with request id', () => {
-//   const promise = request('web_app_read_text_from_clipboard', { req_id: 'a' }, 'clipboard_text_received');
-//
-//   dispatchWindowEvent('clipboard_text_received', { req_id: 'b' });
-//   expect(promise).resolves.toHaveLength(0);
-//   dispatchWindowEvent('clipboard_text_received', { req_id: 'a' });
-//   expect(promise).resolves.toHaveLength(1);
-// });

package/src/bridge/env/__tests__/hasExternalNotify.ts

@@ -1,15 +0,0 @@
-import { expect, it } from 'vitest';
-
-import { hasExternalNotify } from '../hasExternalNotify.js';
-
-it('should return true if passed object contains path property "external.notify" and "notify" is a function property.', () => {
-  expect(hasExternalNotify({})).toBe(false);
-  expect(hasExternalNotify({ external: {} })).toBe(false);
-  expect(hasExternalNotify({ external: { notify: [] } })).toBe(false);
-  expect(hasExternalNotify({
-    external: {
-      notify: () => {
-      },
-    },
-  })).toBe(true);
-});

package/src/bridge/env/__tests__/hasWebviewProxy.ts

@@ -1,15 +0,0 @@
-import { expect, it } from 'vitest';
-
-import { hasWebviewProxy } from '../hasWebviewProxy.js';
-
-it('should return true if passed object contains path property "TelegramWebviewProxy.postEvent" and "postEvent" is a function property.', () => {
-  expect(hasWebviewProxy({})).toBe(false);
-  expect(hasWebviewProxy({ TelegramWebviewProxy: {} })).toBe(false);
-  expect(hasWebviewProxy({ TelegramWebviewProxy: { postEvent: [] } })).toBe(false);
-  expect(hasWebviewProxy({
-    TelegramWebviewProxy: {
-      postEvent: () => {
-      },
-    },
-  })).toBe(true);
-});

package/src/bridge/env/__tests__/isIframe.ts

@@ -1,30 +0,0 @@
-import { afterAll, afterEach, expect, it, vi } from 'vitest';
-
-import { isIframe } from '../isIframe.js';
-
-const windowSpy = vi.spyOn(window, 'window', 'get');
-
-afterEach(() => {
-  windowSpy.mockReset();
-});
-
-afterAll(() => {
-  windowSpy.mockRestore();
-});
-
-it('should return true in case window.self !== window.top. Otherwise, false.', () => {
-  windowSpy.mockImplementation(() => ({ self: 900, top: 1000 }) as any);
-  expect(isIframe()).toBe(true);
-
-  windowSpy.mockImplementation(() => ({ self: 900, top: 900 }) as any);
-  expect(isIframe()).toBe(false);
-});
-
-it('should return true in case window.self getter threw an error', () => {
-  windowSpy.mockImplementation(() => ({
-    get self() {
-      throw new Error();
-    },
-  }) as any);
-  expect(isIframe()).toBe(true);
-});

package/src/bridge/env/hasExternalNotify.ts

@@ -1,19 +0,0 @@
-import { isRecord } from '~/misc/index.js';
-
-type WithExternalNotify<T> = T & {
-  external: {
-    notify: (...args: any) => any;
-  };
-};
-
-/**
- * Returns true in case, passed value contains path `external.notify` property and `notify` is a
- * function.
- * @param value - value to check.
- */
-export function hasExternalNotify<T extends {}>(value: T): value is WithExternalNotify<T> {
-  return 'external' in value
-    && isRecord(value.external)
-    && 'notify' in value.external
-    && typeof value.external.notify === 'function';
-}

package/src/bridge/env/hasWebviewProxy.ts

@@ -1,19 +0,0 @@
-import { isRecord } from '~/misc/index.js';
-
-type WithWebviewProxy<T> = T & {
-  TelegramWebviewProxy: {
-    postEvent: (...args: any) => any;
-  }
-};
-
-/**
- * Returns true in case, passed value contains path `TelegramWebviewProxy.postEvent` property and
- * `postEvent` is a function.
- * @param value - value to check.
- */
-export function hasWebviewProxy<T extends {}>(value: T): value is WithWebviewProxy<T> {
-  return 'TelegramWebviewProxy' in value
-    && isRecord(value.TelegramWebviewProxy)
-    && 'postEvent' in value.TelegramWebviewProxy
-    && typeof value.TelegramWebviewProxy.postEvent === 'function';
-}

package/src/bridge/env/index.ts

@@ -1,3 +0,0 @@
-export * from './hasExternalNotify.js';
-export * from './hasWebviewProxy.js';
-export * from './isIframe.js';

package/src/bridge/env/isIframe.ts

@@ -1,11 +0,0 @@
-/**
- * Returns true in case, current environment is iframe.
- * @see https://stackoverflow.com/a/326076
- */
-export function isIframe(): boolean {
-  try {
-    return window.self !== window.top;
-  } catch (e) {
-    return true;
-  }
-}

package/src/bridge/errors/MethodUnsupportedError.ts

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