@privy-io/react-auth 1.76.1 → 1.76.3-beta-20240726135350

package/dist/index.d.ts

@@ -241,7 +241,7 @@ type RpcConfig = {
     };
 };
 
-declare const DEFAULT_SUPPORTED_CHAINS: readonly [Chain, Chain, Chain, Chain, Chain, Chain, Chain, Chain, Chain, Chain, Chain, Chain, Chain, Chain, Chain, Chain, Chain, Chain, Chain, Chain, Chain, Chain, Chain, Chain, Chain, Chain, Chain, Chain, Chain, Chain];
+declare const DEFAULT_SUPPORTED_CHAINS: readonly [Chain, Chain, Chain, Chain, Chain, Chain, Chain, Chain, Chain, Chain, Chain, Chain, Chain, Chain, Chain, Chain, Chain, Chain, Chain, Chain, Chain, Chain, Chain, Chain, Chain, Chain, Chain, Chain, Chain, Chain, Chain];
 
 type WalletCreateRequestDataType = {
     accessToken: string;
@@ -1122,8 +1122,8 @@ declare class PrivyClient {
     updateApiUrl(customApiUrl?: string | null): void;
     authenticate(): Promise<{
         user: User | null;
-        isNewUser?: boolean | undefined;
-        oAuthTokens?: OAuthTokens | undefined;
+        isNewUser?: boolean;
+        oAuthTokens?: OAuthTokens;
     }>;
     link(): Promise<{
         user: User | null;
@@ -2677,6 +2677,11 @@ interface PrivyInterface {
      *
      */
     updateEmail: () => void;
+    /**
+     * For users who are authenticated and have already linked a phone number, prompts the user to update their phone number.
+     * This will open the Privy Modal which will guide the user through this action.
+     */
+    updatePhone: () => void;
     /**
      * Log the current user out and clears their authentication state. `authenticated` will become false, `user` will become null, and the Privy Auth tokens will be deleted from the browser's local storage.
      *
@@ -3177,8 +3182,8 @@ declare function useWallets(): UseWalletsInterface;
  */
 declare function useMfa(): {
     promptMfa: () => Promise<void>;
-    init: (mfaMethod: "sms" | "totp" | "passkey") => Promise<void | _simplewebauthn_types.PublicKeyCredentialRequestOptionsJSON>;
-    submit: (mfaMethod: "sms" | "totp" | "passkey", mfaCode: string | _simplewebauthn_types.PublicKeyCredentialRequestOptionsJSON) => Promise<void>;
+    init: (mfaMethod: MfaMethod) => Promise<void | _simplewebauthn_types.PublicKeyCredentialRequestOptionsJSON>;
+    submit: (mfaMethod: MfaMethod, mfaCode: string | _simplewebauthn_types.PublicKeyCredentialRequestOptionsJSON) => Promise<void>;
     cancel: () => void;
     mfaMethods: ("sms" | "totp" | "passkey")[];
 };
@@ -3488,7 +3493,7 @@ declare function useLogin(callbacks?: PrivyEvents['login']): {
     /**
      * Opens the Privy login modal and prompts the user to login.
      */
-    login: (options?: RuntimeLoginOverridableOptions | react.MouseEvent<any, any> | undefined) => void;
+    login: (options?: RuntimeLoginOverridableOptions | react.MouseEvent<any, any>) => void;
 };
 
 /**
@@ -3767,8 +3772,8 @@ declare function useConnectWallet(callbacks?: PrivyEvents['connectWallet']): {
      * Opens the Privy modal and prompts the user to connect a wallet.
      */
     connectWallet: (options?: {
-        suggestedAddress?: string | undefined;
-    } | react.MouseEvent<any, any> | undefined) => void;
+        suggestedAddress?: string;
+    } | react.MouseEvent<any, any>) => void;
 };
 
 /**
@@ -3824,7 +3829,7 @@ interface UseFundWalletInterface {
  * @param callbacks.onUserExited {@link PrivyEvents} Callback that will execute when a funding flow is exited. This fires when a user closes a funding flow modal, for any reason.
  * @returns fundWallet - function to on-ramp funds to any given wallet
  */
-declare const useFundWallet: (callbacks?: PrivyEvents['fundWallet']) => UseFundWalletInterface;
+declare const useFundWallet: (callbacks?: PrivyEvents["fundWallet"]) => UseFundWalletInterface;
 
 /**
  * Hook to create and interact with Solana wallets. This currently only supports an embedded Solana wallet and no
@@ -3935,7 +3940,7 @@ declare function useSendTransaction(callbacks?: PrivyEvents['sendTransaction']):
     /**
      * Prompts a user to send a transaction using their embedded wallet.
      */
-    sendTransaction: (data: UnsignedTransactionRequest, uiOptions?: SendTransactionModalUIOptions | undefined, fundWalletConfig?: FundWalletConfig | undefined) => Promise<TransactionReceipt>;
+    sendTransaction: (data: UnsignedTransactionRequest, uiOptions?: SendTransactionModalUIOptions, fundWalletConfig?: FundWalletConfig) => Promise<TransactionReceipt>;
 };
 
 /**
@@ -3983,7 +3988,7 @@ declare function useSignMessage(callbacks?: PrivyEvents['signMessage']): {
     /**
      * Prompts a user to sign a message using their embedded wallet.
      */
-    signMessage: (message: string, uiOptions?: SignMessageModalUIOptions | undefined) => Promise<string>;
+    signMessage: (message: string, uiOptions?: SignMessageModalUIOptions) => Promise<string>;
 };
 
 /**
@@ -3997,7 +4002,7 @@ declare function useSignTypedData(callbacks?: PrivyEvents['signTypedData']): {
     /**
      * Prompts a user to sign typed data using their embedded wallet.
      */
-    signTypedData: (typedData: SignTypedDataParams, uiOptions?: SignMessageModalUIOptions | undefined) => Promise<string>;
+    signTypedData: (typedData: SignTypedDataParams, uiOptions?: SignMessageModalUIOptions) => Promise<string>;
 };
 
 /**
@@ -4077,7 +4082,7 @@ declare function addRpcUrlOverrideToChain(chain: Chain, rpcUrl: string): {
         };
         default: {
             http: readonly string[];
-            webSocket?: readonly string[] | undefined;
+            webSocket?: readonly string[];
         };
     } | {
         privyWalletOverride: {
@@ -4085,12 +4090,12 @@ declare function addRpcUrlOverrideToChain(chain: Chain, rpcUrl: string): {
         };
         default: {
             http: readonly string[];
-            webSocket?: readonly string[] | undefined;
+            webSocket?: readonly string[];
         };
     };
     id: number;
     name: string;
-    network?: string | undefined;
+    network?: string;
     nativeCurrency: {
         name: string;
         symbol: string;
@@ -4105,8 +4110,8 @@ declare function addRpcUrlOverrideToChain(chain: Chain, rpcUrl: string): {
             name: string;
             url: string;
         };
-    } | undefined;
-    testnet?: boolean | undefined;
+    };
+    testnet?: boolean;
 };
 
 /**