@tma.js/sdk 1.4.4 → 1.4.7

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

@@ -1,33 +0,0 @@
-import { boolean, json, number } from '~/parsing/index.js';
-
-export interface ViewportChangedPayload {
-  /**
-   * The viewport height.
-   */
-  height: number;
-  /**
-   * The viewport width.
-   */
-  width: number;
-  /**
-   * Is the viewport currently expanded.
-   */
-  is_expanded: boolean;
-  /**
-   * Is the viewport current state stable and not going to change in the next moment.
-   */
-  is_state_stable: boolean;
-}
-
-export function viewportChanged() {
-  return json<ViewportChangedPayload>({
-    height: number(),
-    width: (value) => (
-      value === null || value === undefined
-        ? window.innerWidth
-        : number().parse(value)
-    ),
-    is_state_stable: boolean(),
-    is_expanded: boolean(),
-  });
-}

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

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

package/src/bridge/events/singletonEmitter.ts

@@ -1,19 +0,0 @@
-import { createEmitter } from '~/bridge/events/createEmitter.js';
-import type { MiniAppsEventEmitter } from '~/bridge/index.js';
-
-const CACHED_EMITTER = 'telegram-mini-apps-cached-emitter';
-
-/**
- * Returns singleton instance of bridge EventEmitter. Also, defines
- * Telegram event handlers.
- */
-export function singletonEmitter(): MiniAppsEventEmitter {
-  const wnd: any = window;
-  const cachedEmitter = wnd[CACHED_EMITTER];
-
-  if (cachedEmitter === undefined) {
-    wnd[CACHED_EMITTER] = createEmitter();
-  }
-
-  return wnd[CACHED_EMITTER];
-}

package/src/bridge/events/subscribe.ts

@@ -1,15 +0,0 @@
-import type { MiniAppsGlobalEventListener } from './events.js';
-import { singletonEmitter } from './singletonEmitter.js';
-import { unsubscribe } from './unsubscribe.js';
-
-type StopListening = () => void;
-
-/**
- * Subscribes to all events sent from the native Telegram application.
- * Returns function used to remove added event listener.
- * @param listener - event listener.
- */
-export function subscribe(listener: MiniAppsGlobalEventListener): StopListening {
-  singletonEmitter().subscribe(listener);
-  return () => unsubscribe(listener);
-}

package/src/bridge/events/unsubscribe.ts

@@ -1,10 +0,0 @@
-import type { MiniAppsGlobalEventListener } from './events.js';
-import { singletonEmitter } from './singletonEmitter.js';
-
-/**
- * Removes global event listener.
- * @param listener - event listener.
- */
-export function unsubscribe(listener: MiniAppsGlobalEventListener): void {
-  singletonEmitter().unsubscribe(listener);
-}

package/src/bridge/index.ts

@@ -1,7 +0,0 @@
-export * from './env/index.js';
-export * from './errors/index.js';
-export * from './events/index.js';
-export * from './methods/index.js';
-export * from './invokeCustomMethod.js';
-export * from './parseMessage.js';
-export * from './request.js';

package/src/bridge/invokeCustomMethod.ts

@@ -1,56 +0,0 @@
-import type { ExecuteWithOptions } from '~/types/index.js';
-
-import type { CustomMethodName, CustomMethodParams } from './methods/index.js';
-import { request } from './request.js';
-
-/**
- * Invokes known custom method. Returns method execution result.
- * @param method - method name.
- * @param params - method parameters.
- * @param requestId - request identifier.
- * @param options - additional options.
- */
-export async function invokeCustomMethod<M extends CustomMethodName>(
-  method: M,
-  params: CustomMethodParams<M>,
-  requestId: string,
-  options?: ExecuteWithOptions,
-): Promise<unknown>;
-
-/**
- * Invokes unknown custom method. Returns method execution result.
- * @param method - method name.
- * @param params - method parameters.
- * @param requestId - request identifier.
- * @param options - additional options.
- */
-export function invokeCustomMethod(
-  method: string,
-  params: object,
-  requestId: string,
-  options?: ExecuteWithOptions,
-): Promise<unknown>;
-
-export async function invokeCustomMethod(
-  method: string,
-  params: object,
-  requestId: string,
-  options: ExecuteWithOptions = {},
-): Promise<unknown> {
-  const { result, error } = await request(
-    'web_app_invoke_custom_method',
-    {
-      method,
-      params,
-      req_id: requestId,
-    },
-    'custom_method_invoked',
-    options,
-  );
-
-  if (error) {
-    throw new Error(error);
-  }
-
-  return result;
-}

package/src/bridge/methods/__tests__/createPostEvent.ts

@@ -1,37 +0,0 @@
-import { expect, it, vi } from 'vitest';
-
-import { createPostEvent } from '../../index';
-import * as postEventModule from '../postEvent';
-
-vi.mock('~/bridge/methods/postEvent.js', () => ({
-  postEvent: vi.fn(),
-}));
-
-it('should throw error if passed method is unsupported in specified version', () => {
-  const postEvent = createPostEvent('6.0');
-  expect(() => postEvent('web_app_request_write_access'))
-    .toThrow('Method "web_app_request_write_access" is unsupported in the Mini Apps version 6.0.');
-});
-
-it('should throw error if passed method parameter is unsupported in specified version', () => {
-  const postEvent = createPostEvent('6.3');
-  expect(() => postEvent('web_app_open_link', {
-    url: '',
-    try_instant_view: true,
-  }))
-    .toThrow('Parameter "try_instant_view" in method "web_app_open_link" is unsupported in the Mini Apps version 6.3.');
-
-  expect(() => postEvent('web_app_set_header_color', {
-    color: '#aaaaaa',
-  }))
-    .toThrow('Parameter "color" in method "web_app_set_header_color" is unsupported in the Mini Apps version 6.3.');
-});
-
-it('should call global postEvent function', () => {
-  const postEvent = createPostEvent('6.3');
-  const spy = vi.spyOn(postEventModule, 'postEvent');
-
-  postEvent('web_app_request_viewport');
-  expect(spy).toHaveBeenCalledOnce();
-  expect(spy).toHaveBeenCalledWith('web_app_request_viewport', undefined);
-});

package/src/bridge/methods/__tests__/postEvent.ts

@@ -1,137 +0,0 @@
-import {
-  afterEach,
-  beforeAll,
-  expect,
-  it,
-  type SpyInstance,
-  vi,
-} from 'vitest';
-
-import { setTargetOrigin } from '../../../globals';
-import { postEvent } from '../../index';
-
-let windowSpy: SpyInstance<[], Window & typeof globalThis>;
-
-beforeAll(() => {
-  windowSpy = vi.spyOn(window, 'window', 'get');
-});
-
-afterEach(() => {
-  windowSpy.mockReset();
-});
-
-it('should call "window.parent.postMessage" with object with properties {eventType: string, eventData: any} converted to string in case, current environment is iframe', () => {
-  const postMessageSpy = vi.fn();
-  windowSpy.mockImplementation(() => ({
-    self: 1000,
-    top: 900,
-    parent: { postMessage: postMessageSpy },
-  }) as any);
-
-  expect(postMessageSpy).toHaveBeenCalledTimes(0);
-  postEvent('web_app_close');
-  expect(postMessageSpy).toHaveBeenCalledTimes(1);
-  expect(postMessageSpy).toHaveBeenCalledWith(JSON.stringify({
-    eventType: 'web_app_close',
-    eventData: undefined,
-  }), 'https://web.telegram.org');
-
-  postMessageSpy.mockClear();
-
-  expect(postMessageSpy).toHaveBeenCalledTimes(0);
-  postEvent('web_app_set_header_color', { color_key: 'bg_color' });
-  expect(postMessageSpy).toHaveBeenCalledTimes(1);
-  expect(postMessageSpy).toHaveBeenCalledWith(JSON.stringify({
-    eventType: 'web_app_set_header_color',
-    eventData: { color_key: 'bg_color' },
-  }), 'https://web.telegram.org');
-
-  postMessageSpy.mockClear();
-
-  expect(postMessageSpy).toHaveBeenCalledTimes(0);
-  postEvent('web_app_close', { targetOrigin: 'abc' });
-  expect(postMessageSpy).toHaveBeenCalledTimes(1);
-  expect(postMessageSpy).toHaveBeenCalledWith(JSON.stringify({
-    eventType: 'web_app_close',
-    eventData: undefined,
-  }), 'abc');
-
-  postMessageSpy.mockClear();
-
-  expect(postMessageSpy).toHaveBeenCalledTimes(0);
-  postEvent(
-    'web_app_set_header_color',
-    { color_key: 'bg_color' },
-    { targetOrigin: 'abc' },
-  );
-  expect(postMessageSpy).toHaveBeenCalledTimes(1);
-  expect(postMessageSpy).toHaveBeenCalledWith(JSON.stringify({
-    eventType: 'web_app_set_header_color',
-    eventData: { color_key: 'bg_color' },
-  }), 'abc');
-});
-
-it('should call "window.TelegramWebviewProxy.postEvent" in case this path exists. Function accepts event name (string) as the first argument and event data (object converted to string) as the second one.', () => {
-  const spy = vi.fn();
-  windowSpy.mockImplementation(() => ({
-    TelegramWebviewProxy: { postEvent: spy },
-  }) as any);
-
-  // Without parameters.
-  expect(spy).toHaveBeenCalledTimes(0);
-  postEvent('web_app_close');
-  expect(spy).toHaveBeenCalledTimes(1);
-  expect(spy).toHaveBeenCalledWith('web_app_close', undefined);
-
-  spy.mockClear();
-
-  // With parameters.
-  expect(spy).toHaveBeenCalledTimes(0);
-  postEvent('web_app_set_header_color', { color_key: 'bg_color' });
-  expect(spy).toHaveBeenCalledTimes(1);
-  expect(spy).toHaveBeenCalledWith('web_app_set_header_color', '{"color_key":"bg_color"}');
-});
-
-it('should call "window.external.notify" in case it exists. Passed value is object, converted to string. This object should contain fields "eventType" and "eventData".', () => {
-  const spy = vi.fn();
-  windowSpy.mockImplementation(() => ({
-    external: { notify: spy },
-  }) as any);
-
-  // Without parameters.
-  expect(spy).toHaveBeenCalledTimes(0);
-  postEvent('web_app_close');
-  expect(spy).toHaveBeenCalledTimes(1);
-  expect(spy).toHaveBeenCalledWith('{"eventType":"web_app_close"}');
-
-  spy.mockClear();
-
-  // With parameters.
-  expect(spy).toHaveBeenCalledTimes(0);
-  postEvent('web_app_set_header_color', { color_key: 'bg_color' });
-  expect(spy).toHaveBeenCalledTimes(1);
-  expect(spy).toHaveBeenCalledWith('{"eventType":"web_app_set_header_color","eventData":{"color_key":"bg_color"}}');
-});
-
-it('should throw an error in case, current environment is unknown', () => {
-  windowSpy.mockImplementation(() => ({}) as any);
-  expect(() => postEvent('web_app_close'))
-    .toThrow('Unable to determine current environment and possible way to send event');
-});
-
-it('should use globally set target origin', () => {
-  const postMessageSpy = vi.fn();
-  windowSpy.mockImplementation(() => ({
-    self: 1000,
-    top: 900,
-    parent: { postMessage: postMessageSpy },
-  }) as any);
-
-  setTargetOrigin('here we go!');
-  postEvent('iframe_ready');
-
-  expect(postMessageSpy).toHaveBeenCalledWith(
-    JSON.stringify({ eventType: 'iframe_ready' }),
-    'here we go!',
-  );
-});

package/src/bridge/methods/createPostEvent.ts

@@ -1,40 +0,0 @@
-import { isRecord } from '~/misc/index.js';
-import { supports } from '~/supports/index.js';
-import type { Version } from '~/version/index.js';
-
-import { type PostEvent, postEvent } from './postEvent.js';
-import { MethodUnsupportedError, ParameterUnsupportedError } from '../errors/index.js';
-
-/**
- * Creates function which checks if specified method and parameters are supported. In case,
- * method or parameters are unsupported, an error will be thrown.
- * @param version - Telegram Mini Apps version.
- * @throws {MethodUnsupportedError} Method is unsupported.
- * @throws {ParameterUnsupportedError} Method parameter is unsupported.
- */
-export function createPostEvent(version: Version): PostEvent {
-  return (method: any, params: any) => {
-    // Firstly, check if method itself is supported.
-    if (!supports(method, version)) {
-      throw new MethodUnsupportedError(method, version);
-    }
-
-    // Method could use parameters, which are supported only in specific versions of Telegram
-    // Mini Apps.
-    if (isRecord(params)) {
-      let validateParam: string | undefined;
-
-      if (method === 'web_app_open_link' && 'try_instant_view' in params) {
-        validateParam = 'try_instant_view';
-      } else if (method === 'web_app_set_header_color' && 'color' in params) {
-        validateParam = 'color';
-      }
-
-      if (validateParam && !supports(method, validateParam, version)) {
-        throw new ParameterUnsupportedError(method, validateParam, version);
-      }
-    }
-
-    return postEvent(method, params);
-  };
-}

package/src/bridge/methods/custom-methods.ts

@@ -1,68 +0,0 @@
-import type { RequestId } from '~/types/index.js';
-
-interface CreateInvokeCustomMethodParams<M extends string, Params extends object> {
-  /**
-   * Unique request identifier.
-   */
-  req_id: RequestId;
-
-  /**
-   * Method name.
-   */
-  method: M;
-
-  /**
-   * Method specific parameters.
-   */
-  params: Params;
-}
-
-export interface CustomMethodsParams {
-  /**
-   * Deletes storage values by their keys.
-   */
-  deleteStorageValues: {
-    keys: string | string[]
-  };
-
-  /**
-   * Gets current user contact in case, Mini has access to it.
-   */
-  getRequestedContact: {};
-
-  /**
-   * Gets all registered storage keys.
-   */
-  getStorageKeys: {};
-
-  /**
-   * Gets storage values by their keys.
-   */
-  getStorageValues: {
-    keys: string | string[]
-  };
-
-  /**
-   * Saves value by specified key in the storage.
-   */
-  saveStorageValue: {
-    key: string;
-    value: string;
-  };
-}
-
-/**
- * Known custom method name.
- */
-export type CustomMethodName = keyof CustomMethodsParams;
-
-/**
- * Custom method parameters.
- */
-export type CustomMethodParams<M extends CustomMethodName> = CustomMethodsParams[M];
-
-export type AnyInvokeCustomMethodParams =
-  | CreateInvokeCustomMethodParams<string, any>
-  | {
-  [M in CustomMethodName]: CreateInvokeCustomMethodParams<M, CustomMethodParams<M>>
-}[CustomMethodName];

package/src/bridge/methods/haptic.ts

@@ -1,52 +0,0 @@
-/**
- * Generic type which creates new types of haptic feedback.
- */
-type CreateHapticFeedbackParams<T extends string, P> = { type: T } & P;
-
-/**
- * Style of impact occurred haptic event.
- * - `light`, indicates a collision between small or lightweight UI objects,
- * - `medium`, indicates a collision between medium-sized or medium-weight UI objects,
- * - `heavy`, indicates a collision between large or heavyweight UI objects,
- * - `rigid`, indicates a collision between hard or inflexible UI objects,
- * - `soft`, indicates a collision between soft or flexible UI objects.
- */
-export type ImpactHapticFeedbackStyle =
-  | 'light'
-  | 'medium'
-  | 'heavy'
-  | 'rigid'
-  | 'soft';
-
-/**
- * Type of notification occurred type event.
- * - `error`, indicates that a task or action has failed,
- * - `success`, indicates that a task or action has completed successfully,
- * - `warning`, indicates that a task or action produced a warning.
- */
-export type NotificationHapticFeedbackType = 'error' | 'success' | 'warning';
-
-/**
- * `impactOccurred` haptic feedback.
- */
-export type ImpactHapticFeedbackParams = CreateHapticFeedbackParams<'impact', {
-  impact_style: ImpactHapticFeedbackStyle;
-}>;
-
-/**
- * `notificationOccurred` haptic feedback.
- */
-export type NotificationHapticFeedbackParams = CreateHapticFeedbackParams<'notification', {
-  notification_type: NotificationHapticFeedbackType;
-}>;
-
-/**
- * `selectionChanged` haptic feedback.
- */
-// eslint-disable-next-line @typescript-eslint/ban-types
-export type SelectionHapticFeedbackParams = CreateHapticFeedbackParams<'selection_change', {}>;
-
-export type AnyHapticFeedbackParams =
-  | ImpactHapticFeedbackParams
-  | NotificationHapticFeedbackParams
-  | SelectionHapticFeedbackParams;

package/src/bridge/methods/index.ts

@@ -1,6 +0,0 @@
-export * from './createPostEvent.js';
-export * from './custom-methods.js';
-export * from './haptic.js';
-export * from './methods.js';
-export * from './popup.js';
-export * from './postEvent.js';