@privy-io/react-auth 1.59.0 → 1.59.1-beta-20240306174853

package/dist/index.d.ts

@@ -362,10 +362,12 @@ declare enum PrivyErrorCode {
     INVALID_CAPTCHA = "invalid_captcha",
     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",
     ALLOWLIST_REJECTED = "allowlist_rejected",
     OAUTH_USER_DENIED = "oauth_user_denied",
     UNKNOWN_AUTH_ERROR = "unknown_auth_error",
     USER_EXITED_AUTH_FLOW = "exited_auth_flow",
+    USER_EXITED_LINK_FLOW = "exited_link_flow",
     USER_EXITED_SET_PASSWORD_FLOW = "user_exited_set_password_flow",
     MUST_BE_AUTHENTICATED = "must_be_authenticated",
     UNKNOWN_CONNECT_WALLET_ERROR = "unknown_connect_wallet_error",
@@ -2640,6 +2642,22 @@ interface PrivyEvents {
          */
         onError?: CallbackError;
     };
+    linkAccount: {
+        /**
+         * Callback that will execute once on a successful linking of a new account/login method.
+         * This will run when any of the 'link' methods are called manually.
+         * @param user {@link User}- the user the account was linked to
+         * @param linkedAccountType {@link LoginMethod}- the type of linked account
+         */
+        onSuccess?: (user: User, linkedAccountType: LoginMethod) => void;
+        /**
+         * Callback that will execute in the case of a non-successful account linking.
+         *
+         * @param error {PrivyErrorCode} - the corresponding error code
+         *
+         */
+        onError?: CallbackError;
+    };
     configureMfa: {
         /**
          * Callback that will execute when MFA is required to complete a given action.
@@ -2870,6 +2888,41 @@ declare const useLoginWithSms: () => UseLoginWithSms;
  */
 declare function useRegisterMfaListener(callbacks: PrivyEvents['configureMfa']): void;
 
+/**
+ * Use this hook to link a new account to an authenticated user, and to attach
+ * callbacks for success and errors.
+ *
+ * @param callbacks.onComplete {@link PrivyEvents} callback to execute for already- or newly-`authenticated` users
+ * @param callbacks.onError {@link PrivyEvents} callback to execute if there is an error during `link`.
+ *
+ * @returns linkEmail - opens the Privy modal and prompts the user to link an email address
+ * @returns linkPhone - opens the Privy modal and prompts the user to link a phone number
+ * @returns linkWallet - opens the Privy modal and prompts the user to link an external wallet
+ * @returns linkGoogle - opens the Privy modal and prompts the user to link their Google account
+ * @returns linkApple - opens the Privy modal and prompts the user to link their Apple account
+ * @returns linkTwitter - opens the Privy modal and prompts the user to link their Twitter account
+ * @returns linkDiscord - opens the Privy modal and prompts the user to link their Discord account
+ * @returns linkGithub - opens the Privy modal and prompts the user to link their Github account
+ * @returns linkLinkedIn - opens the Privy modal and prompts the user to link their LinkedIn account
+ * @returns linkTikTok - opens the Privy modal and prompts the user to link their TikTok account
+ * @returns linkSpotify - opens the Privy modal and prompts the user to link their Spotify account
+ * @returns linkFarcaster - opens the Privy modal and prompts the user to link their Farcaster account
+ */
+declare function useLinkAccount(callbacks?: PrivyEvents['linkAccount']): {
+    linkEmail: () => void;
+    linkPhone: () => void;
+    linkWallet: () => void;
+    linkGoogle: () => void;
+    linkApple: () => void;
+    linkTwitter: () => void;
+    linkDiscord: () => void;
+    linkGithub: () => void;
+    linkLinkedIn: () => void;
+    linkTiktok: () => void;
+    linkSpotify: () => void;
+    linkFarcaster: () => void;
+};
+
 /**
  * Use this hook to connect the user's external wallet, and to attach
  * callbacks after a user succesfully connects their wallet, or if there
@@ -3077,4 +3130,4 @@ declare function addRpcUrlOverrideToChain(chain: Chain, rpcUrl: string): {
     testnet?: boolean | undefined;
 };
 
-export { Apple, AppleOAuthWithMetadata, AsExternalProvider, CallbackError, Captcha, ConnectedWallet, ConnectorManager, ContractUIOptions, Discord, DiscordOAuthWithMetadata, EIP1193Provider, Email, EmailWithMetadata, Farcaster, FarcasterWithMetadata, FundWalletConfig, Github, GithubOAuthWithMetadata, Google, GoogleOAuthWithMetadata, LinkedIn, LinkedInOAuthWithMetadata, LoginMethodOrderOption, LoginWithCode, MessageTypes, MfaMethod, MoonpayConfig, MoonpayCurrencyCode, MoonpayPaymentMethod, NonEmptyArray, OAuthProviderType, Phone, PhoneWithMetadata, PriceDisplayOptions, PrivyClient, PrivyClientConfig, PrivyEvents, PrivyInterface, PrivyProvider, PrivyProviderProps, PrivyProxyProvider, Quantity, DEFAULT_SUPPORTED_CHAINS as SUPPORTED_CHAINS, SendCodeToEmail, SendCodeToSms, SendTransactionModalUIOptions, SignMessageModalUIOptions, SignTypedDataParams, Tiktok, TiktokOAuthWithMetadata, TransactionLog, TransactionReceipt, TransactionUIOptions, Twitter, TwitterOAuthWithMetadata, TypedMessage, UnsignedTransactionRequest, UseFundWalletInterface, UseLoginWithEmail, UseLoginWithSms, UseWalletsInterface, User, VERSION, Wallet, WalletConnector, WalletListEntry, WalletWithMetadata, addRpcUrlOverrideToChain, errorIndicatesMaxMfaRetries, errorIndicatesMfaTimeout, errorIndicatesMfaVerificationFailed, getAccessToken, useConnectWallet, useCreateWallet, useFundWallet, useLogin, useLoginWithEmail, useLoginWithSms, useLogout, useMfa, useMfaEnrollment, useModalStatus, usePrivy, useRegisterMfaListener, useSendTransaction, useSetWalletPassword, useSignMessage, useSignTypedData, useToken, useWallets };
+export { Apple, AppleOAuthWithMetadata, AsExternalProvider, CallbackError, Captcha, ConnectedWallet, ConnectorManager, ContractUIOptions, Discord, DiscordOAuthWithMetadata, EIP1193Provider, Email, EmailWithMetadata, Farcaster, FarcasterWithMetadata, FundWalletConfig, Github, GithubOAuthWithMetadata, Google, GoogleOAuthWithMetadata, LinkedIn, LinkedInOAuthWithMetadata, LoginMethodOrderOption, LoginWithCode, MessageTypes, MfaMethod, MoonpayConfig, MoonpayCurrencyCode, MoonpayPaymentMethod, NonEmptyArray, OAuthProviderType, Phone, PhoneWithMetadata, PriceDisplayOptions, PrivyClient, PrivyClientConfig, PrivyEvents, PrivyInterface, PrivyProvider, PrivyProviderProps, PrivyProxyProvider, Quantity, DEFAULT_SUPPORTED_CHAINS as SUPPORTED_CHAINS, SendCodeToEmail, SendCodeToSms, SendTransactionModalUIOptions, SignMessageModalUIOptions, SignTypedDataParams, Tiktok, TiktokOAuthWithMetadata, TransactionLog, TransactionReceipt, TransactionUIOptions, Twitter, TwitterOAuthWithMetadata, TypedMessage, UnsignedTransactionRequest, UseFundWalletInterface, UseLoginWithEmail, UseLoginWithSms, UseWalletsInterface, User, VERSION, Wallet, WalletConnector, WalletListEntry, WalletWithMetadata, addRpcUrlOverrideToChain, errorIndicatesMaxMfaRetries, errorIndicatesMfaTimeout, errorIndicatesMfaVerificationFailed, getAccessToken, useConnectWallet, useCreateWallet, useFundWallet, useLinkAccount, useLogin, useLoginWithEmail, useLoginWithSms, useLogout, useMfa, useMfaEnrollment, useModalStatus, usePrivy, useRegisterMfaListener, useSendTransaction, useSetWalletPassword, useSignMessage, useSignTypedData, useToken, useWallets };