@privy-io/react-auth 1.6.0-beta.1 → 1.6.0-beta.11

package/dist/index.d.ts

@@ -7,7 +7,7 @@ declare type WalletType = typeof SUPPORTED_WALLET_TYPES[number];
 /** @ignore */
 interface LinkMetadata {
     /** Account type, most commonly useful when filtering through linkedAccounts */
-    type: 'wallet' | 'email' | 'google_oauth' | 'twitter_oauth' | 'discord_oauth';
+    type: 'wallet' | 'email' | 'phone' | 'google_oauth' | 'twitter_oauth' | 'discord_oauth';
     /** Datetime when this account was linked to the user. */
     verifiedAt: Date;
 }
@@ -42,6 +42,11 @@ interface Email {
     /** The email address. */
     address: string;
 }
+/** Object representation of a user's phone number. */
+interface Phone {
+    /** The phone number. */
+    number: string;
+}
 /** Object representation of a user's Google account. */
 interface Google {
     /** The `sub` claim from the Google-issued JWT for this account. */
@@ -74,6 +79,11 @@ interface EmailWithMetadata extends LinkMetadata, Email {
     /** Denotes that this is an email account. */
     type: 'email';
 }
+/** Object representation of a user's phone number, with additional metadata for advanced use cases. */
+interface PhoneWithMetadata extends LinkMetadata, Phone {
+    /** Denotes that this is a phone account. */
+    type: 'phone';
+}
 /** Object representation of a user's wallet, with additional metadata for advanced use cases. */
 interface WalletWithMetadata extends LinkMetadata, Wallet {
     /** Denotes that this is a wallet account. */
@@ -102,6 +112,8 @@ interface User {
     createdAt: Date;
     /** The user's email address, if they have linked one. It cannot be linked to another user. */
     email?: Email;
+    /** The user's phone number, if they have linked one. It cannot be linked to another user. */
+    phone?: Phone;
     /** The user's wallet address, if they have linked one. It cannot be linked to another user. */
     wallet?: Wallet;
     /** The user's Google account, if they have linked one. It cannot be linked to another user. */
@@ -112,7 +124,7 @@ interface User {
     discord?: Discord;
     /** The list of accounts associated with this user. Each account contains additional metadata
      * that may be helpful for advanced use cases. */
-    linkedAccounts: Array<WalletWithMetadata | EmailWithMetadata | GoogleOAuthWithMetadata | TwitterOAuthWithMetadata | DiscordOAuthWithMetadata>;
+    linkedAccounts: Array<WalletWithMetadata | EmailWithMetadata | PhoneWithMetadata | GoogleOAuthWithMetadata | TwitterOAuthWithMetadata | DiscordOAuthWithMetadata>;
 }
 
 /**
@@ -189,22 +201,32 @@ interface PrivyInterface {
     login: () => void;
     /**
      * For users who are authenticated, opens the Privy modal and prompts the user to link an email.
+     * This will open the Privy Modal which will guide the user through this action.
      */
     linkEmail: () => void;
+    /**
+     * For users who are authenticated, opens the Privy modal and prompts the user to link a phone number.
+     * This will open the Privy Modal which will guide the user through this action.
+     */
+    linkPhone: () => void;
     /**
      * For users who are authenticated, opens the Privy modal and prompts the user to link a wallet.
+     * This will open the Privy Modal which will guide the user through this action.
      */
     linkWallet: () => void;
     /**
-     * For users who are authenticated, opens the Privy modal and prompts the user to link google OAuth account
+     * For users who are authenticated, prompts the user to link a Google OAuth account.
+     * This will directly initiate the OAuth flow for Google.
      */
     linkGoogle: () => void;
     /**
-     * For users who are authenticated, opens the Privy modal and prompts the user to link twitter OAuth account
+     * For users who are authenticated, prompts the user to link a Twitter OAuth account
+     * This will directly initiate the OAuth flow for Twitter.
      */
     linkTwitter: () => void;
     /**
-     * For users who are authenticated, opens the Privy modal and prompts the user to link discord OAuth account
+     * For users who are authenticated, prompts the user to link Discord OAuth account
+     * This will directly initiate the OAuth flow for Discord.
      */
     linkDiscord: () => void;
     /**
@@ -238,10 +260,29 @@ interface PrivyInterface {
      */
     getWeb3jsProvider: () => AbstractProvider;
     /**
-     * Unlink accounts.
+     * Unlink an email account from a user, by passing the email address. Note that you can only unlink an email account if the user has at least one other account.
      */
     unlinkEmail: (address: string) => Promise<User>;
+    /**
+     * Unlink a phone account from a user, by passing the phone number. Note that you can only unlink a phone account if the user has at least one other account.
+     */
+    unlinkPhone: (phoneNumber: string) => Promise<User>;
+    /**
+     * Unlink a wallet account from a user, by passing the public address. Note that you can only unlink a wallet account if the user has at least one other account.
+     */
     unlinkWallet: (address: string) => Promise<User>;
+    /**
+     * Unlink a Google social account from a user, by passing the google subject ID. Note that you can only unlink a social account if the user has at least one other account.
+     */
+    unlinkGoogle: (subject: string) => Promise<User>;
+    /**
+     * Unlink a Twitter social account from a user, by passing the twitter subject ID. Note that you can only unlink a social account if the user has at least one other account.
+     */
+    unlinkTwitter: (subject: string) => Promise<User>;
+    /**
+     * Unlink a Discord social account from a user, by passing the discord subject ID. Note that you can only unlink a social account if the user has at least one other account.
+     */
+    unlinkDiscord: (subject: string) => Promise<User>;
 }
 /**
  * [React Hook](https://reactjs.org/docs/hooks-intro.html) that allows you to manage the user's current authentication state and access their linked accounts.
@@ -250,4 +291,6 @@ interface PrivyInterface {
  */
 declare const usePrivy: () => PrivyInterface;
 
-export { Discord, DiscordOAuthWithMetadata, Email, EmailWithMetadata, Google, GoogleOAuthWithMetadata, PrivyInterface, PrivyProvider, PrivyProviderProps, Twitter, TwitterOAuthWithMetadata, User, Wallet, WalletWithMetadata, usePrivy };
+declare const VERSION: string;
+
+export { Discord, DiscordOAuthWithMetadata, Email, EmailWithMetadata, Google, GoogleOAuthWithMetadata, Phone, PhoneWithMetadata, PrivyInterface, PrivyProvider, PrivyProviderProps, Twitter, TwitterOAuthWithMetadata, User, VERSION, Wallet, WalletWithMetadata, usePrivy };