@tma.js/sdk 0.12.7 → 0.12.8

package/src/components/InitData/InitData.ts

@@ -19,7 +19,7 @@ type InitDataState = {
 };
 
 /**
- * Class which is responsible for displaying Web Apps init data.
+ * Class which is responsible for displaying Mini Apps init data.
  */
 export class InitData {
   private readonly state: State<InitDataState>;
@@ -63,18 +63,17 @@ export class InitData {
   }
 
   /**
-   * Date after which a message can be sent via the answerWebAppQuery
-   * method.
-   * @see https://core.telegram.org/bots/api#answerwebappquery
+   * Date after which a message can be sent via the
+   * [answerWebAppQuery](https://core.telegram.org/bots/api#answerwebappquery) method.
    */
   get canSendAfter(): Date | null {
     return this.state.get('canSendAfter');
   }
 
   /**
-   * An object containing data about the chat where the bot was
-   * launched via the attachment menu. Returned for supergroups, channels and
-   * group chats – only for Web Apps launched via the attachment menu.
+   * An object containing data about the chat where the bot was launched via the attachment
+   * menu. Returned for supergroups, channels and group chats – only for Mini Apps launched via
+   * the attachment menu.
    */
   get chat(): Chat | null {
     return this.state.get('chat');
@@ -88,8 +87,8 @@ export class InitData {
   }
 
   /**
-   * A global identifier indicating the chat from which Mini App was
-   * opened. Returned only for applications opened by direct link.
+   * A global identifier indicating the chat from which Mini App was opened. Returned only for
+   * applications opened by direct link.
    */
   get chatInstance(): ChatType | null {
     return this.state.get('chatInstance');
@@ -105,7 +104,7 @@ export class InitData {
   }
 
   /**
-   * A unique identifier for the Web App session, required for sending
+   * A unique identifier for the Mini App session, required for sending
    * messages via the `answerWebAppQuery` method.
    * @see https://core.telegram.org/bots/api#answerwebappquery
    */
@@ -116,7 +115,7 @@ export class InitData {
   /**
    * An object containing data about the chat partner of the current
    * user in the chat where the bot was launched via the attachment menu.
-   * Returned only for private chats and only for Web Apps launched
+   * Returned only for private chats and only for Mini Apps launched
    * via the attachment menu.
    */
   get receiver(): User | null {
@@ -125,7 +124,7 @@ export class InitData {
 
   /**
    * The value of the `startattach` parameter, passed via link. Only
-   * returned for Web Apps when launched from the attachment menu via link.
+   * returned for Mini Apps when launched from the attachment menu via link.
    */
   get startParam(): string | null {
     return this.state.get('startParam');

package/src/components/MainButton/MainButton.ts

@@ -9,7 +9,7 @@ import type { MainButtonEventListener, MainButtonEvents, MainButtonState } from
 
 /**
  * Controls the main button, which is displayed at the bottom
- * of the Web App in the Telegram interface.
+ * of the Mini App in the Telegram interface.
  */
 export class MainButton {
   private readonly ee = new EventEmitter<MainButtonEvents>();
@@ -175,8 +175,8 @@ export class MainButton {
   };
 
   /**
-   * Shows the button. Note that opening the Web App from the attachment
-   * menu hides the main button until the user interacts with the Web App
+   * Shows the button. Note that opening the Mini App from the attachment
+   * menu hides the main button until the user interacts with the Mini App
    * interface.
    *
    * Returns current button instance for chaining.

package/src/components/Viewport/Viewport.ts

@@ -72,7 +72,7 @@ export class Viewport {
 
   /**
    * Returns initialized instance of Viewport which is synchronized with
-   * its actual state in Web Apps.
+   * its actual state in Mini Apps.
    * @param options - method options.
    */
   static async synced(options: RequestOptions = {}): Promise<Viewport> {
@@ -104,12 +104,12 @@ export class Viewport {
   }
 
   /**
-   * The current height of the visible area of the Web App.
+   * The current height of the visible area of the Mini App.
    *
-   * The application can display just the top part of the Web App, with its
+   * The application can display just the top part of the Mini App, with its
    * lower part remaining outside the screen area. From this position, the
-   * user can "pull" the Web App to its maximum height, while the bot can do
-   * the same by calling `expand` method. As the position of the Web App
+   * user can "pull" the Mini App to its maximum height, while the bot can do
+   * the same by calling `expand` method. As the position of the Mini App
    * changes, the current height value of the visible area will be updated
    * in real time.
    *
@@ -128,18 +128,18 @@ export class Viewport {
   }
 
   /**
-   * The height of the visible area of the Web App in its last stable state.
+   * The height of the visible area of the Mini App in its last stable state.
    *
-   * The application can display just the top part of the Web App, with its
+   * The application can display just the top part of the Mini App, with its
    * lower part remaining outside the screen area. From this position,
-   * the user can "pull" the Web App to its maximum height, while the bot can
+   * the user can "pull" the Mini App to its maximum height, while the bot can
    * do the same by calling `expand` method.
    *
    * Unlike the value of `height`, the value of `stableHeight`
-   * does not change as the position of the Web App changes with user
+   * does not change as the position of the Mini App changes with user
    * gestures or during animations. The value of `stableHeight`
    * will be updated after all gestures and animations are completed and
-   * the Web App reaches its final size.
+   * the Mini App reaches its final size.
    *
    * @see init
    * @see expand
@@ -150,8 +150,8 @@ export class Viewport {
   }
 
   /**
-   * Returns true if the Web App is expanded to the maximum available height.
-   * Otherwise, if the Web App occupies part of the screen and can be expanded
+   * Returns true if the Mini App is expanded to the maximum available height.
+   * Otherwise, if the Mini App occupies part of the screen and can be expanded
    * to the full height using `expand` method.
    * @see expand
    */
@@ -167,8 +167,8 @@ export class Viewport {
   }
 
   /**
-   * A method that expands the Web App to the maximum available height. To
-   * find out if the Web App is expanded to the maximum height, refer to the
+   * A method that expands the Mini App to the maximum available height. To
+   * find out if the Mini App is expanded to the maximum height, refer to the
    * value of the `isExpanded`.
    * @see isExpanded
    */

package/src/components/WebApp/WebApp.ts

@@ -20,7 +20,7 @@ import type { ColorScheme } from '../../types.js';
 import type { WebAppEvents, WebAppHeaderColor, WebAppState } from './types.js';
 
 /**
- * Provides common Web Apps functionality not covered by other system
+ * Provides common Mini Apps functionality not covered by other system
  * components.
  */
 export class WebApp {
@@ -70,7 +70,7 @@ export class WebApp {
   }
 
   /**
-   * Closes the Web App.
+   * Closes the Mini App.
    */
   close(): void {
     this.postEvent('web_app_close');
@@ -85,7 +85,7 @@ export class WebApp {
 
   /**
    * Returns true if passed version is more than or equal to current
-   * Web App version.
+   * Mini App version.
    * @param version - compared version.
    */
   isVersionAtLeast(version: Version): boolean {
@@ -93,10 +93,10 @@ export class WebApp {
   }
 
   /**
-   * Opens a link in an external browser. The Web App will not be closed.
+   * Opens a link in an external browser. The Mini App will not be closed.
    *
    * Note that this method can be called only in response to the user
-   * interaction with the Web App interface (e.g. click inside the Web App
+   * interaction with the Mini App interface (e.g. click inside the Mini App
    * or on the main button).
    * @param url - URL to be opened.
    * @param tryInstantView
@@ -118,7 +118,7 @@ export class WebApp {
   }
 
   /**
-   * Opens a Telegram link inside Telegram app. The Web App will be closed.
+   * Opens a Telegram link inside Telegram app. The Mini App will be closed.
    * It expects passing link in full format, with hostname "t.me".
    * @param url - URL to be opened.
    * @throws {Error} URL has not allowed hostname.
@@ -179,18 +179,18 @@ export class WebApp {
   off = this.ee.off.bind(this.ee);
 
   /**
-   * Returns current Web App platform.
+   * Returns current Mini App platform.
    */
   get platform(): Platform {
     return this.currentPlatform;
   }
 
   /**
-   * Informs the Telegram app that the Web App is ready to be displayed.
+   * Informs the Telegram app that the Mini App is ready to be displayed.
    *
    * It is recommended to call this method as early as possible, as soon as
    * all essential interface elements loaded. Once this method called,
-   * the loading placeholder is hidden and the Web App shown.
+   * the loading placeholder is hidden and the Mini App shown.
    *
    * If the method not called, the placeholder will be hidden only when
    * the page fully loaded.
@@ -242,10 +242,10 @@ export class WebApp {
   /**
    * A method used to send data to the bot. When this method called, a
    * service message sent to the bot containing the data of the
-   * length up to 4096 bytes, and the Web App closed. See the field
+   * length up to 4096 bytes, and the Mini App closed. See the field
    * `web_app_data` in the class Message.
    *
-   * This method is only available for Web Apps launched via a Keyboard button.
+   * This method is only available for Mini Apps launched via a Keyboard button.
    * @param data - data to send to bot.
    * @throws {Error} data has incorrect size.
    */
@@ -302,7 +302,7 @@ export class WebApp {
   supportsParam: SupportsFunc<'setHeaderColor.color' | 'openLink.tryInstantView'>;
 
   /**
-   * Current Web App version. This property is used by other components to check if
+   * Current Mini App version. This property is used by other components to check if
    * some functionality is available on current device.
    */
   get version(): Version {

package/src/env.ts

@@ -1,7 +1,7 @@
 import { retrieveLaunchParams } from './launch-params.js';
 
 /**
- * Returns true in case, current environment is Telegram Web Apps.
+ * 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.

package/src/errors/MethodNotSupportedError.ts

@@ -3,7 +3,7 @@
  */
 export class MethodNotSupportedError extends Error {
   constructor(method: string, version: string) {
-    super(`Method "${method}" is not supported in the Web Apps version ${version}.`);
+    super(`Method "${method}" is not supported in the Mini Apps version ${version}.`);
     Object.setPrototypeOf(this, MethodNotSupportedError.prototype);
   }
 }

package/src/errors/ParameterNotSupportedError.ts

@@ -3,7 +3,7 @@
  */
 export class ParameterUnsupportedError extends Error {
   constructor(method: string, param: string, version: string) {
-    super(`Parameter "${param}" in method "${method}" is not supported in the Web Apps version ${version}.`);
+    super(`Parameter "${param}" in method "${method}" is not supported in the Mini Apps version ${version}.`);
     Object.setPrototypeOf(this, ParameterUnsupportedError.prototype);
   }
 }

package/src/init/creators/createViewport.ts

@@ -9,7 +9,7 @@ import { getStorageValue, saveStorageValue } from '../../storage.js';
  * Creates Viewport instance using last locally saved data also saving each state in
  * the storage.
  * @param isPageReload - was current page reloaded.
- * @param platform - Telegram Web Apps platform name.
+ * @param platform - Telegram Mini Apps platform name.
  * @param postEvent - Bridge postEvent function
  */
 export async function createViewport(

package/src/init/creators/createWebApp.ts

@@ -14,7 +14,7 @@ import type { CreateRequestIdFunc } from '../../types.js';
  * @param isPageReload - was current page reloaded.
  * @param backgroundColor - web app background color.
  * @param version - platform version.
- * @param platform - Telegram Web Apps platform name.
+ * @param platform - Telegram Mini Apps platform name.
  * @param createRequestId - function which generates request identifiers.
  * @param postEvent - Bridge postEvent function
  */

package/src/init/css.ts

@@ -58,7 +58,7 @@ function createThemeVariables(themeParams: ThemeParams): void {
 }
 
 /**
- * Creates CSS variables based on Web App background and header colors with
+ * Creates CSS variables based on Mini App background and header colors with
  * theme parameters.
  * @param webApp - WebApp instance.
  * @param themeParams - theme parameters.

package/src/init/init.ts

@@ -93,7 +93,7 @@ async function actualInit(options: InitOptions = {}): Promise<InitResult> {
     setTargetOrigin(targetOrigin);
   }
 
-  // Get Web App launch params and save them to session storage, so they will be accessible from
+  // 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'

package/src/init/types.ts

@@ -83,7 +83,7 @@ export interface InitOptions {
 
   /**
    * Should SDK throw an error in case, unsupported by current version of
-   * Web App method was called. It is highly recommended not to disable this
+   * Mini App method was called. It is highly recommended not to disable this
    * feature as long as it helps developer to find issues related to usage
    * of unsupported methods.
    *