@tonconnect/ui 0.0.17 → 1.0.0-beta.0

package/lib/index.d.ts

@@ -1,4 +1,4 @@
-import { WalletInfoBase, WalletInfoInjected, WalletInfoRemote, ITonConnect, ConnectAdditionalRequest, Wallet, WalletInfo, Account, TonConnectError, SendTransactionRequest, SendTransactionResponse } from '@tonconnect/sdk';
+import { WalletInfoBase, WalletInfoInjectable, WalletInfoRemote, ITonConnect, Wallet, WalletInfo, Account, ConnectAdditionalRequest, TonConnectError, SendTransactionRequest, SendTransactionResponse } from '@tonconnect/sdk';
 import { Property } from 'csstype';
 
 declare type Locales = 'en' | 'ru';
@@ -32,6 +32,7 @@ declare type ColorsSet = {
     background: {
         primary: Color$1;
         secondary: Color$1;
+        segment: Color$1;
     };
     text: {
         primary: Color$1;
@@ -58,6 +59,7 @@ declare type PartialColorsSet = {
     background?: {
         primary?: Color$1;
         secondary?: Color$1;
+        segment?: Color$1;
     };
     text?: {
         primary?: Color$1;
@@ -72,7 +74,7 @@ interface UIPreferences {
      */
     theme?: Theme;
     /**
-     * Birder radius for UI elements.
+     * Border radius for UI elements.
      * @default 'm'
      */
     borderRadius?: BorderRadius;
@@ -82,35 +84,16 @@ interface UIPreferences {
     colorsSet?: Partial<Record<THEME, PartialColorsSet>>;
 }
 
-declare type UIWallet = WalletInfoBase & (Omit<WalletInfoInjected, 'injected' | 'embedded'> | WalletInfoRemote);
+declare type UIWallet = WalletInfoBase & (Omit<WalletInfoInjectable, 'injected' | 'embedded'> | WalletInfoRemote);
 
-declare type WalletsListConfiguration = WalletsListConfigurationExplicit | WalletsListConfigurationImplicit;
 /**
- * Configure whole list of wallets in the modal. Only passed wallets will be displayed.
+ * Add corrections to the default wallets list in the modal: add custom wallets and change wallets order.
  */
-declare type WalletsListConfigurationExplicit = {
-    /**
-     * Allows to configure wallets order and add custom wallets. Must be an array of wallets names from WalletsList or custom wallets.
-     */
-    wallets: (string | UIWallet)[];
-};
-/**
- * Add corrections to the default wallets list in the modal: exclude some wallets and add custom wallets.
- */
-declare type WalletsListConfigurationImplicit = {
-    /**
-     * Allows to exclude wallets from wallets list in the modal by its names. Must be an array of wallet's names from WalletsList.
-     */
-    excludeWallets?: string[];
+declare type WalletsListConfiguration = {
     /**
      * Allows to include extra wallets to the wallets list in the modal.
      */
     includeWallets?: UIWallet[];
-    /**
-     * Allows to specify order of the extra wallets in the wallets list in the modal. Cannot be applied if `includeWallets` is not specified.
-     * @default 'end'.
-     */
-    includeWalletsOrder?: 'start' | 'end';
 };
 
 /**
@@ -155,7 +138,7 @@ interface TonConnectUiOptions {
     /**
      * Configuration for the wallets list in the connect wallet modal.
      */
-    walletsList?: WalletsListConfiguration;
+    walletsListConfiguration?: WalletsListConfiguration;
     /**
      * Configuration for action-period (e.g. sendTransaction) UI elements: modals and notifications and wallet behaviour (return strategy).
      */
@@ -187,34 +170,34 @@ interface TonConnectUiCreateOptionsBase extends TonConnectUiOptions {
      * @default `div#tc-widget-root`.
      */
     widgetRootId?: string;
-    /**
-     * Use it to customize ConnectRequest and add `tonProof` payload.
-     * The function will be called after wallets modal opens, and wallets selection will be blocked until it's resolved.
-     * If you have to make a http-request to your backend, it is better to do it after app initialization (if possible) and return (probably completed) promise to reduce loading time for the user.
-     */
-    getConnectParameters?: () => Promise<ConnectAdditionalRequest>;
-    /**
-     * Redefine wallets list source URL. Must be a link to a json file with [following structure]{@link https://github.com/ton-connect/wallets-list}
-     * @default https://raw.githubusercontent.com/ton-connect/wallets-list/main/wallets.json
-     * @
-     */
-    walletsListSource?: string;
 }
 
 declare type WalletOpenMethod = 'qrcode' | 'universal-link';
-declare type WalletInfoWithOpenMethod = WalletInfoInjected | WalletInfoRemoteWithOpenMethod | (WalletInfoInjected & WalletInfoRemoteWithOpenMethod);
+declare type WalletInfoWithOpenMethod = WalletInfoInjectable | WalletInfoRemoteWithOpenMethod | (WalletInfoInjectable & WalletInfoRemoteWithOpenMethod);
 declare type WalletInfoRemoteWithOpenMethod = WalletInfoRemote & {
     openMethod: WalletOpenMethod;
 };
 declare type ConnectedWallet = Wallet & WalletInfoWithOpenMethod;
 
+declare type Loadable<T> = LoadableLoading | LoadableReady<T>;
+declare type LoadableLoading = {
+    state: 'loading';
+};
+declare type LoadableReady<T> = {
+    state: 'ready';
+    value: T;
+};
+
 declare class TonConnectUI {
     static getWallets(): Promise<WalletInfo[]>;
     private readonly walletInfoStorage;
-    private readonly connector;
-    private _walletInfo;
+    private readonly preferredWalletStorage;
+    readonly connector: ITonConnect;
+    private walletInfo;
     private systemThemeChangeUnsubscribe;
     private actionsConfiguration?;
+    private readonly walletsList;
+    private connectRequestParametersCallback?;
     /**
      * Promise that resolves after end of th connection restoring process (promise will fire after `onStatusChange`, so you can get actual information about wallet and session after when promise resolved).
      * Resolved value `true`/`false` indicates if the session was restored successfully.
@@ -229,19 +212,22 @@ declare class TonConnectUI {
      */
     get account(): Account | null;
     /**
-     * Curren connected wallet app or null.
+     * Curren connected wallet app and its info or null.
      */
-    get wallet(): Wallet | null;
-    /**
-     * Curren connected wallet's info or null.
-     */
-    get walletInfo(): WalletInfoWithOpenMethod | null;
+    get wallet(): (Wallet & WalletInfoWithOpenMethod) | null;
     /**
      * Set and apply new UI options. Object with partial options should be passed. Passed options will be merged with current options.
      * @param options
      */
     set uiOptions(options: TonConnectUiOptions);
     constructor(options?: TonConnectUiCreateOptions);
+    /**
+     * Use it to customize ConnectRequest and add `tonProof` payload.
+     * You can call it multiply times to set updated tonProof payload if previous one is outdated.
+     * If `connectRequestParameters.state === 'loading'` loader will appear instead of the qr code in the wallets modal.
+     * If `connectRequestParameters.state` was changed to 'ready' or it's value has been changed, QR will be re-rendered.
+     */
+    setConnectRequestParameters(connectRequestParameters: Loadable<ConnectAdditionalRequest> | undefined | null): void;
     /**
      * Returns available wallets list.
      */
@@ -266,6 +252,8 @@ declare class TonConnectUI {
      */
     sendTransaction(tx: SendTransactionRequest, options?: ActionConfiguration): Promise<SendTransactionResponse>;
     private subscribeToWalletChange;
+    private setPreferredWalletName;
+    private getSelectedWalletInfo;
     private updateWalletInfo;
     private normalizeWidgetRoot;
     private checkButtonRootExist;
@@ -278,4 +266,4 @@ declare class TonConnectUIError extends TonConnectError {
     constructor(...args: ConstructorParameters<typeof Error>);
 }
 
-export { ActionConfiguration, BorderRadius, Color, ColorsSet, ConnectedWallet, Locales, PartialColorsSet, ReturnStrategy, THEME, Theme, TonConnectUI, TonConnectUIError, TonConnectUiCreateOptions, TonConnectUiCreateOptionsBase, TonConnectUiOptions, TonConnectUiOptionsWithConnector, TonConnectUiOptionsWithManifest, UIPreferences, UIWallet, WalletInfoRemoteWithOpenMethod, WalletInfoWithOpenMethod, WalletOpenMethod, WalletsListConfiguration, WalletsListConfigurationExplicit, WalletsListConfigurationImplicit, TonConnectUI as default };
+export { ActionConfiguration, BorderRadius, Color, ColorsSet, ConnectedWallet, Loadable, LoadableLoading, LoadableReady, Locales, PartialColorsSet, ReturnStrategy, THEME, Theme, TonConnectUI, TonConnectUIError, TonConnectUiCreateOptions, TonConnectUiCreateOptionsBase, TonConnectUiOptions, TonConnectUiOptionsWithConnector, TonConnectUiOptionsWithManifest, UIPreferences, UIWallet, WalletInfoRemoteWithOpenMethod, WalletInfoWithOpenMethod, WalletOpenMethod, WalletsListConfiguration, TonConnectUI as default };