@privy-io/react-auth 1.21.0 → 1.22.0-beta.1

package/dist/index.d.ts

@@ -4,7 +4,7 @@ import WCProvider from '@walletconnect/web3-provider';
 import { AbstractProvider } from 'web3-core';
 import { AxiosResponse, AxiosRequestConfig } from 'axios';
 
-declare const SUPPORTED_OAUTH_PROVIDERS: readonly ["google", "discord", "twitter", "github"];
+declare const SUPPORTED_OAUTH_PROVIDERS: readonly ["google", "discord", "twitter", "github", "apple"];
 type OAuthProviderType = typeof SUPPORTED_OAUTH_PROVIDERS[number];
 declare const SUPPORTED_WALLET_CONNECTION_TYPES: readonly ["metamask", "phantom", "coinbase_wallet", "wallet_connect"];
 type WalletType = typeof SUPPORTED_WALLET_CONNECTION_TYPES[number];
@@ -15,7 +15,7 @@ type WalletBranding = {
     name: string;
     icon?: string | EmbeddedSVG;
 };
-type LinkedAccountType = 'wallet' | 'email' | 'phone' | 'google_oauth' | 'twitter_oauth' | 'discord_oauth' | 'github_oauth';
+type LinkedAccountType = 'wallet' | 'email' | 'phone' | 'google_oauth' | 'twitter_oauth' | 'discord_oauth' | 'github_oauth' | 'apple_oauth';
 /** @ignore */
 interface LinkMetadata {
     /** Account type, most commonly useful when filtering through linkedAccounts */
@@ -101,6 +101,13 @@ interface Github {
     /** The email associated with the Github account. */
     email: string | null;
 }
+/** Object representation of a user's Apple account. */
+interface Apple {
+    /** The `sub` claim from the Apple-issued JWT for this account. */
+    subject: string;
+    /** The email associated with the Apple account. */
+    email: string;
+}
 /** Object representation of a user's email, with additional metadata for advanced use cases. */
 interface EmailWithMetadata extends LinkMetadata, Email {
     /** Denotes that this is an email account. */
@@ -136,10 +143,15 @@ interface GithubOAuthWithMetadata extends LinkMetadata, Github {
     /** Denotes that this is a Github account. */
     type: 'github_oauth';
 }
+/** Object representation of a user's Apple Account, with additional metadata for advanced use cases. */
+interface AppleOAuthWithMetadata extends LinkMetadata, Apple {
+    /** Denotes that this is a Apple account. */
+    type: 'apple_oauth';
+}
 /**
  * Object representation of a user's linked accounts
  */
-type LinkedAccountWithMetadata = WalletWithMetadata | EmailWithMetadata | PhoneWithMetadata | GoogleOAuthWithMetadata | TwitterOAuthWithMetadata | DiscordOAuthWithMetadata | GithubOAuthWithMetadata;
+type LinkedAccountWithMetadata = WalletWithMetadata | EmailWithMetadata | PhoneWithMetadata | GoogleOAuthWithMetadata | TwitterOAuthWithMetadata | DiscordOAuthWithMetadata | GithubOAuthWithMetadata | AppleOAuthWithMetadata;
 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. */
@@ -164,6 +176,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 Apple account, if they have linked one. It cannot be linked to another user. */
+    apple?: Apple;
     /** The list of accounts associated with this user. Each account contains additional metadata
      * that may be helpful for advanced use cases. */
     linkedAccounts: Array<LinkedAccountWithMetadata>;
@@ -181,6 +195,7 @@ type PrivyServerConfig = {
     twitterOAuth?: boolean;
     discordOAuth?: boolean;
     githubOAuth?: boolean;
+    appleOAuth?: boolean;
     termsAndConditionsUrl: string | null;
     privacyPolicyUrl: string | null;
     createdAt?: Date;
@@ -248,6 +263,12 @@ interface PrivyProviderProps {
      * Values here will override their server-configuration counterparts.
      */
     config?: PrivyClientConfig;
+    /**
+     * Override the URL of the Privy API, which is 'https://auth.privy.io' by default.
+     * For development and testing use only.
+     * @hidden
+     */
+    apiUrl?: string;
     /**
      * @ignore
      * @class
@@ -545,6 +566,11 @@ interface PrivyInterface {
      * This will directly initiate the OAuth flow for Github.
      */
     linkGithub: () => void;
+    /**
+     * For users who are authenticated, prompts the user to link Apple OAuth account
+     * This will directly initiate the OAuth flow for Apple.
+     */
+    linkApple: () => void;
     /**
      * Log the current user out and clears their authentication state. `authenticated` will become false, `user` will become null, and the Privy Auth tokens will be deleted from the browser's local storage.
      *
@@ -609,6 +635,10 @@ interface PrivyInterface {
      * Unlink a Github social account from a user, by passing the github subject ID. Note that you can only unlink a social account if the user has at least one other account.
      */
     unlinkGithub: (subject: string) => Promise<User>;
+    /**
+     * Unlink a Apple social account from a user, by passing the apple subject ID. Note that you can only unlink a social account if the user has at least one other account.
+     */
+    unlinkApple: (subject: string) => Promise<User>;
     /**
      * Set one of the authenticated wallet addresses (part of user.linkedAccounts with type 'wallet'). as the active wallet.
      * If you pass a wallet that's not one of the linkedAccounts, this will throw an error.
@@ -705,7 +735,13 @@ interface ResponseOAuthGithub {
     email: string | null;
     verified_at: number;
 }
-type LinkedAccountsResponseType = Array<ResponseEmailAccount | ResponsePhoneAccount | ResponseEthereumAccount | ResponseOAuthGoogle | ResponseOAuthTwitter | ResponseOAuthDiscord | ResponseOAuthGithub>;
+interface ResponseOAuthApple {
+    type: 'apple_oauth';
+    subject: string;
+    email: string;
+    verified_at: number;
+}
+type LinkedAccountsResponseType = Array<ResponseEmailAccount | ResponsePhoneAccount | ResponseEthereumAccount | ResponseOAuthGoogle | ResponseOAuthTwitter | ResponseOAuthDiscord | ResponseOAuthGithub | ResponseOAuthApple>;
 interface GetCurrentUserResponse {
     id: string;
     created_at: number;
@@ -786,6 +822,7 @@ declare class PrivyClient {
     private appId;
     private session;
     private clientAnalyticsId;
+    apiUrl: string;
     authFlow?: AuthFlow;
     connectors: ConnectorManager;
     /**
@@ -796,7 +833,7 @@ declare class PrivyClient {
         /**
          * The URL of the Privy API. Defaults to `https://api.privy.io/v0`.
          */
-        apiURL?: string;
+        apiUrl?: string;
         /**
          * The app id from your console
          */
@@ -863,4 +900,4 @@ declare class PrivyClient {
     forkSession(): Promise<string>;
 }
 
-export { AsExternalProvider, ConnectorManager, Discord, DiscordOAuthWithMetadata, Email, EmailWithMetadata, Github, GithubOAuthWithMetadata, Google, GoogleOAuthWithMetadata, Phone, PhoneWithMetadata, PrivyClient, PrivyClientConfig, PrivyInterface, PrivyProvider, PrivyProviderProps, PrivyProxyProvider, SignMessageModalUIOptions, Twitter, TwitterOAuthWithMetadata, User, VERSION, Wallet, WalletConnector, WalletWithMetadata, getAccessToken, usePrivy };
+export { Apple, AppleOAuthWithMetadata, AsExternalProvider, ConnectorManager, Discord, DiscordOAuthWithMetadata, Email, EmailWithMetadata, Github, GithubOAuthWithMetadata, Google, GoogleOAuthWithMetadata, Phone, PhoneWithMetadata, PrivyClient, PrivyClientConfig, PrivyInterface, PrivyProvider, PrivyProviderProps, PrivyProxyProvider, SignMessageModalUIOptions, Twitter, TwitterOAuthWithMetadata, User, VERSION, Wallet, WalletConnector, WalletWithMetadata, getAccessToken, usePrivy };