@privy-io/react-auth 1.56.0 → 1.56.1

package/dist/index.d.ts

@@ -532,7 +532,7 @@ declare abstract class WalletConnector extends EventEmitter<ConnectorEvents> {
      * A wallet is considered connected if it is present in the wallets array and is
      * in a connected state.
      */
-    buildConnectedWallet(address: string, chainId: string): BaseConnectedWallet;
+    buildConnectedWallet(address: string, chainId: string, meta: ConnectedWalletMetadata): BaseConnectedWallet;
     /**
      * Sync all accounts available via the provider if the wallet is connected.
      *
@@ -675,6 +675,7 @@ interface GetCurrentUserResponse {
     created_at: number;
     linked_accounts: LinkedAccountsResponseType;
     mfa_methods: LinkedMfaMethodsResponseType;
+    has_accepted_terms: boolean;
 }
 
 interface DefaultsType {
@@ -760,7 +761,8 @@ declare class ConnectorManager extends EventEmitter<ConnectorManagerEvents> {
     private defaultChain;
     private store;
     private walletList;
-    constructor(walletConnectCloudProjectId: string, rpcConfig: RpcConfig, chains: Chain[], defaultChain: Chain, store: Store, walletList: WalletListEntry[]);
+    private shouldEnforceDefaultChainOnConnect;
+    constructor(walletConnectCloudProjectId: string, rpcConfig: RpcConfig, chains: Chain[], defaultChain: Chain, store: Store, walletList: WalletListEntry[], shouldEnforceDefaultChainOnConnect: boolean);
     /**
      * The core wallets array that is exposed to developers. It builds
      * the wallets away with the following logic:
@@ -858,7 +860,7 @@ declare class PrivyClient {
      * config. We can set this once and only once. If it is set twice, event listeners will be created
      * on the first ConnectorManager and are not re-created.
      */
-    initializeConnectorManager(walletConnectCloudProjectId: string, rpcConfig: RpcConfig, chains: Chain[], defaultChain: Chain, store: Store, walletList: WalletListEntry[]): void;
+    initializeConnectorManager(walletConnectCloudProjectId: string, rpcConfig: RpcConfig, chains: Chain[], defaultChain: Chain, store: Store, walletList: WalletListEntry[], shouldEnforceDefaultChainOnConnect: boolean): void;
     generateApi(): Http;
     /**
      * In the case of cookie-based auth, re-initialize the http client with the custom api url.
@@ -874,6 +876,7 @@ declare class PrivyClient {
     startAuthFlow(authFlow: AuthFlow): void;
     startMfaFlow(mfaFlow: MfaFlow): void;
     unlinkEmail(address: string): Promise<User>;
+    acceptTerms(): Promise<User>;
     unlinkPhone(phoneNumber: string): Promise<User>;
     unlinkWallet(address: string): Promise<User>;
     unlinkOAuth(provider: OAuthProviderType, subject: string): Promise<User>;
@@ -981,6 +984,7 @@ type ConnectorType = (typeof SUPPORTED_CONNECTOR_TYPES)[number];
  */
 type WalletBranding = {
     name: string;
+    id: string;
     icon?: string | EmbeddedSVG;
 };
 type LinkedAccountType = 'wallet' | 'email' | 'phone' | 'google_oauth' | 'twitter_oauth' | 'discord_oauth' | 'github_oauth' | 'tiktok_oauth' | 'linkedin_oauth' | 'apple_oauth' | 'custom_auth' | 'farcaster';
@@ -1059,6 +1063,17 @@ interface Wallet {
      */
     recoveryMethod?: 'privy' | 'user-passcode';
 }
+/**
+ * Object representation of metadata reported by a connected wallet from a wallet connector
+ */
+interface ConnectedWalletMetadata {
+    /** The wallet name (e.g. Metamask). */
+    name: string;
+    /** The wallet RDNS, falls back to the wallet name if none is available. */
+    id: string;
+    /** The wallet logo */
+    icon?: string;
+}
 /**
  * Object representation of a base connected wallet from a wallet connector.
  */
@@ -1079,6 +1094,10 @@ interface BaseConnectedWallet {
      * e.g. injected, wallet_connect, coinbase_wallet, etc.
      */
     connectorType: ConnectorType;
+    /**
+     * Metadata for the wallet.
+     */
+    meta: ConnectedWalletMetadata;
     /** Returns true if the wallet is connected, false otherwise */
     isConnected: () => Promise<boolean>;
     /**
@@ -1334,6 +1353,11 @@ interface User {
     linkedAccounts: Array<LinkedAccountWithMetadata>;
     /** The list of MFA Methods associated with this user. */
     mfaMethods: Array<MfaMethod>;
+    /**
+     * Whether or not the user has explicitly accepted the Terms and Conditions
+     * and/or Privacy Policy
+     */
+    hasAcceptedTerms: boolean;
 }
 type PrivyServerConfig = {
     id?: string;
@@ -1354,6 +1378,7 @@ type PrivyServerConfig = {
     farcasterAuth?: boolean;
     termsAndConditionsUrl: string | null;
     privacyPolicyUrl: string | null;
+    requireUsersAcceptTerms?: boolean;
     createdAt?: Date;
     updatedAt?: Date;
     customApiUrl?: string | null;
@@ -1363,6 +1388,8 @@ type PrivyServerConfig = {
     captchaEnabled?: boolean;
     captchaSiteKey: string;
     twitterOAuthOnMobileEnabled?: boolean;
+    enforceWalletUis?: boolean;
+    legacyWalletUiConfig?: boolean;
     /** May be deprecated from the server config in a future release */
     logoUrl?: string;
     /** May be deprecated from the server config in a future release */