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

package/dist/dts/FarcasterApi.d.mts

@@ -0,0 +1,467 @@
+export default class FarcasterApi {
+    /**
+     * Begin a login / link flow with a farcaster.
+     */
+    initializeAuth({ relyingParty, redirectUrl, token, }: {
+        relyingParty?: string;
+        redirectUrl?: string;
+        token?: string;
+    }): Promise<import("@privy-io/public-api").PrivyFarcasterConnectInitResponse>;
+    /**
+     * Get the status of a user's SIWF request.
+     */
+    getFarcasterStatus({ channel_token }: {
+        channel_token: string;
+    }): Promise<NonNullable<import("@privy-io/public-api").PrivyFarcasterConnectStatusCompletedResponse | import("@privy-io/public-api").PrivyFarcasterConnectStatusPendingResponse | undefined>>;
+    /**
+     * Authenticate with Privy via the Sign-In With Farcaster spec [FIP-11: Sign in with Farcaster](https://github.com/farcasterxyz/protocol/discussions/110).
+     */
+    authenticate({ channel_token, message, signature, fid, mode, }: {
+        channel_token: string;
+        message: string;
+        signature: string;
+        fid: number;
+        mode?: 'login-or-sign-up' | 'no-signup';
+    }): Promise<import("@privy-io/public-api").PrivyAuthenticatedUser>;
+    /**
+     * Link with Privy via the Sign-In With Farcaster spec [FIP-11: Sign in with Farcaster](https://github.com/farcasterxyz/protocol/discussions/110).
+     */
+    link({ channel_token, message, signature, fid, }: {
+        channel_token: string;
+        message: string;
+        signature: string;
+        fid: number;
+    }): 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 with Privy via the Sign-In With Farcaster spec.
+     */
+    unlink({ fid }: {
+        fid: number;
+    }): 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/GuestApi.d.mts

@@ -0,0 +1,9 @@
+export default class GuestApi {
+    /**
+     * 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
+     */
+    create(): Promise<import("@privy-io/public-api").PrivyAuthenticatedUser>;
+}