@privy-io/react-auth 1.68.0 → 1.69.0-alpha-20240606205421

package/dist/index.d.ts

@@ -238,15 +238,12 @@ type WalletImportRequestDataType = {
     accessToken: string;
     privateKey: string;
 };
-type WalletSetRecoveryPasswordRequestDataType = {
+type WalletSetRecoveryRequestDataType = {
     accessToken: string;
     address: string;
-    recoveryPassword: string;
-    /**
-     * Will be deprecated in a future release, use `recoveryPassword` instead
-     * @deprecated
-     */
-    recoveryPin?: string;
+    recoveryMethod: UserRecoveryMethod;
+    recoveryPassword?: string;
+    recoveryAccessToken?: string;
 };
 type WalletRecoverRequestDataType = {
     address: string;
@@ -256,7 +253,7 @@ type WalletRecoverRequestDataType = {
     mfaMethod?: MfaMethod;
     relyingParty?: string;
     recoveryPassword?: string;
-    recoveryMethod?: UserRecoveryMethod;
+    recoveryMethod?: UserRecoveryMethod | 'privy';
     recoveryAccessToken?: string;
     /**
      * Will be deprecated in a future release, use `recoveryPassword` instead
@@ -340,7 +337,7 @@ type WalletConnectResponseDataType = {
 type WalletRecoverResponseDataType = {
     address: string;
 };
-type WalletSetRecoveryPasswordResponseDataType = {
+type WalletSetRecoveryResponseDataType = {
     address: string;
 };
 type WalletRpcResponseDataType = {
@@ -368,7 +365,7 @@ interface EmbeddedWalletProxy {
     import: (data: WalletImportRequestDataType) => Promise<WalletImportResponseDataType>;
     connect: (data: WalletConnectRequestDataType) => Promise<WalletConnectResponseDataType>;
     recover: (data: WalletRecoverRequestDataType) => Promise<WalletRecoverResponseDataType>;
-    setRecoveryPassword: (data: WalletSetRecoveryPasswordRequestDataType) => Promise<WalletSetRecoveryPasswordResponseDataType>;
+    setRecovery: (data: WalletSetRecoveryRequestDataType) => Promise<WalletSetRecoveryResponseDataType>;
     rpc: (data: WalletRpcRequestDataType) => Promise<WalletRpcResponseDataType>;
     verifyMfa: (data: MfaVerifyRequestDataType) => Promise<MfaVerifyResponseDataType>;
     initEnrollMfa: (data: MfaInitEnrollmentRequestDataType) => Promise<MfaInitEnrollmentResponseDataType>;
@@ -800,7 +797,17 @@ interface ResponseTelegramAccount {
     first_verified_at: number | null;
     latest_verified_at: number | null;
 }
-type LinkedAccountsResponseType = Array<ResponseEmailAccount | ResponsePhoneAccount | ResponseEthereumAccount | ResponseOAuthGoogle | ResponseOAuthTwitter | ResponseOAuthDiscord | ResponseOAuthGithub | ResponseOAuthSpotify | ResponseOAuthInstagram | ResponseOAuthTiktok | ResponseOAuthLinkedIn | ResponseOAuthApple | ResponseCustomJwtAccount | ResponseFarcasterAccount | ResponsePasskeyAccount | ResponseTelegramAccount>;
+interface ResponseCrossAppAccount {
+    type: 'cross_app';
+    embedded_wallets: {
+        address: string;
+    }[];
+    provider_app_id: string;
+    verified_at: number;
+    first_verified_at: number | null;
+    latest_verified_at: number | null;
+}
+type LinkedAccountsResponseType = Array<ResponseEmailAccount | ResponsePhoneAccount | ResponseEthereumAccount | ResponseOAuthGoogle | ResponseOAuthTwitter | ResponseOAuthDiscord | ResponseOAuthGithub | ResponseOAuthSpotify | ResponseOAuthInstagram | ResponseOAuthTiktok | ResponseOAuthLinkedIn | ResponseOAuthApple | ResponseCustomJwtAccount | ResponseFarcasterAccount | ResponsePasskeyAccount | ResponseTelegramAccount | ResponseCrossAppAccount>;
 interface ResponseSmsMfaMethod {
     type: 'sms';
     verified_at: number;
@@ -1040,6 +1047,7 @@ declare class PrivyClient {
         user: User | null;
         oAuthProviderTokens?: OAuthProviderTokens | undefined;
     }>;
+    storeGuestAccessToken(appId: string, guestAccessToken: string | null): void;
     logout(): Promise<void>;
     startAuthFlow<T extends AuthFlow>(authFlow: T): T;
     initMfaSmsVerification(): Promise<void>;
@@ -1165,7 +1173,7 @@ type OAuthProviderType = (typeof SUPPORTED_OAUTH_PROVIDERS)[number];
  * Supported OAuth providers for the recovery flow. Can be `'google-drive'`
  */
 type RecoveryProviderType = (typeof SUPPORTED_RECOVERY_PROVIDERS)[number];
-type LoginMethod = 'email' | 'sms' | 'siwe' | 'farcaster' | OAuthProviderType | 'passkey' | 'telegram';
+type LoginMethod = 'email' | 'sms' | 'siwe' | 'farcaster' | OAuthProviderType | 'passkey' | 'telegram' | `privy:${string}`;
 type LoginWithCode = {
     /**
      * One-time password _([OTP](https://en.wikipedia.org/wiki/One-time_password))_ that was sent to user during first login step
@@ -1192,7 +1200,7 @@ type WalletBranding = {
     id: string;
     icon?: string | EmbeddedSVG;
 };
-type LinkedAccountType = 'wallet' | 'email' | 'phone' | 'google_oauth' | 'twitter_oauth' | 'discord_oauth' | 'github_oauth' | 'spotify_oauth' | 'instagram_oauth' | 'tiktok_oauth' | 'linkedin_oauth' | 'apple_oauth' | 'custom_auth' | 'farcaster' | 'passkey' | 'telegram';
+type LinkedAccountType = 'wallet' | 'email' | 'phone' | 'google_oauth' | 'twitter_oauth' | 'discord_oauth' | 'github_oauth' | 'spotify_oauth' | 'instagram_oauth' | 'tiktok_oauth' | 'linkedin_oauth' | 'apple_oauth' | 'custom_auth' | 'farcaster' | 'passkey' | 'telegram' | 'cross_app';
 /** @ignore */
 interface LinkMetadata {
     /** Account type, most commonly useful when filtering through linkedAccounts */
@@ -1524,6 +1532,22 @@ interface Passkey {
     /** Metadata about the browser that registered the passkey  */
     createdWithBrowser?: string;
 }
+/** Metadata about the provider app for a cross-app account */
+interface ProviderAppMetadata {
+    /** Privy app ID for the provider app. */
+    id: string;
+    /** Name for the provider app. */
+    name?: string;
+    /** Logo URL for the provider app. */
+    logoUrl?: string;
+}
+interface CrossAppAccount {
+    /** The user's embedded wallet address(es) from the provider app */
+    embeddedWallets: {
+        address: string;
+    }[];
+    providerApp: ProviderAppMetadata;
+}
 /** Object representation of a user's email, with additional metadata for advanced use cases. */
 interface EmailWithMetadata extends LinkMetadata, Email {
     /** Denotes that this is an email account. */
@@ -1604,10 +1628,15 @@ interface TelegramWithMetadata extends LinkMetadata, Telegram {
     /** Denotes that this is a Telegram account. */
     type: 'telegram';
 }
+/** Object representation of a user's cross-app account, with additional metadata for advanced use cases. */
+interface CrossAppAccountWithMetadata extends LinkMetadata, CrossAppAccount {
+    /** Denotes that this is a cross-app account */
+    type: 'cross_app';
+}
 /**
  * Object representation of a user's linked accounts
  */
-type LinkedAccountWithMetadata = WalletWithMetadata | EmailWithMetadata | PhoneWithMetadata | GoogleOAuthWithMetadata | TwitterOAuthWithMetadata | DiscordOAuthWithMetadata | GithubOAuthWithMetadata | SpotifyOAuthWithMetadata | InstagramOAuthWithMetadata | TiktokOAuthWithMetadata | LinkedInOAuthWithMetadata | AppleOAuthWithMetadata | CustomJwtAccountWithMetadata | FarcasterWithMetadata | PasskeyWithMetadata | TelegramWithMetadata;
+type LinkedAccountWithMetadata = WalletWithMetadata | EmailWithMetadata | PhoneWithMetadata | GoogleOAuthWithMetadata | TwitterOAuthWithMetadata | DiscordOAuthWithMetadata | GithubOAuthWithMetadata | SpotifyOAuthWithMetadata | InstagramOAuthWithMetadata | TiktokOAuthWithMetadata | LinkedInOAuthWithMetadata | AppleOAuthWithMetadata | CustomJwtAccountWithMetadata | FarcasterWithMetadata | PasskeyWithMetadata | TelegramWithMetadata | CrossAppAccountWithMetadata;
 interface User {
     /** The Privy-issued DID for the user. If you need to store additional information
      * about a user, you can use this DID to reference them. */
@@ -2620,6 +2649,8 @@ interface PrivyInterface {
      */
     createWallet: () => Promise<Wallet>;
     /**
+     * @deprecated. Use `setWalletRecovery` instead.
+     *
      * Set (or reset) a password on a wallet.
      *
      * This method will error if the user does not have an embedded wallet or if the user exits in the middle of the flow.
@@ -2627,6 +2658,15 @@ interface PrivyInterface {
      * @returns Promise for the {@link Wallet} object for the updated embedded wallet
      */
     setWalletPassword: () => Promise<Wallet>;
+    /**
+     * Prompt the user to enable wallet recovery. Current recovery options include password, Google Drive, and iCloud.
+     *
+     * This method will error if the user does not have an embedded wallet, if the user's
+     * embedded wallet already has a cloud-based recovery set, or if the user exits in the middle of the flow.
+     *
+     * @returns Promise for the {@link Wallet} object for the updated embedded wallet
+     */
+    setWalletRecovery: () => Promise<Wallet>;
     /**
      * Prompts a user to sign a message using their embedded wallet using EIP-191's `personal_sign`
      * method (0x45).
@@ -3089,6 +3129,19 @@ interface PrivyEvents {
          */
         onError?: CallbackError;
     };
+    setWalletRecovery: {
+        /**
+         * Callback that will execute once a successful `setWalletRecovery` completes.
+         * @param  wallet {@link Wallet}- the `walle]et` object that the recovery was set for
+         */
+        onSuccess?: (method: UserRecoveryMethod, wallet: Wallet) => void;
+        /**
+         * Callback that will execute in the case of a non-successful setWalletRecovery.
+         *
+         * @param error {PrivyErrorCode} - the corresponding error code
+         */
+        onError?: CallbackError;
+    };
     signMessage: {
         /**
          * Callback that will execute once a successful `signMessage` completes.
@@ -3447,6 +3500,31 @@ interface UseFundWalletInterface {
  */
 declare const useFundWallet: () => UseFundWalletInterface;
 
+/**
+ * Hook to access to link and interact with cross-app accounts from a provider app.
+ * You can access the fields and methods documented here via the {@link useCrossAppAccounts} hook.
+ */
+interface UseCrossAppAccountsInterface {
+    /**
+     * For users who are authenticated, prompts the user to link their account from another Privy app to their account
+     * within your app. Once a user has linked their account, you can request signatures and transactions from their embedded wallet
+     * in the linked app.
+     *
+     * This will redirect the user to a page on the target Privy app ID where they can login and authorize access to your app.
+     * @param options.appId {string} the target Privy app ID from which the user should link another Privy account
+     */
+    linkCrossAppAccount: ({ appId }: {
+        appId: string;
+    }) => void;
+}
+/**
+ * Hook to use cross-app accounts
+ *
+ * @experimental
+ * @returns linkCrossAppAccount - method to link a user's account from a provider app
+ */
+declare const useCrossAppAccounts: () => UseCrossAppAccountsInterface;
+
 /**
  * Use this hook to send a transaction using the embedded wallet and to attach callbacks for success and errors.
  * Transactions sent from the embedded wallet using transaction functions from non-Privy libraries
@@ -3480,6 +3558,23 @@ declare function useSetWalletPassword(callbacks?: PrivyEvents['setWalletPassword
     setWalletPassword: () => Promise<Wallet>;
 };
 
+/**
+ * Use this hook to set user-controlled recovery on the embedded wallet, and to attach callbacks
+ * for successful `recovery set`s, and `recovery set` errors.
+ * Note that the callbacks will only fire for explicit `setWalletRecovery` calls from the Privy SDK.
+ *
+ * @param callbacks.onSuccess {@link PrivyEvents} callback to execute for a successful recovery setting
+ * @param callbacks.onError {@link PrivyEvents} callback to execute if there is an error during `setWalletRecovery` -- ie.
+ * the user doesn't have an embedded wallet, the user already has a cloud-based recovery on the wallet, or the password flow is prematurely exited.
+ * @returns setWalletRecovery - opens the Privy modal and prompts the user to set a password on the embedded wallet
+ */
+declare function useSetWalletRecovery(callbacks?: PrivyEvents['setWalletRecovery']): {
+    /**
+     * Opens the Privy set recovery modal and prompts the user to set wallet password.
+     */
+    setWalletRecovery: () => Promise<Wallet>;
+};
+
 /**
  * Use this hook to sign a message using the embedded wallet, and to attach callbacks for success and errors.
  *
@@ -3594,8 +3689,16 @@ declare function addRpcUrlOverrideToChain(chain: Chain, rpcUrl: string): {
     testnet?: boolean | undefined;
 };
 
+/**
+ * Get the embedded wallet for the user if they have one.
+ *
+ * @param wallets {@link ConnectedWallet} the array of wallets fetched via {@link useWallets}
+ * @returns the embedded wallet if it exists, otherwise null
+ */
+declare function getEmbeddedConnectedWallet(wallets: ConnectedWallet[]): ConnectedWallet | null;
+
 declare const LoginModal: ({ open }: {
     open: boolean;
 }) => react_jsx_runtime.JSX.Element;
 
-export { Apple, AppleOAuthWithMetadata, AsExternalProvider, CallbackError, Captcha, ConnectedWallet, ConnectorManager, ContractUIOptions, Discord, DiscordOAuthWithMetadata, EIP1193Provider, Email, EmailWithMetadata, Farcaster, FarcasterWithMetadata, FundWalletConfig, Github, GithubOAuthWithMetadata, Google, GoogleOAuthWithMetadata, LinkedIn, LinkedInOAuthWithMetadata, LoginMethodOrderOption, LoginModal, LoginWithCode, MessageTypes, MfaMethod, MoonpayConfig, MoonpayCurrencyCode, MoonpayPaymentMethod, NonEmptyArray, OAuthProviderTokens, OAuthProviderType, Passkey, PasskeyWithMetadata, 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, useExperimentalFarcasterSigner, useFundWallet, useLinkAccount, useLogin, useLoginWithEmail, useLoginWithOAuth, 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, LoginModal, LoginWithCode, MessageTypes, MfaMethod, MoonpayConfig, MoonpayCurrencyCode, MoonpayPaymentMethod, NonEmptyArray, OAuthProviderTokens, OAuthProviderType, Passkey, PasskeyWithMetadata, 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, getEmbeddedConnectedWallet, useConnectWallet, useCreateWallet, useCrossAppAccounts, useExperimentalFarcasterSigner, useFundWallet, useLinkAccount, useLogin, useLoginWithEmail, useLoginWithOAuth, useLoginWithSms, useLogout, useMfa, useMfaEnrollment, useModalStatus, usePrivy, useRegisterMfaListener, useSendTransaction, useSetWalletPassword, useSetWalletRecovery, useSignMessage, useSignTypedData, useToken, useWallets };