@tma.js/sdk 2.0.2 → 2.2.0

package/dist/dts/bridge/events/types.d.ts

@@ -1,6 +1,7 @@
 import { RGB } from '../../colors/types.js';
+import { EventListener } from '../../events/event-emitter/types.js';
+import { RemoveEventListenerFn } from '../../events/types.js';
 import { EventEmitter } from '../../events/event-emitter/EventEmitter.js';
-import { EventListener, SubscribeListener } from '../../events/event-emitter/types.js';
 import { RequestId } from '../../request-id/types.js';
 
 export type InvoiceStatus = 'paid' | 'failed' | 'pending' | 'cancelled' | string;
@@ -286,11 +287,16 @@ export type MiniAppsEventPayload<E extends MiniAppsEventName> = MiniAppsEvents[E
  * Returns event listener for the specified Mini Apps event.
  */
 export type MiniAppsEventListener<E extends MiniAppsEventName> = EventListener<MiniAppsEvents[E]>;
+export interface MiniAppsEventEmitter extends Pick<EventEmitter<MiniAppsEvents>, 'on' | 'off' | 'count'> {
+    subscribe(listener: MiniAppsSubscribeListener): RemoveEventListenerFn;
+    unsubscribe(listener: MiniAppsSubscribeListener): void;
+}
 /**
  * Mini Apps event listener used in `subscribe` and `unsubscribe` functions.
  */
-export type MiniAppsSubscribeListener = SubscribeListener<MiniAppsEvents>;
-/**
- * Mini Apps event emitter.
- */
-export type MiniAppsEventEmitter = EventEmitter<MiniAppsEvents>;
+export type MiniAppsSubscribeListener = (payload: {
+    [E in MiniAppsEventName]: {
+        name: E;
+        payload: MiniAppsEventPayload<E>;
+    };
+}[MiniAppsEventName]) => void;

package/dist/dts/components/BackButton/initBackButton.d.ts

@@ -4,4 +4,4 @@ import { BackButton } from './BackButton.js';
  * @returns A new initialized instance of the `BackButton` class.
  * @see BackButton
  */
-export declare const initBackButton: import('../../index.js').InitComponentFn<"version", BackButton, import('./types.js').BackButtonState>;
+export declare const initBackButton: import('../../index.js').InitDynamicComponentFn<BackButton>;

package/dist/dts/components/BiometryManager/initBiometryManager.d.ts

@@ -4,4 +4,4 @@ import { BiometryManager } from './BiometryManager.js';
  * @returns A promise with a new initialized instance of the `BiometryManager` class.
  * @see BiometryManager
  */
-export declare const initBiometryManager: import('../../index.js').InitComponentFn<"version", Promise<BiometryManager>, import('./types.js').BiometryManagerState>;
+export declare const initBiometryManager: import('../../index.js').InitDynamicComponentFn<Promise<BiometryManager>>;

package/dist/dts/components/ClosingBehavior/initClosingBehavior.d.ts

@@ -4,4 +4,4 @@ import { ClosingBehavior } from './ClosingBehavior.js';
  * @returns A new initialized instance of the `ClosingBehavior` class.
  * @see ClosingBehavior
  */
-export declare const initClosingBehavior: import('../../index.js').InitComponentFn<never, ClosingBehavior, import('./types.js').ClosingBehaviorState>;
+export declare const initClosingBehavior: import('../../index.js').InitDynamicComponentFn<ClosingBehavior>;

package/dist/dts/components/CloudStorage/initCloudStorage.d.ts

@@ -4,4 +4,4 @@ import { CloudStorage } from './CloudStorage.js';
  * @returns A new initialized instance of the `CloudStorage` class.
  * @see CloudStorage
  */
-export declare const initCloudStorage: import('../../index.js').InitComponentFn<"version", CloudStorage, never>;
+export declare const initCloudStorage: import('../../index.js').InitStaticComponentFn<CloudStorage>;

package/dist/dts/components/HapticFeedback/initHapticFeedback.d.ts

@@ -4,4 +4,4 @@ import { HapticFeedback } from './HapticFeedback.js';
  * @returns A new initialized instance of the `HapticFeedback` class.
  * @see HapticFeedback
  */
-export declare const initHapticFeedback: import('../../index.js').InitComponentFn<"version", HapticFeedback, never>;
+export declare const initHapticFeedback: import('../../index.js').InitStaticComponentFn<HapticFeedback>;

package/dist/dts/components/InitData/initInitData.d.ts

@@ -4,4 +4,4 @@ import { InitData } from './InitData.js';
  * @returns A new initialized instance of the `InitData` class or undefined.
  * @see InitData
  */
-export declare const initInitData: import('../../index.js').InitComponentFn<"initData", InitData | undefined, never>;
+export declare const initInitData: import('../../index.js').InitStaticComponentFn<InitData | undefined>;

package/dist/dts/components/Invoice/initInvoice.d.ts

@@ -4,4 +4,4 @@ import { Invoice } from './Invoice.js';
  * @returns A new initialized instance of the `Invoice` class.
  * @see Invoice
  */
-export declare const initInvoice: import('../../index.js').InitComponentFn<"version", Invoice, never>;
+export declare const initInvoice: import('../../index.js').InitStaticComponentFn<Invoice>;

package/dist/dts/components/MainButton/MainButton.d.ts

@@ -11,37 +11,14 @@ type Emitter = EventEmitter<MainButtonEvents>;
 export declare class MainButton extends WithStateUtils<MainButtonState> {
     private readonly postEvent;
     constructor({ postEvent, ...rest }: MainButtonProps);
-    /**
-     * Sends current local state to the Telegram application.
-     */
-    private commit;
-    private set isEnabled(value);
-    /**
-     * True if the MainButton is enabled.
-     */
-    get isEnabled(): boolean;
-    private set isLoaderVisible(value);
-    /**
-     * True if the MainButton loader is visible.
-     */
-    get isLoaderVisible(): boolean;
-    private set isVisible(value);
-    /**
-     * True if the MainButton is visible.
-     */
-    get isVisible(): boolean;
     /**
      * The MainButton background color.
      */
-    get backgroundColor(): RGB;
+    get bgColor(): RGB;
     /**
-     * The MainButton text.
-     */
-    get text(): string;
-    /**
-     * The MainButton text color.
+     * Sends current local state to the Telegram application.
      */
-    get textColor(): RGB;
+    private commit;
     /**
      * Disables the MainButton.
      * @see Does not work on Android: https://github.com/Telegram-Mini-Apps/issues/issues/1
@@ -59,6 +36,21 @@ export declare class MainButton extends WithStateUtils<MainButtonState> {
      * Hides the MainButton loading indicator.
      */
     hideLoader(): this;
+    private set isEnabled(value);
+    /**
+     * True if the MainButton is enabled.
+     */
+    get isEnabled(): boolean;
+    private set isLoaderVisible(value);
+    /**
+     * True if the MainButton loader is visible.
+     */
+    get isLoaderVisible(): boolean;
+    private set isVisible(value);
+    /**
+     * True if the MainButton is visible.
+     */
+    get isVisible(): boolean;
     /**
      * Adds a new event listener.
      * @param event - event to listen.
@@ -94,13 +86,21 @@ export declare class MainButton extends WithStateUtils<MainButtonState> {
     setTextColor(textColor: RGB): this;
     /**
      * Updates current Main Button color.
-     * @param backgroundColor - color to set.
+     * @param bgColor - color to set.
      */
-    setBackgroundColor(backgroundColor: RGB): this;
+    setBgColor(bgColor: RGB): this;
     /**
      * Allows setting multiple Main Button parameters.
      * @param params - Main Button parameters.
      */
     setParams(params: Partial<MainButtonParams>): this;
+    /**
+     * The MainButton text.
+     */
+    get text(): string;
+    /**
+     * The MainButton text color.
+     */
+    get textColor(): RGB;
 }
 export {};

package/dist/dts/components/MainButton/initMainButton.d.ts

@@ -4,4 +4,4 @@ import { MainButton } from './MainButton.js';
  * @returns A new initialized instance of the `MainButton` class.
  * @see MainButton
  */
-export declare const initMainButton: import('../../index.js').InitComponentFn<"themeParams", MainButton, import('./types.js').MainButtonState>;
+export declare const initMainButton: import('../../index.js').InitDynamicComponentFn<MainButton>;

package/dist/dts/components/MainButton/types.d.ts

@@ -3,7 +3,7 @@ import { StateEvents } from '../../classes/State/types.js';
 import { RGB } from '../../colors/types.js';
 
 export interface MainButtonParams {
-    backgroundColor: RGB;
+    bgColor: RGB;
     isEnabled: boolean;
     isLoaderVisible: boolean;
     isVisible: boolean;

package/dist/dts/components/MiniApp/initMiniApp.d.ts

@@ -4,4 +4,4 @@ import { MiniApp } from './MiniApp.js';
  * @returns A new initialized instance of the `MiniApp` class.
  * @see MiniApp
  */
-export declare const initMiniApp: import('../../index.js').InitComponentFn<"botInline" | "themeParams" | "version", MiniApp, import('./types.js').MiniAppState>;
+export declare const initMiniApp: import('../../index.js').InitDynamicComponentFn<MiniApp>;

package/dist/dts/components/Popup/initPopup.d.ts

@@ -4,4 +4,4 @@ import { Popup } from './Popup.js';
  * @returns A new initialized instance of the `Popup` class.
  * @see Popup
  */
-export declare const initPopup: import('../../index.js').InitComponentFn<"version", Popup, never>;
+export declare const initPopup: import('../../index.js').InitStaticComponentFn<Popup>;

package/dist/dts/components/QRScanner/initQRScanner.d.ts

@@ -4,4 +4,4 @@ import { QRScanner } from './QRScanner.js';
  * @returns A new initialized instance of the `QRScanner` class.
  * @see QRScanner
  */
-export declare const initQRScanner: import('../../index.js').InitComponentFn<"version", QRScanner, never>;
+export declare const initQRScanner: import('../../index.js').InitStaticComponentFn<QRScanner>;

package/dist/dts/components/SettingsButton/initSettingsButton.d.ts

@@ -4,4 +4,4 @@ import { SettingsButton } from './SettingsButton.js';
  * @returns A new initialized instance of the `SettingsButton` class.
  * @see SettingsButton
  */
-export declare const initSettingsButton: import('../../index.js').InitComponentFn<"version", SettingsButton, import('./types.js').SettingsButtonState>;
+export declare const initSettingsButton: import('../../index.js').InitDynamicComponentFn<SettingsButton>;

package/dist/dts/components/ThemeParams/initThemeParams.d.ts

@@ -4,4 +4,4 @@ import { ThemeParams } from './ThemeParams.js';
  * @returns A new initialized instance of the `ThemeParams` class.
  * @see ThemeParams
  */
-export declare const initThemeParams: import('../../index.js').InitComponentFn<"themeParams", ThemeParams, import('./types.js').ThemeParamsParsed>;
+export declare const initThemeParams: import('../../index.js').InitDynamicComponentFn<ThemeParams>;

package/dist/dts/components/Utils/initUtils.d.ts

@@ -4,4 +4,4 @@ import { Utils } from './Utils.js';
  * @returns A new initialized instance of the `Utils` class.
  * @see Utils
  */
-export declare const initUtils: import('../../index.js').InitComponentFn<"version", Utils, never>;
+export declare const initUtils: import('../../index.js').InitStaticComponentFn<Utils>;

package/dist/dts/components/Viewport/initViewport.d.ts

@@ -1,8 +1,7 @@
 import { Viewport } from './Viewport.js';
-import { ViewportState } from './types.js';
 
 /**
  * @returns A promise with a new initialized instance of the `Viewport` class.
  * @see Viewport
  */
-export declare const initViewport: import('../../misc/createComponentInitFn/types.js').InitComponentFn<"platform", Promise<Viewport>, ViewportState>;
+export declare const initViewport: import('../../index.js').InitDynamicComponentFn<Promise<Viewport>>;

package/dist/dts/index.d.ts

@@ -118,7 +118,7 @@ export * from './launch-params/types.js';
 /**
  * Misc.
  */
-export type { FactoryOptions, FactoryStatic, Factory, FactoryDynamic, InitComponentFn, WithOnChange, } from './misc/createComponentInitFn/types.js';
+export type { FactoryOptions, FactoryStatic, Factory, FactoryDynamic, InitComponentFn, InitStaticComponentFn, InitDynamicComponentFn, WithOnChange, } from './misc/createComponentInitFn/types.js';
 /**
  * Navigation.
  */

package/dist/dts/misc/createCleanup.d.ts

@@ -0,0 +1,11 @@
+import { CleanupFn } from '../types/index.js';
+
+/**
+ * Returns a tuple, containing function to add cleanup, call cleanup, and flag showing whether
+ * cleanup was called. Cleanup will not be performed in case, it was done before.
+ */
+export declare function createCleanup(...fns: CleanupFn[]): [
+    add: (fn: CleanupFn) => void,
+    call: () => void,
+    cleanedUp: boolean
+];

package/dist/dts/misc/createComponentInitFn/createComponentInitFn.d.ts

@@ -1,15 +1,16 @@
-import { LaunchParamName } from '../../launch-params/types.js';
 import { StorageKey, StorageValue } from '../../storage/storage.js';
-import { FactoryDynamic, FactoryStatic, InitComponentFn, WithOnChange } from './types.js';
+import { FactoryDynamic, FactoryStatic, InitStaticComponentFn, InitDynamicComponentFn, WithOnChange } from './types.js';
 
 /**
- * Creates new init function based only on common options.
+ * Creates a new init function based on factory, creating a component, not synchronizing its
+ * state with the session storage.
  * @param factory - function creating new component instance.
  */
-export declare function createComponentInitFn<R, LP extends LaunchParamName = never>(factory: FactoryStatic<LP, R>): InitComponentFn<LP, R, never>;
+export declare function createComponentInitFn<R>(factory: FactoryStatic<R>): InitStaticComponentFn<R>;
 /**
- * Creates new init function based on common options and storage data.
+ * Creates a new init function based on factory, creating a component, synchronizing its
+ * state with the session storage.
  * @param factory - function creating new component instance.
  * @param storageKey - storage key to restore component from.
  */
-export declare function createComponentInitFn<SK extends StorageKey, R extends WithOnChange<StorageValue<SK>> | Promise<WithOnChange<StorageValue<SK>>>, LP extends LaunchParamName = never>(storageKey: SK, factory: FactoryDynamic<LP, R, SK>): InitComponentFn<LP, R, StorageValue<SK>>;
+export declare function createComponentInitFn<SK extends StorageKey, R extends WithOnChange<StorageValue<SK>> | Promise<WithOnChange<StorageValue<SK>>>>(storageKey: SK, factory: FactoryDynamic<R, SK>): InitDynamicComponentFn<R>;

package/dist/dts/misc/createComponentInitFn/types.d.ts

@@ -1,46 +1,54 @@
 import { PostEvent } from '../../bridge/methods/postEvent.js';
-import { LaunchParamName, PickLaunchParams } from '../../launch-params/types.js';
+import { LaunchParams } from '../../launch-params/types.js';
 import { CreateRequestIdFn } from '../../request-id/types.js';
 import { StorageKey, StorageValue } from '../../storage/storage.js';
-import { If, IsNever } from '../../types/index.js';
+import { CleanupFn, If, IsNever } from '../../types/index.js';
+import { RemoveEventListenerFn } from '../../events/types.js';
 
 /**
  * Object, which supports tracking its state changes.
  */
 export interface WithOnChange<State> {
-    on(event: 'change', listener: (state: State) => void): void;
+    on(event: 'change', listener: (state: State) => void): RemoveEventListenerFn;
 }
-type WithState<State> = If<IsNever<State>, {}, {
-    state?: State;
-}>;
 /**
  * Options passed to a component factory.
  */
-export type FactoryOptions<LP extends LaunchParamName, State> = PickLaunchParams<LP> & WithState<State> & {
+export type FactoryOptions<State, SideEffects extends boolean> = LaunchParams & {
     postEvent: PostEvent;
     createRequestId: CreateRequestIdFn;
-};
-export interface Factory<LP extends LaunchParamName, R, State> {
+} & If<IsNever<State>, {}, {
+    state?: State;
+}> & If<SideEffects, {
+    addCleanup(fn: CleanupFn): void;
+}, {}>;
+export interface Factory<Result, SideEffects extends boolean, State> {
     /**
      * Creates a new component instance.
      * @param options - factory options.
      */
-    (options: FactoryOptions<LP, State>): R;
+    (options: FactoryOptions<State, SideEffects>): Result;
 }
-export interface FactoryStatic<LP extends LaunchParamName, R> extends Factory<LP, R, never> {
+export interface FactoryStatic<Result> extends Factory<Result, false, never> {
 }
-export interface FactoryDynamic<LP extends LaunchParamName, R, SK extends StorageKey> extends Factory<LP, R, StorageValue<SK>> {
+export interface FactoryDynamic<Result, SK extends StorageKey> extends Factory<Result, true, StorageValue<SK>> {
 }
-export interface InitComponentFn<LP extends LaunchParamName, Result, State> {
+export interface InitComponentFn<Result, SideEffects extends boolean> {
     /**
-     * Initializes new component instance.
-     * @param options - initialization options.
+     * Initializes a new static component instance.
      */
-    (options?: {
+    (): If<SideEffects, [
+        /**
+         * Execution result.
+         */
+        result: Result,
         /**
-         * Options, applicable only to SSR mode.
+         * Cleanup function.
          */
-        ssr?: Partial<PickLaunchParams<LP>> & WithState<State>;
-    }): Result;
+        cleanup: CleanupFn
+    ], Result>;
+}
+export interface InitStaticComponentFn<Result> extends InitComponentFn<Result, false> {
+}
+export interface InitDynamicComponentFn<Result> extends InitComponentFn<Result, true> {
 }
-export {};

package/dist/dts/navigation/BrowserNavigator/BrowserNavigator.d.ts

@@ -5,7 +5,7 @@ type Emitter<State> = EventEmitter<BrowserNavigatorEvents<State>>;
 export declare class BrowserNavigator<State = {}> {
     private readonly navigator;
     private readonly ee;
-    readonly hashMode?: BrowserNavigatorHashMode;
+    readonly hashMode: BrowserNavigatorHashMode | null;
     readonly base: string;
     constructor(
     /**

package/dist/dts/navigation/BrowserNavigator/types.d.ts

@@ -13,9 +13,10 @@ export interface BrowserNavigatorConOptions {
      */
     base?: string;
     /**
-     * Hash navigation mode. Omit, if non-hash mode is required.
+     * Hash navigation mode. Pass null to enable MPA (Multi Page Application) navigation.
+     * @default 'classic'
      */
-    hashMode?: BrowserNavigatorHashMode;
+    hashMode?: BrowserNavigatorHashMode | null;
     /**
      * Function to call Mini Apps methods.
      * @default Global postEvent function.
@@ -32,12 +33,12 @@ export interface BrowserNavigatorHistoryItem<State> extends URLLike {
 export type BrowserNavigatorAnyHistoryItem<State> = string | Partial<BrowserNavigatorHistoryItem<State>>;
 /**
  * Hash navigation mode.
- * @example 'default'
+ * @example 'classic'
  * '#pathname?search'
  * @example 'slash'
  * '#/pathname?search'
  */
-export type BrowserNavigatorHashMode = 'default' | 'slash';
+export type BrowserNavigatorHashMode = 'classic' | 'slash';
 /**
  * Events supported by `BrowserNavigator`.
  */