@lumiapassport/ui-kit 1.14.22 → 1.14.24

package/dist/index.d.cts

@@ -779,7 +779,8 @@ declare enum PageKey {
     UNLINK_PROVIDER = "unlink-provider",
     SECURITY = "security",
     KEYSARE_BACKUP = "keysare-backup",
-    KEYSHARE_RESTORE = "keyshare-restore"
+    KEYSHARE_RESTORE = "keyshare-restore",
+    NICKNAME_SETTINGS = "nickname-settings"
 }
 /** WIP: need to develop page options typeset, i.e options: AuthOpenOptions | BuyOpenOption etc  */
 interface PageOpenParams {
@@ -984,6 +985,95 @@ interface UseLogoutReturn {
  */
 declare function useLogout(): UseLogoutReturn;
 
+/**
+ * Nickname API types
+ * Types for nickname-related API responses and requests
+ */
+/**
+ * Detailed nickname information
+ * Returned by GET /api/auth/nickname
+ */
+interface NicknameInfo {
+    handle: string;
+    displayHandle: string;
+    createdAt: string;
+    changedAt: string | null;
+    changeCount: number;
+    canChange: boolean;
+    cooldownEndsAt: string | null;
+}
+/**
+ * Result of changing nickname
+ * Returned by PUT /api/auth/nickname
+ */
+interface NicknameChangeResult {
+    handle: string;
+    displayHandle: string;
+    previousHandle: string;
+    isFirstChange: boolean;
+}
+/**
+ * Nickname availability check result
+ * Returned by GET /api/auth/nicknames/{handle}/check
+ */
+interface NicknameAvailability {
+    handle: string;
+    available: boolean;
+    reason?: NicknameUnavailableReason;
+}
+type NicknameUnavailableReason = 'TAKEN' | 'RESERVED' | 'TOO_SHORT' | 'TOO_LONG' | 'INVALID_CHARS' | 'INVALID_UNDERSCORE';
+/**
+ * Nickname to wallet address resolution
+ * Returned by GET /api/auth/nicknames/{handle}/resolve
+ */
+interface NicknameResolution {
+    handle: string;
+    displayHandle: string;
+    walletAddress: `0x${string}`;
+    ownerAddress: `0x${string}`;
+}
+/**
+ * Client-side nickname validation result
+ */
+interface NicknameValidationResult {
+    valid: boolean;
+    error?: NicknameValidationError;
+}
+type NicknameValidationError = 'TOO_SHORT' | 'TOO_LONG' | 'INVALID_CHARS' | 'INVALID_UNDERSCORE';
+
+/**
+ * useNicknameResolve hook
+ * Public hook for resolving nicknames to wallet addresses
+ */
+
+interface UseNicknameResolveResult {
+    data: NicknameResolution | undefined;
+    isLoading: boolean;
+    isResolving: boolean;
+    isError: boolean;
+    isNotFound: boolean;
+    error: Error | null;
+    resolvedAddress: string | null;
+}
+/**
+ * Detect if input looks like a nickname (vs an address)
+ * - Starts with @ or contains only lowercase a-z, 0-9, underscore
+ * - Does not start with 0x
+ */
+declare function looksLikeNickname(input: string): boolean;
+/**
+ * Hook to resolve a nickname to a wallet address
+ *
+ * - Debounces API calls by 300ms
+ * - Only resolves when input looks like a nickname
+ * - Returns resolved address when found
+ *
+ * @param input - The recipient input (can be address or nickname)
+ * @param enabled - Whether resolution should be enabled (default: true)
+ * @returns Resolution data, loading states, error state, resolved address
+ */
+declare function useNicknameResolve(input: string, enabled?: boolean): UseNicknameResolveResult;
+
 declare const LUMIA_EXPLORER_URL: string;
 declare const lumiaBeam: Chain;
 
@@ -1016,6 +1106,7 @@ interface ProviderDetail {
 }
 /**
  * User profile information
+ * Extended to include nickname fields from backend
  */
 interface UserProfile {
     userId: string;
@@ -1029,6 +1120,10 @@ interface UserProfile {
         provider: 'sumsub' | 'uaepass' | 'custom';
         kycStatus: string;
     } | null;
+    nickname: string | null;
+    nicknameDisplay: string | null;
+    nicknameCanChange: boolean;
+    nicknameCooldownEndsAt: string | null;
 }
 interface UpdateProfileRequest {
     displayName?: string;
@@ -1401,4 +1496,4 @@ declare function useLumiaPassportLinkedProfiles(): {
     refresh: () => Promise<void>;
 };
 
-export { type AccountSession, Address, type AddressProps, type Asset, ConnectWalletButton, type ConnectWalletButtonProps, ErrorCodes, Hash, type HashProps, KeyshareBackupMenu as KeyshareBackup, LUMIA_EXPLORER_URL, LumiaLogo, type LumiaPassportCallbacks, type LumiaPassportConfig, LumiaPassportError, LumiaPassportProvider, type LumiaPassportProviderProps, LumiaPassportSessionProvider, LumiaRainbowKitProvider, LumiaWagmiProvider, PageKey, type PageOpenParams, type ProviderDetail, type SendTransactionParams, type SendTransactionResult, type SignTypedDataParams, ThemeToggle, type TokenBalance, type Transaction, TransactionsList, type TypedDataDomain, type TypedDataField, type UpdateProfileRequest, type UseLogoutReturn, type UseSendTransactionReturn, type UseUserOpStatusOptions, type UseUserOpStatusReturn, type UserOpMempool, type UserOpReceipt, type SendTransactionParams$1 as UserOpSendTransactionParams, type UserOpState, UserOpStatus, type UserOpStatusProps, type UserOperation, type UserProfile, UserRejectedError, type WalletReadyStatus, createLumiaPassportError, deployAccount, destroyIframeManager, getIframeManager, getUserProfile, lumiaBeam, prepareUserOperation, queryClient, sendUserOperation, signTypedData, updateUserProfile, useAssets, useLogout, useLumiaPassportAccountSession, useLumiaPassportAddress, useLumiaPassportBalance, useLumiaPassportColorMode, useLumiaPassportConfig, useLumiaPassportError, useLumiaPassportHasServerVault, useLumiaPassportIFrameReady, useLumiaPassportIsMobileView, useLumiaPassportLinkedProfiles, useLumiaPassportLoadingStatus, useLumiaPassportOpen, useLumiaPassportRecoveryUserId, useLumiaPassportSession, useSendTransaction, useSmartAccountTransactions, useTokenBalance, useTokenInfo, useTransactions, useUserOpStatus, wagmiConfig };
+export { type AccountSession, Address, type AddressProps, type Asset, ConnectWalletButton, type ConnectWalletButtonProps, ErrorCodes, Hash, type HashProps, KeyshareBackupMenu as KeyshareBackup, LUMIA_EXPLORER_URL, LumiaLogo, type LumiaPassportCallbacks, type LumiaPassportConfig, LumiaPassportError, LumiaPassportProvider, type LumiaPassportProviderProps, LumiaPassportSessionProvider, LumiaRainbowKitProvider, LumiaWagmiProvider, type NicknameAvailability, type NicknameChangeResult, type NicknameInfo, type NicknameResolution, type NicknameValidationResult, PageKey, type PageOpenParams, type ProviderDetail, type SendTransactionParams, type SendTransactionResult, type SignTypedDataParams, ThemeToggle, type TokenBalance, type Transaction, TransactionsList, type TypedDataDomain, type TypedDataField, type UpdateProfileRequest, type UseLogoutReturn, type UseNicknameResolveResult, type UseSendTransactionReturn, type UseUserOpStatusOptions, type UseUserOpStatusReturn, type UserOpMempool, type UserOpReceipt, type SendTransactionParams$1 as UserOpSendTransactionParams, type UserOpState, UserOpStatus, type UserOpStatusProps, type UserOperation, type UserProfile, UserRejectedError, type WalletReadyStatus, createLumiaPassportError, deployAccount, destroyIframeManager, getIframeManager, getUserProfile, looksLikeNickname, lumiaBeam, prepareUserOperation, queryClient, sendUserOperation, signTypedData, updateUserProfile, useAssets, useLogout, useLumiaPassportAccountSession, useLumiaPassportAddress, useLumiaPassportBalance, useLumiaPassportColorMode, useLumiaPassportConfig, useLumiaPassportError, useLumiaPassportHasServerVault, useLumiaPassportIFrameReady, useLumiaPassportIsMobileView, useLumiaPassportLinkedProfiles, useLumiaPassportLoadingStatus, useLumiaPassportOpen, useLumiaPassportRecoveryUserId, useLumiaPassportSession, useNicknameResolve, useSendTransaction, useSmartAccountTransactions, useTokenBalance, useTokenInfo, useTransactions, useUserOpStatus, wagmiConfig };

package/dist/index.d.ts

@@ -779,7 +779,8 @@ declare enum PageKey {
     UNLINK_PROVIDER = "unlink-provider",
     SECURITY = "security",
     KEYSARE_BACKUP = "keysare-backup",
-    KEYSHARE_RESTORE = "keyshare-restore"
+    KEYSHARE_RESTORE = "keyshare-restore",
+    NICKNAME_SETTINGS = "nickname-settings"
 }
 /** WIP: need to develop page options typeset, i.e options: AuthOpenOptions | BuyOpenOption etc  */
 interface PageOpenParams {
@@ -984,6 +985,95 @@ interface UseLogoutReturn {
  */
 declare function useLogout(): UseLogoutReturn;
 
+/**
+ * Nickname API types
+ * Types for nickname-related API responses and requests
+ */
+/**
+ * Detailed nickname information
+ * Returned by GET /api/auth/nickname
+ */
+interface NicknameInfo {
+    handle: string;
+    displayHandle: string;
+    createdAt: string;
+    changedAt: string | null;
+    changeCount: number;
+    canChange: boolean;
+    cooldownEndsAt: string | null;
+}
+/**
+ * Result of changing nickname
+ * Returned by PUT /api/auth/nickname
+ */
+interface NicknameChangeResult {
+    handle: string;
+    displayHandle: string;
+    previousHandle: string;
+    isFirstChange: boolean;
+}
+/**
+ * Nickname availability check result
+ * Returned by GET /api/auth/nicknames/{handle}/check
+ */
+interface NicknameAvailability {
+    handle: string;
+    available: boolean;
+    reason?: NicknameUnavailableReason;
+}
+type NicknameUnavailableReason = 'TAKEN' | 'RESERVED' | 'TOO_SHORT' | 'TOO_LONG' | 'INVALID_CHARS' | 'INVALID_UNDERSCORE';
+/**
+ * Nickname to wallet address resolution
+ * Returned by GET /api/auth/nicknames/{handle}/resolve
+ */
+interface NicknameResolution {
+    handle: string;
+    displayHandle: string;
+    walletAddress: `0x${string}`;
+    ownerAddress: `0x${string}`;
+}
+/**
+ * Client-side nickname validation result
+ */
+interface NicknameValidationResult {
+    valid: boolean;
+    error?: NicknameValidationError;
+}
+type NicknameValidationError = 'TOO_SHORT' | 'TOO_LONG' | 'INVALID_CHARS' | 'INVALID_UNDERSCORE';
+
+/**
+ * useNicknameResolve hook
+ * Public hook for resolving nicknames to wallet addresses
+ */
+
+interface UseNicknameResolveResult {
+    data: NicknameResolution | undefined;
+    isLoading: boolean;
+    isResolving: boolean;
+    isError: boolean;
+    isNotFound: boolean;
+    error: Error | null;
+    resolvedAddress: string | null;
+}
+/**
+ * Detect if input looks like a nickname (vs an address)
+ * - Starts with @ or contains only lowercase a-z, 0-9, underscore
+ * - Does not start with 0x
+ */
+declare function looksLikeNickname(input: string): boolean;
+/**
+ * Hook to resolve a nickname to a wallet address
+ *
+ * - Debounces API calls by 300ms
+ * - Only resolves when input looks like a nickname
+ * - Returns resolved address when found
+ *
+ * @param input - The recipient input (can be address or nickname)
+ * @param enabled - Whether resolution should be enabled (default: true)
+ * @returns Resolution data, loading states, error state, resolved address
+ */
+declare function useNicknameResolve(input: string, enabled?: boolean): UseNicknameResolveResult;
+
 declare const LUMIA_EXPLORER_URL: string;
 declare const lumiaBeam: Chain;
 
@@ -1016,6 +1106,7 @@ interface ProviderDetail {
 }
 /**
  * User profile information
+ * Extended to include nickname fields from backend
  */
 interface UserProfile {
     userId: string;
@@ -1029,6 +1120,10 @@ interface UserProfile {
         provider: 'sumsub' | 'uaepass' | 'custom';
         kycStatus: string;
     } | null;
+    nickname: string | null;
+    nicknameDisplay: string | null;
+    nicknameCanChange: boolean;
+    nicknameCooldownEndsAt: string | null;
 }
 interface UpdateProfileRequest {
     displayName?: string;
@@ -1401,4 +1496,4 @@ declare function useLumiaPassportLinkedProfiles(): {
     refresh: () => Promise<void>;
 };
 
-export { type AccountSession, Address, type AddressProps, type Asset, ConnectWalletButton, type ConnectWalletButtonProps, ErrorCodes, Hash, type HashProps, KeyshareBackupMenu as KeyshareBackup, LUMIA_EXPLORER_URL, LumiaLogo, type LumiaPassportCallbacks, type LumiaPassportConfig, LumiaPassportError, LumiaPassportProvider, type LumiaPassportProviderProps, LumiaPassportSessionProvider, LumiaRainbowKitProvider, LumiaWagmiProvider, PageKey, type PageOpenParams, type ProviderDetail, type SendTransactionParams, type SendTransactionResult, type SignTypedDataParams, ThemeToggle, type TokenBalance, type Transaction, TransactionsList, type TypedDataDomain, type TypedDataField, type UpdateProfileRequest, type UseLogoutReturn, type UseSendTransactionReturn, type UseUserOpStatusOptions, type UseUserOpStatusReturn, type UserOpMempool, type UserOpReceipt, type SendTransactionParams$1 as UserOpSendTransactionParams, type UserOpState, UserOpStatus, type UserOpStatusProps, type UserOperation, type UserProfile, UserRejectedError, type WalletReadyStatus, createLumiaPassportError, deployAccount, destroyIframeManager, getIframeManager, getUserProfile, lumiaBeam, prepareUserOperation, queryClient, sendUserOperation, signTypedData, updateUserProfile, useAssets, useLogout, useLumiaPassportAccountSession, useLumiaPassportAddress, useLumiaPassportBalance, useLumiaPassportColorMode, useLumiaPassportConfig, useLumiaPassportError, useLumiaPassportHasServerVault, useLumiaPassportIFrameReady, useLumiaPassportIsMobileView, useLumiaPassportLinkedProfiles, useLumiaPassportLoadingStatus, useLumiaPassportOpen, useLumiaPassportRecoveryUserId, useLumiaPassportSession, useSendTransaction, useSmartAccountTransactions, useTokenBalance, useTokenInfo, useTransactions, useUserOpStatus, wagmiConfig };
+export { type AccountSession, Address, type AddressProps, type Asset, ConnectWalletButton, type ConnectWalletButtonProps, ErrorCodes, Hash, type HashProps, KeyshareBackupMenu as KeyshareBackup, LUMIA_EXPLORER_URL, LumiaLogo, type LumiaPassportCallbacks, type LumiaPassportConfig, LumiaPassportError, LumiaPassportProvider, type LumiaPassportProviderProps, LumiaPassportSessionProvider, LumiaRainbowKitProvider, LumiaWagmiProvider, type NicknameAvailability, type NicknameChangeResult, type NicknameInfo, type NicknameResolution, type NicknameValidationResult, PageKey, type PageOpenParams, type ProviderDetail, type SendTransactionParams, type SendTransactionResult, type SignTypedDataParams, ThemeToggle, type TokenBalance, type Transaction, TransactionsList, type TypedDataDomain, type TypedDataField, type UpdateProfileRequest, type UseLogoutReturn, type UseNicknameResolveResult, type UseSendTransactionReturn, type UseUserOpStatusOptions, type UseUserOpStatusReturn, type UserOpMempool, type UserOpReceipt, type SendTransactionParams$1 as UserOpSendTransactionParams, type UserOpState, UserOpStatus, type UserOpStatusProps, type UserOperation, type UserProfile, UserRejectedError, type WalletReadyStatus, createLumiaPassportError, deployAccount, destroyIframeManager, getIframeManager, getUserProfile, looksLikeNickname, lumiaBeam, prepareUserOperation, queryClient, sendUserOperation, signTypedData, updateUserProfile, useAssets, useLogout, useLumiaPassportAccountSession, useLumiaPassportAddress, useLumiaPassportBalance, useLumiaPassportColorMode, useLumiaPassportConfig, useLumiaPassportError, useLumiaPassportHasServerVault, useLumiaPassportIFrameReady, useLumiaPassportIsMobileView, useLumiaPassportLinkedProfiles, useLumiaPassportLoadingStatus, useLumiaPassportOpen, useLumiaPassportRecoveryUserId, useLumiaPassportSession, useNicknameResolve, useSendTransaction, useSmartAccountTransactions, useTokenBalance, useTokenInfo, useTransactions, useUserOpStatus, wagmiConfig };