@privy-io/react-auth 1.12.0-beta.6 → 1.12.0-beta.8

package/dist/index.d.ts

@@ -3,11 +3,11 @@ import { ExternalProvider, Web3Provider } from '@ethersproject/providers';
 import { AbstractProvider } from 'web3-core';
 import { AxiosResponse, AxiosRequestConfig } from 'axios';
 
-declare const SUPPORTED_OAUTH_PROVIDERS: readonly ["google", "discord", "twitter"];
+declare const SUPPORTED_OAUTH_PROVIDERS: readonly ["google", "discord", "twitter", "github"];
 type OAuthProviderType = typeof SUPPORTED_OAUTH_PROVIDERS[number];
 declare const SUPPORTED_WALLET_TYPES: readonly ["metamask", "coinbase_wallet", "wallet_connect"];
 type WalletType = typeof SUPPORTED_WALLET_TYPES[number];
-type LinkedAccountType = 'wallet' | 'email' | 'phone' | 'google_oauth' | 'twitter_oauth' | 'discord_oauth';
+type LinkedAccountType = 'wallet' | 'email' | 'phone' | 'google_oauth' | 'twitter_oauth' | 'discord_oauth' | 'github_oauth';
 /** @ignore */
 interface LinkMetadata {
     /** Account type, most commonly useful when filtering through linkedAccounts */
@@ -78,6 +78,17 @@ interface Discord {
     /** The email associated with the Discord account. */
     email: string | null;
 }
+/** Object representation of a user's Discord account. */
+interface Github {
+    /** The `sub` claim from the Github-issued JWT for this account. */
+    subject: string;
+    /** The username associated with the Github account.  */
+    username: string | null;
+    /** The name associated with the Github account. */
+    name: string | null;
+    /** The email associated with the Github account. */
+    email: string | null;
+}
 /** 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. */
@@ -108,7 +119,12 @@ interface DiscordOAuthWithMetadata extends LinkMetadata, Discord {
     /** Denotes that this is a Discord account. */
     type: 'discord_oauth';
 }
-type LinkedAccountWithMetadata = WalletWithMetadata | EmailWithMetadata | PhoneWithMetadata | GoogleOAuthWithMetadata | TwitterOAuthWithMetadata | DiscordOAuthWithMetadata;
+/** Object representation of a user's Github Account, with additional metadata for advanced use cases. */
+interface GithubOAuthWithMetadata extends LinkMetadata, Github {
+    /** Denotes that this is a Github account. */
+    type: 'github_oauth';
+}
+type LinkedAccountWithMetadata = WalletWithMetadata | EmailWithMetadata | PhoneWithMetadata | GoogleOAuthWithMetadata | TwitterOAuthWithMetadata | DiscordOAuthWithMetadata | GithubOAuthWithMetadata;
 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. */
@@ -131,6 +147,8 @@ interface User {
     twitter?: Twitter;
     /** The user's Discord account, if they have linked one. It cannot be linked to another user. */
     discord?: Discord;
+    /** The user's Github account, if they have linked one. It cannot be linked to another user. */
+    github?: Github;
     /** The list of accounts associated with this user. Each account contains additional metadata
      * that may be helpful for advanced use cases. */
     linkedAccounts: Array<LinkedAccountWithMetadata>;
@@ -149,6 +167,7 @@ interface AppSettings {
     googleOAuth?: boolean;
     twitterOAuth?: boolean;
     discordOAuth?: boolean;
+    githubOAuth?: boolean;
     termsAndConditionsUrl: string | null;
     privacyPolicyUrl: string | null;
     createdAt?: Date;
@@ -331,6 +350,11 @@ interface PrivyInterface {
      * This will directly initiate the OAuth flow for Discord.
      */
     linkDiscord: () => void;
+    /**
+     * For users who are authenticated, prompts the user to link Github OAuth account
+     * This will directly initiate the OAuth flow for Github.
+     */
+    linkGithub: () => 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.
      *
@@ -390,6 +414,10 @@ interface PrivyInterface {
      * 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>;
+    /**
+     * 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>;
     /**
      * 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.
@@ -473,7 +501,15 @@ interface ResponseOAuthDiscord {
     email: string | null;
     verified_at: number;
 }
-type LinkedAccountsType = Array<ResponseEmailAccount | ResponsePhoneAccount | ResponseEthereumAccount | ResponseOAuthGoogle | ResponseOAuthTwitter | ResponseOAuthDiscord>;
+interface ResponseOAuthGithub {
+    type: 'github_oauth';
+    subject: string;
+    username: string | null;
+    name: string | null;
+    email: string | null;
+    verified_at: number;
+}
+type LinkedAccountsType = Array<ResponseEmailAccount | ResponsePhoneAccount | ResponseEthereumAccount | ResponseOAuthGoogle | ResponseOAuthTwitter | ResponseOAuthDiscord | ResponseOAuthGithub>;
 interface GetCurrentUserResponse {
     id: string;
     created_at: number;
@@ -673,4 +709,4 @@ declare class PrivyClient {
     forkSession(): Promise<string>;
 }
 
-export { AsExternalProvider, Discord, DiscordOAuthWithMetadata, Email, EmailWithMetadata, Google, GoogleOAuthWithMetadata, Phone, PhoneWithMetadata, PrivyClient, PrivyConnector, PrivyInterface, PrivyProvider, PrivyProviderProps, PrivyProxyProvider, Twitter, TwitterOAuthWithMetadata, User, VERSION, Wallet, WalletWithMetadata, getAccessToken, usePrivy };
+export { AsExternalProvider, Discord, DiscordOAuthWithMetadata, Email, EmailWithMetadata, GithubOAuthWithMetadata, Google, GoogleOAuthWithMetadata, Phone, PhoneWithMetadata, PrivyClient, PrivyConnector, PrivyInterface, PrivyProvider, PrivyProviderProps, PrivyProxyProvider, Twitter, TwitterOAuthWithMetadata, User, VERSION, Wallet, WalletWithMetadata, getAccessToken, usePrivy };