@privy-io/react-auth 3.48.0 → 3.49.0

package/dist/dts/events-context-8NMDpHyB.d.ts

@@ -1,329 +0,0 @@
-import { Chain } from '@privy-io/js-sdk-core';
-import { P as PrivyErrorCode } from './privyProxyProvider-JBV6XRYP.js';
-import { U as User, L as LoginMethod, a as LinkedAccountWithMetadata, B as BaseConnectedEthereumWallet, b as BaseConnectedSolanaWallet, W as Wallet, M as MfaMethod, c as UserRecoveryMethod, O as OAuthTokens, F as FundingMethod, d as SolanaChain } from './types-BOEI6Njl.js';
-
-/**
- * `CallbackError` optionally includes a second parameter with further error details.
- */
-type CallbackError<Details extends Record<string, any> | undefined = undefined> = Details extends Record<string, any> ? (error: PrivyErrorCode, details: Details) => void : (error: PrivyErrorCode) => void;
-interface PrivyEvents {
-    login: {
-        /**
-         * Callback that will execute once a `login` flow successfully completes.
-         * - If `config.embeddedWallets.createOnLogin` is set to 'off' or a wallet creation flow is not applicable,
-         *   this will run after the user successfully authenticates.
-         * - If `config.embeddedWallets.createOnLogin` is set to 'users-without-wallets' or 'all-users',
-         *   this will run after the user successfully authenticates _and_ creates their wallet (if applicable).
-         * - If a user is already authenticated, this will run immediately and the `wasAlreadyAuthenticated` flag will be set to `true`.
-         *
-         * @param params.user {@link User} the `user` oject corresponding to the authenticated user
-         * @param params.isNewUser {boolean} boolean flag indicating if this is the user's first time logging in to your app
-         * @param params.wasAlreadyAuthenticated {boolean} - boolean flag indicating whether the user entered the application already authenticated
-         * @param params.loginMethod {string} - the method used by the user to login
-         * @param params.loginAccount - the account corresponding to the loginMethod used
-         */
-        onComplete?: (params: {
-            user: User;
-            isNewUser: boolean;
-            wasAlreadyAuthenticated: boolean;
-            loginMethod: LoginMethod | null;
-            loginAccount: LinkedAccountWithMetadata | null;
-        }) => void;
-        /**
-         * Callback that will execute in the case of a non-successful login.
-         *
-         * @param error {@link PrivyErrorCode} - the corresponding error code
-         */
-        onError?: CallbackError;
-    };
-    logout: {
-        /**
-         * Callback that will execute when a user successfully logs out.
-         */
-        onSuccess?: () => void;
-    };
-    connectWallet: {
-        /**
-         * Callback that will execute once a successful `connectWallet` completes.
-         * This will not run in the case of a wallet-based authentication or link flow.
-         *
-         * @param params.wallet {@link BaseConnectedEthereumWallet | BaseConnectedSolanaWallet} the `wallet` object correspending to the connection
-         */
-        onSuccess?: (params: {
-            wallet: BaseConnectedEthereumWallet | BaseConnectedSolanaWallet;
-        }) => void;
-        /**
-         * Callback that will execute in the case of a non-successful wallet connection.
-         *
-         * @param params.error {@link PrivyErrorCode} - the corresponding error code
-         */
-        onError?: CallbackError;
-    };
-    connectOrCreateWallet: {
-        /**
-         * Callback that will execute once a successful `connectWallet` completes.
-         * This will not run in the case of a wallet-based authentication or link flow.
-         *
-         * @param params.wallet {@link BaseConnectedEthereumWallet | BaseConnectedSolanaWallet} the `wallet` object correspending to the connection
-         */
-        onSuccess?: (params: {
-            wallet: BaseConnectedEthereumWallet | BaseConnectedSolanaWallet;
-        }) => void;
-        /**
-         * Callback that will execute in the case of a non-successful wallet connection.
-         *
-         * @param params.error {@link PrivyErrorCode} - the corresponding error code
-         */
-        onError?: CallbackError;
-    };
-    createWallet: {
-        /**
-         * Callback that will execute once on a successful embedded wallet creation.
-         * This will run when `createWallet` is called manually, or when `config.embeddedWallets.createOnLogin` triggers
-         * an automatic wallet creation.
-         *
-         * @param params.wallet {@link BaseConnectedWallet}- the created `wallet` object
-         */
-        onSuccess?: (params: {
-            wallet: Wallet;
-        }) => void;
-        /**
-         * Callback that will execute in the case of a non-successful wallet creation.
-         *
-         * @param params.error {@link PrivyErrorCode} - the corresponding error code
-         */
-        onError?: CallbackError;
-    };
-    linkAccount: {
-        /**
-         * Callback that will execute once on a successful linking of a new account/login method.
-         * This will run when any of the 'link' methods are called manually.
-         * @param params.user {@link User}- the user the account was linked to
-         * @param params.linkMethod {@link LoginMethod}- the type of linked account
-         * @param params.linkedAccount - the newly linked account
-         */
-        onSuccess?: (params: {
-            user: User;
-            linkMethod: LoginMethod;
-            linkedAccount: LinkedAccountWithMetadata;
-        }) => void;
-        /**
-         * Callback that will execute in the case of a non-successful account linking.
-         *
-         * @param error {PrivyErrorCode} - the corresponding error code
-         * @param details.linkMethod {LoginMethod} - the type of (attempted) linked account
-         */
-        onError?: CallbackError<{
-            linkMethod: LoginMethod;
-        }>;
-    };
-    update: {
-        /**
-         * Callback that will execute once on a successful updating of an account.
-         * This will run when any of the 'updateAccount' methods are called manually.
-         * @param params.user {@link User}- the user the account was linked to
-         * @param params.updateMethod {@link LoginMethod}- the type of updated account
-         * @param params.updatedAccount - the newly updated account
-         */
-        onSuccess?: (params: {
-            user: User;
-            updateMethod: LoginMethod;
-            updatedAccount: LinkedAccountWithMetadata;
-        }) => void;
-        /**
-         * Callback that will execute in the case of a non-successful account linking.
-         *
-         * @param error {PrivyErrorCode} - the corresponding error code
-         * @param details.linkMethod {LoginMethod} - the type of (attempted) linked account
-         */
-        onError?: CallbackError<{
-            linkMethod: LoginMethod;
-        }>;
-    };
-    configureMfa: {
-        /**
-         * Callback that will execute when MFA is required to complete a given action.
-         * @param params.mfaMethods {@link MfaMethod[]} - List of MFA methods that the user can choose from
-         */
-        onMfaRequired: (params: {
-            mfaMethods: MfaMethod[];
-        }) => void;
-    };
-    setWalletPassword: {
-        /**
-         * Callback that will execute once a successful `setWalletPassword` completes.
-         * @param params.wallet {@link Wallet}- the `wallet` object that the password was set for
-         */
-        onSuccess?: (params: {
-            wallet: Wallet;
-        }) => void;
-        /**
-         * Callback that will execute in the case of a non-successful setWalletPassword.
-         *
-         * @param params.error {PrivyErrorCode} - the corresponding error code
-         */
-        onError?: CallbackError;
-    };
-    setWalletRecovery: {
-        /**
-         * Callback that will execute once a successful `setWalletRecovery` completes.
-         * @param params.method {@link UserRecoveryMethod} - the recovery method that was set
-         * @param params.wallet {@link Wallet}- the wallet object that the recovery was set for
-         */
-        onSuccess?: (params: {
-            method: UserRecoveryMethod;
-            wallet: Wallet;
-        }) => void;
-        /**
-         * Callback that will execute in the case of a non-successful setWalletRecovery.
-         *
-         * @param params.error {PrivyErrorCode} - the corresponding error code
-         */
-        onError?: CallbackError;
-    };
-    signMessage: {
-        /**
-         * Callback that will execute once a successful `signMessage` completes.
-         * This will not run in the case of a wallet-based authentication or link flow.
-         * @param params.signature - the signature (type string) of the embedded wallet used to sign message
-         */
-        onSuccess?: (params: {
-            signature: string;
-        }) => void;
-        /**
-         * Callback that will execute in the case of a non-successful signMessage.
-         *
-         * @param params.error {@link PrivyErrorCode} - the corresponding error code
-         */
-        onError?: CallbackError;
-    };
-    signTypedData: {
-        /**
-         * Callback that will execute once a successful `signTypedData` completes.
-         * @param params.signature - the signature (type string) of the embedded wallet used to sign
-         */
-        onSuccess?: (params: {
-            signature: string;
-        }) => void;
-        /**
-         * Callback that will execute in the case of a non-successful signTypedData.
-         *
-         * @param params.error {@link PrivyErrorCode} - the corresponding error code
-         */
-        onError?: CallbackError;
-    };
-    sendTransaction: {
-        /**
-         * Callback that will execute once a successful `sendTransaction` completes.
-         * This will not run for transactions with external wallets.
-         * @param an object with the transaction hash
-         */
-        onSuccess?: (params: {
-            hash: `0x${string}`;
-        }) => void;
-        /**
-         * Callback that will execute in the case of a non-successful sendTransaction.
-         *
-         * @param params.error {@link PrivyErrorCode} - the corresponding error code
-         */
-        onError?: CallbackError;
-    };
-    signTransaction: {
-        /**
-         * Callback that will execute once a successful `signTransaction` completes.
-         * This will not run for transactions with external wallets.
-         * @param an object with the transaction signature
-         */
-        onSuccess?: (params: {
-            signature: `0x${string}`;
-        }) => void;
-        /**
-         * Callback that will execute in the case of a non-successful signTransaction.
-         *
-         * @param params.error {@link PrivyErrorCode} - the corresponding error code
-         */
-        onError?: CallbackError;
-    };
-    accessToken: {
-        /**
-         * Callback that will execute when a user's access token is granted.
-         * @param params.accessToken - The user's access token
-         */
-        onAccessTokenGranted: (params: {
-            accessToken: string;
-        }) => void;
-        /**
-         * Callback that will execute when a user's access token is removed.
-         */
-        onAccessTokenRemoved: () => void;
-    };
-    oAuthAuthorization: {
-        /**
-         * Callback that will execute when a user successfully authorizes an OAuth flow.
-         *
-         * @param params.oAuthTokens {@link OAuthTokens} - the OAuth tokens returned from the OAuth provider:
-         * @param params.oAuthTokens.provider - {string}  The OAuth provider type.
-         * @param params.oAuthTokens.accessToken - {string} The OAuth access token.
-         * @param params.oAuthTokens.accessTokenExpiresInSeconds - {number} (optional) The number of seconds until the OAuth access token expires.
-         * @param params.oAuthTokens.refreshToken - {string} (optional) The OAuth refresh token.
-         * @param params.oAuthTokens.refreshTokenExpiresInSeconds - {number} (optional) The number of seconds until the OAuth refresh token expires.
-         * if the refresh token is present and this field is undefined, it is assumed
-         * that the refresh token does not have an expiration date.
-         * @param params.oAuthTokens.scopes -  {string[]} (optional) The list of OAuth scopes the access token is approved for.
-         *
-         * @param params.user {@link User} The authenticated user
-         */
-        onOAuthTokenGrant: (params: {
-            oAuthTokens: OAuthTokens;
-            user: User;
-        }) => void;
-    };
-    fundWallet: {
-        /**
-         * Callback that will execute when a funding flow is exited. This fires when a user closes a funding flow modal, for any reason.
-         *
-         * @param params.address {string} The address of the wallet being funded
-         * @param params.chain {Chain} The chain of the wallet being funded
-         * @param params.fundingMethod {@link FundingMethod} The funding method associated with the flow at time of exit. If the user had not yet selected
-         * a recovery method, this will be null.
-         * @param params.balance {bigint} The value for the funded wallet at the point of user exit.
-         */
-        onUserExited?: (params: {
-            address: string;
-            chain: Chain;
-            fundingMethod: FundingMethod | 'manual' | null;
-            balance: bigint | undefined;
-        }) => void;
-    };
-    fundSolanaWallet: {
-        /**
-         * Callback that will execute when a funding flow is exited. This fires when a user closes a funding flow modal, for any reason.
-         *
-         * @param params.address {string} The address of the wallet being funded
-         * @param params.fundingMethod {@link FundingMethod} The funding method associated with the flow at time of exit. If the user had not yet selected
-         * a recovery method, this will be null.
-         * @param params.balance {bigint} The value for the funded wallet at the point of user exit.
-         */
-        onUserExited?: (params: {
-            address: string;
-            fundingMethod: FundingMethod | 'manual' | null;
-            chain: SolanaChain;
-            balance: bigint | undefined;
-        }) => void;
-    };
-    customAuth: {
-        /**
-         * Callback that will execute when Privy successfully exchanges a custom auth JWT for a Privy JWT
-         * @param params.user - The Privy user
-         */
-        onAuthenticated: (params: {
-            user: User;
-        }) => void;
-        /**
-         * Callback that will execute when Privy detects a user is logged out from the third-party auth system, and correspondingly logs the user out.
-         */
-        onUnauthenticated: () => void;
-    };
-}
-
-export type { CallbackError as C, PrivyEvents as P };

package/dist/dts/importWallet-BtAIPo9T.d.mts

@@ -1,12 +0,0 @@
-import { S as SessionSignerInput } from './types-BOEI6Njl.mjs';
-
-/**
- * Input for importing a wallet from a private key.
- */
-type ImportWalletInput = {
-    /** The private key of the wallet to import. */
-    privateKey: string;
-    additionalSigners?: SessionSignerInput;
-};
-
-export type { ImportWalletInput as I };

package/dist/dts/importWallet-BtAIPo9T.d.ts

@@ -1,12 +0,0 @@
-import { S as SessionSignerInput } from './types-BOEI6Njl.js';
-
-/**
- * Input for importing a wallet from a private key.
- */
-type ImportWalletInput = {
-    /** The private key of the wallet to import. */
-    privateKey: string;
-    additionalSigners?: SessionSignerInput;
-};
-
-export type { ImportWalletInput as I };

package/dist/dts/privyProxyProvider-JBV6XRYP.d.mts

@@ -1,171 +0,0 @@
-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;
-}
-/**
- * The PrivyConnector instance threw an exception.
- */
-declare class PrivyConnectorError extends PrivyError {
-    type: string;
-    constructor(message: string, cause?: unknown, privyErrorCode?: PrivyErrorCode);
-}
-declare enum PrivyErrorCode {
-    OAUTH_ACCOUNT_SUSPENDED = "oauth_account_suspended",
-    MISSING_OR_INVALID_PRIVY_APP_ID = "missing_or_invalid_privy_app_id",
-    MISSING_OR_INVALID_PRIVY_ACCOUNT_ID = "missing_or_invalid_privy_account_id",
-    MISSING_OR_INVALID_TOKEN = "missing_or_invalid_token",
-    INVALID_DATA = "invalid_data",
-    INVALID_CAPTCHA = "invalid_captcha",
-    LINKED_TO_ANOTHER_USER = "linked_to_another_user",
-    CANNOT_LINK_MORE_OF_TYPE = "cannot_link_more_of_type",
-    FAILED_TO_LINK_ACCOUNT = "failed_to_link_account",
-    FAILED_TO_UPDATE_ACCOUNT = "failed_to_update_account",
-    USER_EXITED_UPDATE_FLOW = "exited_update_flow",
-    ALLOWLIST_REJECTED = "allowlist_rejected",
-    OAUTH_USER_DENIED = "oauth_user_denied",
-    OAUTH_UNEXPECTED = "oauth_unexpected",
-    UNKNOWN_AUTH_ERROR = "unknown_auth_error",
-    USER_EXITED_AUTH_FLOW = "exited_auth_flow",
-    USER_EXITED_LINK_FLOW = "exited_link_flow",
-    USER_EXITED_SET_PASSWORD_FLOW = "user_exited_set_password_flow",
-    MUST_BE_AUTHENTICATED = "must_be_authenticated",
-    UNKNOWN_CONNECT_WALLET_ERROR = "unknown_connect_wallet_error",
-    GENERIC_CONNECT_WALLET_ERROR = "generic_connect_wallet_error",
-    CLIENT_REQUEST_TIMEOUT = "client_request_timeout",
-    INVALID_CREDENTIALS = "invalid_credentials",
-    MISSING_MFA_CREDENTIALS = "missing_or_invalid_mfa",
-    UNKNOWN_MFA_ERROR = "unknown_mfa_error",
-    EMBEDDED_WALLET_ALREADY_EXISTS = "embedded_wallet_already_exists",
-    EMBEDDED_WALLET_NOT_FOUND = "embedded_wallet_not_found",
-    EMBEDDED_WALLET_CREATE_ERROR = "embedded_wallet_create_error",
-    UNKNOWN_EMBEDDED_WALLET_ERROR = "unknown_embedded_wallet_error",
-    EMBEDDED_WALLET_PASSWORD_UNCONFIRMED = "embedded_wallet_password_unconfirmed",
-    EMBEDDED_WALLET_PASSWORD_ALREADY_EXISTS = "embedded_wallet_password_already_exists",
-    EMBEDDED_WALLET_RECOVERY_ALREADY_EXISTS = "embedded_wallet_recovery_already_exists",
-    TRANSACTION_FAILURE = "transaction_failure",
-    UNSUPPORTED_CHAIN_ID = "unsupported_chain_id",
-    NOT_SUPPORTED = "not_supported",
-    CAPTCHA_TIMEOUT = "captcha_timeout",
-    INVALID_MESSAGE = "invalid_message",
-    UNABLE_TO_SIGN = "unable_to_sign",
-    CAPTCHA_FAILURE = "captcha_failure",
-    CAPTCHA_DISABLED = "captcha_disabled",
-    SESSION_STORAGE_UNAVAILABLE = "session_storage_unavailable",
-    TOO_MANY_REQUESTS = "too_many_requests",
-    USER_LIMIT_REACHED = "max_accounts_reached",
-    DISALLOWED_LOGIN_METHOD = "disallowed_login_method",
-    DISALLOWED_PLUS_EMAIL = "disallowed_plus_email",
-    PASSKEY_NOT_ALLOWED = "passkey_not_allowed",
-    USER_DOES_NOT_EXIST = "user_does_not_exist",
-    INSUFFICIENT_BALANCE = "insufficient_balance",
-    ONRAMP_MINIMUM_IDENTITY_VERIFICATION_REQUIRED = "onramp_minimum_identity_verification_required",
-    ONRAMP_IDENTITY_VERIFICATION_REQUIRED = "onramp_identity_verification_required",
-    ONRAMP_DOCUMENT_VERIFICATION_REQUIRED = "onramp_document_verification_required",
-    ONRAMP_UNSUPPORTED_INFORMATION = "onramp_unsupported_information",
-    ONRAMP_TRANSACTION_LIMIT_REACHED = "transaction_limit_reached",
-    ONRAMP_QUOTE_EXPIRED = "onramp_quote_expired",
-    ONRAMP_PAYMENT_METHOD_DECLINED = "onramp_payment_method_declined",
-    ONRAMP_WALLET_OWNERSHIP_REQUIRED = "onramp_wallet_ownership_required",
-    ACCOUNT_TRANSFER_REQUIRED = "account_transfer_required",
-    BUFFER_NOT_DEFINED = "buffer_not_defined",
-    UNSUPPORTED_WALLET_TYPE = "unsupported_wallet_type",
-    NO_SOLANA_ACCOUNTS = "no_solana_accounts",
-    UNKNOWN_FUNDING_ERROR = "unknown_funding_error"
-}
-
-declare class WalletTimeoutError extends PrivyConnectorError {
-    type: string;
-    constructor();
-}
-/**
- * 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);
-}
-
-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 {
-    rpcTimeoutDuration?: number;
-    request: (request: {
-        method: string;
-        params?: Array<any> | undefined;
-    }) => Promise<any>;
-    on: (eventName: string, listener: EIP1193OnEventHandler) => any;
-    removeListener: (eventName: string | symbol, listener: (...args: any[]) => void) => any;
-}
-interface RequestArguments {
-    readonly method: string;
-    readonly params?: readonly unknown[] | object | any;
-}
-
-declare global {
-    interface Window {
-        ethereum?: any;
-    }
-}
-/**
- * @hidden
- *
- * The PrivyProxyProvider adds a middleware layer on top of the underlying wallet provider.
- * */
-declare class PrivyProxyProvider implements EIP1193Provider {
-    rpcTimeoutDuration: number;
-    walletProvider?: EIP1193Provider;
-    private _subscriptions;
-    constructor(walletProvider?: EIP1193Provider, rpcTimeoutDuration?: number);
-    on(eventName: string, listener: (...args: any[]) => void): any;
-    /**
-     * Subscribe to an event on the underlying wallet provider, tolerating
-     * providers that do not implement the EIP-1193 event emitter.
-     *
-     * Some legacy injected providers expose `request` but no callable `on`.
-     * Guarding here keeps such a provider a no-op for events instead of throwing
-     * `this.walletProvider?.on is not a function`, mirroring `removeListener`.
-     */
-    private addWalletProviderListener;
-    request(request: {
-        method: string;
-        params?: any[] | undefined;
-    }): Promise<any>;
-    removeListener: (eventName: string | symbol, listener: (...args: any[]) => void) => any;
-    walletTimeout: (error?: WalletTimeoutError, timeoutMs?: number) => Promise<string[]>;
-    setWalletProvider: (provider: EIP1193Provider) => void;
-}
-
-export { PrivyErrorCode as P, PrivyProxyProvider as a };
-export type { EIP1193Provider as E, RequestArguments as R };