@privy-io/react-auth 1.12.1-beta.5 → 1.13.0-beta.10

package/dist/index.d.ts

@@ -78,7 +78,7 @@ interface Discord {
     /** The email associated with the Discord account. */
     email: string | null;
 }
-/** Object representation of a user's Discord account. */
+/** Object representation of a user's Github account. */
 interface Github {
     /** The `sub` claim from the Github-issued JWT for this account. */
     subject: string;
@@ -161,6 +161,7 @@ interface AppSettings {
     theme?: 'System' | 'Light' | 'Dark' | string;
     accentColor?: string;
     showWalletLoginFirst?: boolean;
+    allowlistConfig: AllowlistConfig;
     walletAuth?: boolean;
     emailAuth?: boolean;
     smsAuth?: boolean;
@@ -173,6 +174,12 @@ interface AppSettings {
     createdAt?: Date;
     updatedAt?: Date;
 }
+interface AllowlistConfig {
+    errorTitle: string | null;
+    errorDetail: string | null;
+    errorCtaText: string | null;
+    errorCtaLink: string | null;
+}
 
 declare function getAccessToken(): Promise<string | null>;
 /**
@@ -190,16 +197,6 @@ interface PrivyProviderProps {
      *
      */
     onSuccess?: (user: User, isNewUser: boolean) => void;
-    /**
-     * @experimental **Experimental**: This feature is {@link https://docs.privy.io/guide/faq/experimental-features subject to change at any time}.
-     *
-     * An optional callback that will execute if a `login` call fails.
-     *
-     * Within this callback, you can access:
-     * - an `isNotAllowed` boolean flag indicating if the user was prevented from logging in by
-     * your app's allowlist, if you have one enabled
-     */
-    onError?: (isNotAllowed: boolean) => void;
     /** @ignore */
     children: React.ReactNode;
 }
@@ -261,37 +258,57 @@ declare class AsExternalProvider extends PrivyProxyProvider implements ExternalP
     }, callback: (error: any, response: any) => void) => void;
 }
 
-declare class PrivyConnector {
-    private ethProvider;
-    walletType: WalletType | null;
+declare abstract class WalletConnector {
+    provider: PrivyProxyProvider;
+    walletType: WalletType;
+    connected: boolean;
+    address: string | null;
+    chain: string | null;
+    constructor(walletType: WalletType, provider: PrivyProxyProvider, address: string | null);
+    fetchAddress(): Promise<string | null>;
+    fetchChainId(): Promise<string>;
+    getConnectedWallet(): Promise<Wallet | null>;
+    abstract connect(options: {
+        showPrompt: boolean;
+    }): Promise<Wallet | null>;
+    abstract isConnected(): Promise<boolean>;
+    abstract promptConnection(walletType: WalletType): void;
+}
+
+declare class ConnectorManager {
+    walletConnectors: WalletConnector[];
+    activeWalletConnector?: WalletConnector;
+    initialized: boolean;
     constructor();
-    getEthereumProvider: () => EIP1193Provider;
     initialize(): void;
-    destroy(): void;
-    getConnectedWallet(): Promise<Wallet | null>;
+    getEthereumProvider: () => EIP1193Provider;
     /**
-     * Connects to the wallet.
-     *
-     * @param options.showPrompt if true, prompts the user for a connection when no connection can be automatically re-established.
-     * @returns {string | null} EIP-55 mixed-case checksum-encoded address of connected wallet or null if user does not connect.
+     * Load state from the server user object (linked wallets).
+     * Currently, we can't load them because we don't know the wallet type.
+     * Once we've fixed this, we can load the wallets from the server and
+     * initialize their WalletConnector objects accordingly.
+     **/
+    initializeLinkedWallets(user: User): void;
+    load(): void;
+    save(): void;
+    /**
+     * Note that we purposefully don't delete CONNECTORS_STATE_KEY from localStorage
+     * This is because we can't recuperate state from the server state along yet (PRI-569).
      */
-    connect(options: {
-        showPrompt: boolean;
-    }): Promise<Wallet | null>;
-    private isConnected;
-    private promptConnection;
+    destroy(): void;
+    addWalletConnector(walletConnector: WalletConnector): void;
+    removeWallet(address: string): void;
     /**
-     * The currently connected EIP-155 chain id. E.g., `1` for Ethereum mainnet.
-     *
-     * @returns {string} The EIP-155 chain id.
+     * Performing personal_sign with the active wallet
+     * If the active wallet is not connected, we connect it in just-in-time" fashion.
      */
-    chainId(): Promise<string>;
+    activeWalletSign(message: string): Promise<string | null>;
     /**
-     * The currently connected address.
-     *
-     * @returns {string | null} EIP-55 mixed-case checksum-encoded address or null if not connected.
+     * Set a wallet as active, by passing the address.
+     * If the address is null or not found, do nothing and return false.
+     * If the connector was successfully found and set active, return true.
      */
-    address(): Promise<string | null>;
+    setActiveWallet(address: string | null): boolean;
 }
 
 /**
@@ -386,10 +403,10 @@ interface PrivyInterface {
      */
     getWeb3jsProvider: () => AbstractProvider;
     /**
-     * Get the PrivyConnector object
+     * Get the ConnectorManager object
      * This shouldn't need to be used directly unless creating a plugin, like a WAGMI plugin
      */
-    walletConnector: PrivyConnector | null;
+    walletConnectors: ConnectorManager | null;
     /**
      * Unlink an email account from a user, by passing the email address. Note that you can only unlink an email account if the user has at least one other account.
      */
@@ -570,7 +587,7 @@ declare class PrivyClient {
     private appId;
     private session;
     authFlow?: AuthFlow;
-    connector: PrivyConnector;
+    connectors: ConnectorManager;
     /**
      * Creates a new Privy client.
      * @param options Initialization options.
@@ -643,4 +660,4 @@ declare class PrivyClient {
     forkSession(): Promise<string>;
 }
 
-export { AsExternalProvider, Discord, DiscordOAuthWithMetadata, Email, EmailWithMetadata, GithubOAuthWithMetadata, Google, GoogleOAuthWithMetadata, Phone, PhoneWithMetadata, PrivyClient, PrivyConnector, PrivyInterface, PrivyProvider, PrivyProviderProps, PrivyProxyProvider, Twitter, TwitterOAuthWithMetadata, User, VERSION, Wallet, WalletWithMetadata, getAccessToken, usePrivy };
+export { AsExternalProvider, ConnectorManager, Discord, DiscordOAuthWithMetadata, Email, EmailWithMetadata, GithubOAuthWithMetadata, Google, GoogleOAuthWithMetadata, Phone, PhoneWithMetadata, PrivyClient, PrivyInterface, PrivyProvider, PrivyProviderProps, PrivyProxyProvider, Twitter, TwitterOAuthWithMetadata, User, VERSION, Wallet, WalletWithMetadata, getAccessToken, usePrivy };