@privy-io/react-auth 1.6.0-beta.3 → 1.6.0-beta.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.d.ts CHANGED
@@ -189,22 +189,27 @@ interface PrivyInterface {
189
189
  login: () => void;
190
190
  /**
191
191
  * For users who are authenticated, opens the Privy modal and prompts the user to link an email.
192
+ * This will open the Privy Modal which will guide the user through this action.
192
193
  */
193
194
  linkEmail: () => void;
194
195
  /**
195
196
  * For users who are authenticated, opens the Privy modal and prompts the user to link a wallet.
197
+ * This will open the Privy Modal which will guide the user through this action.
196
198
  */
197
199
  linkWallet: () => void;
198
200
  /**
199
- * For users who are authenticated, opens the Privy modal and prompts the user to link google OAuth account
201
+ * For users who are authenticated, prompts the user to link a Google OAuth account.
202
+ * This will directly initiate the OAuth flow for Google.
200
203
  */
201
204
  linkGoogle: () => void;
202
205
  /**
203
- * For users who are authenticated, opens the Privy modal and prompts the user to link twitter OAuth account
206
+ * For users who are authenticated, prompts the user to link a Twitter OAuth account
207
+ * This will directly initiate the OAuth flow for Twitter.
204
208
  */
205
209
  linkTwitter: () => void;
206
210
  /**
207
- * For users who are authenticated, opens the Privy modal and prompts the user to link discord OAuth account
211
+ * For users who are authenticated, prompts the user to link Discord OAuth account
212
+ * This will directly initiate the OAuth flow for Discord.
208
213
  */
209
214
  linkDiscord: () => void;
210
215
  /**
@@ -238,10 +243,25 @@ interface PrivyInterface {
238
243
  */
239
244
  getWeb3jsProvider: () => AbstractProvider;
240
245
  /**
241
- * Unlink accounts.
246
+ * 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.
242
247
  */
243
248
  unlinkEmail: (address: string) => Promise<User>;
249
+ /**
250
+ * 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.
251
+ */
244
252
  unlinkWallet: (address: string) => Promise<User>;
253
+ /**
254
+ * 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.
255
+ */
256
+ unlinkGoogle: (subject: string) => Promise<User>;
257
+ /**
258
+ * 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.
259
+ */
260
+ unlinkTwitter: (subject: string) => Promise<User>;
261
+ /**
262
+ * 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.
263
+ */
264
+ unlinkDiscord: (subject: string) => Promise<User>;
245
265
  }
246
266
  /**
247
267
  * [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.