@tma.js/sdk 1.4.3 → 1.4.6

package/src/popup/__tests__/Popup.ts

@@ -1,130 +0,0 @@
-import { describe, expect, it } from 'vitest';
-
-// import {emitDesktopEvent, mockDesktop} from '../../../tests';
-// import { Popup } from './Popup';
-// import {Bridge} from '@tma.js/bridge';
-// import {PopupParams} from './types';
-// import {preparePopupParams} from './utils';
-
-// beforeAll(mockDesktop);
-
-describe('components', () => {
-  describe('Popup', () => {
-    it('should be fine', () => {
-      expect(true).toBe(true);
-    });
-    // it('isOpened', () => {
-    //  it('should emit event "openChange" with specified value in setter', () => {
-    //     const popup = new Popup('7');
-    //     const spy = vi.spyOn((popup as any).ee, 'emit');
-    //     (popup as any).isOpened = true;
-    //     expect(spy).lastCalledWith('openChange', true);
-    //
-    //     (popup as any).isOpened = false;
-    //     expect(spy).lastCalledWith('openChange', false);
-    //   });
-    // });
-    //
-    // it('show', () => {
-    //  it('should throw an error in case, current version is less than 6.2', () => {
-    //     expect(() => new Popup('6.1').show({message: 'Hey!'})).toThrow();
-    //     expect(() => new Popup('6.2').show({message: 'Hey!'})).not.toThrow();
-    //   });
-    //
-    //  it('should call bridge event "web_app_open_popup" with prepared parameters', () => {
-    //     const bridge = new Bridge();
-    //     const spy = vi.spyOn(bridge, 'postEvent');
-    //     const popup = new Popup('7', {bridge});
-    //     const params: PopupParams = {message: 'Message'};
-    //     const prepared = preparePopupParams(params);
-    //     popup.show(params);
-    //     expect(spy).toHaveBeenCalledWith('web_app_open_popup', prepared);
-    //   });
-    //
-    //  it('should emit event "open" with prepared params', () => {
-    //     const popup = new Popup('7');
-    //     const spy = vi.spyOn((popup as any).ee, 'emit');
-    //     const params: PopupParams = {message: 'Message'};
-    //     const prepared = preparePopupParams(params);
-    //     popup.show(params);
-    //     expect(spy).toHaveBeenCalledWith('open', prepared);
-    //   });
-    //
-    //  it('should set "isOpened" property to true', () => {
-    //     const popup = new Popup('7');
-    //     expect(popup.isOpened).toBe(false);
-    //     popup.show({message: 'Message'});
-    //     expect(popup.isOpened).toBe(true);
-    //   });
-    //
-    //  it('should set "isOpened" property to false when promise is resolved', async () => {
-    //     const popup = new Popup('7');
-    //     const promise = popup.show({message: 'Message'});
-    //
-    //     emitDesktopEvent('popup_closed', {button_id: null});
-    //     await promise;
-    //     expect(popup.isOpened).toBe(false);
-    //   });
-    //
-    //  it('should set "isOpened" property to true', () => {
-    //     const popup = new Popup('7');
-    //     popup.show({message: 'Message'});
-    //     expect(popup.isOpened).toBe(true);
-    //   });
-    //
-    //  it('should emit close event with specified button_id when promise is resolved',
-    //   async () => {
-    //     const popup = new Popup('7');
-    //     const spy = vi.spyOn((popup as any).ee, 'emit');
-    //     const promise = popup.show({message: 'Message'});
-    //     emitDesktopEvent('popup_closed', {button_id: 'Hey!'});
-    //     await promise;
-    //     expect(spy).lastCalledWith('close', 'Hey!');
-    //   });
-    // });
-    //
-    // it('showAlert', () => {
-    //  it('should call "show" with passed message and buttons = [{type: "close"}]', () => {
-    //     const popup = new Popup('7');
-    //     const spy = vi.spyOn(popup, 'show');
-    //
-    //     popup.showAlert('Message');
-    //
-    //     expect(spy).toHaveBeenCalledWith({
-    //       message: 'Message',
-    //       buttons: [{type: 'close'}],
-    //     });
-    //   });
-    // });
-    //
-    // it('showConfirm', () => {
-    //  test(
-    //     'should call "show" with passed message and ' +
-    //     'buttons = [{type: "ok", id: "ok"}, {id: "cancel", type: "cancel"}]',
-    //     () => {
-    //       const popup = new Popup('7');
-    //       const spy = vi.spyOn(popup, 'show');
-    //
-    //       popup.showConfirm('Message');
-    //
-    //       expect(spy).toHaveBeenCalledWith({
-    //         message: 'Message',
-    //         buttons: [{type: 'ok', id: 'ok'}, {id: 'cancel', type: 'cancel'}],
-    //       });
-    //     },
-    //   );
-    //
-    //  it('should resolve true in case, user pressed button with id "ok"', async () => {
-    //     const promise = new Popup('7').showConfirm('Message');
-    //     emitDesktopEvent('popup_closed', {button_id: 'ok'});
-    //     expect(await promise).toBe(true);
-    //   });
-    //
-    //  it('should resolve false in case, user pressed any other button', async () => {
-    //     const promise = new Popup('7').showConfirm('Message');
-    //     emitDesktopEvent('popup_closed', {button_id: 'cancel'});
-    //     await expect(promise).resolves.toBe(false);
-    //   });
-    // });
-  });
-});

package/src/popup/__tests__/preparePopupParams.ts

@@ -1,85 +0,0 @@
-import { expect, it } from 'vitest';
-
-import { preparePopupParams } from '../preparePopupParams';
-
-/**
- * Creates test text.
- * @param length - text length.
- */
-function createText(length: number): string {
-  return new Array(length).fill('a').join('');
-}
-
-it('should throw an error in case, title length is more than 64 symbols', () => {
-  expect(() => preparePopupParams({
-    title: createText(65),
-    message: 'Hey!',
-  })).toThrow(/^Title has incorrect size/);
-
-  expect(() => preparePopupParams({
-    title: createText(64),
-    message: 'Hey!',
-  })).not.toThrow();
-});
-
-it('should throw an error in case, message length is zero or more than 256 symbols', () => {
-  expect(() => preparePopupParams({
-    message: '',
-  })).toThrow(/^Message has incorrect size/);
-
-  expect(() => preparePopupParams({
-    message: createText(257),
-  })).toThrow(/^Message has incorrect size/);
-
-  expect(() => preparePopupParams({
-    message: createText(256),
-  })).not.toThrow();
-});
-
-it('should throw an error in case, buttons count is more than 3', () => {
-  expect(() => preparePopupParams({
-    message: 'a',
-    buttons: new Array(4).fill({ type: 'close' }),
-  })).toThrow(/^Buttons have incorrect size/);
-
-  expect(() => preparePopupParams({
-    message: 'a',
-    buttons: new Array(3).fill({ type: 'close' }),
-  })).not.toThrow();
-});
-
-it('should append button type "close" in case, buttons array is empty', () => {
-  expect(preparePopupParams({ message: 'a' }).buttons).toStrictEqual([{
-    type: 'close',
-    id: '',
-  }]);
-});
-
-it('should throw an error in case, some button text length size is zero or more than 64 symbols', () => {
-  expect(() => preparePopupParams({
-    message: 'A',
-    buttons: [{ type: 'default', text: createText(65) }],
-  })).toThrowError(/^Button text with type/);
-
-  expect(() => preparePopupParams({
-    message: 'A',
-    buttons: [{ type: 'default', text: '' }],
-  })).toThrowError(/^Button text with type/);
-
-  expect(() => preparePopupParams({
-    message: 'A',
-    buttons: [{ type: 'default', text: createText(64) }],
-  })).not.toThrow();
-});
-
-it('should fulfill all optional popup parameters', () => {
-  expect(preparePopupParams({
-    message: 'Message',
-    buttons: [{ type: 'default', text: 'Wow!' }, { type: 'close' }],
-  }))
-    .toStrictEqual({
-      title: '',
-      message: 'Message',
-      buttons: [{ id: '', type: 'default', text: 'Wow!' }, { type: 'close', id: '' }],
-    });
-});

package/src/popup/index.ts

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

package/src/popup/preparePopupParams.ts

@@ -1,59 +0,0 @@
-import type { PopupButton, PopupParams as BridgePopupParams } from '~/bridge/index.js';
-
-import type { OpenPopupOptions } from './types.js';
-
-/**
- * Prepares popup parameters before sending them to native app.
- * @param params - popup parameters.
- */
-export function preparePopupParams(params: OpenPopupOptions): BridgePopupParams {
-  const message = params.message.trim();
-  const title = (params.title || '').trim();
-  const buttons = params.buttons || [];
-  let preparedButtons: PopupButton[];
-
-  // Check title.
-  if (title.length > 64) {
-    throw new Error(`Title has incorrect size: ${title.length}`);
-  }
-
-  // Check message.
-  if (message.length === 0 || message.length > 256) {
-    throw new Error(`Message has incorrect size: ${message.length}`);
-  }
-
-  // Check buttons.
-  if (buttons.length > 3) {
-    throw new Error(`Buttons have incorrect size: ${buttons.length}`);
-  }
-
-  // Append button in case, there are no buttons passed.
-  if (buttons.length === 0) {
-    preparedButtons = [{ type: 'close', id: '' }];
-  } else {
-    // Otherwise, check all the buttons.
-    preparedButtons = buttons.map((b) => {
-      const { id = '' } = b;
-
-      // Check button ID.
-      if (id.length > 64) {
-        throw new Error(`Button ID has incorrect size: ${id}`);
-      }
-
-      if (b.type === undefined || b.type === 'default' || b.type === 'destructive') {
-        const text = b.text.trim();
-
-        if (text.length === 0 || text.length > 64) {
-          const type = b.type || 'default';
-
-          throw new Error(`Button text with type "${type}" has incorrect size: ${b.text.length}`);
-        }
-
-        return { ...b, text, id };
-      }
-
-      return { ...b, id };
-    });
-  }
-  return { title, message, buttons: preparedButtons };
-}

package/src/popup/types.ts

@@ -1,69 +0,0 @@
-import type { StateEvents } from '~/state/index.js';
-
-export interface PopupState {
-  isOpened: boolean;
-}
-
-export type PopupEvents = StateEvents<PopupState>;
-
-export type PopupEventName = keyof PopupEvents;
-
-export type PopupEventListener<E extends PopupEventName> = PopupEvents[E];
-
-/**
- * This object describes the native popup.
- * @see https://core.telegram.org/bots/webapps#popupparams
- */
-export interface OpenPopupOptions {
-  /**
-   * The text to be displayed in the popup title, 0-64 characters.
-   * @default ""
-   */
-  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.
-   * @default [{type: 'close'}]
-   */
-  buttons?: OpenPopupOptionsButton[];
-}
-
-/**
- * This object describes the native popup button.
- * @see https://core.telegram.org/bots/webapps#popupbutton
- */
-export type OpenPopupOptionsButton = {
-  /**
-   * Identifier of the button, 0-64 characters.
-   * @default ""
-   */
-  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/qr-scanner/QRScanner.ts

@@ -1,95 +0,0 @@
-import {
-  type PostEvent,
-  postEvent as defaultPostEvent,
-  request,
-} 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 { QRScannerEvents, QRScannerState } from './types.js';
-
-/**
- * Provides QR scanner functionality.
- */
-export class QRScanner {
-  private readonly ee = new EventEmitter<QRScannerEvents>();
-
-  private readonly state: State<QRScannerState>;
-
-  constructor(
-    version: Version,
-    private readonly postEvent: PostEvent = defaultPostEvent,
-  ) {
-    this.state = new State({ isOpened: false }, this.ee);
-    this.supports = createSupportsFunc(version, {
-      close: 'web_app_close_scan_qr_popup',
-      open: 'web_app_open_scan_qr_popup',
-    });
-  }
-
-  /**
-   * Closes scanner.
-   */
-  close(): void {
-    this.postEvent('web_app_close_scan_qr_popup');
-    this.isOpened = false;
-  }
-
-  private set isOpened(value) {
-    this.state.set('isOpened', value);
-  }
-
-  /**
-   * Returns true in case, QR scanner is currently opened.
-   */
-  get isOpened(): boolean {
-    return this.state.get('isOpened');
-  }
-
-  /**
-   * Opens scanner with specified title shown to user. Method returns promise
-   * with scanned QR content in case, it was scanned. It will contain null in
-   * case, scanner was closed.
-   * @param text - title to display.
-   */
-  async open(text?: string): Promise<string | null> {
-    if (this.isOpened) {
-      throw new Error('QR scanner is already opened.');
-    }
-
-    this.isOpened = true;
-
-    try {
-      const result = await request(
-        'web_app_open_scan_qr_popup',
-        { text },
-        ['qr_text_received', 'scan_qr_popup_closed'],
-        { postEvent: this.postEvent },
-      );
-
-      return typeof result === 'object' && typeof result.data === 'string' ? result.data : null;
-    } finally {
-      this.isOpened = false;
-    }
-  }
-
-  /**
-   * Adds new event listener.
-   */
-  on = this.ee.on.bind(this.ee);
-
-  /**
-   * Removes event listener.
-   */
-  off = this.ee.off.bind(this.ee);
-
-  /**
-   * Checks if specified method is supported by current component.
-   */
-  supports: SupportsFunc<'open' | 'close'>;
-}

package/src/qr-scanner/index.ts

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

package/src/qr-scanner/types.ts

@@ -1,11 +0,0 @@
-import type { StateEvents } from '~/state/index.js';
-
-export interface QRScannerState {
-  isOpened: boolean;
-}
-
-export type QRScannerEvents = StateEvents<QRScannerState>;
-
-export type QRScannerEventName = keyof QRScannerEvents;
-
-export type QRScannerEventListener<E extends QRScannerEventName> = QRScannerEvents[E];

package/src/settings-button/SettingsButton.ts

@@ -1,85 +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 { SettingsButtonEvents, SettingsButtonState } from './types.js';
-
-type Emitter = EventEmitter<SettingsButtonEvents>;
-
-export class SettingsButton {
-  private readonly ee: Emitter = new EventEmitter();
-
-  private readonly state: State<SettingsButtonState>;
-
-  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_settings_button',
-      hide: 'web_app_setup_settings_button',
-    });
-  }
-
-  private set isVisible(visible: boolean) {
-    this.state.set('isVisible', visible);
-    this.postEvent('web_app_setup_settings_button', { is_visible: visible });
-  }
-
-  /**
-   * True if SettingsButton is currently visible.
-   */
-  get isVisible(): boolean {
-    return this.state.get('isVisible');
-  }
-
-  /**
-   * Hides the SettingsButton.
-   */
-  hide(): void {
-    this.isVisible = false;
-  }
-
-  /**
-   * Adds event listener.
-   * @param event - event name.
-   * @param listener - event listener.
-   */
-  on: Emitter['on'] = (event, listener) => (
-    event === 'click'
-      ? on('settings_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('settings_button_pressed', listener)
-      : this.ee.off(event, listener)
-  );
-
-  /**
-   * Shows the SettingsButton.
-   */
-  show(): void {
-    this.isVisible = true;
-  }
-
-  /**
-   * Checks if specified method is supported by current component.
-   */
-  supports: SupportsFunc<'show' | 'hide'>;
-}

package/src/settings-button/index.ts

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

package/src/settings-button/types.ts

@@ -1,15 +0,0 @@
-import type { MiniAppsEventListener } from '~/bridge/index.js';
-import type { StateEvents } from '~/state/index.js';
-
-export interface SettingsButtonState {
-  isVisible: boolean;
-}
-
-export interface SettingsButtonEvents extends StateEvents<SettingsButtonState> {
-  click: MiniAppsEventListener<'settings_button_pressed'>;
-}
-
-export type SettingsButtonEventName = keyof SettingsButtonEvents;
-
-export type SettingsButtonEventListener<E extends SettingsButtonEventName> =
-  SettingsButtonEvents[E];

package/src/state/State.ts

@@ -1,67 +0,0 @@
-import type { EventEmitter } from '~/event-emitter/index.js';
-import type { StringKeys } from '~/types/index.js';
-
-import type { StateEvents } from './types.js';
-
-/**
- * Represents state which is observable via passed EventEmitter.
- */
-export class State<S extends object> {
-  constructor(
-    private readonly state: S,
-    private readonly ee: Pick<EventEmitter<StateEvents<S>>, 'on' | 'off' | 'emit'>,
-  ) {
-  }
-
-  private internalSet<K extends StringKeys<S>>(key: K, value: S[K]): boolean {
-    if (this.state[key] === value || value === undefined) {
-      return false;
-    }
-
-    this.state[key] = value;
-    (this.ee as any).emit(`change:${key}`, value);
-
-    return true;
-  }
-
-  /**
-   * Returns copy of current state.
-   */
-  clone(): S {
-    return { ...this.state };
-  }
-
-  /**
-   * Sets value by key.
-   * @param key - state key.
-   * @param value - value to set.
-   */
-  set<K extends StringKeys<S>>(key: K, value: S[K]): void;
-  set(state: Partial<S>): void;
-  set(keyOrState: StringKeys<S> | Partial<S>, value?: S[keyof S]): void {
-    let didChange = false;
-
-    if (typeof keyOrState === 'string') {
-      didChange = this.internalSet(keyOrState, value as any);
-    } else {
-      // eslint-disable-next-line
-      for (const key in keyOrState) {
-        if (this.internalSet(key, keyOrState[key] as any)) {
-          didChange = true;
-        }
-      }
-    }
-
-    if (didChange) {
-      (this.ee as any).emit('change');
-    }
-  }
-
-  /**
-   * Returns value by specified key.
-   * @param key - state key.
-   */
-  get<K extends StringKeys<S>>(key: K): S[K] {
-    return this.state[key];
-  }
-}

package/src/state/index.ts

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

package/src/state/types.ts

@@ -1,31 +0,0 @@
-import type { StringKeys } from '~/types/index.js';
-
-/**
- * Computes state property changed event.
- */
-export type PropChangedEvent<K extends string> = `change:${K}`;
-
-/**
- * Extracts state property type by its computed change event name.
- */
-export type PropertyType<State extends object, Event extends string> = {
-  [Key in StringKeys<State>]: Event extends PropChangedEvent<Key> ? State[Key] : never;
-}[StringKeys<State>];
-
-/**
- * Creates map, where key is event name which is used, when state property was changed.
- * Value is according listener.
- */
-export type PropChangedEventsMap<State extends object> = {
-  [Event in PropChangedEvent<StringKeys<State>>]: (value: PropertyType<State, Event>) => void;
-};
-
-/**
- * Creates map with all events emitted by state.
- */
-export type StateEvents<State extends object> = PropChangedEventsMap<State> & {
-  /**
-   * Being called whenever any property was updated.
-   */
-  change: () => void;
-};