Merge pull request #243 from Telegram-Mini-Apps/feature/deprecate-ret…

…rieve-launch-data

Deprecate `retrieveLaunchData` function

.changeset/spicy-melons-arrive.md

@@ -0,0 +1,7 @@
+---
+"@tma.js/sdk-react": patch
+"@tma.js/sdk-solid": patch
+"@tma.js/sdk": patch
+---
+
+Deprecate retrieveLaunchData function

apps/docs/packages/tma-js-sdk/launch-parameters.md

@@ -113,11 +113,11 @@ serializeLaunchParams({
 ## Retrieving
 
 This package enables the extraction of launch parameters from the current environment using
-the `retrieveLaunchData` function which surely extracts launch parameters and determines if current
-page was reloaded. This function throws an error if all known sources contain invalid data.
+the `retrieveLaunchParams` function which surely extracts launch parameters. This function 
+throws an error if all known sources contain invalid data.
 
 ```typescript
-import { retrieveLaunchData } from '@tma.js/sdk';
+import { retrieveLaunchParams } from '@tma.js/sdk';
 
-const { launchParams, isPageReload } = retrieveLaunchData();
+const launchParams = retrieveLaunchParams();
 ```

apps/docs/packages/tma-js-sdk/navigation.md

@@ -301,7 +301,7 @@ Here is the example how developer could instantiate the stable instance of `Hash
 
 ```typescript
 import {
-  retrieveLaunchData,
+  isPageReload,
   HashNavigator,
   type HashNavigatorOptions,
 } from '@tma.js/sdk';
@@ -314,7 +314,7 @@ function createNavigator() {
 
   // If page was reloaded, we assume that navigator had to 
   // previously save its state in the session storage.
-  if (retrieveLaunchData().isPageReload) {
+  if (isPageReload()) {
     const stateRaw = sessionStorage.getItem('hash-navigator-state');
     if (stateRaw) {
       try {

apps/docs/packages/tma-js-solid-router-integration.md

@@ -106,7 +106,7 @@ function App() {
 
 ```typescript [createNavigator.ts]
 import {
-  retrieveLaunchData,
+  isPageReload,
   HashNavigator,
   type HashNavigatorOptions,
 } from '@tma.js/sdk';
@@ -119,7 +119,7 @@ export function createNavigator(): HashNavigator {
 
   // If page was reloaded, we assume that navigator had to previously save
   // its state in the session storage.
-  if (retrieveLaunchData().isPageReload) {
+  if (isPageReload()) {
     const stateRaw = sessionStorage.getItem('hash-navigator-state');
     if (stateRaw) {
       try {

apps/docs/platform/init-data.md

@@ -10,13 +10,13 @@ and init data specifically.
 
 ## Retrieving
 
-To extract init data, developer can use `retrieveLaunchData` function
+To extract init data, developer can use the `retrieveLaunchParams` function
 from [@tma.js/sdk](../packages/tma-js-sdk.md).
 
 ```typescript
-import { retrieveLaunchData } from '@tma.js/sdk';
+import { retrieveLaunchParams } from '@tma.js/sdk';
 
-const { initDataRaw, initData } = retrieveLaunchData().launchParams;
+const { initDataRaw, initData } = retrieveLaunchParams();
 ```
 
 ## Authorization and Authentication
@@ -42,9 +42,9 @@ carried out on the server side.
 Here is how a developer could send init data to server:
 
 ```typescript
-import { retrieveLaunchData } from '@tma.js/sdk';
+import { retrieveLaunchParams } from '@tma.js/sdk';
 
-const { initDataRaw } = retrieveLaunchData().launchParams;
+const { initDataRaw } = retrieveLaunchParams();
 
 fetch('https://example.com/api', {
     method: 'POST',

packages/sdk-react/src/tools/launch-params.tsx

@@ -1,11 +1,11 @@
-import { type LaunchParams, retrieveLaunchData } from '@tma.js/sdk';
+import { type LaunchParams, retrieveLaunchParams } from '@tma.js/sdk';
 import React, { type ComponentType, useMemo } from 'react';
 
 /**
  * Hooks to retrieve launch parameters.
  */
 export function useLaunchParams(): LaunchParams {
-  return useMemo(() => retrieveLaunchData().launchParams, []);
+  return useMemo(retrieveLaunchParams, []);
 }
 
 /**

packages/sdk-solid/src/tools/launch-params.tsx

@@ -1,8 +1,8 @@
-import { type LaunchParams, retrieveLaunchData } from '@tma.js/sdk';
+import { type LaunchParams, retrieveLaunchParams } from '@tma.js/sdk';
 
 /**
- * Hooks to retrieve launch parameters.
+ * Hook to retrieve launch parameters.
  */
 export function useLaunchParams(): LaunchParams {
-  return retrieveLaunchData().launchParams;
+  return retrieveLaunchParams();
 }

packages/sdk/src/bridge/__tests__/request.ts

@@ -16,9 +16,9 @@ import { type PostEvent, postEvent as globalPostEvent } from '../methods/postEve
 import { createWindow } from '../../../test-utils/createWindow';
 import { dispatchWindowMessageEvent } from '../../../test-utils/dispatchWindowMessageEvent';
 
-vi.mock('../methods/postEvent.js', async () => {
+vi.mock('../methods/postEvent', async () => {
   const { postEvent: actualPostEvent } = await vi
-    .importActual('../methods/postEvent.js') as { postEvent: PostEvent };
+    .importActual('../methods/postEvent') as { postEvent: PostEvent };
 
   return {
     postEvent: vi.fn(actualPostEvent),

packages/sdk/src/bridge/env/index.ts

@@ -1,3 +1,2 @@
 export * from './hasExternalNotify.js';
 export * from './hasWebviewProxy.js';
-export * from './isIframe.js';

packages/sdk/src/bridge/methods/postEvent.ts

@@ -1,3 +1,5 @@
+import { isIframe } from '~/misc/isIframe.js';
+
 import type {
   MiniAppsEmptyMethodName,
   MiniAppsMethodName,
@@ -8,7 +10,6 @@ import { logger, targetOrigin as globalTargetOrigin } from '../../globals.js';
 import {
   hasExternalNotify,
   hasWebviewProxy,
-  isIframe,
 } from '../env/index.js';
 
 interface PostEventOptions {

packages/sdk/src/index.ts

@@ -5,7 +5,6 @@ export {
 } from './back-button/index.js';
 export {
   createPostEvent,
-  isIframe,
   invokeCustomMethod,
   on,
   off,
@@ -90,6 +89,7 @@ export {
   launchParamsParser,
   parseLaunchParams,
   retrieveLaunchData,
+  retrieveLaunchParams,
   serializeLaunchParams,
   type LaunchParams,
   type LaunchData,
@@ -110,7 +110,12 @@ export {
   type MiniAppEvents,
   type MiniAppProps,
 } from './mini-app/index.js';
-export { isTMA, isRecord } from './misc/index.js';
+export {
+  isTMA,
+  isRecord,
+  isIframe,
+  isPageReload,
+} from './misc/index.js';
 export {
   getHash,
   HashNavigator,

packages/sdk/src/init/init.ts

@@ -1,4 +1,4 @@
-import { createPostEvent, isIframe, on } from '~/bridge/index.js';
+import { createPostEvent, on } from '~/bridge/index.js';
 import { CloudStorage } from '~/cloud-storage/index.js';
 import { HapticFeedback } from '~/haptic-feedback/index.js';
 import { catchCustomStyles } from '~/init/catchCustomStyles.js';
@@ -15,7 +15,8 @@ import {
 import { processCSSVars } from '~/init/css/index.js';
 import { InitData } from '~/init-data/index.js';
 import { Invoice } from '~/invoice/index.js';
-import { retrieveLaunchData } from '~/launch-params/index.js';
+import { retrieveLaunchParams } from '~/launch-params/index.js';
+import { isIframe, isPageReload } from '~/misc/index.js';
 import { Popup } from '~/popup/index.js';
 import { QRScanner } from '~/qr-scanner/index.js';
 import { Utils } from '~/utils/index.js';
@@ -37,18 +38,15 @@ export function init(options: InitOptions = {}): InitResult | Promise<InitResult
   } = options;
 
   try {
-    // Retrieve launch data.
     const {
-      launchParams: {
-        initData,
-        initDataRaw,
-        version,
-        platform,
-        themeParams,
-        botInline = false,
-      },
-      isPageReload,
-    } = retrieveLaunchData();
+      initData,
+      initDataRaw,
+      version,
+      platform,
+      themeParams,
+      botInline = false,
+    } = retrieveLaunchParams();
+    const isPageReloaded = isPageReload();
 
     const createRequestId = createRequestIdGenerator();
     const postEvent = createPostEvent(version);
@@ -68,20 +66,20 @@ export function init(options: InitOptions = {}): InitResult | Promise<InitResult
     }
 
     const result: Omit<InitResult, 'viewport'> = {
-      backButton: createBackButton(isPageReload, version, postEvent),
-      closingBehavior: createClosingBehavior(isPageReload, postEvent),
+      backButton: createBackButton(isPageReloaded, version, postEvent),
+      closingBehavior: createClosingBehavior(isPageReloaded, postEvent),
       cloudStorage: new CloudStorage(version, createRequestId, postEvent),
       createRequestId,
       hapticFeedback: new HapticFeedback(version, postEvent),
       invoice: new Invoice(version, postEvent),
       mainButton: createMainButton(
-        isPageReload,
+        isPageReloaded,
         themeParams.buttonColor || '#000000',
         themeParams.buttonTextColor || '#ffffff',
         postEvent,
       ),
       miniApp: createMiniApp(
-        isPageReload,
+        isPageReloaded,
         themeParams.backgroundColor || '#ffffff',
         version,
         botInline,
@@ -91,7 +89,7 @@ export function init(options: InitOptions = {}): InitResult | Promise<InitResult
       popup: new Popup(version, postEvent),
       postEvent,
       qrScanner: new QRScanner(version, postEvent),
-      settingsButton: createSettingsButton(isPageReload, version, postEvent),
+      settingsButton: createSettingsButton(isPageReloaded, version, postEvent),
       themeParams: createThemeParams(themeParams),
       utils: new Utils(version, createRequestId, postEvent),
       ...(initData
@@ -103,7 +101,7 @@ export function init(options: InitOptions = {}): InitResult | Promise<InitResult
         : {}),
     };
 
-    const viewport = createViewport(isPageReload, platform, postEvent, complete);
+    const viewport = createViewport(isPageReloaded, platform, postEvent, complete);
     if (viewport instanceof Promise || complete) {
       return Promise.resolve(viewport).then((vp) => {
         processCSSVars(

packages/sdk/src/launch-params/index.ts

@@ -1,13 +1,10 @@
-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 './retrieveLaunchParams.js';
 export * from './serializeLaunchParams.js';
 export * from './storage.js';
 export * from './types.js';