@privy-io/react-auth 1.88.4 → 1.89.0-beta-20241008232954

package/dist/dts/index.d.ts

@@ -1100,7 +1100,7 @@ interface PrivyInterface {
      *
      * This method will error if the user is not authenticated or does not have an embedded wallet.
      *
-     * If the `config.embeddedWallets.noPromptOnSignature` property is set to true, the signature will
+     * If the `config.embeddedWallets.showWalletUIs` property is set to false, the signature will
      * be computed without prompting the user. Otherwise (the default), Privy will show the user a modal
      * to prompt them for a signature. This can be customized via the {@link SignMessageModalUIOptions}.
      *
@@ -1239,7 +1239,7 @@ interface PrivyInterface {
      * If no `chainId` is specified as part of the {@link UnsignedTransactionRequest}, Privy will default
      * to the embedded wallet's current chain ID.
      *
-     * If the `config.embeddedWallets.noPromptOnSignature` property is set to true, the wallet will
+     * If the `config.embeddedWallets.showWalletUIs` property is set to false, the wallet will
      * attempt to send the transaction without prompting the user. Otherwise (the default), Privy
      * will show the user a modal to have them confirm the transaction. This can be customized via
      * the {@link SendTransactionModalUIOptions}.
@@ -1257,7 +1257,7 @@ interface PrivyInterface {
      *
      * This method will error if the user is not authenticated or does not have a solana embedded wallet.
      *
-     * If the `config.embeddedWallets.noPromptOnSignature` property is set to true, the wallet will attempt to send
+     * If the `config.embeddedWallets.showWalletUIs` property is set to false, the wallet will attempt to send
      * the transaction without prompting the user. Otherwise (the default), Privy will show the user a modal to have
      * them confirm the transaction. This can be customized via the {@link SendTransactionModalUIOptions}.
      *
@@ -1566,6 +1566,26 @@ interface PrivyEvents {
             linkMethod: LoginMethod;
         }>;
     };
+    update: {
+        /**
+         * Callback that will execute once on a successful updating of an account.
+         * This will run when any of the 'updateAccount' methods are called manually.
+         * @param user {@link User}- the user the account was linked to
+         * @param updateMethod {@link LoginMethod}- the type of updated account
+         * @param updatedAccount - the newly updated account
+         */
+        onSuccess?: (user: User, updateMethod: LoginMethod, updatedAccount: LinkedAccountWithMetadata) => void;
+        /**
+         * Callback that will execute in the case of a non-successful account linking.
+         *
+         * @param error {PrivyErrorCode} - the corresponding error code
+         * @param details.linkMethod {LoginMethod} - the type of (attempted) linked account
+         *
+         */
+        onError?: CallbackError<{
+            linkMethod: LoginMethod;
+        }>;
+    };
     configureMfa: {
         /**
          * Callback that will execute when MFA is required to complete a given action.
@@ -2030,6 +2050,23 @@ declare function useLinkAccount(callbacks?: PrivyEvents['linkAccount']): {
     linkTelegram: () => void;
 };
 
+/**
+ * Use this hook to update a users account and to attach callbacks
+ * for successful `updateAccount`, and`updateAccount` errors.
+ *
+ * @param callbacks.onSuccess {@link PrivyEvents} callback to execute for after successful account update
+ * @param callbacks.onError {@link PrivyEvents} callback to execute if there is an error during `updatePhone` or `updateEmail`.
+ * @returns updateEmail - opens the Privy modal and prompts the user to update email
+ * @returns updatePhone - opens the Privy modal and prompts the user to update phone number
+ */
+declare function useUpdateAccount(callbacks?: PrivyEvents['update']): {
+    /**
+     * Opens the Privy modal and prompts the user to update their accont.
+     */
+    updateEmail: () => void;
+    updatePhone: () => void;
+};
+
 /**
  * Use this hook to connect the user's external wallet, and to attach
  * callbacks after a user successfully connects their wallet, or if there
@@ -2487,4 +2524,4 @@ declare const LoginModal: ({ open }: {
     open: boolean;
 }) => react_jsx_runtime.JSX.Element;
 
-export { type CallbackError, Captcha, ConnectWalletModalOptions, ConnectedWallet, ConnectorManager, CustomAuthFlowState, EIP1193Provider, EthereumWalletConnector, FundWalletConfig, LoginModal, LoginModalOptions, LoginWithCode, MfaMethod, OAuthFlowState, OAuthProviderType, OAuthTokens, OtpFlowState, PasskeyFlowState, PrivyClient, PrivyClientConfig, type PrivyEvents, type PrivyInterface, PrivyProvider, type PrivyProviderProps, PrivyProxyProvider, DEFAULT_SUPPORTED_CHAINS as SUPPORTED_CHAINS, type SendCodeToEmail, type SendCodeToSms, SendTransactionModalUIOptions, SignMessageModalUIOptions, SignTypedDataParams, SiweFlowState, SolanaTransactionReceipt, SupportedSolanaTransaction, TransactionReceipt, UnsignedTransactionRequest, type UseConnectCoinbaseSmartWalletInterface, type UseCustomAuth, type UseFundWalletInterface, type UseLoginWithEmail, type UseLoginWithPasskey, type UseLoginWithSms, type UseOAuthTokens, type UseWalletsInterface, User, VERSION, Wallet, WalletConnector, WalletListEntry, addPrivyRpcToChain, addRpcUrlOverrideToChain, errorIndicatesMaxMfaRetries, errorIndicatesMfaTimeout, errorIndicatesMfaVerificationFailed, getAccessToken, getEmbeddedConnectedWallet, useConnectCoinbaseSmartWallet, useConnectWallet, useCreateWallet, useCrossAppAccounts, useCustomAuth, useExperimentalFarcasterSigner, useFarcasterSigner, useFundWallet, useGuestAccounts, useLinkAccount, useLinkWithSiwe, useLogin, useLoginWithEmail, useLoginWithOAuth, useLoginWithPasskey, useLoginWithSms, useLogout, useMfa, useMfaEnrollment, useModalStatus, useOAuthTokens, usePrivy, useRegisterMfaListener, useSendSolanaTransaction, useSendTransaction, useSetWalletPassword, useSetWalletRecovery, useSignMessage, useSignTypedData, useToken, useWallets };
+export { type CallbackError, Captcha, ConnectWalletModalOptions, ConnectedWallet, ConnectorManager, CustomAuthFlowState, EIP1193Provider, EthereumWalletConnector, FundWalletConfig, LoginModal, LoginModalOptions, LoginWithCode, MfaMethod, OAuthFlowState, OAuthProviderType, OAuthTokens, OtpFlowState, PasskeyFlowState, PrivyClient, PrivyClientConfig, type PrivyEvents, type PrivyInterface, PrivyProvider, type PrivyProviderProps, PrivyProxyProvider, DEFAULT_SUPPORTED_CHAINS as SUPPORTED_CHAINS, type SendCodeToEmail, type SendCodeToSms, SendTransactionModalUIOptions, SignMessageModalUIOptions, SignTypedDataParams, SiweFlowState, SolanaTransactionReceipt, SupportedSolanaTransaction, TransactionReceipt, UnsignedTransactionRequest, type UseConnectCoinbaseSmartWalletInterface, type UseCustomAuth, type UseFundWalletInterface, type UseLoginWithEmail, type UseLoginWithPasskey, type UseLoginWithSms, type UseOAuthTokens, type UseWalletsInterface, User, VERSION, Wallet, WalletConnector, WalletListEntry, addPrivyRpcToChain, addRpcUrlOverrideToChain, errorIndicatesMaxMfaRetries, errorIndicatesMfaTimeout, errorIndicatesMfaVerificationFailed, getAccessToken, getEmbeddedConnectedWallet, useConnectCoinbaseSmartWallet, useConnectWallet, useCreateWallet, useCrossAppAccounts, useCustomAuth, useExperimentalFarcasterSigner, useFarcasterSigner, useFundWallet, useGuestAccounts, useLinkAccount, useLinkWithSiwe, useLogin, useLoginWithEmail, useLoginWithOAuth, useLoginWithPasskey, useLoginWithSms, useLogout, useMfa, useMfaEnrollment, useModalStatus, useOAuthTokens, usePrivy, useRegisterMfaListener, useSendSolanaTransaction, useSendTransaction, useSetWalletPassword, useSetWalletRecovery, useSignMessage, useSignTypedData, useToken, useUpdateAccount, useWallets };

package/dist/dts/types.d.mts

@@ -191,6 +191,8 @@ declare enum PrivyErrorCode {
     LINKED_TO_ANOTHER_USER = "linked_to_another_user",
     CANNOT_LINK_MORE_OF_TYPE = "cannot_link_more_of_type",
     FAILED_TO_LINK_ACCOUNT = "failed_to_link_account",
+    FAILED_TO_UPDATE_ACCOUNT = "failed_to_update_account",
+    USER_EXITED_UPDATE_FLOW = "exited_update_flow",
     ALLOWLIST_REJECTED = "allowlist_rejected",
     OAUTH_USER_DENIED = "oauth_user_denied",
     OAUTH_UNEXPECTED = "oauth_unexpected",
@@ -768,7 +770,7 @@ type LoginWithCode = {
 };
 declare const EMBEDDED_WALLET_CLIENT_TYPES: readonly ["privy"];
 type EmbeddedWalletClientType = (typeof EMBEDDED_WALLET_CLIENT_TYPES)[number];
-declare const INJECTED_WALLET_CLIENT_TYPES: readonly ["metamask", "phantom", "brave_wallet", "rainbow", "uniswap_wallet_extension", "uniswap_extension", "rabby_wallet", "crypto.com_wallet_extension"];
+declare const INJECTED_WALLET_CLIENT_TYPES: readonly ["metamask", "phantom", "brave_wallet", "rainbow", "uniswap_wallet_extension", "uniswap_extension", "rabby_wallet", "bybit_wallet", "crypto.com_wallet_extension"];
 type InjectedWalletClientType = (typeof INJECTED_WALLET_CLIENT_TYPES)[number];
 declare const COINBASE_WALLET_CLIENT_TYPES: readonly ["coinbase_wallet", "coinbase_smart_wallet"];
 type CoinbaseWalletClientType = (typeof COINBASE_WALLET_CLIENT_TYPES)[number];
@@ -1436,7 +1438,7 @@ type PriceDisplayOptions = {
 };
 type WalletListEntry = 'metamask' | 'coinbase_wallet' | 'rainbow' | 'phantom' | 'zerion' | 'cryptocom' | 'uniswap' | 'okx_wallet' | 'universal_profile'
 /** @deprecated Use `detected_ethereum_wallets` or `detected_solana_wallets` instead */
- | 'detected_wallets' | 'detected_solana_wallets' | 'detected_ethereum_wallets' | 'wallet_connect' | 'rabby_wallet' | 'safe';
+ | 'detected_wallets' | 'detected_solana_wallets' | 'detected_ethereum_wallets' | 'wallet_connect' | 'rabby_wallet' | 'bybit_wallet' | 'safe';
 type NonEmptyArray<T> = [T, ...T[]];
 type LoginMethodOrderOption = 'email' | 'sms' | WalletListEntry | OAuthProviderType | 'farcaster' | 'telegram';
 type ExternalWalletsConfig = {
@@ -1710,18 +1712,28 @@ interface PrivyClientConfig {
         requireUserPasswordOnCreate?: boolean;
         /**
          * @deprecated. Instead, use the server-driven configuration found in the Privy console: https://dashboard.privy.io/apps/YOUR_APP_ID/embedded.
+         * or the client-side 'embeddedWallets.showWalletUIs' configuration.
          * If true, Privy will not prompt or instantiate any UI for embedded wallet signatures and transactions.
          * If false, embedded wallet actions will raise a modal and require user confirmation to proceed.
          *
          * Defaults to false.
          */
         noPromptOnSignature?: boolean;
+        /**
+         * Override any settings for the embedded wallet's UI to show or hide the wallet UIs.
+         *
+         * If true, wallet UIs will always be shown.
+         * If false, wallet UIs will always be hidden.
+         *
+         * If not set, the default behavior will match the server configuration.
+         */
+        showWalletUIs?: boolean;
         /**
          * @experimental
          *
          * **This setting is only honored when using the EIP-1193 Ethereum Provider to interface
          * with the embedded wallet, i.e. using `getEthereumProvider` or `getEthersProvider`.
-         * This setting is only honored when used alongside `noPromptOnSignature: true`**
+         * This setting is only honored when used alongside `showWalletUIs: false`**
          *
          * If true, calls to `sendTransaction` will wait for the transaction to be confirmed before resolving.
          * If false, calls to `sendTransaction` will resolve once the transaction has been submitted.
@@ -1732,7 +1744,7 @@ interface PrivyClientConfig {
          * <PrivyProvider
          *   config={{
          *     embeddedWallets: {
-         *       noPromptOnSignature: true,
+         *       showWalletUIs: false,
          *       waitForTransactionConfirmation: false,
          *     },
          *   }}
@@ -1929,6 +1941,11 @@ type OAuthFlowState = {
  * UI configuration object for the embedded wallet's Sign Message screen
  */
 type SignMessageModalUIOptions = {
+    /**
+     * Whether or not to show wallet UIs for this action. Defaults to the wallet UI setting enabled
+     * for your app in the Privy Dashboard, or `showWalletUIs` in the `embeddedWallets` config.
+     */
+    showWalletUIs?: boolean;
     /**
      * Title for the Sign Message screen. Defaults to 'Sign'.
      */
@@ -2042,6 +2059,11 @@ type ContractUIOptions = {
  * UI customization object for the embedded wallet's Send Transaction screen
  */
 type SendTransactionModalUIOptions = {
+    /**
+     * Whether or not to show wallet UIs for this action. Defaults to the wallet UI setting enabled
+     * for your app in the Privy Dashboard, or `showWalletUIs` in the `embeddedWallets` config.
+     */
+    showWalletUIs?: boolean;
     /**
      * Text to display at top of Send Transaction screen. Defaults to
      * 'Review transaction' or 'Send (insert token symbol)' if transaction

package/dist/dts/types.d.ts

@@ -191,6 +191,8 @@ declare enum PrivyErrorCode {
     LINKED_TO_ANOTHER_USER = "linked_to_another_user",
     CANNOT_LINK_MORE_OF_TYPE = "cannot_link_more_of_type",
     FAILED_TO_LINK_ACCOUNT = "failed_to_link_account",
+    FAILED_TO_UPDATE_ACCOUNT = "failed_to_update_account",
+    USER_EXITED_UPDATE_FLOW = "exited_update_flow",
     ALLOWLIST_REJECTED = "allowlist_rejected",
     OAUTH_USER_DENIED = "oauth_user_denied",
     OAUTH_UNEXPECTED = "oauth_unexpected",
@@ -768,7 +770,7 @@ type LoginWithCode = {
 };
 declare const EMBEDDED_WALLET_CLIENT_TYPES: readonly ["privy"];
 type EmbeddedWalletClientType = (typeof EMBEDDED_WALLET_CLIENT_TYPES)[number];
-declare const INJECTED_WALLET_CLIENT_TYPES: readonly ["metamask", "phantom", "brave_wallet", "rainbow", "uniswap_wallet_extension", "uniswap_extension", "rabby_wallet", "crypto.com_wallet_extension"];
+declare const INJECTED_WALLET_CLIENT_TYPES: readonly ["metamask", "phantom", "brave_wallet", "rainbow", "uniswap_wallet_extension", "uniswap_extension", "rabby_wallet", "bybit_wallet", "crypto.com_wallet_extension"];
 type InjectedWalletClientType = (typeof INJECTED_WALLET_CLIENT_TYPES)[number];
 declare const COINBASE_WALLET_CLIENT_TYPES: readonly ["coinbase_wallet", "coinbase_smart_wallet"];
 type CoinbaseWalletClientType = (typeof COINBASE_WALLET_CLIENT_TYPES)[number];
@@ -1436,7 +1438,7 @@ type PriceDisplayOptions = {
 };
 type WalletListEntry = 'metamask' | 'coinbase_wallet' | 'rainbow' | 'phantom' | 'zerion' | 'cryptocom' | 'uniswap' | 'okx_wallet' | 'universal_profile'
 /** @deprecated Use `detected_ethereum_wallets` or `detected_solana_wallets` instead */
- | 'detected_wallets' | 'detected_solana_wallets' | 'detected_ethereum_wallets' | 'wallet_connect' | 'rabby_wallet' | 'safe';
+ | 'detected_wallets' | 'detected_solana_wallets' | 'detected_ethereum_wallets' | 'wallet_connect' | 'rabby_wallet' | 'bybit_wallet' | 'safe';
 type NonEmptyArray<T> = [T, ...T[]];
 type LoginMethodOrderOption = 'email' | 'sms' | WalletListEntry | OAuthProviderType | 'farcaster' | 'telegram';
 type ExternalWalletsConfig = {
@@ -1710,18 +1712,28 @@ interface PrivyClientConfig {
         requireUserPasswordOnCreate?: boolean;
         /**
          * @deprecated. Instead, use the server-driven configuration found in the Privy console: https://dashboard.privy.io/apps/YOUR_APP_ID/embedded.
+         * or the client-side 'embeddedWallets.showWalletUIs' configuration.
          * If true, Privy will not prompt or instantiate any UI for embedded wallet signatures and transactions.
          * If false, embedded wallet actions will raise a modal and require user confirmation to proceed.
          *
          * Defaults to false.
          */
         noPromptOnSignature?: boolean;
+        /**
+         * Override any settings for the embedded wallet's UI to show or hide the wallet UIs.
+         *
+         * If true, wallet UIs will always be shown.
+         * If false, wallet UIs will always be hidden.
+         *
+         * If not set, the default behavior will match the server configuration.
+         */
+        showWalletUIs?: boolean;
         /**
          * @experimental
          *
          * **This setting is only honored when using the EIP-1193 Ethereum Provider to interface
          * with the embedded wallet, i.e. using `getEthereumProvider` or `getEthersProvider`.
-         * This setting is only honored when used alongside `noPromptOnSignature: true`**
+         * This setting is only honored when used alongside `showWalletUIs: false`**
          *
          * If true, calls to `sendTransaction` will wait for the transaction to be confirmed before resolving.
          * If false, calls to `sendTransaction` will resolve once the transaction has been submitted.
@@ -1732,7 +1744,7 @@ interface PrivyClientConfig {
          * <PrivyProvider
          *   config={{
          *     embeddedWallets: {
-         *       noPromptOnSignature: true,
+         *       showWalletUIs: false,
          *       waitForTransactionConfirmation: false,
          *     },
          *   }}
@@ -1929,6 +1941,11 @@ type OAuthFlowState = {
  * UI configuration object for the embedded wallet's Sign Message screen
  */
 type SignMessageModalUIOptions = {
+    /**
+     * Whether or not to show wallet UIs for this action. Defaults to the wallet UI setting enabled
+     * for your app in the Privy Dashboard, or `showWalletUIs` in the `embeddedWallets` config.
+     */
+    showWalletUIs?: boolean;
     /**
      * Title for the Sign Message screen. Defaults to 'Sign'.
      */
@@ -2042,6 +2059,11 @@ type ContractUIOptions = {
  * UI customization object for the embedded wallet's Send Transaction screen
  */
 type SendTransactionModalUIOptions = {
+    /**
+     * Whether or not to show wallet UIs for this action. Defaults to the wallet UI setting enabled
+     * for your app in the Privy Dashboard, or `showWalletUIs` in the `embeddedWallets` config.
+     */
+    showWalletUIs?: boolean;
     /**
      * Text to display at top of Send Transaction screen. Defaults to
      * 'Review transaction' or 'Send (insert token symbol)' if transaction