@embarkai/ui-kit 0.4.74 → 0.4.75

package/dist/index.d.ts

@@ -1167,6 +1167,52 @@ declare const TransactionsList: react__default.FC<TransactionsListProps>;
 
 declare function KeyshareBackupMenu(): react.JSX.Element;
 
+interface TourStepAction {
+    caption: string;
+    onClick: () => void;
+}
+interface TourStep {
+    /** step's target element ID */
+    elId: string;
+    /** tooltip's title */
+    title: string;
+    /** tooltip's description */
+    description: string;
+    /** hide "Hide" button */
+    forced?: boolean;
+    /** wait for X secs */
+    waitSecs?: number;
+    /** */
+    actions?: TourStepAction[];
+    /** callback invoked when the user proceeds to the next step */
+    onNext?: () => void;
+}
+
+declare class Onboarder {
+    private tour;
+    private tourPointer;
+    private elements;
+    /** deferred DOM observer */
+    private domObserverTimer;
+    private domObserver;
+    /** deferred resize observer */
+    private resizeObserverTimer;
+    private resizeObserver;
+    /** TOUR */
+    startTour(tour: TourStep[]): void;
+    endTour(): void;
+    next(): void;
+    /**
+     * Registers an element with the onboarder.
+     * @param onboardingElementId - Unique onboarding element name to register.
+     * @param elementRef - The ref of the element to register.
+     */
+    registerElement(onboardingElementId: string, elementRef?: HTMLElement | null): void;
+    getCurrentStep(): TourStep | null;
+    getCurrentPointer(): number;
+}
+declare const onboarder: Onboarder;
+
 interface RecoveryStatsDeviceEntry {
     deviceId: string;
     name?: string;
@@ -2251,47 +2297,7 @@ declare function useSmartAccountTransactions(): {
     }>;
 };
 
-interface TourStepAction {
-    caption: string;
-    onClick: () => void;
-}
-interface TourStep {
-    /** step's target element ID */
-    elId: string;
-    /** tooltip's title */
-    title: string;
-    /** tooltip's description */
-    description: string;
-    /** wait for X secs */
-    waitSecs?: number;
-    /** */
-    actions?: TourStepAction[];
-    /** callback invoked when the user proceeds to the next step */
-    onNext?: () => void;
-}
-declare class Onboarder {
-    private tour;
-    private tourPointer;
-    private elements;
-    /** deferred DOM observer */
-    private domObserverTimer;
-    private domObserver;
-    /** deferred resize observer */
-    private resizeObserverTimer;
-    private resizeObserver;
-    /** TOUR */
-    startTour(tour: TourStep[]): void;
-    endTour(): void;
-    next(): void;
-    /**
-     * Registers an element with the onboarder.
-     * @param onboardingElementId - Unique onboarding element name to register.
-     * @param elementRef - The ref of the element to register.
-     */
-    registerElement(onboardingElementId: string, elementRef?: HTMLElement | null): void;
-    getCurrentStep(): TourStep | null;
-}
-declare const onboarder: Onboarder;
+declare const ONBOARDING_TOURS: Partial<Record<PageKey, () => TourStep[]>>;
 
 type FinchpayTransactionStatus = 'CREATED' | 'PROCESSING' | 'REFUNDED' | 'SENDING' | 'HOLD' | 'COMPLETE' | 'ERROR' | 'EXPIRED' | 'REJECTED_BY_ANTI_FRAUD';
 interface FinchpayTxPayload {
@@ -2388,11 +2394,6 @@ declare function getInProgressOnrampTransactionsList(params: GetTransactionsList
     inProgressTXs: (BinanceTransaction | FinchpayTransaction)[];
 }>;
 
-declare const BUY_MENU_BINANCE_TOUR: TourStep[];
-
-declare const SEND_MENU_TOUR: TourStep[];
-declare const BRIDGE_MENU_TOUR: TourStep[];
-
 declare const NETWORKS_ICONS: Record<number, FC<SVGProps<SVGSVGElement>>>;
 
 declare const TOKENS_ICONS: Record<string, FC<SVGProps<SVGSVGElement>>>;
@@ -2459,10 +2460,30 @@ declare const PASSPORT_TRANSLATIONS: {
                     oops: string;
                 };
                 onboarding: {
+                    embarkAI: {
+                        title: string;
+                        description: string;
+                    };
+                    userSection: {
+                        title: string;
+                        description: string;
+                    };
                     tourButton: {
                         title: string;
                         description: string;
                     };
+                    chainButton: {
+                        title: string;
+                        description: string;
+                    };
+                    logoutButton: {
+                        title: string;
+                        description: string;
+                    };
+                    settingsMenu: {
+                        title: string;
+                        description: string;
+                    };
                 };
             };
             auth: {
@@ -2503,6 +2524,24 @@ declare const PASSPORT_TRANSLATIONS: {
                 receive: string;
                 buy: string;
                 assets: string;
+                onboarding: {
+                    sendButton: {
+                        title: string;
+                        description: string;
+                    };
+                    receiveButton: {
+                        title: string;
+                        description: string;
+                    };
+                    buyButton: {
+                        title: string;
+                        description: string;
+                    };
+                    portfolioButton: {
+                        title: string;
+                        description: string;
+                    };
+                };
             };
             sendMenu: {
                 title: string;
@@ -2619,6 +2658,12 @@ declare const PASSPORT_TRANSLATIONS: {
                 copyAddress: string;
                 warning: string;
                 share: string;
+                onboarding: {
+                    receiveMenu: {
+                        title: string;
+                        description: string;
+                    };
+                };
             };
             buyMenu: {
                 title: string;
@@ -2690,6 +2735,12 @@ declare const PASSPORT_TRANSLATIONS: {
                 noTransactions: string;
                 internalTransactions: string;
                 comingSoon: string;
+                onboarding: {
+                    transactionsMenu: {
+                        title: string;
+                        description: string;
+                    };
+                };
             };
             kycMenu: {
                 title: string;
@@ -2724,6 +2775,12 @@ declare const PASSPORT_TRANSLATIONS: {
                     welcome: string;
                     message: string;
                 };
+                onboarding: {
+                    nicknameMenu: {
+                        title: string;
+                        description: string;
+                    };
+                };
             };
             profilesMenu: {
                 title: string;
@@ -2743,6 +2800,12 @@ declare const PASSPORT_TRANSLATIONS: {
                 unlinkTitle: string;
                 unlinkConfirm: string;
                 unlinkPlaceholder: string;
+                onboarding: {
+                    profilesMenu: {
+                        title: string;
+                        description: string;
+                    };
+                };
             };
             securityMenu: {
                 title: string;
@@ -2769,6 +2832,43 @@ declare const PASSPORT_TRANSLATIONS: {
                 };
                 lastBackup: string;
                 lastBackupMeta: string;
+                onboarding: {
+                    securityMenu: {
+                        title: string;
+                        description: string;
+                    };
+                    keyshare: {
+                        title: string;
+                        description: string;
+                        detailsButton: string;
+                        details: {
+                            concept: {
+                                title: string;
+                                description: string;
+                            };
+                            server: {
+                                title: string;
+                                description: string;
+                            };
+                            local: {
+                                title: string;
+                                description: string;
+                            };
+                            vault: {
+                                title: string;
+                                description: string;
+                            };
+                        };
+                    };
+                    keyshareExistingVaultBkp: {
+                        title: string;
+                        description: string;
+                    };
+                    connectedApps: {
+                        title: string;
+                        description: string;
+                    };
+                };
             };
             backupMenu: {
                 title: string;
@@ -2787,6 +2887,32 @@ declare const PASSPORT_TRANSLATIONS: {
                 fileCreate: string;
                 fileRestore: string;
                 cloud: string;
+                onboarding: {
+                    backupMenu: {
+                        title: string;
+                        description: string;
+                    };
+                    backupEncryptionMethod: {
+                        title: string;
+                        description: string;
+                    };
+                    backupEncryptionPassword: {
+                        title: string;
+                        description: string;
+                    };
+                    backupEncryptionPasskey: {
+                        title: string;
+                        description: string;
+                    };
+                    backupStatus: {
+                        title: string;
+                        description: string;
+                    };
+                    backupAdvanced: {
+                        title: string;
+                        description: string;
+                    };
+                };
             };
             restoreMenu: {
                 title: string;
@@ -2806,6 +2932,15 @@ declare const PASSPORT_TRANSLATIONS: {
                     confirmButton: string;
                     cancelButton: string;
                 };
+                onboarding: {
+                    chainMenu: {
+                        title: string;
+                        description: string;
+                    };
+                };
+            };
+            guardiansMenu: {
+                title: string;
             };
         };
     };
@@ -2863,10 +2998,30 @@ declare const PASSPORT_TRANSLATIONS: {
                     oops: string;
                 };
                 onboarding: {
+                    embarkAI: {
+                        title: string;
+                        description: string;
+                    };
+                    userSection: {
+                        title: string;
+                        description: string;
+                    };
                     tourButton: {
                         title: string;
                         description: string;
                     };
+                    chainButton: {
+                        title: string;
+                        description: string;
+                    };
+                    logoutButton: {
+                        title: string;
+                        description: string;
+                    };
+                    settingsMenu: {
+                        title: string;
+                        description: string;
+                    };
                 };
             };
             auth: {
@@ -2907,6 +3062,24 @@ declare const PASSPORT_TRANSLATIONS: {
                 receive: string;
                 buy: string;
                 assets: string;
+                onboarding: {
+                    sendButton: {
+                        title: string;
+                        description: string;
+                    };
+                    receiveButton: {
+                        title: string;
+                        description: string;
+                    };
+                    buyButton: {
+                        title: string;
+                        description: string;
+                    };
+                    portfolioButton: {
+                        title: string;
+                        description: string;
+                    };
+                };
             };
             sendMenu: {
                 title: string;
@@ -3023,6 +3196,12 @@ declare const PASSPORT_TRANSLATIONS: {
                 copyAddress: string;
                 warning: string;
                 share: string;
+                onboarding: {
+                    receiveMenu: {
+                        title: string;
+                        description: string;
+                    };
+                };
             };
             buyMenu: {
                 title: string;
@@ -3094,6 +3273,12 @@ declare const PASSPORT_TRANSLATIONS: {
                 noTransactions: string;
                 internalTransactions: string;
                 comingSoon: string;
+                onboarding: {
+                    transactionsMenu: {
+                        title: string;
+                        description: string;
+                    };
+                };
             };
             kycMenu: {
                 title: string;
@@ -3128,6 +3313,12 @@ declare const PASSPORT_TRANSLATIONS: {
                     welcome: string;
                     message: string;
                 };
+                onboarding: {
+                    nicknameMenu: {
+                        title: string;
+                        description: string;
+                    };
+                };
             };
             profilesMenu: {
                 title: string;
@@ -3147,6 +3338,12 @@ declare const PASSPORT_TRANSLATIONS: {
                 unlinkTitle: string;
                 unlinkConfirm: string;
                 unlinkPlaceholder: string;
+                onboarding: {
+                    profilesMenu: {
+                        title: string;
+                        description: string;
+                    };
+                };
             };
             securityMenu: {
                 title: string;
@@ -3173,6 +3370,43 @@ declare const PASSPORT_TRANSLATIONS: {
                 };
                 lastBackup: string;
                 lastBackupMeta: string;
+                onboarding: {
+                    securityMenu: {
+                        title: string;
+                        description: string;
+                    };
+                    keyshare: {
+                        title: string;
+                        description: string;
+                        detailsButton: string;
+                        details: {
+                            concept: {
+                                title: string;
+                                description: string;
+                            };
+                            server: {
+                                title: string;
+                                description: string;
+                            };
+                            local: {
+                                title: string;
+                                description: string;
+                            };
+                            vault: {
+                                title: string;
+                                description: string;
+                            };
+                        };
+                    };
+                    keyshareExistingVaultBkp: {
+                        title: string;
+                        description: string;
+                    };
+                    connectedApps: {
+                        title: string;
+                        description: string;
+                    };
+                };
             };
             backupMenu: {
                 title: string;
@@ -3191,6 +3425,32 @@ declare const PASSPORT_TRANSLATIONS: {
                 fileCreate: string;
                 fileRestore: string;
                 cloud: string;
+                onboarding: {
+                    backupMenu: {
+                        title: string;
+                        description: string;
+                    };
+                    backupEncryptionMethod: {
+                        title: string;
+                        description: string;
+                    };
+                    backupEncryptionPassword: {
+                        title: string;
+                        description: string;
+                    };
+                    backupEncryptionPasskey: {
+                        title: string;
+                        description: string;
+                    };
+                    backupStatus: {
+                        title: string;
+                        description: string;
+                    };
+                    backupAdvanced: {
+                        title: string;
+                        description: string;
+                    };
+                };
             };
             restoreMenu: {
                 title: string;
@@ -3210,6 +3470,15 @@ declare const PASSPORT_TRANSLATIONS: {
                     confirmButton: string;
                     cancelButton: string;
                 };
+                onboarding: {
+                    chainMenu: {
+                        title: string;
+                        description: string;
+                    };
+                };
+            };
+            guardiansMenu: {
+                title: string;
             };
         };
     };
@@ -3267,10 +3536,30 @@ declare const PASSPORT_TRANSLATIONS: {
                     oops: string;
                 };
                 onboarding: {
+                    embarkAI: {
+                        title: string;
+                        description: string;
+                    };
+                    userSection: {
+                        title: string;
+                        description: string;
+                    };
                     tourButton: {
                         title: string;
                         description: string;
                     };
+                    chainButton: {
+                        title: string;
+                        description: string;
+                    };
+                    logoutButton: {
+                        title: string;
+                        description: string;
+                    };
+                    settingsMenu: {
+                        title: string;
+                        description: string;
+                    };
                 };
             };
             auth: {
@@ -3311,6 +3600,24 @@ declare const PASSPORT_TRANSLATIONS: {
                 receive: string;
                 buy: string;
                 assets: string;
+                onboarding: {
+                    sendButton: {
+                        title: string;
+                        description: string;
+                    };
+                    receiveButton: {
+                        title: string;
+                        description: string;
+                    };
+                    buyButton: {
+                        title: string;
+                        description: string;
+                    };
+                    portfolioButton: {
+                        title: string;
+                        description: string;
+                    };
+                };
             };
             sendMenu: {
                 title: string;
@@ -3427,6 +3734,12 @@ declare const PASSPORT_TRANSLATIONS: {
                 copyAddress: string;
                 warning: string;
                 share: string;
+                onboarding: {
+                    receiveMenu: {
+                        title: string;
+                        description: string;
+                    };
+                };
             };
             buyMenu: {
                 title: string;
@@ -3498,6 +3811,12 @@ declare const PASSPORT_TRANSLATIONS: {
                 noTransactions: string;
                 internalTransactions: string;
                 comingSoon: string;
+                onboarding: {
+                    transactionsMenu: {
+                        title: string;
+                        description: string;
+                    };
+                };
             };
             kycMenu: {
                 title: string;
@@ -3532,6 +3851,12 @@ declare const PASSPORT_TRANSLATIONS: {
                     welcome: string;
                     message: string;
                 };
+                onboarding: {
+                    nicknameMenu: {
+                        title: string;
+                        description: string;
+                    };
+                };
             };
             profilesMenu: {
                 title: string;
@@ -3551,6 +3876,12 @@ declare const PASSPORT_TRANSLATIONS: {
                 unlinkTitle: string;
                 unlinkConfirm: string;
                 unlinkPlaceholder: string;
+                onboarding: {
+                    profilesMenu: {
+                        title: string;
+                        description: string;
+                    };
+                };
             };
             securityMenu: {
                 title: string;
@@ -3577,6 +3908,43 @@ declare const PASSPORT_TRANSLATIONS: {
                 };
                 lastBackup: string;
                 lastBackupMeta: string;
+                onboarding: {
+                    securityMenu: {
+                        title: string;
+                        description: string;
+                    };
+                    keyshare: {
+                        title: string;
+                        description: string;
+                        detailsButton: string;
+                        details: {
+                            concept: {
+                                title: string;
+                                description: string;
+                            };
+                            server: {
+                                title: string;
+                                description: string;
+                            };
+                            local: {
+                                title: string;
+                                description: string;
+                            };
+                            vault: {
+                                title: string;
+                                description: string;
+                            };
+                        };
+                    };
+                    keyshareExistingVaultBkp: {
+                        title: string;
+                        description: string;
+                    };
+                    connectedApps: {
+                        title: string;
+                        description: string;
+                    };
+                };
             };
             backupMenu: {
                 title: string;
@@ -3595,6 +3963,32 @@ declare const PASSPORT_TRANSLATIONS: {
                 fileCreate: string;
                 fileRestore: string;
                 cloud: string;
+                onboarding: {
+                    backupMenu: {
+                        title: string;
+                        description: string;
+                    };
+                    backupEncryptionMethod: {
+                        title: string;
+                        description: string;
+                    };
+                    backupEncryptionPassword: {
+                        title: string;
+                        description: string;
+                    };
+                    backupEncryptionPasskey: {
+                        title: string;
+                        description: string;
+                    };
+                    backupStatus: {
+                        title: string;
+                        description: string;
+                    };
+                    backupAdvanced: {
+                        title: string;
+                        description: string;
+                    };
+                };
             };
             restoreMenu: {
                 title: string;
@@ -3614,6 +4008,15 @@ declare const PASSPORT_TRANSLATIONS: {
                     confirmButton: string;
                     cancelButton: string;
                 };
+                onboarding: {
+                    chainMenu: {
+                        title: string;
+                        description: string;
+                    };
+                };
+            };
+            guardiansMenu: {
+                title: string;
             };
         };
     };
@@ -3652,4 +4055,4 @@ declare function getLanguageIcon(languageKey: string): string | null;
 
 declare const USER_PROFILE_QUERY_KEY: string;
 
-export { AccountAbstractionError, type AccountSession, Address, type AddressProps, type Asset, BRIDGE_MENU_TOUR, BUY_MENU_BINANCE_TOUR, type BatchOperation, type CallbacksConfig, ConnectWalletButton, type ConnectWalletButtonProps, type DirectTransactionParams, ErrorCodes, type FingerprintVerificationResult, Hash, type HashProps, KeyshareBackupMenu as KeyshareBackup, LOCAL_STORAGE_I18N_KEY, LangToggle, NETWORKS_ICONS, type NicknameAvailability, type NicknameAvatar, type NicknameChangeResult, type NicknameInfo, type NicknameResolution, type NicknameResolveRequest, type NicknameResolvedTarget, type NicknameValidationResult, PASSPORT_TRANSLATIONS, PageKey, type PageOpenParams, type PrepareBatchUserOperationParams, Provider, type ProviderConfig, type ProviderDetail, type ProviderProps, type RegisterSmartAccountResult, SEND_MENU_TOUR, type SendBatchUserOperationParams, type SendTransactionParams, type SendTransactionResult, SessionExpiredError, type SignTypedDataParams, type SmartAccountEntry, TOKENS_ICONS, ThemeToggle, type TokenBalance, type Transaction, TransactionsList, type TransferToLinkedParams, type TypedDataDomain, type TypedDataField, USER_PROFILE_QUERY_KEY, type UpdateProfileRequest, type UseDirectWalletReturn, type UseErc3643ComplianceOptions, type UseErc3643ComplianceResult, type UseLogoutReturn, type UseNicknameResolveOptions, type UseNicknameResolveResult, type UseSendDirectTransactionReturn, type UseSendTransactionReturn, type UseTransferToLinkedReturn, type UseUserOpStatusOptions, type UseUserOpStatusReturn, type UseWalletModeReturn, type UserOpMempool, type SendTransactionParams$1 as UserOpSendTransactionParams, type UserOpState, UserOpStatus, type UserOpStatusProps, type UserOperation, type UserOperationByHash, type UserOperationReceipt, UserOperationTimeoutError, type UserProfile, UserRejectedError, WALLET_ICONS, type WaitForReceiptOptions, type WalletMode, type WalletReadyStatus, type WatchToken, checkWrapedTokenSymbol, combineI18NResources, createAccountAbstractionError, deployAccount, destroyIframeManager, generateFingerprint, getAllSmartAccounts, getAssetRate, getAvailableLanguages, getExplorerUrl, getIframeManager, getInProgressOnrampTransactionsList, getLanguageIcon, getShareRecoveryStats, getSmartAccountForChain, getUserOperationByHash, getUserOperationReceipt, getUserProfile, isSessionExpiredError, looksLikeNickname, onboarder, prepareBatchUserOperation, prepareUserOperation, requireActiveChainId, sendBatchUserOperation, sendUserOperation, signTypedData, updateUserProfile, useAccountSession, useActiveChainId, useAddress, useAssetUsdtRate, useAssets, useBalance, useBlockscoutAssets, useColorMode, useConnectedApps, useDirectWallet, useErc3643Compliance, useError, useHasServerVault, useHydrated, useIFrameReady, useIsMobileView, useKeyshareRecoveryStats, useLinkedProfiles, useLoadingStatus, useLogout, useNativeWalletSignature, useNicknameResolve, useOpenPage, useProviderConfig, useRecoveryUserId, useSendDirectTransaction, useSendTransaction, useSession, useSmartAccountTransactions, useTokenBalance, useTokenInfo, useTransactions, useTransferToLinkedWallet, useUserOpStatus, useWalletMode, verifyFingerprint, verifyFingerprintDetailed, waitForStoreHydration, waitForUserOperationReceipt };
+export { AccountAbstractionError, type AccountSession, Address, type AddressProps, type Asset, type BatchOperation, type CallbacksConfig, ConnectWalletButton, type ConnectWalletButtonProps, type DirectTransactionParams, ErrorCodes, type FingerprintVerificationResult, Hash, type HashProps, KeyshareBackupMenu as KeyshareBackup, LOCAL_STORAGE_I18N_KEY, LangToggle, NETWORKS_ICONS, type NicknameAvailability, type NicknameAvatar, type NicknameChangeResult, type NicknameInfo, type NicknameResolution, type NicknameResolveRequest, type NicknameResolvedTarget, type NicknameValidationResult, ONBOARDING_TOURS, PASSPORT_TRANSLATIONS, PageKey, type PageOpenParams, type PrepareBatchUserOperationParams, Provider, type ProviderConfig, type ProviderDetail, type ProviderProps, type RegisterSmartAccountResult, type SendBatchUserOperationParams, type SendTransactionParams, type SendTransactionResult, SessionExpiredError, type SignTypedDataParams, type SmartAccountEntry, TOKENS_ICONS, ThemeToggle, type TokenBalance, type Transaction, TransactionsList, type TransferToLinkedParams, type TypedDataDomain, type TypedDataField, USER_PROFILE_QUERY_KEY, type UpdateProfileRequest, type UseDirectWalletReturn, type UseErc3643ComplianceOptions, type UseErc3643ComplianceResult, type UseLogoutReturn, type UseNicknameResolveOptions, type UseNicknameResolveResult, type UseSendDirectTransactionReturn, type UseSendTransactionReturn, type UseTransferToLinkedReturn, type UseUserOpStatusOptions, type UseUserOpStatusReturn, type UseWalletModeReturn, type UserOpMempool, type SendTransactionParams$1 as UserOpSendTransactionParams, type UserOpState, UserOpStatus, type UserOpStatusProps, type UserOperation, type UserOperationByHash, type UserOperationReceipt, UserOperationTimeoutError, type UserProfile, UserRejectedError, WALLET_ICONS, type WaitForReceiptOptions, type WalletMode, type WalletReadyStatus, type WatchToken, checkWrapedTokenSymbol, combineI18NResources, createAccountAbstractionError, deployAccount, destroyIframeManager, generateFingerprint, getAllSmartAccounts, getAssetRate, getAvailableLanguages, getExplorerUrl, getIframeManager, getInProgressOnrampTransactionsList, getLanguageIcon, getShareRecoveryStats, getSmartAccountForChain, getUserOperationByHash, getUserOperationReceipt, getUserProfile, isSessionExpiredError, looksLikeNickname, onboarder, prepareBatchUserOperation, prepareUserOperation, requireActiveChainId, sendBatchUserOperation, sendUserOperation, signTypedData, updateUserProfile, useAccountSession, useActiveChainId, useAddress, useAssetUsdtRate, useAssets, useBalance, useBlockscoutAssets, useColorMode, useConnectedApps, useDirectWallet, useErc3643Compliance, useError, useHasServerVault, useHydrated, useIFrameReady, useIsMobileView, useKeyshareRecoveryStats, useLinkedProfiles, useLoadingStatus, useLogout, useNativeWalletSignature, useNicknameResolve, useOpenPage, useProviderConfig, useRecoveryUserId, useSendDirectTransaction, useSendTransaction, useSession, useSmartAccountTransactions, useTokenBalance, useTokenInfo, useTransactions, useTransferToLinkedWallet, useUserOpStatus, useWalletMode, verifyFingerprint, verifyFingerprintDetailed, waitForStoreHydration, waitForUserOperationReceipt };