@tma.js/sdk 0.12.9 → 0.13.1

package/src/env.ts

@@ -1,17 +1,22 @@
-import { retrieveLaunchParams } from './launch-params.js';
+import { retrieveLaunchData } from '@tma.js/launch-params';
 
 /**
  * Returns true in case, current environment is Telegram Mini Apps.
- *
- * `isTWA` utilizes such function as `retrieveLaunchParams`, which attempts to retrieve
- * launch parameters from the current environment.
- * @see retrieveLaunchParams
  */
-export function isTWA(): boolean {
+export function isTMA(): boolean {
   try {
-    retrieveLaunchParams();
+    retrieveLaunchData();
     return true;
   } catch (e) {
     return false;
   }
 }
+
+/**
+ * Returns true in case, current environment is Telegram Mini Apps.
+ * @see computeLaunchData
+ * @deprecated Use `isTMA`
+ */
+export function isTWA(): boolean {
+  return isTMA();
+}

package/src/index.ts

@@ -2,6 +2,5 @@ export * from './components/index.js';
 export * from './errors/index.js';
 export * from './init/index.js';
 export * from './env.js';
-export * from './launch-params.js';
 export * from './types.js';
 export * from './url.js';

package/src/init/creators/index.ts

@@ -1,7 +1,6 @@
 export * from './createBackButton.js';
 export * from './createClosingBehavior.js';
 export * from './createMainButton.js';
-export * from './createPostEvent.js';
 export * from './createRequestIdGenerator.js';
 export * from './createThemeParams.js';
 export * from './createViewport.js';

package/src/init/init.ts

@@ -3,14 +3,11 @@ import {
   setDebug,
   setTargetOrigin,
   on,
+  createPostEvent,
+  postEvent as bridgePostEvent,
 } from '@tma.js/bridge';
 import { withTimeout } from '@tma.js/utils';
-import type { LaunchParams } from '@tma.js/launch-params';
-import {
-  parse as parseLaunchParams,
-  saveToStorage as saveLaunchParamsToStorage,
-  retrieveFromStorage,
-} from '@tma.js/launch-params';
+import { parse, retrieveLaunchData } from '@tma.js/launch-params';
 
 import {
   CloudStorage,
@@ -26,49 +23,17 @@ import {
   parseCSSVarsOptions,
 } from './css.js';
 import {
-  createPostEvent,
   createThemeParams,
   createBackButton,
   createMainButton,
   createViewport,
-  createWebApp, createRequestIdGenerator, createClosingBehavior,
+  createWebApp,
+  createRequestIdGenerator,
+  createClosingBehavior,
 } from './creators/index.js';
-import { retrieveLaunchParams } from '../launch-params.js';
 
 import type { InitOptions, InitResult } from './types.js';
 
-/**
- * Returns true in case, current session was created due to native location reload.
- */
-function isNativePageReload(): boolean {
-  return (
-    window
-      .performance
-      .getEntriesByType('navigation') as PerformanceNavigationTiming[]
-  ).some((entry) => entry.type === 'reload');
-}
-
-/**
- * Returns true if current page was reloaded.
- * @param launchParamsFromStorage - launch parameters from sessionStorage.
- * @param currentLaunchParams - actual launch parameters.
- */
-function computePageReload(
-  launchParamsFromStorage: LaunchParams | null,
-  currentLaunchParams: LaunchParams,
-): boolean {
-  // To check if page was reloaded, we should check if previous init data hash equals to the
-  // current one. Nevertheless, there are some cases, when init data is missing. For example,
-  // when app was launched via KeyboardButton. In this case we try to use the native way of
-  // checking if current page was reloaded (which could still return incorrect result).
-  // Issue: https://github.com/Telegram-Mini-Apps/issues/issues/12
-  if (!launchParamsFromStorage) {
-    return false;
-  }
-
-  return launchParamsFromStorage.initData?.hash === currentLaunchParams.initData?.hash;
-}
-
 /**
  * Represents actual init function.
  * @param options - init options.
@@ -80,8 +45,8 @@ async function actualInit(options: InitOptions = {}): Promise<InitResult> {
     acceptScrollbarStyle = true,
     acceptCustomStyles = acceptScrollbarStyle,
     targetOrigin,
+    launchParams: launchParamsOption,
     debug = false,
-    launchParams: optionsLaunchParams,
   } = options;
 
   // Set global settings.
@@ -93,19 +58,12 @@ async function actualInit(options: InitOptions = {}): Promise<InitResult> {
     setTargetOrigin(targetOrigin);
   }
 
-  // Get Mini App launch params and save them to session storage, so they will be accessible from
-  // anywhere.
-  const launchParamsFromStorage = retrieveFromStorage();
-  const launchParams = optionsLaunchParams instanceof URLSearchParams || typeof optionsLaunchParams === 'string'
-    ? parseLaunchParams(optionsLaunchParams)
-    : retrieveLaunchParams();
-
-  saveLaunchParamsToStorage(launchParams);
-
-  // Compute if page was reloaded. We will need it to decide if SDK components should be restored
-  // or created from scratch.
-  const isPageReload = isNativePageReload()
-    || computePageReload(launchParamsFromStorage, launchParams);
+  // Retrieve launch data.
+  const { launchParams, isPageReload } = retrieveLaunchData({
+    currentLaunchParams: typeof launchParamsOption === 'string' || launchParamsOption instanceof URLSearchParams
+      ? parse(launchParamsOption)
+      : launchParamsOption,
+  });
 
   const {
     initData,
@@ -121,7 +79,9 @@ async function actualInit(options: InitOptions = {}): Promise<InitResult> {
   } = lpThemeParams;
 
   const createRequestId = createRequestIdGenerator();
-  const postEvent = createPostEvent(checkCompat, version);
+  const postEvent = checkCompat
+    ? createPostEvent(version)
+    : bridgePostEvent;
   const themeParams = createThemeParams(lpThemeParams);
   const webApp = createWebApp(
     isPageReload,

package/src/supports.ts

@@ -2,15 +2,15 @@ import type { Version } from '@tma.js/utils';
 import {
   supports,
   type MethodName,
-  type HasCheckSupportMethodName,
-  type HasCheckSupportMethodParam,
+  type MethodVersionedParams,
+  type MethodWithVersionedParams,
 } from '@tma.js/bridge';
 
 export type SupportsFunc<M extends string> = (method: M) => boolean;
 
 type HasCheckSupportMethodTuple = {
-  [M in HasCheckSupportMethodName]: [M, HasCheckSupportMethodParam<M>]
-}[HasCheckSupportMethodName];
+  [M in MethodWithVersionedParams]: [M, MethodVersionedParams<M>]
+}[MethodWithVersionedParams];
 
 /**
  * Returns function, which accepts predefined method name and checks if it is supported

package/dist/dts/init/creators/createPostEvent.d.ts

@@ -1,7 +0,0 @@
-import { type PostEvent } from '@tma.js/bridge';
-/**
- * Creates postEvent function.
- * @param checkCompat - should compatibility check be enabled.
- * @param version - platform version.
- */
-export declare function createPostEvent(checkCompat: boolean, version: string): PostEvent;

package/dist/dts/launch-params.d.ts

@@ -1,6 +0,0 @@
-import { type LaunchParams } from '@tma.js/launch-params';
-/**
- * Attempts to extract launch params from window.location.hash. In case, window.location.hash
- * lacks of valid data, function attempts to extract launch params from the sessionStorage.
- */
-export declare function retrieveLaunchParams(): LaunchParams;

package/src/init/creators/createPostEvent.ts

@@ -1,36 +0,0 @@
-import {
-  supports,
-  postEvent as defaultPostEvent,
-  detectSupportParams,
-  type PostEvent,
-} from '@tma.js/bridge';
-import { isRecord } from '@tma.js/utils';
-
-import { MethodNotSupportedError, ParameterUnsupportedError } from '../../errors/index.js';
-
-/**
- * Creates postEvent function.
- * @param checkCompat - should compatibility check be enabled.
- * @param version - platform version.
- */
-export function createPostEvent(checkCompat: boolean, version: string): PostEvent {
-  return checkCompat
-    ? (method: any, params: any) => {
-      // Firstly, check if method itself is supported.
-      if (!supports(method, version)) {
-        throw new MethodNotSupportedError(method, version);
-      }
-
-      // Method could use parameters, which are supported only in specific versions of TWA.
-      if (isRecord(params)) {
-        detectSupportParams(method, params).forEach((param) => {
-          if (!supports(method as any, param, version)) {
-            throw new ParameterUnsupportedError(method, param, version);
-          }
-        });
-      }
-
-      return defaultPostEvent(method, params);
-    }
-    : defaultPostEvent;
-}

package/src/launch-params.ts

@@ -1,28 +0,0 @@
-import { parse, retrieveFromStorage, type LaunchParams } from '@tma.js/launch-params';
-
-/**
- * Attempts to extract launch params from window.location.hash. In case, window.location.hash
- * lacks of valid data, function attempts to extract launch params from the sessionStorage.
- */
-export function retrieveLaunchParams(): LaunchParams {
-  let error: unknown | undefined;
-
-  // Try to extract Mini App data from hash. This block of code  covers usual flow, when
-  // application was firstly opened by the user and its hash always contains required parameters.
-  try {
-    return parse(window.location.hash.slice(1));
-  } catch (e) {
-    error = e;
-  }
-
-  // Mini Apps allows reloading current page. In this case, window.location.reload() will be
-  // called which means, that init will be called again. As the result, current window
-  // location will lose Mini App data. To solve this problem, we are extracting launch
-  // params saved previously.
-  const fromStorage = retrieveFromStorage();
-  if (fromStorage) {
-    return fromStorage;
-  }
-
-  throw new Error('Unable to extract launch params', { cause: error });
-}