decane-connect-kit 2.19.0 → 2.21.0

package/dist/index.d.cts

@@ -92,7 +92,7 @@ interface DecaneConnectConfig {
     appId: string;
     apiKey: string;
     chains: Chain[];
-    authMethods: Array<'google' | 'email' | 'phone' | 'kingschat'>;
+    authMethods: Array<'google' | 'email' | 'phone' | 'kingschat' | 'x'>;
     /**
      * Scopes requested from KingsChat at sign-in. Defaults to
      * `['send_chat_message']`, which is what KingsChat's own SDK asks for and is
@@ -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 {
@@ -303,6 +305,23 @@ interface DecaneConnect {
      * Decane session; it is never treated as one on its own.
      */
     connectWithKingsChat(): Promise<ConnectResult>;
+    /**
+     * Sign in with X (Twitter).
+     *
+     * A redirect, like Google and unlike KingsChat's popup: calling it navigates
+     * away, and the promise never resolves. Call it again on the page X returns
+     * to and it finishes the sign-in from the URL instead of starting a new one.
+     *
+     * X releases no email address, so `result.profile` carries a name and a
+     * picture and nothing else. Anything that needs an address must ask the user
+     * for one.
+     */
+    connectWithX(): Promise<ConnectResult>;
+    /**
+     * Finish a redirect sign-in already present in the URL, whichever provider
+     * started it. Throws when there is nothing to finish — it never starts one.
+     */
+    completeRedirectSignIn(): Promise<ConnectResult>;
     /**
      * Sign in with a KingsChat access token the app already holds — from
      * kingschat-web-sdk, a native SDK, or any other flow. Use when you want to
@@ -530,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;
@@ -537,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 {
@@ -548,6 +586,14 @@ declare class ApiClient {
     getGoogleInitUrl(): Promise<{
         url: string;
     }>;
+    /**
+     * The X consent URL. Same contract as Google's: the backend holds the client
+     * secret and the PKCE verifier, and answers 503 X_NOT_CONFIGURED when the
+     * deployment has no X credentials.
+     */
+    getXInitUrl(): Promise<{
+        url: string;
+    }>;
     /**
      * Exchange a Google ID token the app already holds for a Decane session.
      * Resolves to the SAME identity as the redirect flow, so one Google account
@@ -755,7 +801,7 @@ interface DecaneProvider {
 type ConnectMode = "all" | "social" | "wallets" | "evm" | "solana" | "tron" | "evm+social" | "solana+social" | "tron+social" | "evm+tron" | "evm+tron+social";
 interface SocialConfig {
     apiKey: string;
-    authMethods?: ("google" | "email" | "phone" | "kingschat")[];
+    authMethods?: ("google" | "email" | "phone" | "kingschat" | "x")[];
     /**
      * Scopes requested from KingsChat. Defaults to `['send_chat_message']`, which
      * is what KingsChat's own SDK asks for and is enough to establish identity.
@@ -1159,9 +1205,10 @@ interface WalletSelectorProps {
     theme?: "light" | "dark" | "auto";
     networks?: "evm" | "solana" | "tron" | "bitcoin" | "all";
     mode?: ConnectMode;
-    socialAuthMethods?: ("google" | "email" | "phone" | "kingschat")[];
+    socialAuthMethods?: ("google" | "email" | "phone" | "kingschat" | "x")[];
     onGoogleSignIn?: () => Promise<void>;
     onKingsChatSignIn?: () => Promise<void>;
+    onXSignIn?: () => Promise<void>;
     onEmailStart?: (email: string) => Promise<{
         codeRequired: true;
     }>;
@@ -1179,7 +1226,7 @@ interface WalletSelectorProps {
     passkeyAddress?: string | null;
     onPasskeySignIn?: () => Promise<unknown>;
 }
-declare function WalletSelector({ provider, open, onClose, onConnect, theme, networks, mode, socialAuthMethods, onGoogleSignIn, onKingsChatSignIn, onEmailStart, onEmailVerify, onPhoneStart, onPhoneVerify, customAuthLabel, onCustomAuthSignIn, canUsePasskey, passkeyAddress, onPasskeySignIn, }: WalletSelectorProps): React.ReactPortal | null;
+declare function WalletSelector({ provider, open, onClose, onConnect, theme, networks, mode, socialAuthMethods, onGoogleSignIn, onKingsChatSignIn, onXSignIn, onEmailStart, onEmailVerify, onPhoneStart, onPhoneVerify, customAuthLabel, onCustomAuthSignIn, canUsePasskey, passkeyAddress, onPasskeySignIn, }: WalletSelectorProps): React.ReactPortal | null;
 
 type Theme = "light" | "dark" | "auto";
 interface SocialAuthState {
@@ -1203,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;
     /**
@@ -1243,6 +1299,7 @@ interface SocialWalletModalProps {
     onDisconnect: () => Promise<void>;
     onGoogleSignIn: () => Promise<void>;
     onKingsChatSignIn?: () => Promise<void>;
+    onXSignIn?: () => Promise<void>;
     onEmailStart: (email: string) => Promise<{
         codeRequired: true;
     }>;
@@ -1251,7 +1308,7 @@ interface SocialWalletModalProps {
         codeRequired: true;
     }>;
     onPhoneVerify?: (phone: string, code: string) => Promise<void>;
-    authMethods?: Array<"google" | "email" | "phone" | "kingschat">;
+    authMethods?: Array<"google" | "email" | "phone" | "kingschat" | "x">;
     customAuthLabel?: string;
     onCustomAuthSignIn?: () => Promise<void>;
     canUsePasskey?: boolean;
@@ -1295,11 +1352,13 @@ declare function useSocialAuth(): {
     sessionExpiresAt: number | null;
     canUsePasskey: boolean;
     profile: AuthProfile | null;
+    providerSubject: string | null;
     phase: "creating" | "unlocking" | null;
     isCreatingWallet: boolean;
     needsReconnect: boolean;
     googleLoading: boolean;
     kingschatLoading: boolean;
+    xLoading: boolean;
     emailLoading: boolean;
     phoneLoading: boolean;
     tokenLoading: boolean;
@@ -1309,6 +1368,7 @@ declare function useSocialAuth(): {
     clearError: () => void;
     signInWithGoogle: () => Promise<void>;
     signInWithKingsChat: () => Promise<void>;
+    signInWithX: () => Promise<void>;
     sendEmailCode: (email: string) => Promise<{
         codeRequired: true;
     }>;

package/dist/index.d.ts

@@ -92,7 +92,7 @@ interface DecaneConnectConfig {
     appId: string;
     apiKey: string;
     chains: Chain[];
-    authMethods: Array<'google' | 'email' | 'phone' | 'kingschat'>;
+    authMethods: Array<'google' | 'email' | 'phone' | 'kingschat' | 'x'>;
     /**
      * Scopes requested from KingsChat at sign-in. Defaults to
      * `['send_chat_message']`, which is what KingsChat's own SDK asks for and is
@@ -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 {
@@ -303,6 +305,23 @@ interface DecaneConnect {
      * Decane session; it is never treated as one on its own.
      */
     connectWithKingsChat(): Promise<ConnectResult>;
+    /**
+     * Sign in with X (Twitter).
+     *
+     * A redirect, like Google and unlike KingsChat's popup: calling it navigates
+     * away, and the promise never resolves. Call it again on the page X returns
+     * to and it finishes the sign-in from the URL instead of starting a new one.
+     *
+     * X releases no email address, so `result.profile` carries a name and a
+     * picture and nothing else. Anything that needs an address must ask the user
+     * for one.
+     */
+    connectWithX(): Promise<ConnectResult>;
+    /**
+     * Finish a redirect sign-in already present in the URL, whichever provider
+     * started it. Throws when there is nothing to finish — it never starts one.
+     */
+    completeRedirectSignIn(): Promise<ConnectResult>;
     /**
      * Sign in with a KingsChat access token the app already holds — from
      * kingschat-web-sdk, a native SDK, or any other flow. Use when you want to
@@ -530,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;
@@ -537,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 {
@@ -548,6 +586,14 @@ declare class ApiClient {
     getGoogleInitUrl(): Promise<{
         url: string;
     }>;
+    /**
+     * The X consent URL. Same contract as Google's: the backend holds the client
+     * secret and the PKCE verifier, and answers 503 X_NOT_CONFIGURED when the
+     * deployment has no X credentials.
+     */
+    getXInitUrl(): Promise<{
+        url: string;
+    }>;
     /**
      * Exchange a Google ID token the app already holds for a Decane session.
      * Resolves to the SAME identity as the redirect flow, so one Google account
@@ -755,7 +801,7 @@ interface DecaneProvider {
 type ConnectMode = "all" | "social" | "wallets" | "evm" | "solana" | "tron" | "evm+social" | "solana+social" | "tron+social" | "evm+tron" | "evm+tron+social";
 interface SocialConfig {
     apiKey: string;
-    authMethods?: ("google" | "email" | "phone" | "kingschat")[];
+    authMethods?: ("google" | "email" | "phone" | "kingschat" | "x")[];
     /**
      * Scopes requested from KingsChat. Defaults to `['send_chat_message']`, which
      * is what KingsChat's own SDK asks for and is enough to establish identity.
@@ -1159,9 +1205,10 @@ interface WalletSelectorProps {
     theme?: "light" | "dark" | "auto";
     networks?: "evm" | "solana" | "tron" | "bitcoin" | "all";
     mode?: ConnectMode;
-    socialAuthMethods?: ("google" | "email" | "phone" | "kingschat")[];
+    socialAuthMethods?: ("google" | "email" | "phone" | "kingschat" | "x")[];
     onGoogleSignIn?: () => Promise<void>;
     onKingsChatSignIn?: () => Promise<void>;
+    onXSignIn?: () => Promise<void>;
     onEmailStart?: (email: string) => Promise<{
         codeRequired: true;
     }>;
@@ -1179,7 +1226,7 @@ interface WalletSelectorProps {
     passkeyAddress?: string | null;
     onPasskeySignIn?: () => Promise<unknown>;
 }
-declare function WalletSelector({ provider, open, onClose, onConnect, theme, networks, mode, socialAuthMethods, onGoogleSignIn, onKingsChatSignIn, onEmailStart, onEmailVerify, onPhoneStart, onPhoneVerify, customAuthLabel, onCustomAuthSignIn, canUsePasskey, passkeyAddress, onPasskeySignIn, }: WalletSelectorProps): React.ReactPortal | null;
+declare function WalletSelector({ provider, open, onClose, onConnect, theme, networks, mode, socialAuthMethods, onGoogleSignIn, onKingsChatSignIn, onXSignIn, onEmailStart, onEmailVerify, onPhoneStart, onPhoneVerify, customAuthLabel, onCustomAuthSignIn, canUsePasskey, passkeyAddress, onPasskeySignIn, }: WalletSelectorProps): React.ReactPortal | null;
 
 type Theme = "light" | "dark" | "auto";
 interface SocialAuthState {
@@ -1203,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;
     /**
@@ -1243,6 +1299,7 @@ interface SocialWalletModalProps {
     onDisconnect: () => Promise<void>;
     onGoogleSignIn: () => Promise<void>;
     onKingsChatSignIn?: () => Promise<void>;
+    onXSignIn?: () => Promise<void>;
     onEmailStart: (email: string) => Promise<{
         codeRequired: true;
     }>;
@@ -1251,7 +1308,7 @@ interface SocialWalletModalProps {
         codeRequired: true;
     }>;
     onPhoneVerify?: (phone: string, code: string) => Promise<void>;
-    authMethods?: Array<"google" | "email" | "phone" | "kingschat">;
+    authMethods?: Array<"google" | "email" | "phone" | "kingschat" | "x">;
     customAuthLabel?: string;
     onCustomAuthSignIn?: () => Promise<void>;
     canUsePasskey?: boolean;
@@ -1295,11 +1352,13 @@ declare function useSocialAuth(): {
     sessionExpiresAt: number | null;
     canUsePasskey: boolean;
     profile: AuthProfile | null;
+    providerSubject: string | null;
     phase: "creating" | "unlocking" | null;
     isCreatingWallet: boolean;
     needsReconnect: boolean;
     googleLoading: boolean;
     kingschatLoading: boolean;
+    xLoading: boolean;
     emailLoading: boolean;
     phoneLoading: boolean;
     tokenLoading: boolean;
@@ -1309,6 +1368,7 @@ declare function useSocialAuth(): {
     clearError: () => void;
     signInWithGoogle: () => Promise<void>;
     signInWithKingsChat: () => Promise<void>;
+    signInWithX: () => Promise<void>;
     sendEmailCode: (email: string) => Promise<{
         codeRequired: true;
     }>;