@privy-io/js-sdk-core 0.28.0 → 0.28.1

package/dist/dts/EmailApi.d.mts

@@ -0,0 +1,451 @@
+export default class EmailApi {
+    /**
+     * Sends a one time login code to a user's email address
+     *
+     * @param email The email address to send the one time login code
+     * @param token A CAPTCHA token
+     */
+    sendCode(email: string, token?: string): Promise<import("@privy-io/public-api").PrivySuccessObject>;
+    /**
+     * Logs a user in via an email address and one time code
+     *
+     * @param email The email address that the one time code was sent to
+     * @param code The one time code
+     * @param mode Optional Whether or not to block sign ups (only allow existing users to log in).
+     */
+    loginWithCode(email: string, code: string, mode?: 'login-or-sign-up' | 'no-signup'): Promise<import("@privy-io/public-api").PrivyAuthenticatedUser>;
+    /**
+     * Links an email adress to an existing user
+     *
+     * @param email The email address that the one time code was sent to
+     * @param code The one time code
+     */
+    linkWithCode(email: string, code: string): Promise<{
+        id: string;
+        mfa_methods: ({
+            type: "sms";
+            verified_at: number;
+        } | {
+            type: "totp";
+            verified_at: number;
+        } | {
+            type: "passkey";
+            verified_at: number;
+        })[];
+        linked_accounts: ({
+            type: "email";
+            address: string;
+            verified_at: number;
+            first_verified_at: number | null;
+            latest_verified_at: number | null;
+        } | {
+            type: "phone";
+            verified_at: number;
+            first_verified_at: number | null;
+            latest_verified_at: number | null;
+            phoneNumber: string;
+        } | {
+            type: "wallet";
+            address: string;
+            verified_at: number;
+            first_verified_at: number | null;
+            latest_verified_at: number | null;
+            chain_type: "ethereum";
+            wallet_client: "unknown";
+            chain_id?: string | undefined;
+            wallet_client_type?: string | undefined;
+            connector_type?: string | undefined;
+        } | {
+            type: "smart_wallet";
+            address: string;
+            smart_wallet_type: "safe" | "kernel" | "biconomy" | "light_account";
+            verified_at: number;
+            first_verified_at: number | null;
+            latest_verified_at: number | null;
+        } | {
+            type: "wallet";
+            address: string;
+            verified_at: number;
+            first_verified_at: number | null;
+            latest_verified_at: number | null;
+            chain_type: "solana";
+            wallet_client: "unknown";
+            wallet_client_type?: string | undefined;
+            connector_type?: string | undefined;
+        } | {
+            type: "farcaster";
+            fid: number;
+            verified_at: number;
+            first_verified_at: number | null;
+            latest_verified_at: number | null;
+            owner_address: string;
+            username?: string | undefined;
+            display_name?: string | undefined;
+            bio?: string | undefined;
+            profile_picture?: string | undefined;
+            profile_picture_url?: string | undefined;
+            homepage_url?: string | undefined;
+            signer_public_key?: string | undefined;
+        } | {
+            type: "passkey";
+            verified_at: number;
+            first_verified_at: number | null;
+            latest_verified_at: number | null;
+            credential_id: string;
+            enrolled_in_mfa: boolean;
+            created_with_browser?: string | undefined;
+            created_with_os?: string | undefined;
+            created_with_device?: string | undefined;
+            authenticator_name?: string | undefined;
+        } | {
+            telegramUserId: string;
+            firstName: string | null | undefined;
+            type: "telegram";
+            verified_at: number;
+            first_verified_at: number | null;
+            latest_verified_at: number | null;
+            telegram_user_id: string;
+            username?: string | null | undefined;
+            first_name?: string | null | undefined;
+            last_name?: string | null | undefined;
+            photo_url?: string | null | undefined;
+        } | {
+            type: "wallet";
+            address: string;
+            chain_id: "eip155:1";
+            verified_at: number;
+            first_verified_at: number | null;
+            latest_verified_at: number | null;
+            chain_type: "ethereum";
+            wallet_client: "privy";
+            wallet_client_type: "privy";
+            connector_type: "embedded";
+            imported: boolean;
+            wallet_index: number;
+            recovery_method: "user-passcode" | "google-drive" | "icloud" | "privy";
+        } | {
+            type: "wallet";
+            address: string;
+            public_key: string;
+            chain_id: "solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp";
+            verified_at: number;
+            first_verified_at: number | null;
+            latest_verified_at: number | null;
+            chain_type: "solana";
+            wallet_client_type: "privy";
+            connector_type: "embedded";
+            imported: boolean;
+            recovery_method: "privy";
+        } | {
+            type: "google_oauth";
+            name: string | null;
+            email: string;
+            verified_at: number;
+            first_verified_at: number | null;
+            latest_verified_at: number | null;
+            subject: string;
+        } | {
+            type: "twitter_oauth";
+            name: string | null;
+            username: string | null;
+            verified_at: number;
+            first_verified_at: number | null;
+            latest_verified_at: number | null;
+            profile_picture_url: string | null;
+            subject: string;
+        } | {
+            type: "discord_oauth";
+            email: string | null;
+            username: string | null;
+            verified_at: number;
+            first_verified_at: number | null;
+            latest_verified_at: number | null;
+            subject: string;
+        } | {
+            type: "github_oauth";
+            name: string | null;
+            email: string | null;
+            username: string | null;
+            verified_at: number;
+            first_verified_at: number | null;
+            latest_verified_at: number | null;
+            subject: string;
+        } | {
+            type: "linkedin_oauth";
+            email: string | null;
+            verified_at: number;
+            first_verified_at: number | null;
+            latest_verified_at: number | null;
+            subject: string;
+            name?: string | undefined;
+            vanity_name?: string | undefined;
+        } | {
+            type: "spotify_oauth";
+            name: string | null;
+            email: string | null;
+            verified_at: number;
+            first_verified_at: number | null;
+            latest_verified_at: number | null;
+            subject: string;
+        } | {
+            type: "instagram_oauth";
+            username: string | null;
+            verified_at: number;
+            first_verified_at: number | null;
+            latest_verified_at: number | null;
+            subject: string;
+        } | {
+            type: "tiktok_oauth";
+            name: string | null;
+            username: string | null;
+            verified_at: number;
+            first_verified_at: number | null;
+            latest_verified_at: number | null;
+            subject: string;
+        } | {
+            type: "apple_oauth";
+            email: string | null;
+            verified_at: number;
+            first_verified_at: number | null;
+            latest_verified_at: number | null;
+            subject: string;
+        } | {
+            type: "custom_auth";
+            verified_at: number;
+            first_verified_at: number | null;
+            latest_verified_at: number | null;
+            custom_user_id: string;
+        } | {
+            type: "cross_app";
+            provider_app_id: string;
+            verified_at: number;
+            first_verified_at: number | null;
+            latest_verified_at: number | null;
+            subject: string;
+            embedded_wallets: {
+                address: string;
+            }[];
+            smart_wallets: {
+                address: string;
+            }[];
+        })[];
+        created_at: number;
+        has_accepted_terms: boolean;
+        is_guest: boolean;
+        custom_metadata?: Record<string, string> | undefined;
+    }>;
+    unlink(email: string): Promise<{
+        id: string;
+        mfa_methods: ({
+            type: "sms";
+            verified_at: number;
+        } | {
+            type: "totp";
+            verified_at: number;
+        } | {
+            type: "passkey";
+            verified_at: number;
+        })[];
+        linked_accounts: ({
+            type: "email";
+            address: string;
+            verified_at: number;
+            first_verified_at: number | null;
+            latest_verified_at: number | null;
+        } | {
+            type: "phone";
+            verified_at: number;
+            first_verified_at: number | null;
+            latest_verified_at: number | null;
+            phoneNumber: string;
+        } | {
+            type: "wallet";
+            address: string;
+            verified_at: number;
+            first_verified_at: number | null;
+            latest_verified_at: number | null;
+            chain_type: "ethereum";
+            wallet_client: "unknown";
+            chain_id?: string | undefined;
+            wallet_client_type?: string | undefined;
+            connector_type?: string | undefined;
+        } | {
+            type: "smart_wallet";
+            address: string;
+            smart_wallet_type: "safe" | "kernel" | "biconomy" | "light_account";
+            verified_at: number;
+            first_verified_at: number | null;
+            latest_verified_at: number | null;
+        } | {
+            type: "wallet";
+            address: string;
+            verified_at: number;
+            first_verified_at: number | null;
+            latest_verified_at: number | null;
+            chain_type: "solana";
+            wallet_client: "unknown";
+            wallet_client_type?: string | undefined;
+            connector_type?: string | undefined;
+        } | {
+            type: "farcaster";
+            fid: number;
+            verified_at: number;
+            first_verified_at: number | null;
+            latest_verified_at: number | null;
+            owner_address: string;
+            username?: string | undefined;
+            display_name?: string | undefined;
+            bio?: string | undefined;
+            profile_picture?: string | undefined;
+            profile_picture_url?: string | undefined;
+            homepage_url?: string | undefined;
+            signer_public_key?: string | undefined;
+        } | {
+            type: "passkey";
+            verified_at: number;
+            first_verified_at: number | null;
+            latest_verified_at: number | null;
+            credential_id: string;
+            enrolled_in_mfa: boolean;
+            created_with_browser?: string | undefined;
+            created_with_os?: string | undefined;
+            created_with_device?: string | undefined;
+            authenticator_name?: string | undefined;
+        } | {
+            telegramUserId: string;
+            firstName: string | null | undefined;
+            type: "telegram";
+            verified_at: number;
+            first_verified_at: number | null;
+            latest_verified_at: number | null;
+            telegram_user_id: string;
+            username?: string | null | undefined;
+            first_name?: string | null | undefined;
+            last_name?: string | null | undefined;
+            photo_url?: string | null | undefined;
+        } | {
+            type: "wallet";
+            address: string;
+            chain_id: "eip155:1";
+            verified_at: number;
+            first_verified_at: number | null;
+            latest_verified_at: number | null;
+            chain_type: "ethereum";
+            wallet_client: "privy";
+            wallet_client_type: "privy";
+            connector_type: "embedded";
+            imported: boolean;
+            wallet_index: number;
+            recovery_method: "user-passcode" | "google-drive" | "icloud" | "privy";
+        } | {
+            type: "wallet";
+            address: string;
+            public_key: string;
+            chain_id: "solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp";
+            verified_at: number;
+            first_verified_at: number | null;
+            latest_verified_at: number | null;
+            chain_type: "solana";
+            wallet_client_type: "privy";
+            connector_type: "embedded";
+            imported: boolean;
+            recovery_method: "privy";
+        } | {
+            type: "google_oauth";
+            name: string | null;
+            email: string;
+            verified_at: number;
+            first_verified_at: number | null;
+            latest_verified_at: number | null;
+            subject: string;
+        } | {
+            type: "twitter_oauth";
+            name: string | null;
+            username: string | null;
+            verified_at: number;
+            first_verified_at: number | null;
+            latest_verified_at: number | null;
+            profile_picture_url: string | null;
+            subject: string;
+        } | {
+            type: "discord_oauth";
+            email: string | null;
+            username: string | null;
+            verified_at: number;
+            first_verified_at: number | null;
+            latest_verified_at: number | null;
+            subject: string;
+        } | {
+            type: "github_oauth";
+            name: string | null;
+            email: string | null;
+            username: string | null;
+            verified_at: number;
+            first_verified_at: number | null;
+            latest_verified_at: number | null;
+            subject: string;
+        } | {
+            type: "linkedin_oauth";
+            email: string | null;
+            verified_at: number;
+            first_verified_at: number | null;
+            latest_verified_at: number | null;
+            subject: string;
+            name?: string | undefined;
+            vanity_name?: string | undefined;
+        } | {
+            type: "spotify_oauth";
+            name: string | null;
+            email: string | null;
+            verified_at: number;
+            first_verified_at: number | null;
+            latest_verified_at: number | null;
+            subject: string;
+        } | {
+            type: "instagram_oauth";
+            username: string | null;
+            verified_at: number;
+            first_verified_at: number | null;
+            latest_verified_at: number | null;
+            subject: string;
+        } | {
+            type: "tiktok_oauth";
+            name: string | null;
+            username: string | null;
+            verified_at: number;
+            first_verified_at: number | null;
+            latest_verified_at: number | null;
+            subject: string;
+        } | {
+            type: "apple_oauth";
+            email: string | null;
+            verified_at: number;
+            first_verified_at: number | null;
+            latest_verified_at: number | null;
+            subject: string;
+        } | {
+            type: "custom_auth";
+            verified_at: number;
+            first_verified_at: number | null;
+            latest_verified_at: number | null;
+            custom_user_id: string;
+        } | {
+            type: "cross_app";
+            provider_app_id: string;
+            verified_at: number;
+            first_verified_at: number | null;
+            latest_verified_at: number | null;
+            subject: string;
+            embedded_wallets: {
+                address: string;
+            }[];
+            smart_wallets: {
+                address: string;
+            }[];
+        })[];
+        created_at: number;
+        has_accepted_terms: boolean;
+        is_guest: boolean;
+        custom_metadata?: Record<string, string> | undefined;
+    }>;
+}

package/dist/dts/EmbeddedWalletApi.d.mts

@@ -0,0 +1,103 @@
+import type { PrivyEthereumEmbeddedWalletAccount, PrivySolanaEmbeddedWalletAccount, PrivyUser } from '@privy-io/public-api/schemas';
+import { EmbeddedSolanaWalletProvider, EmbeddedWalletProvider } from './embedded';
+import type { IEmbeddedWalletRecoveryOptions, PrivyResponseEvent, SetRecoveryInput } from './embedded/types';
+/** Options for creating the Solana embedded wallet */
+type CreateSolanaOpts = {
+    /**
+     * The user's existing Ethereum embedded wallet if they have one. This parameter
+     * MUST be set if the user has an Ethereum embedded wallet, otherwise Solana creation
+     * will fail in the iframe.
+     */
+    ethereumAccount?: PrivyEthereumEmbeddedWalletAccount;
+};
+export default class EmbeddedWalletApi {
+    /**
+     * Creates an embedded wallet
+     *
+     * @param password Recovery password for the embedded wallet
+     * @returns EmbeddedWalletProvider implementing EIP1193Provider
+     */
+    create(password?: string, recoveryMethod?: IEmbeddedWalletRecoveryOptions, recoveryToken?: string, recoverySecretOverride?: string, iCloudRecordNameOverride?: string): Promise<{
+        user: PrivyUser;
+        provider: EmbeddedWalletProvider;
+    }>;
+    /**
+     * Creates an embedded Solana wallet
+     *
+     * @param opts.ethereumAccount {PrivyEthereumEmbeddedWalletAccount} the user's existing embedded wallet account if they have one. This parameter
+     * MUST be passed if the user has an existing Ethereum embedded wallet otherwise Solana wallet creation will fail.
+     * @returns EmbeddedWalletProvider implementing Phantom Provider
+     */
+    createSolana(opts?: CreateSolanaOpts): Promise<EmbeddedSolanaWalletProvider>;
+    hasEmbeddedWallet(): Promise<boolean>;
+    isPasswordRequired(): Promise<boolean>;
+    /**
+     * Retrieve this users embedded wallet.
+     * If the wallet has never been used on this device recover.
+     *
+     * @param password Recovery password for the embedded wallet
+     * @returns EmbeddedWalletProvider implementing EIP1193Provider
+     */
+    getProvider(wallet: PrivyEthereumEmbeddedWalletAccount, password?: string, recoveryToken?: string, recoverySecretOverride?: string): Promise<EmbeddedWalletProvider>;
+    /**
+     * Retrieve this users embedded Solana wallet.
+     * If the wallet has never been used on this device recover.
+     *
+     * @returns EmbeddedSolanaWalletProvider
+     */
+    getSolanaProvider(wallet: PrivySolanaEmbeddedWalletAccount): Promise<EmbeddedSolanaWalletProvider>;
+    /**
+     * @deprecated Use `setRecovery` instead.
+     *
+     * Add or change the password used to recover an embedded wallet.
+     *
+     * @param password New recovery password
+     * @param currentPassword Current recovery password used to recover the embedded wallet
+     * @returns EmbeddedWalletProvider implementing EIP1193Provider
+     */
+    setPassword(wallet: PrivyEthereumEmbeddedWalletAccount, password: string): Promise<EmbeddedWalletProvider>;
+    /**
+     * Add or change the recovery method used to recover an embedded wallet.
+     *
+     * @param password New recovery password
+     * @param currentPassword Current recovery password used to recover the embedded wallet
+     * @returns EmbeddedWalletProvider implementing EIP1193Provider
+     */
+    setRecovery({ wallet, ...recoveryArgs }: SetRecoveryInput): Promise<{
+        user: PrivyUser;
+        provider: EmbeddedWalletProvider;
+    }>;
+    /**
+     * @returns URL to load in the embedded wallet iframe
+     */
+    getURL(): string;
+    /**
+     * @deprecated Use `onMessage` instead
+     *
+     * @returns Allows the user to subscribe
+     * to the response events from the embedded wallet iframe
+     *
+     * @example
+     * const handler = privy.wallet.getMessageHandler()
+     * window.addEventListener('message', handler)
+     */
+    getMessageHandler(): (event: PrivyResponseEvent) => void;
+    /**
+     * Handles messages from the embedded wallet secure contexts
+     *
+     * @example
+     * const onMessage = async (e: WebViewMessageEvent) => {
+     *   const {data} = e.nativeEvent;
+     *   client.embeddedWallet.onMessage(JSON.parse(data));
+     * }
+     */
+    onMessage(event: PrivyResponseEvent): void;
+    /**
+     * Retrieve this users embedded Solana wallet.
+     * If the wallet has never been used on this device recover.
+     *
+     * @returns EmbeddedSolanaWalletProvider
+     */
+    _loadSolana(wallet: PrivySolanaEmbeddedWalletAccount): Promise<string>;
+}
+export {};

package/dist/dts/Error.d.mts

@@ -0,0 +1,20 @@
+import type { PrivyErrorCode } from '@privy-io/api-base';
+type AuthAction = 'login' | 'link';
+type Method = 'email' | 'sms' | 'oauth' | 'siwe' | 'passkey' | 'farcaster';
+export type ClientErrorCode = `failed_to_complete_${AuthAction}_with_oauth` | `${AuthAction}_with_oauth_returned_with_invalid_credentials` | `${AuthAction}_with_oauth_was_cancelled_by_user` | 'attempted_rpc_call_before_logged_in' | 'attempted_submit_otp_before_sending' | 'attempted_to_set_password_before_connected' | 'attempted_to_set_password_but_password_already_set' | `attempted_login_with_${Method}_while_already_logged_in` | `attempted_link_${Method}_before_logged_in` | `attempted_unlink_siwe_before_logged_in` | 'embedded_wallet_needs_recovery' | 'embedded_wallet_creation_error' | 'embedded_wallet_recovery_error' | 'embedded_wallet_set_password_error' | 'embedded_wallet_set_recovery_error' | 'unknown_embedded_wallet_error' | 'embedded_wallet_does_not_exist' | 'embedded_wallet_already_exists' | 'embedded_wallet_webview_not_loaded' | 'embedded_wallet_request_error' | 'no_passkey_found_for_challenge' | 'pkce_state_code_mismatch' | 'failed_to_create_passkey' | 'failed_to_generate_farcaster_uri' | 'failed_to_generate_farcaster_channel_token' | 'farcaster_polling_timeout' | 'farcaster_polling_canceled' | 'unsupported_recovery_method' | 'attempted_to_create_guest_account_for_logged_in_user' | 'third_party_auth_error';
+export type ErrorBody<T extends PrivyErrorCode | ClientErrorCode> = {
+    error: string;
+    code: T;
+};
+export type ServerErrorBody = ErrorBody<PrivyErrorCode>;
+export declare class PrivyApiError extends Error {
+    error: string;
+    code: PrivyErrorCode;
+    constructor({ error, code }: ServerErrorBody);
+}
+export declare class PrivyClientError extends Error {
+    error: string;
+    code: ClientErrorCode;
+    constructor({ error, code }: ErrorBody<ClientErrorCode>);
+}
+export {};