@privy-io/react-auth 1.41.0 → 1.42.0-beta-20231002210349

package/dist/index.d.ts

@@ -509,6 +509,12 @@ interface ResponseOAuthGithub {
     email: string | null;
     verified_at: number;
 }
+interface ResponseOAuthTiktok {
+    type: 'tiktok_oauth';
+    subject: string;
+    username: string | null;
+    verified_at: number;
+}
 interface ResponseOAuthLinkedIn {
     type: 'linkedin_oauth';
     subject: string;
@@ -527,7 +533,7 @@ interface ResponseCustomJwtAccount {
     custom_user_id: string;
     verified_at: number;
 }
-type LinkedAccountsResponseType = Array<ResponseEmailAccount | ResponsePhoneAccount | ResponseEthereumAccount | ResponseOAuthGoogle | ResponseOAuthTwitter | ResponseOAuthDiscord | ResponseOAuthGithub | ResponseOAuthLinkedIn | ResponseOAuthApple | ResponseCustomJwtAccount>;
+type LinkedAccountsResponseType = Array<ResponseEmailAccount | ResponsePhoneAccount | ResponseEthereumAccount | ResponseOAuthGoogle | ResponseOAuthTwitter | ResponseOAuthDiscord | ResponseOAuthGithub | ResponseOAuthTiktok | ResponseOAuthLinkedIn | ResponseOAuthApple | ResponseCustomJwtAccount>;
 interface GetCurrentUserResponse {
     id: string;
     created_at: number;
@@ -789,7 +795,7 @@ type MoonpaySignResponse = {
     externalTransactionId: string;
 };
 
-declare const SUPPORTED_OAUTH_PROVIDERS: readonly ["google", "discord", "twitter", "github", "linkedin", "apple"];
+declare const SUPPORTED_OAUTH_PROVIDERS: readonly ["google", "discord", "twitter", "github", "tiktok", "linkedin", "apple"];
 type OAuthProviderType = (typeof SUPPORTED_OAUTH_PROVIDERS)[number];
 type EmbeddedWalletClientType = 'privy';
 type InjectedWalletClientType = 'metamask' | 'phantom';
@@ -805,7 +811,7 @@ type WalletBranding = {
     name: string;
     icon?: string | EmbeddedSVG;
 };
-type LinkedAccountType = 'wallet' | 'email' | 'phone' | 'google_oauth' | 'twitter_oauth' | 'discord_oauth' | 'github_oauth' | 'linkedin_oauth' | 'apple_oauth' | 'custom_auth';
+type LinkedAccountType = 'wallet' | 'email' | 'phone' | 'google_oauth' | 'twitter_oauth' | 'discord_oauth' | 'github_oauth' | 'tiktok_oauth' | 'linkedin_oauth' | 'apple_oauth' | 'custom_auth';
 /** @ignore */
 interface LinkMetadata {
     /** Account type, most commonly useful when filtering through linkedAccounts */
@@ -994,6 +1000,13 @@ interface Github {
     /** The email associated with the Github account. */
     email: string | null;
 }
+/** Object representation of a user's Tiktok account. */
+interface Tiktok {
+    /** The `sub` claim from the Tiktok-issued JWT for this account. */
+    subject: string;
+    /** The username associated with the Tiktok account.  */
+    username: string | null;
+}
 /** Object representation of a user's LinkedIn account. */
 interface LinkedIn {
     /** The `sub` claim from the LinkedIn-issued JWT for this account. */
@@ -1049,6 +1062,11 @@ interface GithubOAuthWithMetadata extends LinkMetadata, Github {
     /** Denotes that this is a Github account. */
     type: 'github_oauth';
 }
+/** Object representation of a user's Tiktok Account, with additional metadata for advanced use cases. */
+interface TiktokOAuthWithMetadata extends LinkMetadata, Tiktok {
+    /** Denotes that this is a Tiktok account. */
+    type: 'tiktok_oauth';
+}
 /** Object representation of a user's LinkedIn Account, with additional metadata for advanced use cases. */
 interface LinkedInOAuthWithMetadata extends LinkMetadata, LinkedIn {
     /** Denotes that this is a LinkedIn account. */
@@ -1067,7 +1085,7 @@ interface CustomJwtAccountWithMetadata extends LinkMetadata, CustomJwtAccount {
 /**
  * Object representation of a user's linked accounts
  */
-type LinkedAccountWithMetadata = WalletWithMetadata | EmailWithMetadata | PhoneWithMetadata | GoogleOAuthWithMetadata | TwitterOAuthWithMetadata | DiscordOAuthWithMetadata | GithubOAuthWithMetadata | LinkedInOAuthWithMetadata | AppleOAuthWithMetadata | CustomJwtAccountWithMetadata;
+type LinkedAccountWithMetadata = WalletWithMetadata | EmailWithMetadata | PhoneWithMetadata | GoogleOAuthWithMetadata | TwitterOAuthWithMetadata | DiscordOAuthWithMetadata | GithubOAuthWithMetadata | TiktokOAuthWithMetadata | LinkedInOAuthWithMetadata | AppleOAuthWithMetadata | CustomJwtAccountWithMetadata;
 interface User {
     /** The Privy-issued DID for the user. If you need to store additional information
      * about a user, you can use this DID to reference them. */
@@ -1091,6 +1109,8 @@ interface User {
     discord?: Discord;
     /** The user's Github account, if they have linked one. It cannot be linked to another user. */
     github?: Github;
+    /** The user's Tiktok account, if they have linked one. It cannot be linked to another user. */
+    tiktok?: Tiktok;
     /** The user's LinkedIn account, if they have linked one. It cannot be linked to another user. */
     linkedin?: LinkedIn;
     /** The user's Apple account, if they have linked one. It cannot be linked to another user. */
@@ -1112,6 +1132,7 @@ type PrivyServerConfig = {
     twitterOAuth?: boolean;
     discordOAuth?: boolean;
     githubOAuth?: boolean;
+    tiktokOAuth?: boolean;
     linkedinOAuth?: boolean;
     appleOAuth?: boolean;
     termsAndConditionsUrl: string | null;
@@ -1161,7 +1182,7 @@ type PrivyClientConfig = {
      *  Social login methods require `email` OR `sms` to also be specified.
      *  `loginMethods` cannot be an empty array if specified.
      *  The order of this array does not currently dictate order of the login methods in the UI, but may in the future. */
-    loginMethods?: Array<'wallet' | 'email' | 'sms' | 'google' | 'twitter' | 'discord' | 'github' | 'linkedin' | 'apple'>;
+    loginMethods?: Array<'wallet' | 'email' | 'sms' | 'google' | 'twitter' | 'discord' | 'github' | 'linkedin' | 'tiktok' | 'apple'>;
     /**
      * This property is only required for apps that use a third-party authentication provider.
      */
@@ -1518,6 +1539,11 @@ interface PrivyInterface {
      * This will directly initiate the OAuth flow for Github.
      */
     linkGithub: () => void;
+    /**
+     * For users who are authenticated, prompts the user to link Tiktok OAuth account
+     * This will directly initiate the OAuth flow for Tiktok.
+     */
+    linkTiktok: () => void;
     /**
      * For users who are authenticated, prompts the user to link LinkedIn OAuth account
      * This will directly initiate the OAuth flow for LinkedIn.
@@ -1626,6 +1652,13 @@ interface PrivyInterface {
      * @returns Promise for the {@link User} object after the provided Github account has been unlinked
      */
     unlinkGithub: (subject: string) => Promise<User>;
+    /**
+     * Unlink a Tiktok social account from a user, by passing the tiktok subject ID. Note that you can only unlink a social account if the user has at least one other account.
+     *
+     * @param subject {string} tiktok account's subject ID
+     * @returns Promise for the {@link User} object after the provided Tiktok account has been unlinked
+     */
+    unlinkTiktok: (subject: string) => Promise<User>;
     /**
      * Unlink a LinkedIn social account from a user, by passing the linkedin subject ID. Note that you can only unlink a social account if the user has at least one other account.
      *
@@ -1878,4 +1911,4 @@ declare function useCreateWallet(callbacks?: PrivyEvents['createWallet']): {
     createWallet: () => Promise<Wallet>;
 };
 
-export { Apple, AppleOAuthWithMetadata, AsExternalProvider, CallbackError, ConnectedWallet, ConnectorManager, ContractUIOptions, Discord, DiscordOAuthWithMetadata, EIP1193Provider, Email, EmailWithMetadata, FundWalletConfig, Github, GithubOAuthWithMetadata, Google, GoogleOAuthWithMetadata, LinkedIn, LinkedInOAuthWithMetadata, MoonpayConfig, MoonpayCurrencyCode, MoonpayPaymentMethod, Phone, PhoneWithMetadata, PrivyClient, PrivyClientConfig, PrivyEvents, PrivyInterface, PrivyProvider, PrivyProviderProps, PrivyProxyProvider, Quantity, DEFAULT_SUPPORTED_CHAINS as SUPPORTED_CHAINS, SendTransactionModalUIOptions, SignMessageModalUIOptions, TransactionLog, TransactionReceipt, TransactionUIOptions, Twitter, TwitterOAuthWithMetadata, UnsignedTransactionRequest, UseWalletsInterface, User, VERSION, Wallet, WalletConnector, WalletWithMetadata, getAccessToken, useConnectWallet, useCreateWallet, useLogin, useLogout, usePrivy, useWallets };
+export { Apple, AppleOAuthWithMetadata, AsExternalProvider, CallbackError, ConnectedWallet, ConnectorManager, ContractUIOptions, Discord, DiscordOAuthWithMetadata, EIP1193Provider, Email, EmailWithMetadata, FundWalletConfig, Github, GithubOAuthWithMetadata, Google, GoogleOAuthWithMetadata, LinkedIn, LinkedInOAuthWithMetadata, MoonpayConfig, MoonpayCurrencyCode, MoonpayPaymentMethod, Phone, PhoneWithMetadata, PrivyClient, PrivyClientConfig, PrivyEvents, PrivyInterface, PrivyProvider, PrivyProviderProps, PrivyProxyProvider, Quantity, DEFAULT_SUPPORTED_CHAINS as SUPPORTED_CHAINS, SendTransactionModalUIOptions, SignMessageModalUIOptions, Tiktok, TiktokOAuthWithMetadata, TransactionLog, TransactionReceipt, TransactionUIOptions, Twitter, TwitterOAuthWithMetadata, UnsignedTransactionRequest, UseWalletsInterface, User, VERSION, Wallet, WalletConnector, WalletWithMetadata, getAccessToken, useConnectWallet, useCreateWallet, useLogin, useLogout, usePrivy, useWallets };