@tma.js/sdk 1.4.4 → 1.4.7

package/src/launch-params/computeLaunchData.ts

@@ -1,81 +0,0 @@
-import { computePageReload } from './computePageReload.js';
-import { retrieveCurrent } from './retrieveCurrent.js';
-import { retrieveFromStorage } from './storage.js';
-import type { LaunchData } from './types.js';
-
-/**
- * Returns true in case, current environment is iframe.
- * @see https://stackoverflow.com/a/326076
- */
-function isIframe(): boolean {
-  try {
-    return window.self !== window.top;
-  } catch (e) {
-    return true;
-  }
-}
-
-/**
- * Computes launch data information. Extracts both previous and current launch parameters
- * to compute current list of them. Additionally, computes if page was reloaded.
- */
-export function computeLaunchData(): LaunchData {
-  // Retrieve launch parameters from the session storage. We consider this value as the launch
-  // parameters saved previously, in the previous runtime session (before the page reload).
-  const lpPrevious = retrieveFromStorage();
-
-  // Currently used launch parameters passed to the Mini App.
-  const lpCurrent = retrieveCurrent();
-
-  const isPageReload = computePageReload();
-
-  if (lpPrevious) {
-    if (lpCurrent) {
-      return {
-        launchParams: lpCurrent,
-        isPageReload: isIframe()
-          // In iframes we should check page reload via 2 ways:
-          // 1. Native one via navigation entry.
-          // 2. By comparing raw init data representations, when the first step did not return
-          // explicit true.
-          //
-          // The reason is Telegram provides the horrible way of reloading current iframes which
-          // does not guarantee, that reload will be proceeded properly.
-          // Issue: https://github.com/morethanwords/tweb/issues/271
-          //
-          // We trust isPageReload variable value only in case it is "true". Otherwise, it can be
-          // wrong. That's why we compare raw init data raw representations, which is unstable
-          // also. This will not work as expected in cases, user launches applications via
-          // KeyboardButton-s which can lack of init data. So, this code will not differ reload
-          // from the fresh start.
-          ? isPageReload || lpPrevious.initDataRaw === lpCurrent.initDataRaw
-
-          // In environments different from iframe, when we have both previous and current launch
-          // parameters it is guaranteed that page was reloaded as long as session is created only
-          // for the Mini App launch and will be automatically disposed after it is closed.
-          : true,
-      };
-    }
-
-    // Explicit page reload allows us to trust previously saved launch parameters.
-    if (isPageReload) {
-      return {
-        launchParams: lpPrevious,
-        isPageReload,
-      };
-    }
-
-    // We can't trust previously saved launch parameters as long as we don't really know if
-    // current session was born due to restart. It is better to throw an error.
-    throw new Error('Unable to retrieve current launch parameters, which must exist.');
-  }
-
-  if (lpCurrent) {
-    return {
-      launchParams: lpCurrent,
-      isPageReload: false,
-    };
-  }
-
-  throw new Error('Unable to retrieve any launch parameters.');
-}

package/src/launch-params/computePageReload.ts

@@ -1,13 +0,0 @@
-import { getFirstNavigationEntry } from './getFirstNavigationEntry.js';
-
-/**
- * Determines if current page was reloaded.
- * @returns Boolean if function was able to compute any valid value. Null in case, no
- * navigation entries were found.
- */
-export function computePageReload(): boolean | null {
-  const firstNavigationEntry = getFirstNavigationEntry();
-  return firstNavigationEntry
-    ? firstNavigationEntry.type === 'reload'
-    : null;
-}

package/src/launch-params/getFirstNavigationEntry.ts

@@ -1,10 +0,0 @@
-/**
- * Returns the first navigation entry from window.performance.
- * @returns First navigation entry or null, in case performance functionality is not supported
- * or navigation entry was not found.
- */
-export function getFirstNavigationEntry(): PerformanceNavigationTiming | null {
-  return (
-    performance.getEntriesByType('navigation')[0] as PerformanceNavigationTiming | undefined
-  ) || null;
-}

package/src/launch-params/index.ts

@@ -1,13 +0,0 @@
-export * from './computeLaunchData.js';
-export * from './computePageReload.js';
-export * from './getFirstNavigationEntry.js';
-export * from './launchParamsParser.js';
-export * from './parseLaunchParams.js';
-export * from './retrieveCurrent.js';
-export * from './retrieveFromLocation.js';
-export * from './retrieveFromPerformance.js';
-export * from './retrieveFromUrl.js';
-export * from './retrieveLaunchData.js';
-export * from './serializeLaunchParams.js';
-export * from './storage.js';
-export * from './types.js';

package/src/launch-params/launchParamsParser.ts

@@ -1,45 +0,0 @@
-import { initDataParser } from '~/init-data/index.js';
-import { boolean, searchParams, string } from '~/parsing/index.js';
-import { themeParamsParser } from '~/theme-params/index.js';
-
-import type { LaunchParams } from './types.js';
-
-/**
- * Returns parser used to parse launch params.
- */
-export function launchParamsParser() {
-  return searchParams<LaunchParams>({
-    botInline: {
-      type: boolean().optional(),
-      from: 'tgWebAppBotInline',
-    },
-    initData: {
-      type: initDataParser().optional(),
-      from: 'tgWebAppData',
-    },
-    initDataRaw: {
-      type: string().optional(),
-      from: 'tgWebAppData',
-    },
-    platform: {
-      type: string(),
-      from: 'tgWebAppPlatform',
-    },
-    showSettings: {
-      type: boolean().optional(),
-      from: 'tgWebAppShowSettings',
-    },
-    startParam: {
-      type: string().optional(),
-      from: 'tgWebAppStartParam',
-    },
-    themeParams: {
-      type: themeParamsParser(),
-      from: 'tgWebAppThemeParams',
-    },
-    version: {
-      type: string(),
-      from: 'tgWebAppVersion',
-    },
-  }, 'LaunchParams');
-}

package/src/launch-params/parseLaunchParams.ts

@@ -1,10 +0,0 @@
-import { launchParamsParser } from './launchParamsParser.js';
-import type { LaunchParams } from './types.js';
-
-/**
- * Parses value as launch parameters.
- * @param value - value to parse.
- */
-export function parseLaunchParams(value: unknown): LaunchParams {
-  return launchParamsParser().parse(value);
-}

package/src/launch-params/retrieveCurrent.ts

@@ -1,27 +0,0 @@
-import { retrieveFromLocation } from './retrieveFromLocation.js';
-import { retrieveFromPerformance } from './retrieveFromPerformance.js';
-import type { LaunchParams } from './types.js';
-
-/**
- * Attempts to retrieve launch parameters using every known way.
- */
-export function retrieveCurrent(): LaunchParams | null {
-  // First of all, attempt to retrieve launch parameters from the window.performance as long as
-  // this way is considered the most stable. Nevertheless, this method can return nothing in case,
-  // location was changed and then page was reloaded.
-  try {
-    return retrieveFromPerformance();
-    // eslint-disable-next-line no-empty
-  } catch (e) {
-  }
-
-  // In case, usage of window.performance was unsuccessful, try to retrieve launch parameters
-  // from the window.location.
-  try {
-    return retrieveFromLocation();
-    // eslint-disable-next-line no-empty
-  } catch (e) {
-  }
-
-  return null;
-}

package/src/launch-params/retrieveFromLocation.ts

@@ -1,10 +0,0 @@
-import { retrieveFromUrl } from './retrieveFromUrl.js';
-import type { LaunchParams } from './types.js';
-
-/**
- * Attempts to extract launch parameters from the current window location hash.
- * @throws {Error} window.location.hash contains invalid data.
- */
-export function retrieveFromLocation(): LaunchParams {
-  return retrieveFromUrl(window.location.href);
-}

package/src/launch-params/retrieveFromPerformance.ts

@@ -1,18 +0,0 @@
-import { getFirstNavigationEntry } from './getFirstNavigationEntry.js';
-import { retrieveFromUrl } from './retrieveFromUrl.js';
-import type { LaunchParams } from './types.js';
-
-/**
- * Attempts to read launch parameters using window.performance data.
- * @throws {Error} Unable to get first navigation entry.
- * @throws {Error} First navigation entry does not contain hash part.
- * @throws {TypeError} Unable to parse value.
- */
-export function retrieveFromPerformance(): LaunchParams {
-  const navigationEntry = getFirstNavigationEntry();
-  if (!navigationEntry) {
-    throw new Error('Unable to get first navigation entry.');
-  }
-
-  return retrieveFromUrl(navigationEntry.name);
-}

package/src/launch-params/retrieveFromUrl.ts

@@ -1,19 +0,0 @@
-import { parseLaunchParams } from '~/launch-params/parseLaunchParams.js';
-import type { LaunchParams } from '~/launch-params/types.js';
-
-/**
- * Retrieves launch parameters from the specified URL.
- * @param url - URL to extract launch parameters from.
- */
-export function retrieveFromUrl(url: string): LaunchParams {
-  const queryParams = url.includes('?')
-    // If URL includes "?", we expect it to possibly contain "#". The reason is TMA allows passing
-    // start parameter via tgWebAppStartParam **query** parameter. Replacing "#" with "&" we
-    // expect merging query parameters with hash parameters and creating complete launch
-    // parameters information.
-    ? url.replace('#', '&').slice(url.indexOf('?') + 1)
-    // Otherwise, we expect specifying launch parameters only in the hash part.
-    : url.slice(url.indexOf('#') + 1);
-
-  return parseLaunchParams(queryParams);
-}

package/src/launch-params/retrieveLaunchData.ts

@@ -1,30 +0,0 @@
-import { computeLaunchData } from './computeLaunchData.js';
-import { saveToStorage } from './storage.js';
-import type { LaunchData } from './types.js';
-
-const WINDOW_KEY = 'tmajsLaunchData';
-
-/**
- * Returns launch data information. Function ignores passed options in case, it was already
- * called. It caches the last returned value.
- */
-export function retrieveLaunchData(): LaunchData {
-  // Return previously cached value.
-  const cached = (window as any)[WINDOW_KEY];
-  if (cached) {
-    return cached;
-  }
-
-  // Get current launch data.
-  const launchData = computeLaunchData();
-
-  // To prevent the additional computation of launch data and possible break of the code
-  // logic, we store this data in the window. Several calls of retrieveLaunchData will surely
-  // break something.
-  (window as any)[WINDOW_KEY] = launchData;
-
-  // Save launch parameters in the session storage. We will need them during page reloads.
-  saveToStorage(launchData.launchParams);
-
-  return launchData;
-}

package/src/launch-params/serializeLaunchParams.ts

@@ -1,37 +0,0 @@
-import { serializeThemeParams } from '~/theme-params/index.js';
-
-import type { LaunchParams } from './types.js';
-
-/**
- * Converts launch parameters to its initial representation.
- * @param value - launch parameters.
- */
-export function serializeLaunchParams(value: LaunchParams): string {
-  const {
-    initDataRaw,
-    themeParams,
-    platform,
-    version,
-    showSettings,
-    botInline,
-  } = value;
-
-  const params = new URLSearchParams();
-
-  if (initDataRaw) {
-    params.set('tgWebAppData', initDataRaw);
-  }
-  params.set('tgWebAppPlatform', platform);
-  params.set('tgWebAppThemeParams', serializeThemeParams(themeParams));
-  params.set('tgWebAppVersion', version);
-
-  if (typeof showSettings === 'boolean') {
-    params.set('tgWebAppShowSettings', showSettings ? '1' : '0');
-  }
-
-  if (typeof botInline === 'boolean') {
-    params.set('tgWebAppBotInline', botInline ? '1' : '0');
-  }
-
-  return params.toString();
-}

package/src/launch-params/storage.ts

@@ -1,33 +0,0 @@
-import { launchParamsParser } from '~/launch-params/launchParamsParser.js';
-
-import { serializeLaunchParams } from './serializeLaunchParams.js';
-import type { LaunchParams } from './types.js';
-
-const SESSION_STORAGE_KEY = 'telegram-mini-apps-launch-params';
-
-/**
- * Attempts to extract launch parameters directly from the session storage.
- * @returns Launch parameters in case, they were stored before or null, if there is no launch
- * parameters key in the session storage.
- * @throws {Error} Data stored in the session storage is invalid.
- */
-export function retrieveFromStorage(): LaunchParams | null {
-  const raw = sessionStorage.getItem(SESSION_STORAGE_KEY);
-
-  return raw
-    // We are not handling the error on purpose as long as we are waiting for data stored by
-    // this session storage key to contain the valid launch parameters.
-    ? launchParamsParser().parse(raw)
-    : null;
-}
-
-/**
- * Saves specified launch parameters in the session storage.
- * @param value - launch params to save.
- */
-export function saveToStorage(value: LaunchParams): void {
-  // TODO: We probably don't need serialize here. We used it only to correctly serialize Date
-  //  values which being converted strings. To solve the problem we could improve date parser
-  //  to allows parsing such invalid (Dates, converted to strings) values.
-  sessionStorage.setItem(SESSION_STORAGE_KEY, serializeLaunchParams(value));
-}

package/src/launch-params/types.ts

@@ -1,62 +0,0 @@
-import type { InitDataParsed } from '~/init-data/index.js';
-import type { ThemeParamsParsed } from '~/theme-params/index.js';
-import type { Platform } from '~/types/index.js';
-
-/**
- * Telegram Mini Apps launch parameters.
- * @see https://docs.telegram-mini-apps.com/platform/launch-parameters/common-information
- */
-export interface LaunchParams {
-  /**
-   * True if Mini App is currently launched in inline mode.
-   */
-  botInline?: boolean;
-
-  /**
-   * Current launch init data. Can be missing in case, application was launched via
-   * KeyboardButton.
-   */
-  initData?: InitDataParsed;
-
-  /**
-   * The same as initData but in initial, raw format.
-   */
-  initDataRaw?: string;
-
-  /**
-   * Current Telegram application identifier.
-   */
-  platform: Platform;
-
-  /**
-   * True if application is required to show the Settings Button.
-   */
-  showSettings?: boolean;
-
-  /**
-   * Start parameter passed in the application link.
-   */
-  startParam?: string;
-
-  /**
-   * Mini App palette settings.
-   */
-  themeParams: ThemeParamsParsed;
-
-  /**
-   * Current Mini Apps version.
-   */
-  version: string;
-}
-
-export interface LaunchData {
-  /**
-   * Was current application reloaded.
-   */
-  isPageReload: boolean;
-
-  /**
-   * Current application launch parameters.
-   */
-  launchParams: LaunchParams;
-}

package/src/logger/Logger.ts

@@ -1,72 +0,0 @@
-/**
- * Message log level.
- */
-export type LogLevel = 'log' | 'error' | 'warn';
-
-export class Logger {
-  constructor(private readonly prefix: string, private enabled: boolean) {
-  }
-
-  /**
-   * Prints message into a console in case, logger is currently enabled.
-   * @param level - log level.
-   * @param args - arguments.
-   */
-  private print(level: LogLevel, ...args: any[]): void {
-    if (!this.enabled) {
-      return;
-    }
-
-    const now = new Date();
-    const date = Intl
-      .DateTimeFormat('en-GB', {
-        hour: '2-digit',
-        minute: '2-digit',
-        second: '2-digit',
-        fractionalSecondDigits: 3,
-        timeZone: 'UTC',
-      })
-      .format(now);
-
-    // eslint-disable-next-line no-console
-    console[level](`[${date}]`, this.prefix, ...args);
-  }
-
-  /**
-   * Disables the logger.
-   */
-  disable() {
-    this.enabled = false;
-  }
-
-  /**
-   * Prints error message into a console.
-   * @param args
-   */
-  error(...args: any[]): void {
-    this.print('error', ...args);
-  }
-
-  /**
-   * Enables the logger.
-   */
-  enable() {
-    this.enabled = true;
-  }
-
-  /**
-   * Prints log message into a console.
-   * @param args
-   */
-  log(...args: any[]): void {
-    this.print('log', ...args);
-  }
-
-  /**
-   * Prints warning message into a console.
-   * @param args
-   */
-  warn(...args: any[]): void {
-    this.print('warn', ...args);
-  }
-}

package/src/logger/__tests__/Logger.ts

@@ -1,107 +0,0 @@
-import {
-  afterAll,
-  afterEach,
-  beforeAll,
-  describe,
-  expect,
-  it,
-  vi,
-} from 'vitest';
-
-import { Logger } from '../Logger';
-
-const now = new Date('2022-11-04T09:09:43.007Z');
-
-afterEach(() => {
-  vi.resetAllMocks();
-});
-
-beforeAll(() => {
-  vi.useFakeTimers().setSystemTime(now);
-});
-
-afterAll(() => {
-  vi.useRealTimers();
-});
-
-it('should not call console methods if logger is disabled', () => {
-  const logger = new Logger('', false);
-  const spy = vi.fn();
-
-  vi.spyOn(console, 'log').mockImplementation(spy);
-  vi.spyOn(console, 'warn').mockImplementation(spy);
-  vi.spyOn(console, 'error').mockImplementation(spy);
-
-  logger.log();
-  logger.warn();
-  logger.error();
-  expect(spy).not.toHaveBeenCalled();
-});
-
-describe('enable', () => {
-  it('should start logging messages into console', () => {
-    const logger = new Logger('', false);
-    const spy = vi.fn();
-
-    vi.spyOn(console, 'log').mockImplementation(spy);
-    logger.log();
-    expect(spy).not.toHaveBeenCalled();
-
-    logger.enable();
-    logger.log();
-    expect(spy).toHaveBeenCalledOnce();
-  });
-});
-
-describe('disable', () => {
-  it('should stop logging messages into console', () => {
-    const logger = new Logger('', true);
-    const spy = vi.fn();
-
-    vi.spyOn(console, 'log').mockImplementation(spy);
-    logger.log();
-    expect(spy).toHaveBeenCalledOnce();
-
-    spy.mockReset();
-
-    logger.disable();
-    logger.log();
-    expect(spy).not.toHaveBeenCalled();
-  });
-});
-
-describe('error', () => {
-  it('should call console.error()', () => {
-    const logger = new Logger('My prefix', true);
-    const spy = vi.fn();
-    vi.spyOn(console, 'error').mockImplementation(spy);
-
-    logger.error('Test');
-    expect(spy).toHaveBeenCalledOnce();
-    expect(spy).toHaveBeenCalledWith('[09:09:43.007]', 'My prefix', 'Test');
-  });
-});
-
-describe('log', () => {
-  it('should call console.log()', () => {
-    const logger = new Logger('My prefix', true);
-    const spy = vi.fn();
-    vi.spyOn(console, 'log').mockImplementation(spy);
-
-    logger.log('Test');
-    expect(spy).toHaveBeenCalledOnce();
-    expect(spy).toHaveBeenCalledWith('[09:09:43.007]', 'My prefix', 'Test');
-  });
-});
-
-describe('warn', () => {
-  it('should call console.warn()', () => {
-    const logger = new Logger('My prefix', true);
-    const spy = vi.fn();
-    vi.spyOn(console, 'warn').mockImplementation(spy);
-
-    logger.warn('Test');
-    expect(spy).toHaveBeenCalledOnce();
-    expect(spy).toHaveBeenCalledWith('[09:09:43.007]', 'My prefix', 'Test');
-  });
-});

package/src/logger/index.ts

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