@privy-io/react-auth 1.26.0 → 1.26.1-beta.10

package/dist/index.d.ts

@@ -140,12 +140,65 @@ interface EmbeddedWalletProxy {
     rpc: (data: WalletRpcRequestDataType) => Promise<WalletRpcResponseDataType>;
 }
 
+declare abstract class PrivyError extends Error {
+    /**
+     * Privy error type.
+     */
+    abstract type: string;
+    /**
+     * Original Error object, it the error originated client-side.
+     */
+    cause?: Error;
+    /**
+     * An optional error code, often included in Privy API responses.
+     */
+    privyErrorCode?: PrivyErrorCode;
+    /**
+     * @param type Privy error type.
+     * @param message Human-readable message.
+     * @param cause Source of this error.
+     */
+    protected constructor(message: string, cause?: unknown, privyErrorCode?: PrivyErrorCode);
+    toString(): string;
+}
+declare enum PrivyErrorCode {
+    MISSING_OR_INVALID_PRIVY_APP_ID = "missing_or_invalid_privy_app_id",
+    MISSING_OR_INVALID_PRIVY_ACCOUNT_ID = "missing_or_invalid_privy_account_id",
+    INVALID_DATA = "invalid_data",
+    LINKED_TO_ANOTHER_USER = "linked_to_another_user",
+    ALLOWLIST_REJECTED = "allowlist_rejected"
+}
+
+/**
+ * A ProviderRpcError combines the necessary bits of the {PrivyError} with the
+ * EIP-compliant ProviderRpcError. This is meant to be a type around errors raised
+ * by the ethereum provider.
+ */
+declare class ProviderRpcError extends PrivyError {
+    type: string;
+    readonly code: number;
+    readonly data?: unknown;
+    constructor(message: string, code: number, data?: unknown);
+}
+
 declare global {
     interface Window {
         ethereum?: unknown;
     }
 }
-type EIP1193OnEventHandler = ((accounts: string[]) => void) | ((chainId: string | number) => void);
+type ProviderConnectInfo = {
+    chainId: string;
+};
+type OnConnectEventHandler = (connectInfo: ProviderConnectInfo) => void;
+type OnDisconnectEventHandler = (error: ProviderRpcError) => void;
+type OnChainChangedEventHandler = (chainId: string | number) => void;
+type OnAccountsChangedEventHandler = (accounts: string[]) => void;
+type ProviderMessage = {
+    type: string;
+    data: unknown;
+};
+type OnMessageEventHandler = (message: ProviderMessage) => void;
+type EIP1193OnEventHandler = OnConnectEventHandler | OnDisconnectEventHandler | OnChainChangedEventHandler | OnAccountsChangedEventHandler | OnMessageEventHandler;
 interface EIP1193Provider {
     request: (request: {
         method: string;
@@ -416,15 +469,14 @@ interface ConnectedWallet extends BaseConnectedWallet {
     /** True if this wallet is linked to the authenticated user. False if it is not yet linked or
      * the user has not yet authenticated. */
     linked: boolean;
-    /** Link this wallet to the authenticated user. Throws a PrivyClientError if the user is not
-     * authenticated or if the wallet is not connected. */
-    link: () => Promise<void>;
+    /** Login with this wallet or link this wallet to the authenticated user.
+     *
+     * Throws a PrivyClientError if the wallet is not connected.
+     */
+    loginOrLink: () => Promise<void>;
     /** Unlink this wallet to the authenticated user. Throws a PrivyClientError if the user is not
      * authenticated. */
     unlink: () => Promise<void>;
-    /** Login with this wallet. Throws a PrivyClientError if the user is already authenticated or
-     * the wallet is not connected. */
-    login: () => Promise<void>;
 }
 /** Object representation of a user's email. */
 interface Email {
@@ -747,7 +799,7 @@ declare class ConnectorManager extends EventEmitter<ConnectorManagerEvents> {
      * the wallets away with the following logic:
      *
      * 1. Flatten all wallets from all connectors
-     * 2. Sorted by connectedAT
+     * 2. Sorted by connectedAt
      * 3. Active wallet is moved to front of array (if it exists)
      */
     get wallets(): BaseConnectedWallet[];