@tonconnect/ui 2.1.1-beta.0 → 2.2.0

package/lib/index.d.ts

@@ -1,4 +1,4 @@
-import { WalletInfoInjectable, WalletInfoRemote, RequiredFeatures, VersionEvent, ConnectionEvent, ConnectionRestoringEvent, DisconnectionEvent, TransactionSigningEvent, ITonConnect, EventDispatcher, SdkActionEvent, Wallet, WalletInfo, Account, ConnectAdditionalRequest, TonConnectError, SendTransactionRequest, SendTransactionResponse } from '@tonconnect/sdk';
+import { WalletInfoInjectable, WalletInfoRemote, RequiredFeatures, VersionEvent, ConnectionEvent, ConnectionRestoringEvent, DisconnectionEvent, TransactionSigningEvent, DataSigningEvent, ITonConnect, EventDispatcher, SdkActionEvent, Wallet, FeatureName, WalletInfo, Account, ConnectAdditionalRequest, TonConnectError, SendTransactionRequest, SendTransactionResponse, SignDataPayload, SignDataResponse } from '@tonconnect/sdk';
 export * from '@tonconnect/sdk';
 import { Property } from 'csstype';
 
@@ -161,6 +161,10 @@ interface TonConnectUiOptions {
      * Required features for wallets. If wallet doesn't support required features, it will be disabled.
      */
     walletsRequiredFeatures?: RequiredFeatures;
+    /**
+     * Preferred features for wallets. If wallet doesn't support preferred features, it will be moved to the end of the list.
+     */
+    walletsPreferredFeatures?: RequiredFeatures;
     /**
      * Configuration for action-period (e.g. sendTransaction) UI elements: modals and notifications and wallet behaviour (return strategy).
      */
@@ -175,7 +179,7 @@ interface TonConnectUiOptions {
 /**
  * User action events.
  */
-declare type UserActionEvent = VersionEvent | ConnectionEvent | ConnectionRestoringEvent | DisconnectionEvent | TransactionSigningEvent;
+declare type UserActionEvent = VersionEvent | ConnectionEvent | ConnectionRestoringEvent | DisconnectionEvent | TransactionSigningEvent | DataSigningEvent;
 
 declare type TonConnectUiCreateOptions = TonConnectUiOptionsWithConnector | TonConnectUiOptionsWithManifest;
 interface TonConnectUiOptionsWithManifest extends TonConnectUiCreateOptionsBase {
@@ -270,10 +274,25 @@ declare type WalletModalClosed = {
      */
     closeReason: WalletsModalCloseReason | null;
 };
+declare type ChooseSupportedFeatureWalletsModal = {
+    /**
+     * Modal window status.
+     */
+    status: 'opened';
+    /**
+     * Always `null` for choose supported feature wallet modal.
+     */
+    closeReason: null;
+    type: 'wallet-not-support-feature';
+    requiredFeature: {
+        featureName: FeatureName;
+        value?: RequiredFeatures['sendTransaction'];
+    };
+};
 /**
  * Modal window state.
  */
-declare type WalletsModalState = WalletModalOpened | WalletModalClosed;
+declare type WalletsModalState = WalletModalOpened | WalletModalClosed | ChooseSupportedFeatureWalletsModal;
 /**
  * Modal window close reason.
  */
@@ -331,7 +350,10 @@ declare class TonConnectUI {
     private systemThemeChangeUnsubscribe;
     private actionsConfiguration?;
     private readonly walletsList;
-    readonly walletsRequiredFeatures?: RequiredFeatures;
+    private _walletsRequiredFeatures?;
+    get walletsRequiredFeatures(): RequiredFeatures | undefined;
+    private _walletsPreferredFeatures?;
+    get walletsPreferredFeatures(): RequiredFeatures | undefined;
     private connectRequestParametersCallback?;
     /**
      * TonConnect instance.
@@ -444,6 +466,12 @@ declare class TonConnectUI {
      * @param options modal and notifications behaviour settings. Default is show only 'before' modal and all notifications.
      */
     sendTransaction(tx: SendTransactionRequest, options?: ActionConfiguration): Promise<SendTransactionResponse>;
+    /**
+     * Signs the data and returns the signature.
+     * @param data data to sign.
+     */
+    signData(data: SignDataPayload): Promise<SignDataResponse>;
+    private redirectAfterRequestSent;
     /**
      * TODO: remove in the next major version.
      * Initiates a connection with an embedded wallet, awaits its completion, and returns the connected wallet information.
@@ -481,6 +509,17 @@ declare class TonConnectUI {
      * @internal
      */
     private waitForSendTransaction;
+    /**
+     * Waits for a transaction to be sent based on provided options, returning the transaction response.
+     * @param options - Configuration for transaction statuses and errors handling.
+     * @options.transaction - Transaction to send.
+     * @options.ignoreErrors - If true, ignores errors during waiting, waiting continues until a valid transaction is sent. Default is false.
+     * @options.abortSignal - Optional AbortSignal for external cancellation. Throws TonConnectUIError if aborted.
+     * @param onRequestSent (optional) will be called after the transaction is sent to the wallet.
+     * @throws TonConnectUIError if waiting is aborted or no valid transaction response is received and ignoreErrors is false.
+     * @internal
+     */
+    private waitForSignData;
     /**
      * Subscribe to the transaction modal window state changes, returns a function which has to be called to unsubscribe.
      * @internal