@tma.js/sdk 1.4.4 → 1.4.6

package/src/event-emitter/EventEmitter.ts

@@ -1,146 +0,0 @@
-import type {
-  AnySubscribeListener,
-  EmptyEventName,
-  EventListener, EventName,
-  EventParams, NonEmptyEventName, RemoveEventListener,
-} from './types.js';
-
-type AddedEventListener = [listener: EventListener<any>, once: boolean];
-
-/**
- * Opinionated event emitter implementation.
- */
-export class EventEmitter<Schema> {
-  private readonly listeners: Map<string, AddedEventListener[]> = new Map();
-
-  private readonly subscribeListeners: AnySubscribeListener<Schema>[] = [];
-
-  /**
-   * Adds specified event listener.
-   * @param event - event name.
-   * @param listener - event listener.
-   * @param once - should listener called only once.
-   */
-  private addListener<E extends EventName<Schema>>(
-    event: E,
-    listener: EventListener<Schema[E]>,
-    once: boolean,
-  ): RemoveEventListener {
-    let listeners = this.listeners.get(event);
-    if (!listeners) {
-      listeners = [];
-      this.listeners.set(event, listeners);
-    }
-
-    listeners.push([listener, once]);
-
-    return () => this.off(event, listener);
-  }
-
-  /**
-   * Emits known event which has no parameters.
-   * @param event - event name.
-   */
-  emit<E extends EmptyEventName<Schema>>(event: E): void;
-
-  /**
-   * Emits known event which has parameters.
-   * @param event - event name.
-   * @param args - list of event listener arguments.
-   */
-  emit<E extends NonEmptyEventName<Schema>>(
-    event: E,
-    ...args: EventParams<Schema[E]>
-  ): void;
-
-  emit(event: EventName<Schema>, ...args: any[]): void {
-    this.subscribeListeners.forEach((l) => (l as any)(event, ...args));
-
-    const listeners = this.listeners.get(event);
-    if (!listeners) {
-      return;
-    }
-
-    listeners.forEach(([listener, once], idx) => {
-      listener(...args);
-      if (once) {
-        listeners.splice(idx, 1);
-      }
-    });
-  }
-
-  /**
-   * Adds event listener.
-   * @param event - event name.
-   * @param listener - event listener.
-   * @returns Function to remove event listener.
-   */
-  on<E extends EventName<Schema>>(
-    event: E,
-    listener: EventListener<Schema[E]>,
-  ): RemoveEventListener {
-    return this.addListener(event, listener, false);
-  }
-
-  /**
-   * Adds event listener following the logic, described in `on` method, but calls specified
-   * listener only once, removing it after.
-   * @param event - event name.
-   * @param listener - event listener.
-   * @returns Function to remove event listener.
-   * @see on
-   */
-  once<E extends EventName<Schema>>(
-    event: E,
-    listener: EventListener<Schema[E]>,
-  ): RemoveEventListener {
-    return this.addListener(event, listener, true);
-  }
-
-  /**
-   * Removes event listener. In case, specified listener was bound several times, it removes
-   * only a single one.
-   * @param event - event name.
-   * @param listener - event listener.
-   */
-  off<E extends EventName<Schema>>(event: E, listener: EventListener<Schema[E]>): void {
-    const listeners = this.listeners.get(event);
-    if (!listeners) {
-      return;
-    }
-
-    for (let i = 0; i < listeners.length; i += 1) {
-      if (listener === listeners[i][0]) {
-        listeners.splice(i, 1);
-        return;
-      }
-    }
-  }
-
-  /**
-   * Adds event listener to all events.
-   * @param listener - events listener.
-   * @returns Function to remove event listener.
-   * @see on
-   * @see once
-   */
-  subscribe(listener: AnySubscribeListener<Schema>): RemoveEventListener {
-    this.subscribeListeners.push(listener);
-    return () => this.unsubscribe(listener);
-  }
-
-  /**
-   * Removes global event listener. In case, specified listener was bound several times, it removes
-   * only a single one.
-   * @param listener - events listener.
-   * @returns Function to remove event listener.
-   */
-  unsubscribe(listener: AnySubscribeListener<Schema>): void {
-    for (let i = 0; i < this.subscribeListeners.length; i += 1) {
-      if (this.subscribeListeners[i] === listener) {
-        this.subscribeListeners.splice(i, 1);
-        return;
-      }
-    }
-  }
-}

package/src/event-emitter/__tests__/EventEmitter.ts

@@ -1,145 +0,0 @@
-import { beforeEach, describe, expect, it, vi } from 'vitest';
-
-import { EventEmitter } from '../EventEmitter';
-
-interface EventsMap {
-  test: (a: number, b: boolean) => void;
-  hey: never;
-}
-
-let ee: EventEmitter<EventsMap>;
-
-beforeEach(() => {
-  ee = new EventEmitter<EventsMap>();
-});
-
-describe('on', () => {
-  it('should emit bound listener with specified arguments', () => {
-    const listener = vi.fn();
-    ee.on('test', listener);
-    ee.emit('test', 1, true);
-    expect(listener).toHaveBeenCalledOnce();
-    expect(listener).toBeCalledWith(1, true);
-  });
-
-  it('should emit bound listener with specified arguments as many times as it was bound', () => {
-    const listener = vi.fn();
-    ee.on('test', listener);
-    ee.on('test', listener);
-    ee.emit('test', 1, true);
-    expect(listener).toHaveBeenCalledTimes(2);
-    expect(listener).toHaveBeenNthCalledWith(1, 1, true);
-    expect(listener).toHaveBeenNthCalledWith(2, 1, true);
-  });
-
-  it('should not emit bound listener in case, event name does not match', () => {
-    const listener = vi.fn();
-    ee.on('test', listener);
-    ee.emit('hey');
-    expect(listener).not.toBeCalled();
-  });
-
-  it('should remove listener if returned function was called', () => {
-    const listener = vi.fn();
-    const off = ee.on('test', listener);
-
-    off();
-    ee.emit('test', 1, true);
-    expect(listener).not.toBeCalled();
-  });
-});
-
-describe('once', () => {
-  it('should emit bound listener with specified arguments only once', () => {
-    const listener = vi.fn();
-    ee.once('test', listener);
-    ee.emit('test', 1, true);
-    ee.emit('test', 1, true);
-    ee.emit('test', 1, true);
-    expect(listener).toHaveBeenCalledOnce();
-    expect(listener).toBeCalledWith(1, true);
-  });
-
-  it('should emit bound listener with specified arguments as many times as it was bound', () => {
-    const listener = vi.fn();
-    ee.once('test', listener);
-    ee.once('test', listener);
-    ee.emit('test', 1, true);
-    ee.emit('test', 1, true);
-    expect(listener).toHaveBeenCalledTimes(2);
-    expect(listener).toHaveBeenNthCalledWith(1, 1, true);
-    expect(listener).toHaveBeenNthCalledWith(2, 1, true);
-  });
-
-  it('should not emit bound listener in case, event name does not match', () => {
-    const listener = vi.fn();
-    ee.once('test', listener);
-    ee.emit('hey');
-    expect(listener).not.toBeCalled();
-  });
-
-  it('should remove listener if returned function was called', () => {
-    const listener = vi.fn();
-    const off = ee.once('test', listener);
-
-    off();
-    ee.emit('test', 1, true);
-    expect(listener).not.toBeCalled();
-  });
-});
-
-describe('off', () => {
-  it('should not emit bound listener in case, it was unbound', () => {
-    const listener = vi.fn();
-    ee.on('test', listener);
-    ee.off('test', listener);
-    ee.emit('test', 1, true);
-    expect(listener).not.toBeCalled();
-  });
-
-  it('should not do anything in case, event has no listeners', () => {
-    expect(() => {
-      const listener = vi.fn();
-      ee.off('test', listener);
-    }).not.toThrow();
-  });
-
-  it('should remove event listener bound via "once" method', () => {
-    const listener = vi.fn();
-    ee.once('test', listener);
-    ee.off('test', listener);
-    ee.emit('test', 1, true);
-    expect(listener).not.toBeCalled();
-  });
-
-  it('should not do anything if received not bound listener', () => {
-    ee.on('test', vi.fn());
-    expect(() => ee.off('test', vi.fn())).not.toThrow();
-  });
-});
-
-describe('subscribe', () => {
-  it('should catch any emitted event', () => {
-    const listener = vi.fn();
-    ee.subscribe(listener);
-    ee.emit('test', 1, true);
-    ee.emit('hey');
-    expect(listener).toBeCalledTimes(2);
-    expect(listener).toHaveBeenNthCalledWith(1, 'test', 1, true);
-    expect(listener).toHaveBeenNthCalledWith(2, 'hey');
-  });
-});
-
-describe('unsubscribe', () => {
-  it('should not emit event if it was unbound', () => {
-    const listener = vi.fn();
-    ee.subscribe(listener);
-    ee.unsubscribe(listener);
-    ee.emit('test', 1, true);
-    expect(listener).not.toBeCalled();
-  });
-
-  it('should not do anything if received not bound listener', () => {
-    expect(() => ee.unsubscribe(vi.fn())).not.toThrow();
-  });
-});

package/src/event-emitter/index.ts

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

package/src/event-emitter/types.ts

@@ -1,60 +0,0 @@
-import type { IsNever } from '~/types/index.js';
-
-/**
- * Function accepting the list of passed arguments and returning nothing.
- */
-type VoidFunc<Args extends any[] = []> = (...args: Args) => void;
-
-/**
- * Accepts type assuming, it is responsible for describing event listener
- * parameters. Covers following cases:
- * 1. If function is passed, return its arguments.
- * 2. If never or void is passed, return empty tuple.
- * 3. If array is passed return this type.
- * 4. Otherwise, return tuple with passed type.
- */
-export type EventParams<Params> = Params extends any[]
-  ? Params
-  : Params extends (...args: any[]) => any
-    ? Parameters<Params>
-    : IsNever<Params> extends true
-      ? []
-      : Params extends void
-        ? []
-        : [Params];
-
-/**
- * Returns function that represents event listener with specified
- * list of parameters.
- */
-export type EventListener<Params> = VoidFunc<EventParams<Params>>;
-
-/**
- * Returns event names.
- */
-export type EventName<Schema> = Extract<keyof Schema, string>;
-
-/**
- * Returns event names which do not require any arguments.
- */
-export type EmptyEventName<Schema> = {
-  [E in EventName<Schema>]: EventParams<Schema[E]> extends [] ? E : never;
-}[EventName<Schema>];
-
-/**
- * Returns event names which require arguments.
- */
-export type NonEmptyEventName<Schema> =
-  Exclude<EventName<Schema>, EmptyEventName<Schema>>;
-
-/**
- * Represents any listener, which could be used in EventEmitter.subscribe.
- */
-export type AnySubscribeListener<Schema> = {
-  [E in keyof Schema]: (event: E, ...args: EventParams<Schema[E]>) => void;
-}[keyof Schema];
-
-/**
- * Function which removes event listener.
- */
-export type RemoveEventListener = () => void;

package/src/globals.ts

@@ -1,38 +0,0 @@
-import { Logger } from '~/logger/index.js';
-
-let currentTargetOrigin = 'https://web.telegram.org';
-
-export const logger = new Logger('[SDK]', false);
-
-/**
- * Sets new debug mode. Enabling debug mode leads to printing
- * additional messages in console, related to the processes
- * inside the package.
- * @param value - should debug mode be enabled.
- */
-export function setDebug(value: boolean): void {
-  if (value) {
-    logger.enable();
-    return;
-  }
-  logger.disable();
-}
-
-/**
- * Sets new global targetOrigin, used by `postEvent` method.
- * Default value is "https://web.telegram.org". You don't need to
- * use this method until you know what you are doing.
- *
- * This method could be used for test purposes.
- * @param value - new target origin.
- */
-export function setTargetOrigin(value: string): void {
-  currentTargetOrigin = value;
-}
-
-/**
- * Returns current global target origin.
- */
-export function targetOrigin(): string {
-  return currentTargetOrigin;
-}

package/src/haptic-feedback/HapticFeedback.ts

@@ -1,70 +0,0 @@
-import {
-  type ImpactHapticFeedbackStyle,
-  type NotificationHapticFeedbackType,
-  type PostEvent,
-  postEvent as defaultPostEvent,
-} from '~/bridge/index.js';
-import {
-  createSupportsFunc,
-  type SupportsFunc,
-} from '~/supports/index.js';
-import type { Version } from '~/version/index.js';
-
-/**
- * Class which controls haptic feedback. It allows calling different types of
- * haptic notifications which usually occur after user interaction with
- * application.
- */
-export class HapticFeedback {
-  constructor(
-    version: Version,
-    private readonly postEvent: PostEvent = defaultPostEvent,
-  ) {
-    this.supports = createSupportsFunc(version, {
-      impactOccurred: 'web_app_trigger_haptic_feedback',
-      notificationOccurred: 'web_app_trigger_haptic_feedback',
-      selectionChanged: 'web_app_trigger_haptic_feedback',
-    });
-  }
-
-  /**
-   * A method tells that an impact occurred. The Telegram app may play the
-   * appropriate haptics based on style value passed.
-   * @param style - impact style.
-   */
-  impactOccurred(style: ImpactHapticFeedbackStyle): void {
-    this.postEvent('web_app_trigger_haptic_feedback', {
-      type: 'impact',
-      impact_style: style,
-    });
-  }
-
-  /**
-   * A method tells that a task or action has succeeded, failed, or produced
-   * a warning. The Telegram app may play the appropriate haptics based on
-   * type value passed.
-   * @param type - notification type.
-   */
-  notificationOccurred(type: NotificationHapticFeedbackType): void {
-    this.postEvent('web_app_trigger_haptic_feedback', {
-      type: 'notification',
-      notification_type: type,
-    });
-  }
-
-  /**
-   * A method tells that the user has changed a selection. The Telegram app
-   * may play the appropriate haptics.
-   *
-   * Do not use this feedback when the user makes or confirms a selection;
-   * use it only when the selection changes.
-   */
-  selectionChanged(): void {
-    this.postEvent('web_app_trigger_haptic_feedback', { type: 'selection_change' });
-  }
-
-  /**
-   * Checks if specified method is supported by current component.
-   */
-  supports: SupportsFunc<'impactOccurred' | 'notificationOccurred' | 'selectionChanged'>;
-}

package/src/haptic-feedback/__tests__/HapticFeedback.ts

@@ -1,68 +0,0 @@
-import { describe, expect, it, vi } from 'vitest';
-
-import { HapticFeedback } from '../HapticFeedback';
-
-describe('impactOccurred', () => {
-  it('should call "web_app_trigger_haptic_feedback" method with { type: "impact", style: {{style}} }', () => {
-    const postEvent = vi.fn();
-    const haptic = new HapticFeedback('', postEvent);
-
-    expect(postEvent).toHaveBeenCalledTimes(0);
-    haptic.impactOccurred('heavy');
-    expect(postEvent).toHaveBeenCalledTimes(1);
-    expect(postEvent).toHaveBeenCalledWith('web_app_trigger_haptic_feedback', {
-      type: 'impact',
-      impact_style: 'heavy',
-    });
-  });
-});
-
-describe('notificationOccurred', () => {
-  it('should call "web_app_trigger_haptic_feedback" method with { type: "notification", notification_type: {{type}} }', () => {
-    const postEvent = vi.fn();
-    const haptic = new HapticFeedback('', postEvent);
-
-    expect(postEvent).toHaveBeenCalledTimes(0);
-    haptic.notificationOccurred('success');
-    expect(postEvent).toHaveBeenCalledTimes(1);
-    expect(postEvent).toHaveBeenCalledWith('web_app_trigger_haptic_feedback', {
-      type: 'notification',
-      notification_type: 'success',
-    });
-  });
-});
-
-describe('selectionChanged', () => {
-  it('should call "web_app_trigger_haptic_feedback" method with { type: "selection_change" }', () => {
-    const postEvent = vi.fn();
-    const haptic = new HapticFeedback('', postEvent);
-
-    expect(postEvent).toHaveBeenCalledTimes(0);
-    haptic.selectionChanged();
-    expect(postEvent).toHaveBeenCalledTimes(1);
-    expect(postEvent).toHaveBeenCalledWith('web_app_trigger_haptic_feedback', {
-      type: 'selection_change',
-    });
-  });
-});
-
-describe('supports', () => {
-  describe('impactOccurred / notificationOccurred / selectionChanged', () => {
-    it('should return true in case, HapticFeedback version is 6.1 or higher. False, otherwise', () => {
-      const haptic1 = new HapticFeedback('6.0');
-      expect(haptic1.supports('impactOccurred')).toBe(false);
-      expect(haptic1.supports('notificationOccurred')).toBe(false);
-      expect(haptic1.supports('selectionChanged')).toBe(false);
-
-      const haptic2 = new HapticFeedback('6.1');
-      expect(haptic2.supports('impactOccurred')).toBe(true);
-      expect(haptic2.supports('notificationOccurred')).toBe(true);
-      expect(haptic2.supports('selectionChanged')).toBe(true);
-
-      const haptic3 = new HapticFeedback('6.2');
-      expect(haptic3.supports('impactOccurred')).toBe(true);
-      expect(haptic3.supports('notificationOccurred')).toBe(true);
-      expect(haptic3.supports('selectionChanged')).toBe(true);
-    });
-  });
-});

package/src/haptic-feedback/index.ts

@@ -1 +0,0 @@
-export * from './HapticFeedback.js';