@privy-io/react-auth 1.70.0 → 1.71.0-beta-20240611222124

package/dist/index.d.ts

@@ -797,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;
@@ -1037,6 +1047,8 @@ declare class PrivyClient {
         user: User | null;
         oAuthProviderTokens?: OAuthProviderTokens | undefined;
     }>;
+    storeProviderAccessToken(appId: string, providerAccessToken: string | null): void;
+    getProviderAccessToken(appId: string): string | null;
     logout(): Promise<void>;
     startAuthFlow<T extends AuthFlow>(authFlow: T): T;
     initMfaSmsVerification(): Promise<void>;
@@ -1162,7 +1174,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
@@ -1189,7 +1201,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 */
@@ -1521,6 +1533,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. */
@@ -1601,10 +1629,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. */
@@ -2225,6 +2258,20 @@ type SendTransactionModalUIOptions = {
      */
     senderInfo?: ContractUIOptions;
 };
+/**
+ * Our external-facing `UnsignedTransactionRequest` type makes the `chainId` field optional,
+ * matching ethers, wagmi, and a bunch of other libraries. However, our modal needs to be "aware"
+ * of the transaction's `chainId` to ensure it does price conversion, quote labeling, etc. importantly.
+ *
+ * Thus, in the modal, we enforce a stricter type `UnsignedTransactionRequestWithChainId` which wraps
+ * `UnsignedTransactionRequest` to make `chainId` required.
+ *
+ * If the developer does not set a `chainId` in their `UnsignedTransactionRequest`, we default to the embedded
+ * provider's  current `chainId` in `privy-provider.tsx` > `sendTransaction`
+ */
+type UnsignedTransactionRequestWithChainId = UnsignedTransactionRequest & {
+    chainId: number;
+};
 type PrivyFarcasterSignerInitResponse = {
     public_key: string;
     status: 'pending_approval';
@@ -3470,6 +3517,71 @@ 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;
+    /**
+     * For users who have linked an account from another privy app, prompts the user to sign a message
+     * with their embedded wallet from the linked privy app.
+     *
+     * This will redirect the user to a page on the target Privy app where they can sign the message.
+     *
+     *
+     * @param message {string} the message to sign
+     * @param options.address {string} the address of the embedded wallet from the linked privy app
+     */
+    signMessage: (message: string, o: {
+        address: string;
+    }) => Promise<string>;
+    /**
+     * For users who have linked an account from another privy app, prompts the user to sign typed data
+     * with their embedded wallet from the linked privy app.
+     *
+     * This will redirect the user to a page on the target Privy app where they can sign the message.
+     *
+     *
+     * @param data {SignTypedDataParameters} the typed data to sign
+     * @param options.address {string} the address of the embedded wallet from the linked privy app
+     */
+    signTypedData: (data: SignTypedDataParams, o: {
+        address: string;
+    }) => Promise<string>;
+    /**
+     * For users who have linked an account from another privy app, prompts the user to send a
+     * transaction with their embedded wallet from the linked privy app.
+     *
+     * This will redirect the user to a page on the target Privy app where they can sign the message.
+     *
+     *
+     * @param tx {UnsignedTransactionRequestWithChainId} the transaction to send
+     * @param options.address {string} the address of the embedded wallet from the linked privy app
+     */
+    sendTransaction: (tx: UnsignedTransactionRequestWithChainId, o: {
+        address: string;
+    }) => Promise<string>;
+}
+/**
+ * Hook to use cross-app accounts
+ *
+ * @experimental
+ * @returns o.linkCrossAppAccount - method to link a user's account from a provider app
+ * @returns o.signMessage - method sign a message with a user's embedded wallet 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
@@ -3646,4 +3758,4 @@ 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, getEmbeddedConnectedWallet, useConnectWallet, useCreateWallet, useExperimentalFarcasterSigner, useFundWallet, useLinkAccount, useLogin, useLoginWithEmail, useLoginWithOAuth, useLoginWithSms, useLogout, useMfa, useMfaEnrollment, useModalStatus, usePrivy, useRegisterMfaListener, useSendTransaction, useSetWalletPassword, useSetWalletRecovery, useSignMessage, useSignTypedData, useToken, useWallets };
+export { Apple, AppleOAuthWithMetadata, AsExternalProvider, CallbackError, Captcha, ConnectedWallet, ConnectorManager, ContractUIOptions, CrossAppAccount, CrossAppAccountWithMetadata, 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, Telegram, TelegramWithMetadata, 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 };