decane-connect-kit 2.20.0 → 2.21.0

package/dist/index.d.cts

@@ -229,6 +229,8 @@ interface ConnectResult {
     isNewUser: boolean;
     /** Present when the provider released a profile — see {@link AuthProfile}. */
     profile?: AuthProfile;
+    /** See {@link AuthResult.providerSubject}. */
+    providerSubject?: string;
 }
 /** A recorded on-chain transaction in the user's history. */
 interface TransactionRecord {
@@ -547,6 +549,16 @@ interface AuthProfile {
     name?: string;
     email?: string;
     picture?: string;
+    /**
+     * The handle the user signs in under, where the provider has one. X sets it
+     * and releases no email at all, so for those accounts this is the only
+     * human-readable thing there is.
+     *
+     * Display only. A handle can be released by its owner and registered by
+     * somebody else, so never key an account, a lookup or access on it — use
+     * {@link AuthResult.providerSubject}, which cannot move.
+     */
+    username?: string;
 }
 interface AuthResult {
     jwt: string;
@@ -554,6 +566,15 @@ interface AuthResult {
     hasShare: boolean;
     userId: string;
     profile?: AuthProfile;
+    /**
+     * The provider's own stable id for this user — X's numeric user id, for
+     * instance. Present only where the provider gives one.
+     *
+     * Unlike a handle or an email this cannot be reassigned, which is what makes
+     * it safe to match an account against: the same value identifies the same
+     * person on both sides of a migration.
+     */
+    providerSubject?: string;
 }
 
 declare class ApiClient {
@@ -1229,6 +1250,15 @@ interface SocialAuthState {
      * you need it in that state.
      */
     profile: AuthProfile | null;
+    /**
+     * The provider's own stable id for this user, where it gives one — X's
+     * numeric user id, for instance. Null for providers that do not.
+     *
+     * Unlike a handle or an email this cannot be reassigned, so it is the value
+     * to match an account against. Like `profile` it comes from the sign-in and
+     * cannot be re-fetched, so copy it if you need it after a reload.
+     */
+    providerSubject: string | null;
     isUnlocked: boolean;
     sessionExpiresAt: number | null;
     /**
@@ -1322,6 +1352,7 @@ declare function useSocialAuth(): {
     sessionExpiresAt: number | null;
     canUsePasskey: boolean;
     profile: AuthProfile | null;
+    providerSubject: string | null;
     phase: "creating" | "unlocking" | null;
     isCreatingWallet: boolean;
     needsReconnect: boolean;

package/dist/index.d.ts

@@ -229,6 +229,8 @@ interface ConnectResult {
     isNewUser: boolean;
     /** Present when the provider released a profile — see {@link AuthProfile}. */
     profile?: AuthProfile;
+    /** See {@link AuthResult.providerSubject}. */
+    providerSubject?: string;
 }
 /** A recorded on-chain transaction in the user's history. */
 interface TransactionRecord {
@@ -547,6 +549,16 @@ interface AuthProfile {
     name?: string;
     email?: string;
     picture?: string;
+    /**
+     * The handle the user signs in under, where the provider has one. X sets it
+     * and releases no email at all, so for those accounts this is the only
+     * human-readable thing there is.
+     *
+     * Display only. A handle can be released by its owner and registered by
+     * somebody else, so never key an account, a lookup or access on it — use
+     * {@link AuthResult.providerSubject}, which cannot move.
+     */
+    username?: string;
 }
 interface AuthResult {
     jwt: string;
@@ -554,6 +566,15 @@ interface AuthResult {
     hasShare: boolean;
     userId: string;
     profile?: AuthProfile;
+    /**
+     * The provider's own stable id for this user — X's numeric user id, for
+     * instance. Present only where the provider gives one.
+     *
+     * Unlike a handle or an email this cannot be reassigned, which is what makes
+     * it safe to match an account against: the same value identifies the same
+     * person on both sides of a migration.
+     */
+    providerSubject?: string;
 }
 
 declare class ApiClient {
@@ -1229,6 +1250,15 @@ interface SocialAuthState {
      * you need it in that state.
      */
     profile: AuthProfile | null;
+    /**
+     * The provider's own stable id for this user, where it gives one — X's
+     * numeric user id, for instance. Null for providers that do not.
+     *
+     * Unlike a handle or an email this cannot be reassigned, so it is the value
+     * to match an account against. Like `profile` it comes from the sign-in and
+     * cannot be re-fetched, so copy it if you need it after a reload.
+     */
+    providerSubject: string | null;
     isUnlocked: boolean;
     sessionExpiresAt: number | null;
     /**
@@ -1322,6 +1352,7 @@ declare function useSocialAuth(): {
     sessionExpiresAt: number | null;
     canUsePasskey: boolean;
     profile: AuthProfile | null;
+    providerSubject: string | null;
     phase: "creating" | "unlocking" | null;
     isCreatingWallet: boolean;
     needsReconnect: boolean;

package/dist/index.js

@@ -1956,10 +1956,13 @@ function readRedirectOutcome(search) {
   const name = params.get("decane_name");
   const email = params.get("decane_email");
   const picture = params.get("decane_picture");
+  const username = params.get("decane_username");
+  const providerSubject = params.get("decane_provider_subject");
   const profile = {
     ...name ? { name } : {},
     ...email ? { email } : {},
-    ...picture ? { picture } : {}
+    ...picture ? { picture } : {},
+    ...username ? { username } : {}
   };
   return {
     kind: "result",
@@ -1972,7 +1975,8 @@ function readRedirectOutcome(search) {
       // test `result.profile` rather than an object that is always present but
       // sometimes empty. X never sends an email, so this is the normal case
       // there rather than an edge one.
-      ...Object.keys(profile).length ? { profile } : {}
+      ...Object.keys(profile).length ? { profile } : {},
+      ...providerSubject ? { providerSubject } : {}
     }
   };
 }
@@ -4368,7 +4372,8 @@ async function createDecaneConnect(config) {
     return {
       addresses,
       isNewUser: result.isNewUser,
-      ...result.profile ? { profile: result.profile } : {}
+      ...result.profile ? { profile: result.profile } : {},
+      ...result.providerSubject ? { providerSubject: result.providerSubject } : {}
     };
   }
   const client = {
@@ -7188,6 +7193,7 @@ var DEFAULT_SOCIAL = {
   addresses: null,
   isNewUser: false,
   profile: null,
+  providerSubject: null,
   isUnlocked: false,
   sessionExpiresAt: null,
   needsReconnect: false,
@@ -7323,6 +7329,7 @@ function DecaneKit({ config, children }) {
       addresses: result.addresses,
       isNewUser: result.isNewUser,
       profile: result.profile ?? null,
+      providerSubject: result.providerSubject ?? null,
       isUnlocked: sdk?.isUnlocked() ?? false,
       sessionExpiresAt: sdk?.sessionExpiresAt() ?? null,
       needsReconnect: false,
@@ -7855,6 +7862,9 @@ function useSocialAuth() {
     // user first signed in, so it carries the same name and email a Google
     // sign-in does rather than coming back anonymous.
     profile: socialAuth.profile,
+    // The provider's stable id, where it gives one. Null otherwise. Safe to
+    // match an account on, unlike the handle in `profile.username`.
+    providerSubject: socialAuth.providerSubject,
     // Long-running work in progress, for driving your own status UI.
     phase: socialAuth.phase,
     isCreatingWallet: socialAuth.phase === "creating",