decane-connect-kit 2.6.2 → 2.7.0

package/dist/index.d.cts

@@ -476,6 +476,8 @@ interface ConnectResult {
         tron?: string;
     };
     isNewUser: boolean;
+    /** Present when the provider released a profile — see {@link AuthProfile}. */
+    profile?: AuthProfile;
 }
 /** A recorded on-chain transaction in the user's history. */
 interface TransactionRecord {
@@ -701,11 +703,28 @@ interface WrappedShareMeta {
     pinSalt?: string;
     pinIterations?: number;
 }
+/**
+ * Who the user is, as the identity provider just described them.
+ *
+ * Passed through from the provider at sign-in and never stored by Decane — the
+ * backend keeps only an HMAC and a masked identifier, so there is no profile to
+ * look up later. Cache what you need at sign-in if you want to show a name
+ * after a page reload.
+ *
+ * Every field is optional because providers differ in what they release, and a
+ * user can withhold most of it. Email sign-in returns an empty profile.
+ */
+interface AuthProfile {
+    name?: string;
+    email?: string;
+    picture?: string;
+}
 interface AuthResult {
     jwt: string;
     isNewUser: boolean;
     hasShare: boolean;
     userId: string;
+    profile?: AuthProfile;
 }
 
 declare function createDecaneConnect(config: DecaneConnectConfig): Promise<DecaneConnect>;
@@ -1210,4 +1229,4 @@ declare function useSignTypedData(): {
     reset: () => void;
 };
 
-export { type ActiveSession, AttestationError, type AuthResult, BUILT_IN_CHAINS, type BalanceResult, type CAIP25Method, type CAIP25SessionRequest, type CAIP25SessionResult, CHAINS, CallSequenceError, type Chain, type ChainDescriptor, type ChainId, type ChainScope, type ChainSupport, type ChainType, type ConnectMode, type ConnectResult, type DecaneConfig, type DecaneConnect, type DecaneConnectConfig, DecaneConnectError, DecaneError, DecaneErrorCode, DecaneKit, DecaneLogo, DecaneMark, type DecaneProvider, DecaneWordmark, type Eip1193Provider, type EthereumProviderOptions, ExportNotAuthorizedError, InvalidApiKeyError, InvalidPinError, InvalidRecoveryFileError, type KingsChatTokens, NetworkError, NewDeviceError, OriginNotAllowedError, type PortableBackup, PromptPinNotConfiguredError, ReconnectRequiredError, type RecordTransactionInput, RecoveryFailedError, type RecoveryProgress, type RecoveryShareFile, RecoveryWalletMismatchError, type SdkEvent, type SendTransactionRequest, SessionExpiredError, ShareCorruptedError, type SignMessageRequest, type SignTypedDataRequest, type SignedAuthorization, type SocialAuthState, type SocialConfig, SocialWalletModal, StaleDeviceShareError, type Theme, type TransactionRecord, type TxParams, type UnifiedWalletAccount, UnlockRequiredError, UserCancelledError, WalletSelector, WebAuthnNotSupportedError, type WrappedShareMeta, WrongPasswordError, createDecane, createDecaneConnect, createEthereumProvider, loginWithKingsChatPopup, startEmailAuth, useChainSwitch, useDecane, useEthereumProvider, useSendTransaction, useSignMessage, useSignTypedData, useSocialAuth, useSocialBalance, useSocialWallet, useWalletSelector, verifyEmailCode };
+export { type ActiveSession, AttestationError, type AuthProfile, type AuthResult, BUILT_IN_CHAINS, type BalanceResult, type CAIP25Method, type CAIP25SessionRequest, type CAIP25SessionResult, CHAINS, CallSequenceError, type Chain, type ChainDescriptor, type ChainId, type ChainScope, type ChainSupport, type ChainType, type ConnectMode, type ConnectResult, type DecaneConfig, type DecaneConnect, type DecaneConnectConfig, DecaneConnectError, DecaneError, DecaneErrorCode, DecaneKit, DecaneLogo, DecaneMark, type DecaneProvider, DecaneWordmark, type Eip1193Provider, type EthereumProviderOptions, ExportNotAuthorizedError, InvalidApiKeyError, InvalidPinError, InvalidRecoveryFileError, type KingsChatTokens, NetworkError, NewDeviceError, OriginNotAllowedError, type PortableBackup, PromptPinNotConfiguredError, ReconnectRequiredError, type RecordTransactionInput, RecoveryFailedError, type RecoveryProgress, type RecoveryShareFile, RecoveryWalletMismatchError, type SdkEvent, type SendTransactionRequest, SessionExpiredError, ShareCorruptedError, type SignMessageRequest, type SignTypedDataRequest, type SignedAuthorization, type SocialAuthState, type SocialConfig, SocialWalletModal, StaleDeviceShareError, type Theme, type TransactionRecord, type TxParams, type UnifiedWalletAccount, UnlockRequiredError, UserCancelledError, WalletSelector, WebAuthnNotSupportedError, type WrappedShareMeta, WrongPasswordError, createDecane, createDecaneConnect, createEthereumProvider, loginWithKingsChatPopup, startEmailAuth, useChainSwitch, useDecane, useEthereumProvider, useSendTransaction, useSignMessage, useSignTypedData, useSocialAuth, useSocialBalance, useSocialWallet, useWalletSelector, verifyEmailCode };

package/dist/index.d.ts

@@ -476,6 +476,8 @@ interface ConnectResult {
         tron?: string;
     };
     isNewUser: boolean;
+    /** Present when the provider released a profile — see {@link AuthProfile}. */
+    profile?: AuthProfile;
 }
 /** A recorded on-chain transaction in the user's history. */
 interface TransactionRecord {
@@ -701,11 +703,28 @@ interface WrappedShareMeta {
     pinSalt?: string;
     pinIterations?: number;
 }
+/**
+ * Who the user is, as the identity provider just described them.
+ *
+ * Passed through from the provider at sign-in and never stored by Decane — the
+ * backend keeps only an HMAC and a masked identifier, so there is no profile to
+ * look up later. Cache what you need at sign-in if you want to show a name
+ * after a page reload.
+ *
+ * Every field is optional because providers differ in what they release, and a
+ * user can withhold most of it. Email sign-in returns an empty profile.
+ */
+interface AuthProfile {
+    name?: string;
+    email?: string;
+    picture?: string;
+}
 interface AuthResult {
     jwt: string;
     isNewUser: boolean;
     hasShare: boolean;
     userId: string;
+    profile?: AuthProfile;
 }
 
 declare function createDecaneConnect(config: DecaneConnectConfig): Promise<DecaneConnect>;
@@ -1210,4 +1229,4 @@ declare function useSignTypedData(): {
     reset: () => void;
 };
 
-export { type ActiveSession, AttestationError, type AuthResult, BUILT_IN_CHAINS, type BalanceResult, type CAIP25Method, type CAIP25SessionRequest, type CAIP25SessionResult, CHAINS, CallSequenceError, type Chain, type ChainDescriptor, type ChainId, type ChainScope, type ChainSupport, type ChainType, type ConnectMode, type ConnectResult, type DecaneConfig, type DecaneConnect, type DecaneConnectConfig, DecaneConnectError, DecaneError, DecaneErrorCode, DecaneKit, DecaneLogo, DecaneMark, type DecaneProvider, DecaneWordmark, type Eip1193Provider, type EthereumProviderOptions, ExportNotAuthorizedError, InvalidApiKeyError, InvalidPinError, InvalidRecoveryFileError, type KingsChatTokens, NetworkError, NewDeviceError, OriginNotAllowedError, type PortableBackup, PromptPinNotConfiguredError, ReconnectRequiredError, type RecordTransactionInput, RecoveryFailedError, type RecoveryProgress, type RecoveryShareFile, RecoveryWalletMismatchError, type SdkEvent, type SendTransactionRequest, SessionExpiredError, ShareCorruptedError, type SignMessageRequest, type SignTypedDataRequest, type SignedAuthorization, type SocialAuthState, type SocialConfig, SocialWalletModal, StaleDeviceShareError, type Theme, type TransactionRecord, type TxParams, type UnifiedWalletAccount, UnlockRequiredError, UserCancelledError, WalletSelector, WebAuthnNotSupportedError, type WrappedShareMeta, WrongPasswordError, createDecane, createDecaneConnect, createEthereumProvider, loginWithKingsChatPopup, startEmailAuth, useChainSwitch, useDecane, useEthereumProvider, useSendTransaction, useSignMessage, useSignTypedData, useSocialAuth, useSocialBalance, useSocialWallet, useWalletSelector, verifyEmailCode };
+export { type ActiveSession, AttestationError, type AuthProfile, type AuthResult, BUILT_IN_CHAINS, type BalanceResult, type CAIP25Method, type CAIP25SessionRequest, type CAIP25SessionResult, CHAINS, CallSequenceError, type Chain, type ChainDescriptor, type ChainId, type ChainScope, type ChainSupport, type ChainType, type ConnectMode, type ConnectResult, type DecaneConfig, type DecaneConnect, type DecaneConnectConfig, DecaneConnectError, DecaneError, DecaneErrorCode, DecaneKit, DecaneLogo, DecaneMark, type DecaneProvider, DecaneWordmark, type Eip1193Provider, type EthereumProviderOptions, ExportNotAuthorizedError, InvalidApiKeyError, InvalidPinError, InvalidRecoveryFileError, type KingsChatTokens, NetworkError, NewDeviceError, OriginNotAllowedError, type PortableBackup, PromptPinNotConfiguredError, ReconnectRequiredError, type RecordTransactionInput, RecoveryFailedError, type RecoveryProgress, type RecoveryShareFile, RecoveryWalletMismatchError, type SdkEvent, type SendTransactionRequest, SessionExpiredError, ShareCorruptedError, type SignMessageRequest, type SignTypedDataRequest, type SignedAuthorization, type SocialAuthState, type SocialConfig, SocialWalletModal, StaleDeviceShareError, type Theme, type TransactionRecord, type TxParams, type UnifiedWalletAccount, UnlockRequiredError, UserCancelledError, WalletSelector, WebAuthnNotSupportedError, type WrappedShareMeta, WrongPasswordError, createDecane, createDecaneConnect, createEthereumProvider, loginWithKingsChatPopup, startEmailAuth, useChainSwitch, useDecane, useEthereumProvider, useSendTransaction, useSignMessage, useSignTypedData, useSocialAuth, useSocialBalance, useSocialWallet, useWalletSelector, verifyEmailCode };

package/dist/index.js

@@ -3837,7 +3837,11 @@ async function createDecaneConnect(config) {
     savePersisted(PERSIST_KEY, persisted);
     events.emit("connected");
     persistLiveSession();
-    return { addresses, isNewUser: result.isNewUser };
+    return {
+      addresses,
+      isNewUser: result.isNewUser,
+      ...result.profile ? { profile: result.profile } : {}
+    };
   }
   const client = {
     async connect() {
@@ -3872,11 +3876,23 @@ async function createDecaneConnect(config) {
         throw new CallSequenceError(`Google sign-in failed: ${decaneError}`);
       }
       if (decaneJwt) {
+        const name = params.get("decane_name");
+        const email = params.get("decane_email");
+        const picture = params.get("decane_picture");
+        const profile = {
+          ...name ? { name } : {},
+          ...email ? { email } : {},
+          ...picture ? { picture } : {}
+        };
         const result = {
           jwt: decaneJwt,
           userId: params.get("decane_user_id") ?? "",
           isNewUser: params.get("decane_is_new_user") === "true",
-          hasShare: params.get("decane_has_share") === "true"
+          hasShare: params.get("decane_has_share") === "true",
+          // Omitted entirely when Google released nothing, so callers can test
+          // `result.profile` rather than an object that is always present but
+          // sometimes empty.
+          ...Object.keys(profile).length ? { profile } : {}
         };
         window.history.replaceState({}, "", window.location.pathname);
         return handleAuthResult(result);