Skip to content

Privacy-first password manager with built-in email aliasing. Fully encrypted and self-hostable.

Add refresh trigger to item view pages in all clients

Leendert de Borstabea4e6946c7
diff --git a/apps/browser-extension/src/entrypoints/popup/hooks/useVaultRefresh.ts b/apps/browser-extension/src/entrypoints/popup/hooks/useVaultRefresh.ts
new file mode 100644
index 000000000..33d6f2185
--- /dev/null
+++ b/apps/browser-extension/src/entrypoints/popup/hooks/useVaultRefresh.ts
@@ -0,0 +1,49 @@
+import { useCallback } from 'react';
+
+import { useApp } from '@/entrypoints/popup/context/AppContext';
+import { useDb } from '@/entrypoints/popup/context/DbContext';
+import { useLoading } from '@/entrypoints/popup/context/LoadingContext';
+import { useVaultSync } from '@/entrypoints/popup/hooks/useVaultSync';
+
+import { logFailure } from '@/utils/Diagnostics';
+
+/** Minimum time the full screen spinner stays up, so a fast refresh still visibly does something. */
+const MIN_SPINNER_MS = 150;
+
+/**
+ * Manual "refresh" action: syncs the vault with the server. Pages reload their data when the (new) sqlite client is set.
+ */
+export const useVaultRefresh = (): (() => Promise<void>) => {
+ const dbContext = useDb();
+ const app = useApp();
+ const { showLoading, hideLoading } = useLoading();
+ const { syncVault } = useVaultSync();
+
+ return useCallback(async (): Promise<void> => {
+ if (!dbContext?.sqliteClient) {
+ return;
+ }
+
+ const startedAt = Date.now();
+ showLoading();
+ try {
+ await syncVault({
+ /**
+ * On error.
+ */
+ onError: (error) => {
+ logFailure('Error syncing vault', error);
+ },
+ });
+ } catch (err) {
+ logFailure('Error refreshing vault', err);
+ await app.logout('Error while syncing vault, please re-authenticate.');
+ } finally {
+ const remaining = MIN_SPINNER_MS - (Date.now() - startedAt);
+ if (remaining > 0) {
+ await new Promise(resolve => setTimeout(resolve, remaining));
+ }
+ hideLoading();
+ }
+ }, [dbContext, app, syncVault, showLoading, hideLoading]);
+};
diff --git a/apps/browser-extension/src/entrypoints/popup/pages/items/ItemDetails.tsx b/apps/browser-extension/src/entrypoints/popup/pages/items/ItemDetails.tsx
index 09877e684..fb002ab79 100644
--- a/apps/browser-extension/src/entrypoints/popup/pages/items/ItemDetails.tsx
+++ b/apps/browser-extension/src/entrypoints/popup/pages/items/ItemDetails.tsx
@@ -14,9 +14,11 @@ import {
PasskeyBlock
} from '@/entrypoints/popup/components/Items/Details';
import ItemIcon from '@/entrypoints/popup/components/Items/ItemIcon';
+import ReloadButton from '@/entrypoints/popup/components/ReloadButton';
import { useDb } from '@/entrypoints/popup/context/DbContext';
import { useHeaderButtons } from '@/entrypoints/popup/context/HeaderButtonsContext';
import { useLoading } from '@/entrypoints/popup/context/LoadingContext';
+import { useVaultRefresh } from '@/entrypoints/popup/hooks/useVaultRefresh';
import { PopoutUtility } from '@/entrypoints/popup/utils/PopoutUtility';
import { logExpected, logFailure } from '@/utils/Diagnostics';
@@ -37,6 +39,7 @@ const ItemDetails: React.FC = (): React.ReactElement => {
const [item, setItem] = useState<Item | null>(null);
const { setIsInitialLoading } = useLoading();
const { setHeaderButtons, setBackButtonTitle } = useHeaderButtons();
+ const refreshVault = useVaultRefresh();
/**
* Open the item details in a new expanded popup.
@@ -193,6 +196,7 @@ const ItemDetails: React.FC = (): React.ReactElement => {
)}
</div>
</div>
+ <ReloadButton onClick={() => void refreshVault()} />
</div>
{/* Email block with recent emails - only for Login and Alias types with email field */}
diff --git a/apps/browser-extension/src/entrypoints/popup/pages/items/ItemsList.tsx b/apps/browser-extension/src/entrypoints/popup/pages/items/ItemsList.tsx
index 29a3d7b08..178b3b8e1 100644
--- a/apps/browser-extension/src/entrypoints/popup/pages/items/ItemsList.tsx
+++ b/apps/browser-extension/src/entrypoints/popup/pages/items/ItemsList.tsx
@@ -22,17 +22,15 @@ import ItemFilterDropdown from '@/entrypoints/popup/components/Items/ItemFilterD
import { ITEM_TYPE_OPTIONS } from '@/entrypoints/popup/components/Items/ItemTypeSelector';
import LoadingSpinner from '@/entrypoints/popup/components/LoadingSpinner';
import ReloadButton from '@/entrypoints/popup/components/ReloadButton';
-import { useApp } from '@/entrypoints/popup/context/AppContext';
import { useDb } from '@/entrypoints/popup/context/DbContext';
import { useHeaderButtons } from '@/entrypoints/popup/context/HeaderButtonsContext';
import { useLoading } from '@/entrypoints/popup/context/LoadingContext';
import { useListKeyboardNav } from '@/entrypoints/popup/hooks/useListKeyboardNav';
import { useVaultMutate } from '@/entrypoints/popup/hooks/useVaultMutate';
-import { useVaultSync } from '@/entrypoints/popup/hooks/useVaultSync';
+import { useVaultRefresh } from '@/entrypoints/popup/hooks/useVaultRefresh';
import { PopoutUtility } from '@/entrypoints/popup/utils/PopoutUtility';
import { devLog } from '@/utils/devLogger/DevLogger';
-import { logFailure } from '@/utils/Diagnostics';
import { itemRoute } from '@/utils/ItemRoute';
import { LocalPreferencesService } from '@/utils/LocalPreferencesService';
@@ -125,9 +123,8 @@ const ItemsList: React.FC = () => {
const location = useLocation();
const [searchParams] = useSearchParams();
const dbContext = useDb();
- const app = useApp();
const navigate = useNavigate();
- const { syncVault } = useVaultSync();
+ const refreshVault = useVaultRefresh();
const { executeVaultMutationAsync } = useVaultMutate();
const { setHeaderButtons, setBackButtonTitle } = useHeaderButtons();
const [items, setItems] = useState<Item[]>([]);
@@ -432,51 +429,6 @@ const ItemsList: React.FC = () => {
setShowEditFolderModal(false);
}, [dbContext, currentFolderRef, executeVaultMutationAsync]);
- /**
- * Retrieve latest vault and refresh the items list.
- */
- const onRefresh = useCallback(async () : Promise<void> => {
- if (!dbContext?.sqliteClient) {
- return;
- }
-
- try {
- // Sync vault and load items
- await syncVault({
- /**
- * On success.
- */
- onSuccess: async (_hasNewVault) => {
- // Items list is refreshed automatically when the (new) sqlite client is available via useEffect hook below.
- },
- /**
- * On offline.
- */
- onOffline: () => {
- // Continue with local vault in offline mode.
- },
- /**
- * On error.
- */
- onError: async (error) => {
- logFailure('Error syncing vault', error);
- },
- });
- } catch (err) {
- logFailure('Error refreshing items', err);
- await app.logout('Error while syncing vault, please re-authenticate.');
- }
- }, [dbContext, app, syncVault]);
-
- /**
- * Get latest vault from server and refresh the items list.
- */
- const syncVaultAndRefresh = useCallback(async () : Promise<void> => {
- setIsLoading(true);
- await onRefresh();
- setIsLoading(false);
- }, [onRefresh, setIsLoading]);
-
// Set header buttons on mount and clear on unmount
useEffect((): (() => void) => {
const headerButtonsJSX = (
@@ -961,7 +913,7 @@ const ItemsList: React.FC = () => {
</>
)}
</div>
- <ReloadButton onClick={syncVaultAndRefresh} />
+ <ReloadButton onClick={() => void refreshVault()} />
</div>
</div>
diff --git a/apps/mobile-app/app/(tabs)/items/[manifestId]/[id]/index.tsx b/apps/mobile-app/app/(tabs)/items/[manifestId]/[id]/index.tsx
index 47cec7be3..d1fff0ace 100644
--- a/apps/mobile-app/app/(tabs)/items/[manifestId]/[id]/index.tsx
+++ b/apps/mobile-app/app/(tabs)/items/[manifestId]/[id]/index.tsx
@@ -4,7 +4,7 @@ import MaterialIcons from '@expo/vector-icons/MaterialIcons';
import { useLocalSearchParams, useNavigation, useRouter } from 'expo-router';
import { useCallback, useEffect, useState } from 'react';
import { useTranslation } from 'react-i18next';
-import { ActivityIndicator, View, Text, StyleSheet, Linking, Platform, Share, TouchableOpacity } from 'react-native';
+import { ActivityIndicator, View, Text, StyleSheet, Linking, Platform, RefreshControl, Share, TouchableOpacity } from 'react-native';
import ContextMenu from 'react-native-context-menu-view';
import Toast from 'react-native-toast-message';
@@ -15,6 +15,7 @@ import { itemEditRoute } from '@/utils/ItemRoute';
import { useColors } from '@/hooks/useColorScheme';
import { useNavigationDebounce } from '@/hooks/useNavigationDebounce';
+import { useVaultRefresh } from '@/hooks/useVaultRefresh';
import { FolderBreadcrumb } from '@/components/folders/FolderBreadcrumb';
import { AliasDetails } from '@/components/items/details/AliasDetails';
@@ -94,25 +95,39 @@ export default function ItemDetailsScreen() : React.ReactNode {
navigation.setOptions(headerOptions);
}, [navigation, item, handleEdit, colors.primary, router, t]);
- useEffect(() => {
- /**
- * Load the item.
- */
- const loadItem = async () : Promise<void> => {
- if (!dbContext.dbAvailable) {
- return;
- }
+ /**
+ * Load the item, returns false when it no longer exists.
+ */
+ const loadItem = useCallback(async () : Promise<boolean> => {
+ if (!dbContext.dbAvailable) {
+ return true;
+ }
- try {
- const result = await dbContext.sqliteClient!.items.getById(itemRef);
- setItem(result);
- } catch (err) {
- console.error('Error loading item:', err);
- } finally {
- setIsLoading(false);
- }
- };
+ try {
+ const result = await dbContext.sqliteClient!.items.getById(itemRef);
+ setItem(result);
+ return result !== null;
+ } catch (err) {
+ console.error('Error loading item:', err);
+ return true;
+ } finally {
+ setIsLoading(false);
+ }
+ }, [itemRef, dbContext.dbAvailable, dbContext.sqliteClient]);
+
+ /**
+ * Reload the item after a pull-to-refresh sync, leaving the screen when it was deleted elsewhere.
+ */
+ const reloadAfterSync = useCallback(async () : Promise<void> => {
+ if (!await loadItem()) {
+ router.back();
+ }
+ }, [loadItem, router]);
+ const { refreshing, onRefresh } = useVaultRefresh(reloadAfterSync);
+
+ useEffect(() => {
+ // eslint-disable-next-line react-hooks/set-state-in-effect -- loadItem is async; setState only fires after data is fetched
loadItem();
// Add listener for item changes
@@ -132,7 +147,7 @@ export default function ItemDetailsScreen() : React.ReactNode {
itemChangedSub.remove();
Toast.hide();
};
- }, [itemRef, dbContext.dbAvailable, dbContext.sqliteClient]);
+ }, [itemRef, loadItem]);
if (isLoading) {
return (
@@ -291,7 +306,17 @@ export default function ItemDetailsScreen() : React.ReactNode {
return (
<ThemedContainer>
- <ThemedScrollView>
+ <ThemedScrollView
+ refreshControl={
+ <RefreshControl
+ refreshing={refreshing}
+ onRefresh={onRefresh}
+ colors={[colors.primary]}
+ tintColor={colors.primary}
+ progressViewOffset={Platform.OS === 'ios' ? 44 : undefined}
+ />
+ }
+ >
{/* Folder breadcrumb navigation */}
<FolderBreadcrumb folder={item.FolderId ? { Id: item.FolderId, ManifestId: item.ManifestId } : null} />
diff --git a/apps/mobile-app/app/(tabs)/items/folder/[manifestId]/[id].tsx b/apps/mobile-app/app/(tabs)/items/folder/[manifestId]/[id].tsx
index e859353b6..38bff113f 100644
--- a/apps/mobile-app/app/(tabs)/items/folder/[manifestId]/[id].tsx
+++ b/apps/mobile-app/app/(tabs)/items/folder/[manifestId]/[id].tsx
@@ -14,15 +14,13 @@ import type { DisplayItem } from '@/utils/DisplayItem';
import emitter from '@/utils/EventEmitter';
import { folderRoute } from '@/utils/FolderRoute';
import { HapticsUtility } from '@/utils/HapticsUtility';
-import { VaultAuthenticationError } from '@/utils/types/errors/VaultAuthenticationError';
import { useColors } from '@/hooks/useColorScheme';
import { useItemSort, useSortedItems } from '@/hooks/useItemSort';
-import { useMinDurationLoading } from '@/hooks/useMinDurationLoading';
import { useNavigationDebounce } from '@/hooks/useNavigationDebounce';
import { usePersonalManifestId } from '@/hooks/usePersonalManifestId';
import { useVaultMutate } from '@/hooks/useVaultMutate';
-import { useVaultSync } from '@/hooks/useVaultSync';
+import { useVaultRefresh } from '@/hooks/useVaultRefresh';
import { DeleteFolderModal } from '@/components/folders/DeleteFolderModal';
import { FolderBreadcrumb } from '@/components/folders/FolderBreadcrumb';
@@ -39,7 +37,6 @@ import { RobustPressable } from '@/components/ui/RobustPressable';
import { SkeletonLoader } from '@/components/ui/SkeletonLoader';
import { useApp } from '@/context/AppContext';
import { useDb } from '@/context/DbContext';
-import { useDialog } from '@/context/DialogContext';
import type { FolderWithCount } from '@/components/folders/FolderPill';
import type { ItemSummary } from '@aliasvault/client/database/mappers/ItemMapper';
@@ -73,7 +70,6 @@ const ITEM_TYPE_OPTIONS: ItemTypeOption[] = [
export default function FolderViewScreen(): React.ReactNode {
const { id: folderId, manifestId, filter: filterParam } = useLocalSearchParams<{ manifestId: string; id: string; filter?: string }>();
const folderRef = useMemo((): FolderRef => ({ Id: folderId, ManifestId: manifestId }), [folderId, manifestId]);
- const { syncVault } = useVaultSync();
const colors = useColors();
const { t } = useTranslation();
const navigation = useNavigation();
@@ -89,7 +85,6 @@ export default function FolderViewScreen(): React.ReactNode {
const [allFolders, setAllFolders] = useState<Folder[]>([]);
const personalManifestId = usePersonalManifestId();
const [isLoadingItems, setIsLoadingItems] = useState(true);
- const [refreshing, setRefreshing] = useMinDurationLoading(false, 200);
const { executeVaultMutation } = useVaultMutate();
const [searchQuery, setSearchQuery] = useState('');
const [filterType, setFilterType] = useState<ItemFilterType>(() => parseItemFilterType(filterParam));
@@ -102,7 +97,6 @@ export default function FolderViewScreen(): React.ReactNode {
const authContext = useApp();
const dbContext = useDb();
- const { showAlert } = useDialog();
const isAuthenticated = authContext.isLoggedIn;
const isDatabaseAvailable = dbContext.dbAvailable;
@@ -223,73 +217,7 @@ export default function FolderViewScreen(): React.ReactNode {
};
}, [loadItems]);
- /**
- * Handle pull-to-refresh.
- */
- const onRefresh = useCallback(async () => {
- HapticsUtility.impact();
-
- setRefreshing(true);
- setIsLoadingItems(true);
-
- // Always attempt sync, even when offline - this allows recovery when connection is restored
- try {
- await syncVault({
- /**
- * On success.
- */
- onSuccess: async (hasNewVault) => {
- await loadItems();
- await dbContext.refreshSyncState(); // Clear offline state if we were offline
- setIsLoadingItems(false);
- setRefreshing(false);
- setTimeout(() => {
- Toast.show({
- type: 'success',
- text1: hasNewVault ? t('items.vaultSyncedSuccessfully') : t('items.vaultUpToDate'),
- position: 'top',
- visibilityTime: 1200,
- });
- }, 200);
- },
- /**
- * On offline - just set offline mode, ServerSyncIndicator shows status.
- */
- onOffline: () => {
- setRefreshing(false);
- setIsLoadingItems(false);
- authContext.setOfflineMode(true);
- },
- /**
- * On error.
- */
- onError: async (error) => {
- console.error('Error syncing vault:', error);
- setRefreshing(false);
- setIsLoadingItems(false);
- showAlert(t('common.error'), error);
- },
- /**
- * On upgrade required.
- */
- onUpgradeRequired: (): void => {
- router.replace('/upgrade');
- },
- });
- } catch (err) {
- console.error('Error refreshing items:', err);
- setRefreshing(false);
- setIsLoadingItems(false);
-
- if (!(err instanceof VaultAuthenticationError)) {
- Toast.show({
- type: 'error',
- text1: t('items.vaultSyncFailed'),
- text2: t('common.errors.unknownError'),
- });
- }
- }
- }, [syncVault, loadItems, setIsLoadingItems, setRefreshing, authContext, dbContext, router, showAlert, t]);
+ const { refreshing, onRefresh } = useVaultRefresh(loadItems, setIsLoadingItems);
useEffect(() => {
if (!isAuthenticated || !isDatabaseAvailable) {
diff --git a/apps/mobile-app/app/(tabs)/items/index.tsx b/apps/mobile-app/app/(tabs)/items/index.tsx
index f9faf893e..6122b08cf 100644
--- a/apps/mobile-app/app/(tabs)/items/index.tsx
+++ b/apps/mobile-app/app/(tabs)/items/index.tsx
@@ -8,13 +8,11 @@ import { useState, useEffect, useCallback, useRef, useMemo } from 'react';
import { useTranslation } from 'react-i18next';
import { StyleSheet, Text, Platform, Animated, TextInput, TouchableOpacity, View, RefreshControl } from 'react-native';
import { useSafeAreaInsets } from 'react-native-safe-area-context';
-import Toast from 'react-native-toast-message';
import type { DisplayItem } from '@/utils/DisplayItem';
import emitter from '@/utils/EventEmitter';
import { folderRoute } from '@/utils/FolderRoute';
import { HapticsUtility } from '@/utils/HapticsUtility';
-import { VaultAuthenticationError } from '@/utils/types/errors/VaultAuthenticationError';
import { useAppReviewPrompt } from '@/hooks/useAppReviewPrompt';
import { useColors } from '@/hooks/useColorScheme';
@@ -22,10 +20,9 @@ import { useMinDurationLoading } from '@/hooks/useMinDurationLoading';
import { useNavigationDebounce } from '@/hooks/useNavigationDebounce';
import { usePersonalManifestId } from '@/hooks/usePersonalManifestId';
import { useVaultMutate } from '@/hooks/useVaultMutate';
-import { useVaultSync } from '@/hooks/useVaultSync';
+import { useVaultRefresh } from '@/hooks/useVaultRefresh';
import Logo from '@/assets/images/logo.svg';
-import { ConfirmDialog } from '@/components/common/ConfirmDialog';
import { FolderModal } from '@/components/folders/FolderModal';
import { FolderPill, type FolderWithCount } from '@/components/folders/FolderPill';
import { AddItemFab } from '@/components/items/AddItemFab';
@@ -68,7 +65,6 @@ const ITEM_TYPE_OPTIONS: ItemTypeOption[] = [
* Items screen - main vault items list.
*/
export default function ItemsScreen(): React.ReactNode {
- const { syncVault } = useVaultSync();
const { t } = useTranslation();
const colors = useColors();
const navigate = useNavigationDebounce();
@@ -84,7 +80,6 @@ export default function ItemsScreen(): React.ReactNode {
const personalManifestId = usePersonalManifestId();
const [isLoadingItems, setIsLoadingItems] = useMinDurationLoading(false, 200);
const [hasLoadedItems, setHasLoadedItems] = useState(false);
- const [refreshing, setRefreshing] = useMinDurationLoading(false, 200);
const { executeVaultMutation } = useVaultMutate();
const [showFolderModal, setShowFolderModal] = useState(false);
@@ -102,16 +97,6 @@ export default function ItemsScreen(): React.ReactNode {
// Scoped key (manifest and id) of a freshly duplicated item that gets scrolled into view and briefly highlighted
const [highlightedItemKey, setHighlightedItemKey] = useState<string | null>(null);
- // Alert dialog state
- const [alertConfig, setAlertConfig] = useState<{ title: string; message: string } | null>(null);
-
- /**
- * Hide the alert dialog.
- */
- const hideAlert = useCallback((): void => {
- setAlertConfig(null);
- }, []);
-
const authContext = useApp();
const dbContext = useDb();
@@ -329,78 +314,9 @@ export default function ItemsScreen(): React.ReactNode {
unsubscribeFocus();
unsubscribeBlur();
};
- }, [isTabFocused, loadItems, navigation, setRefreshing]);
-
- /**
- * Handle pull-to-refresh.
- */
- const onRefresh = useCallback(async () => {
- HapticsUtility.impact();
-
- setRefreshing(true);
- setIsLoadingItems(true);
+ }, [isTabFocused, loadItems, navigation]);
- // Always attempt sync, even when offline - this allows recovery when connection is restored
- try {
- await syncVault({
- /**
- * On success.
- */
- onSuccess: async (hasNewVault) => {
- await loadItems();
- await dbContext.refreshSyncState(); // Clear offline state if we were offline
- setIsLoadingItems(false);
- setRefreshing(false);
- setTimeout(() => {
- Toast.show({
- type: 'success',
- text1: hasNewVault ? t('items.vaultSyncedSuccessfully') : t('items.vaultUpToDate'),
- position: 'top',
- visibilityTime: 1200,
- });
- }, 200);
- },
- /**
- * On offline - just update state, ServerSyncIndicator shows offline status.
- */
- onOffline: async () => {
- setRefreshing(false);
- setIsLoadingItems(false);
- await dbContext.setIsOffline(true);
- await dbContext.refreshSyncState();
- },
- /**
- * On error.
- */
- onError: async (error) => {
- console.error('Error syncing vault:', error);
- setRefreshing(false);
- setIsLoadingItems(false);
-
- // Show generic error message to user, detailed error is logged above
- setAlertConfig({ title: t('common.error'), message: t('common.errors.unknownError') });
- },
- /**
- * On upgrade required.
- */
- onUpgradeRequired: (): void => {
- router.replace('/upgrade');
- },
- });
- } catch (err) {
- console.error('Error refreshing items:', err);
- setRefreshing(false);
- setIsLoadingItems(false);
-
- if (!(err instanceof VaultAuthenticationError)) {
- Toast.show({
- type: 'error',
- text1: t('items.vaultSyncFailed'),
- text2: t('common.errors.unknownError'),
- });
- }
- }
- }, [syncVault, loadItems, setIsLoadingItems, setRefreshing, dbContext, router, t]);
+ const { refreshing, onRefresh } = useVaultRefresh(loadItems, setIsLoadingItems);
useEffect(() => {
if (!isAuthenticated || !isDatabaseAvailable) {
@@ -990,14 +906,6 @@ export default function ItemsScreen(): React.ReactNode {
mode="create"
/>
- {/* Alert dialog */}
- <ConfirmDialog
- isVisible={alertConfig !== null}
- title={alertConfig?.title ?? ''}
- message={alertConfig?.message ?? ''}
- buttons={[{ text: t('common.ok'), style: 'default', onPress: hideAlert }]}
- onClose={hideAlert}
- />
</ThemedContainer>
);
}
diff --git a/apps/mobile-app/hooks/useVaultRefresh.ts b/apps/mobile-app/hooks/useVaultRefresh.ts
new file mode 100644
index 000000000..df4f7969b
--- /dev/null
+++ b/apps/mobile-app/hooks/useVaultRefresh.ts
@@ -0,0 +1,104 @@
+import { useRouter } from 'expo-router';
+import { useCallback } from 'react';
+import Toast from 'react-native-toast-message';
+
+import { HapticsUtility } from '@/utils/HapticsUtility';
+import { VaultAuthenticationError } from '@/utils/types/errors/VaultAuthenticationError';
+
+import { useMinDurationLoading } from '@/hooks/useMinDurationLoading';
+import { useTranslation } from '@/hooks/useTranslation';
+import { useVaultSync } from '@/hooks/useVaultSync';
+
+import { useDb } from '@/context/DbContext';
+import { useDialog } from '@/context/DialogContext';
+
+/**
+ * Pull-to-refresh: syncs the vault with the server, then calls `reload` so the screen shows the synced data.
+ * @param reload - reloads the screen's data from the local vault
+ * @param setIsLoading - optional loading state of the screen, set while the refresh runs
+ */
+export const useVaultRefresh = (
+ reload: () => Promise<void>,
+ setIsLoading?: (isLoading: boolean) => void
+): { refreshing: boolean; onRefresh: () => Promise<void> } => {
+ const { t } = useTranslation();
+ const router = useRouter();
+ const dbContext = useDb();
+ const { showAlert } = useDialog();
+ const { syncVault } = useVaultSync();
+ const [refreshing, setRefreshing] = useMinDurationLoading(false, 200);
+
+ const onRefresh = useCallback(async (): Promise<void> => {
+ HapticsUtility.impact();
+
+ /**
+ * Stop the refresh and loading indicators.
+ */
+ const done = (): void => {
+ setRefreshing(false);
+ setIsLoading?.(false);
+ };
+
+ setRefreshing(true);
+ setIsLoading?.(true);
+
+ // Always attempt sync, even when offline - this allows recovery when connection is restored
+ try {
+ await syncVault({
+ /**
+ * On success.
+ */
+ onSuccess: async (hasNewVault) => {
+ await reload();
+ await dbContext.refreshSyncState(); // Clear offline state if we were offline
+ done();
+ setTimeout(() => {
+ Toast.show({
+ type: 'success',
+ text1: hasNewVault ? t('items.vaultSyncedSuccessfully') : t('items.vaultUpToDate'),
+ position: 'top',
+ visibilityTime: 1200,
+ });
+ }, 200);
+ },
+ /**
+ * On offline - just update state, ServerSyncIndicator shows offline status.
+ */
+ onOffline: async () => {
+ done();
+ await dbContext.setIsOffline(true);
+ await dbContext.refreshSyncState();
+ },
+ /**
+ * On error.
+ */
+ onError: (error) => {
+ console.error('Error syncing vault:', error);
+ done();
+
+ // Show generic error message to user, detailed error is logged above
+ showAlert(t('common.error'), t('common.errors.unknownError'));
+ },
+ /**
+ * On upgrade required.
+ */
+ onUpgradeRequired: (): void => {
+ router.replace('/upgrade');
+ },
+ });
+ } catch (err) {
+ console.error('Error refreshing vault:', err);
+ done();
+
+ if (!(err instanceof VaultAuthenticationError)) {
+ Toast.show({
+ type: 'error',
+ text1: t('items.vaultSyncFailed'),
+ text2: t('common.errors.unknownError'),
+ });
+ }
+ }
+ }, [syncVault, reload, setIsLoading, setRefreshing, dbContext, router, showAlert, t]);
+
+ return { refreshing, onRefresh };
+};
diff --git a/apps/web/src/components/shared/RefreshButton.tsx b/apps/web/src/components/shared/RefreshButton.tsx
index 22b20c0aa..44e0942e9 100644
--- a/apps/web/src/components/shared/RefreshButton.tsx
+++ b/apps/web/src/components/shared/RefreshButton.tsx
@@ -6,13 +6,14 @@ import Icon from '@/components/shared/Icon';
type RefreshButtonProps = {
onClick: () => void | Promise<void>;
buttonText: string;
+ iconOnly?: boolean;
additionalClasses?: string;
};
/**
* Secondary (outline) refresh button that spins its icon for a moment after being clicked.
*/
-const RefreshButton: React.FC<RefreshButtonProps> = ({ onClick, buttonText, additionalClasses = '' }) => {
+const RefreshButton: React.FC<RefreshButtonProps> = ({ onClick, buttonText, iconOnly = false, additionalClasses = '' }) => {
const [isRefreshing, setIsRefreshing] = useState(false);
const timerRef = useRef<ReturnType<typeof setTimeout> | null>(null);
@@ -28,18 +29,18 @@ const RefreshButton: React.FC<RefreshButtonProps> = ({ onClick, buttonText, addi
* Run the click handler and keep the icon spinning for half a second.
*/
const handleClick = useCallback(async (): Promise<void> => {
- if (isRefreshing) {
- return;
+ if (timerRef.current) {
+ clearTimeout(timerRef.current);
}
setIsRefreshing(true);
await onClick();
timerRef.current = setTimeout(() => setIsRefreshing(false), 500);
- }, [isRefreshing, onClick]);
+ }, [onClick]);
return (
<Button onClick={() => void handleClick()} display="flex" color="outline" additionalClasses={additionalClasses}>
- <Icon name="refresh" className={`w-4 h-4 ${isRefreshing ? 'animate-spin-ccw' : ''}`} />
- <span className="ml-2">{buttonText}</span>
+ <Icon name="refresh" className={`${iconOnly ? 'w-5 h-5' : 'w-4 h-4'} ${isRefreshing ? 'animate-spin-ccw' : ''}`} />
+ <span className={iconOnly ? 'sr-only' : 'ml-2'}>{buttonText}</span>
</Button>
);
};
diff --git a/apps/web/src/hooks/useVaultRefresh.ts b/apps/web/src/hooks/useVaultRefresh.ts
new file mode 100644
index 000000000..11745f067
--- /dev/null
+++ b/apps/web/src/hooks/useVaultRefresh.ts
@@ -0,0 +1,30 @@
+import { useCallback } from 'react';
+
+import { useLoading } from '@/context/LoadingContext';
+import { useVaultSync } from '@/hooks/useVaultSync';
+
+/** Minimum time the full screen spinner stays up for UX purposes. */
+const MIN_SPINNER_MS = 150;
+
+/**
+ * Manual "refresh" action: syncs the vault with the server, then calls `reload` so the page shows the synced data.
+ * @param reload - reloads the page's data from the local vault
+ */
+export const useVaultRefresh = (reload: () => void): (() => Promise<void>) => {
+ const { showLoading, hideLoading } = useLoading();
+ const { syncVault } = useVaultSync();
+
+ return useCallback(async (): Promise<void> => {
+ const startedAt = Date.now();
+ showLoading();
+ try {
+ await syncVault({ onSuccess: reload });
+ } finally {
+ const remaining = MIN_SPINNER_MS - (Date.now() - startedAt);
+ if (remaining > 0) {
+ await new Promise(resolve => setTimeout(resolve, remaining));
+ }
+ hideLoading();
+ }
+ }, [reload, syncVault, showLoading, hideLoading]);
+};
diff --git a/apps/web/src/pages/items/Home.tsx b/apps/web/src/pages/items/Home.tsx
index 439228d4d..b7a58e070 100644
--- a/apps/web/src/pages/items/Home.tsx
+++ b/apps/web/src/pages/items/Home.tsx
@@ -32,7 +32,7 @@ import { useQuickCreate } from '@/context/QuickCreateContext';
import { useClickOutside } from '@/hooks/useClickOutside';
import { usePageTitle } from '@/hooks/usePageTitle';
import { useVaultMutate, VaultPushFailedError } from '@/hooks/useVaultMutate';
-import { useVaultSync } from '@/hooks/useVaultSync';
+import { useVaultRefresh } from '@/hooks/useVaultRefresh';
import { folderRoute } from '@/utils/ItemRoute';
import { getLocalPreferenceJson, setLocalPreferenceJson } from '@/utils/LocalPreferences';
import { LocalPreferenceKeys } from '@/utils/StorageKeys';
@@ -80,7 +80,6 @@ const ItemsHome: React.FC = () => {
const [searchParams] = useSearchParams();
const dbContext = useDb();
const notifications = useNotifications();
- const { syncVault } = useVaultSync();
const { executeVaultMutationAsync, executeVaultMutationInBackground } = useVaultMutate();
usePageTitle('Home');
@@ -348,12 +347,7 @@ const ItemsHome: React.FC = () => {
setVisibleItemCount(BATCH_SIZE);
};
- /**
- * Pull the latest vault from the server, then reload the list.
- */
- const refreshVault = async (): Promise<void> => {
- await syncVault({ onSuccess: loadItems });
- };
+ const refreshVault = useVaultRefresh(loadItems);
/**
* Infinite scroll: load the next batch when the sentinel comes into view.
diff --git a/apps/web/src/pages/items/View.tsx b/apps/web/src/pages/items/View.tsx
index 2670af830..7e46f1a9b 100644
--- a/apps/web/src/pages/items/View.tsx
+++ b/apps/web/src/pages/items/View.tsx
@@ -22,6 +22,7 @@ import Icon from '@/components/shared/Icon';
import LinkButton from '@/components/shared/LinkButton';
import PageContent from '@/components/shared/PageContent';
import PageHeader from '@/components/shared/PageHeader';
+import RefreshButton from '@/components/shared/RefreshButton';
import SectionTitle from '@/components/shared/SectionTitle';
import TotpViewer from '@/components/totp/TotpViewer';
import { useDb } from '@/context/DbContext';
@@ -30,6 +31,7 @@ import { useEmailDomains } from '@/hooks/useEmailDomains';
import { useKeyboardShortcut } from '@/hooks/useKeyboardShortcut';
import { usePageTitle } from '@/hooks/usePageTitle';
import { useVaultMutate } from '@/hooks/useVaultMutate';
+import { useVaultRefresh } from '@/hooks/useVaultRefresh';
import { folderRoute, itemRoute } from '@/utils/ItemRoute';
import type { ItemRef } from '@aliasvault/client/database/ItemRef';
@@ -118,6 +120,8 @@ const ItemView: React.FC = () => {
// Reload when the vault is (re)loaded, so changes synced from other devices show without a refresh.
useEffect(() => loadEntry(), [loadEntry]);
+ const refreshVault = useVaultRefresh(loadEntry);
+
useKeyboardShortcut('ge', () => {
if (item) {
navigate(itemRoute(item, true));
@@ -177,6 +181,7 @@ const ItemView: React.FC = () => {
titleSuffix={<ItemTypePill itemType={item.ItemType} />}
customActions={(
<>
+ <RefreshButton onClick={refreshVault} buttonText={t('common.refresh')} iconOnly />
<LinkButton smallText={t('common.edit')} text={t('items.editItem')} href={itemRoute(item, true)} color="primary" />
<Button color="danger" onClick={() => setShowDeleteModal(true)}>
<span className="md:hidden">{t('common.delete')}</span>