@privy-io/js-sdk-core 0.24.4 → 0.25.1-beta-20240731190849

package/dist/dts/PhoneApi.d.ts

@@ -19,6 +19,392 @@ export default class PhoneApi {
      * @param phoneNumber The phone number that the one time code was sent to
      * @param code The one time code
      */
-    linkWithCode(phoneNumber: string, code: string): Promise<import("@privy-io/public-api").PrivyUser>;
-    unlink(phoneNumber: string): Promise<import("@privy-io/public-api").PrivyUser>;
+    linkWithCode(phoneNumber: 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";
+            phoneNumber: string;
+            verified_at: number;
+            first_verified_at: number | null;
+            latest_verified_at: number | null;
+        } | {
+            type: "wallet";
+            address: string;
+            chain_type: "ethereum";
+            verified_at: number;
+            first_verified_at: number | null;
+            latest_verified_at: number | null;
+            wallet_client: "unknown";
+            chain_id?: string | undefined;
+            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";
+            credential_id: string;
+            verified_at: number;
+            first_verified_at: number | null;
+            latest_verified_at: number | null;
+            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_type: "ethereum";
+            verified_at: number;
+            first_verified_at: number | null;
+            latest_verified_at: number | null;
+            chain_id: "eip155:1";
+            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_type: "solana";
+            verified_at: number;
+            first_verified_at: number | null;
+            latest_verified_at: number | null;
+            wallet_client_type: "privy";
+            connector_type: "embedded";
+            imported: boolean;
+            recovery_method: "privy";
+        } | {
+            type: "google_oauth";
+            name: string | null;
+            email: string;
+            subject: string;
+            verified_at: number;
+            first_verified_at: number | null;
+            latest_verified_at: number | null;
+        } | {
+            type: "twitter_oauth";
+            name: string | null;
+            username: string | null;
+            subject: string;
+            verified_at: number;
+            first_verified_at: number | null;
+            latest_verified_at: number | null;
+            profile_picture_url: string | null;
+        } | {
+            type: "discord_oauth";
+            email: string | null;
+            username: string | null;
+            subject: string;
+            verified_at: number;
+            first_verified_at: number | null;
+            latest_verified_at: number | null;
+        } | {
+            type: "github_oauth";
+            name: string | null;
+            email: string | null;
+            username: string | null;
+            subject: string;
+            verified_at: number;
+            first_verified_at: number | null;
+            latest_verified_at: number | null;
+        } | {
+            type: "linkedin_oauth";
+            email: string | null;
+            subject: string;
+            verified_at: number;
+            first_verified_at: number | null;
+            latest_verified_at: number | null;
+            name?: string | undefined;
+            vanity_name?: string | undefined;
+        } | {
+            type: "spotify_oauth";
+            name: string | null;
+            email: string | null;
+            subject: string;
+            verified_at: number;
+            first_verified_at: number | null;
+            latest_verified_at: number | null;
+        } | {
+            type: "instagram_oauth";
+            username: string | null;
+            subject: string;
+            verified_at: number;
+            first_verified_at: number | null;
+            latest_verified_at: number | null;
+        } | {
+            type: "tiktok_oauth";
+            name: string | null;
+            username: string | null;
+            subject: string;
+            verified_at: number;
+            first_verified_at: number | null;
+            latest_verified_at: number | null;
+        } | {
+            type: "apple_oauth";
+            email: string | null;
+            subject: string;
+            verified_at: number;
+            first_verified_at: number | null;
+            latest_verified_at: number | null;
+        } | {
+            type: "custom_auth";
+            verified_at: number;
+            first_verified_at: number | null;
+            latest_verified_at: number | null;
+            custom_user_id: string;
+        } | {
+            type: "cross_app";
+            subject: string;
+            verified_at: number;
+            first_verified_at: number | null;
+            latest_verified_at: number | null;
+            provider_app_id: string;
+            embedded_wallets: {
+                address: string;
+            }[];
+            smart_wallets: {
+                address: string;
+            }[];
+        })[];
+        created_at: number;
+        has_accepted_terms: boolean;
+    }>;
+    unlink(phoneNumber: 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";
+            phoneNumber: string;
+            verified_at: number;
+            first_verified_at: number | null;
+            latest_verified_at: number | null;
+        } | {
+            type: "wallet";
+            address: string;
+            chain_type: "ethereum";
+            verified_at: number;
+            first_verified_at: number | null;
+            latest_verified_at: number | null;
+            wallet_client: "unknown";
+            chain_id?: string | undefined;
+            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";
+            credential_id: string;
+            verified_at: number;
+            first_verified_at: number | null;
+            latest_verified_at: number | null;
+            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_type: "ethereum";
+            verified_at: number;
+            first_verified_at: number | null;
+            latest_verified_at: number | null;
+            chain_id: "eip155:1";
+            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_type: "solana";
+            verified_at: number;
+            first_verified_at: number | null;
+            latest_verified_at: number | null;
+            wallet_client_type: "privy";
+            connector_type: "embedded";
+            imported: boolean;
+            recovery_method: "privy";
+        } | {
+            type: "google_oauth";
+            name: string | null;
+            email: string;
+            subject: string;
+            verified_at: number;
+            first_verified_at: number | null;
+            latest_verified_at: number | null;
+        } | {
+            type: "twitter_oauth";
+            name: string | null;
+            username: string | null;
+            subject: string;
+            verified_at: number;
+            first_verified_at: number | null;
+            latest_verified_at: number | null;
+            profile_picture_url: string | null;
+        } | {
+            type: "discord_oauth";
+            email: string | null;
+            username: string | null;
+            subject: string;
+            verified_at: number;
+            first_verified_at: number | null;
+            latest_verified_at: number | null;
+        } | {
+            type: "github_oauth";
+            name: string | null;
+            email: string | null;
+            username: string | null;
+            subject: string;
+            verified_at: number;
+            first_verified_at: number | null;
+            latest_verified_at: number | null;
+        } | {
+            type: "linkedin_oauth";
+            email: string | null;
+            subject: string;
+            verified_at: number;
+            first_verified_at: number | null;
+            latest_verified_at: number | null;
+            name?: string | undefined;
+            vanity_name?: string | undefined;
+        } | {
+            type: "spotify_oauth";
+            name: string | null;
+            email: string | null;
+            subject: string;
+            verified_at: number;
+            first_verified_at: number | null;
+            latest_verified_at: number | null;
+        } | {
+            type: "instagram_oauth";
+            username: string | null;
+            subject: string;
+            verified_at: number;
+            first_verified_at: number | null;
+            latest_verified_at: number | null;
+        } | {
+            type: "tiktok_oauth";
+            name: string | null;
+            username: string | null;
+            subject: string;
+            verified_at: number;
+            first_verified_at: number | null;
+            latest_verified_at: number | null;
+        } | {
+            type: "apple_oauth";
+            email: string | null;
+            subject: string;
+            verified_at: number;
+            first_verified_at: number | null;
+            latest_verified_at: number | null;
+        } | {
+            type: "custom_auth";
+            verified_at: number;
+            first_verified_at: number | null;
+            latest_verified_at: number | null;
+            custom_user_id: string;
+        } | {
+            type: "cross_app";
+            subject: string;
+            verified_at: number;
+            first_verified_at: number | null;
+            latest_verified_at: number | null;
+            provider_app_id: string;
+            embedded_wallets: {
+                address: string;
+            }[];
+            smart_wallets: {
+                address: string;
+            }[];
+        })[];
+        created_at: number;
+        has_accepted_terms: boolean;
+    }>;
 }

package/dist/dts/Privy.d.ts

@@ -74,4 +74,5 @@ export default class Privy {
     constructor({ clientId, ...o }: PrivyOptions);
     setMessagePoster(poster: EmbeddedWalletMessagePoster): void;
     getAccessToken(): Promise<string | null>;
+    getIdentityToken(): Promise<string | null>;
 }

package/dist/dts/RecoveryApi.d.ts

@@ -9,4 +9,11 @@ export default class RecoveryApi {
      * APIs for recovery auth with iCloud
      */
     readonly icloudAuth: RecoveryICloudApi;
+    /**
+     * Pulls the recovery material
+     *
+     * @param address The embedded wallet's address
+     * @param chain_type The chain_type to fetch the recovery material for
+     */
+    getRecoveryKeyMaterial(address: string, chain_type?: string): Promise<import("@privy-io/public-api").PrivyRecoveryKeyMaterialResponse>;
 }

package/dist/dts/RecoveryICloudApi.d.ts

@@ -6,4 +6,10 @@ export default class RecoveryICloudApi {
      * @param redirectURI The URL to redirect to after a successful OAuth flow
      */
     init(client_type: 'web' | 'expo-ios'): Promise<import("@privy-io/public-api").PrivyOAuthInitResponse>;
+    /**
+     * Pulls the iCloud configuration for recovery
+     *
+     * @param client_type The querying client (web | expo-ios)
+     */
+    getICloudConfiguration(client_type: 'web' | 'expo-ios'): Promise<import("@privy-io/public-api").PrivyRecoveryConfigurationICloudResponse>;
 }

package/dist/dts/Session.d.ts

@@ -4,7 +4,7 @@ type Opts = {
     storage: Storage;
     isUsingServerCookies: boolean;
 };
-type SessionClearedReason = 'unknown' | 'logout' | 'set_with_non_string_value' | 'getToken_error' | 'getRefreshToken_error' | 'getForkedToken_error' | 'session_update_action: clear' | 'missing_or_invalid_token';
+type SessionClearedReason = 'unknown' | 'logout' | 'set_with_non_string_value' | 'getToken_error' | 'getRefreshToken_error' | 'getIdentityToken_error' | 'getForkedToken_error' | 'session_update_action: clear' | 'missing_or_invalid_token';
 type SessionOpts = {
     cookiesEnabled: boolean;
 };
@@ -15,20 +15,23 @@ type SessionEvent = {
     storage_cleared: [SessionValueClearedOpts];
     token_cleared: [SessionValueClearedOpts];
     refresh_token_cleared: [SessionValueClearedOpts];
+    identity_token_cleared: [SessionValueClearedOpts];
     forked_token_cleared: [SessionValueClearedOpts];
     token_stored: [SessionOpts];
     refresh_token_stored: [SessionOpts];
+    identity_token_stored: [SessionOpts];
 };
 /**
  * `Session` represents the session lifecycle of the login. It manages token
  * storage, refresh, and deletion.
  */
 export declare class Session extends EventEmitter<SessionEvent> {
-    static events: readonly ["storage_cleared", "token_cleared", "refresh_token_cleared", "forked_token_cleared", "token_stored", "refresh_token_stored"];
+    static events: readonly ["storage_cleared", "token_cleared", "refresh_token_cleared", "identity_token_cleared", "forked_token_cleared", "token_stored", "refresh_token_stored", "identity_token_stored"];
     constructor(o: Opts);
     set isUsingServerCookies(isUsingServerCookies: boolean);
     getToken(): Promise<string | null>;
     getRefreshToken(): Promise<string | null>;
+    getIdentityToken(): Promise<string | null>;
     getForkedToken(): Promise<string | null>;
     get mightHaveServerCookies(): boolean;
     /**
@@ -59,9 +62,10 @@ export declare class Session extends EventEmitter<SessionEvent> {
      */
     destroyLocalState(opts?: {
         reason: SessionClearedReason;
-    }): Promise<[void, void, void]>;
+    }): Promise<[void, void, void, void]>;
     storeToken(token: string | null): Promise<void>;
     storeRefreshToken(refreshToken: string | null): Promise<void>;
+    storeIdentityToken(token: string | null | undefined): Promise<void>;
     private clearForkedToken;
 }
 export {};

package/dist/dts/UserApi.d.ts

@@ -30,10 +30,10 @@ export default class UserApi {
             } | {
                 type: "wallet";
                 address: string;
+                chain_type: "ethereum";
                 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;
@@ -78,11 +78,11 @@ export default class UserApi {
             } | {
                 type: "wallet";
                 address: string;
+                chain_type: "ethereum";
                 verified_at: number;
                 first_verified_at: number | null;
                 latest_verified_at: number | null;
                 chain_id: "eip155:1";
-                chain_type: "ethereum";
                 wallet_client: "privy";
                 wallet_client_type: "privy";
                 connector_type: "embedded";
@@ -93,10 +93,10 @@ export default class UserApi {
                 type: "wallet";
                 address: string;
                 public_key: string;
+                chain_type: "solana";
                 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;

package/dist/dts/embedded/types.d.ts

@@ -143,8 +143,9 @@ export interface SolanaRpcResponseType {
     };
 }
 export type PrivyEventType = 'privy:iframe:ready' | 'privy:wallet:create' | 'privy:wallet:connect' | 'privy:wallet:recover' | 'privy:wallet:rpc' | 'privy:wallet:set-recovery' | 'privy:solana-wallet:create' | 'privy:solana-wallet:connect' | 'privy:solana-wallet:recover' | 'privy:solana-wallet:rpc';
+export type IEmbeddedWalletRecoveryOptions = 'privy' | 'user-passcode' | 'google-drive' | 'icloud' | 'icloud-native';
+export type IUserRecoveryMethod = 'user-passcode' | 'google-drive' | 'icloud' | 'icloud-native';
 export type EmbeddedWalletRecoveryOptions = 'privy' | 'user-passcode' | 'google-drive' | 'icloud';
-export type UserRecoveryMethod = Omit<EmbeddedWalletRecoveryOptions, 'privy'>;
 export type PasswordRecoveryInput = {
     recoveryMethod: 'user-passcode';
     password: string;
@@ -153,15 +154,22 @@ export type CloudRecoveryInput = {
     recoveryMethod: 'google-drive' | 'icloud';
     recoveryAccessToken: string;
 };
+export type ICloudNativeRecoveryInput = {
+    recoveryMethod: 'icloud-native';
+    recoverySecretOverride: string;
+    iCloudRecordNameOverride: string;
+};
 export type SetRecoveryInput = {
     wallet: PrivyEthereumEmbeddedWalletAccount;
-} & (PasswordRecoveryInput | CloudRecoveryInput);
+} & (PasswordRecoveryInput | CloudRecoveryInput | ICloudNativeRecoveryInput);
 export type IframeReadyRequestDataType = Record<string, never>;
 export type WalletCreateRequestDataType = {
     accessToken: string;
     recoveryPassword?: string;
-    recoveryMethod?: EmbeddedWalletRecoveryOptions;
+    recoveryMethod?: IEmbeddedWalletRecoveryOptions;
     recoveryAccessToken?: string;
+    recoverySecretOverride?: string;
+    iCloudRecordNameOverride?: string;
 };
 export type WalletConnectRequestDataType = {
     accessToken: string;
@@ -173,13 +181,16 @@ export type WalletRecoverRequestDataType = {
     recoveryPassword?: string;
     recoveryMethod?: string;
     recoveryAccessToken?: string;
+    recoverySecretOverride?: string;
 };
 export type WalletSetRecoveryRequestDataType = {
     accessToken: string;
     address: string;
-    recoveryMethod: UserRecoveryMethod;
+    recoveryMethod: IUserRecoveryMethod;
     recoveryPassword?: string;
     recoveryAccessToken?: string;
+    recoverySecretOverride?: string;
+    iCloudRecordNameOverride?: string;
 };
 export type WalletRpcRequestDataType = {
     accessToken: string;

package/dist/dts/embedded/utils/index.d.ts

@@ -1,6 +1,6 @@
 import { StaticJsonRpcProvider } from '@ethersproject/providers';
 import type { Chain, RpcConfig } from '../../chains';
-import type { EmbeddedWalletRecoveryOptions, PreparedTransactionRequest, UnsignedTransactionRequest, UnsignedTransactionRequestWithChainId, UserRecoveryMethod } from '../types';
+import type { EmbeddedWalletRecoveryOptions, PreparedTransactionRequest, UnsignedTransactionRequest, UnsignedTransactionRequestWithChainId, IUserRecoveryMethod } from '../types';
 /**
  * Build a JSON RPC provider for a given chainId if it is one of our
  * supported chains.
@@ -32,5 +32,5 @@ export declare function populateTransactionRequest(address: string, txRequest: U
  */
 export declare function throwIfInvalidRecoveryUpgradePath({ currentRecoveryMethod, upgradeToRecoveryMethod, }: {
     currentRecoveryMethod: EmbeddedWalletRecoveryOptions;
-    upgradeToRecoveryMethod: UserRecoveryMethod;
+    upgradeToRecoveryMethod: IUserRecoveryMethod;
 }): boolean;

package/dist/embedded/types.js.map

@@ -1 +1 @@
-{"version":3,"file":"types.js","sources":["../../src/embedded/types.ts"],"sourcesContent":[null],"names":["SUPPORTED_JSON_RPC_METHODS","isSupportedRpcMethod","method","includes","SUPPORTED_SOLANA_RPC_METHODS","isSupportedSolanaRpcMethod","PrivyIframeErrorTypes"],"mappings":"AAca,MAAAA,EAA6B,CACxC,WACA,iCACA,sBACA,gBACA,wBAIWC,EAAwBC,GAC5BF,EAA2BG,SAASD,GAgLvCE,EAA+B,CAAC,eAGzBC,EAA8BH,GAClCE,EAA6BD,SAASD,GAqIlCI,EAAwB,CACnC,QACA,4BACA,uBACA,uBACA"}
+{"version":3,"file":"types.js","sources":["../../src/embedded/types.ts"],"sourcesContent":[null],"names":["SUPPORTED_JSON_RPC_METHODS","isSupportedRpcMethod","method","includes","SUPPORTED_SOLANA_RPC_METHODS","isSupportedSolanaRpcMethod","PrivyIframeErrorTypes"],"mappings":"AAca,MAAAA,EAA6B,CACxC,WACA,iCACA,sBACA,gBACA,wBAIWC,EAAwBC,GAC5BF,EAA2BG,SAASD,GAgLvCE,EAA+B,CAAC,eAGzBC,EAA8BH,GAClCE,EAA6BD,SAASD,GAwJlCI,EAAwB,CACnC,QACA,4BACA,uBACA,uBACA"}