Skip to content

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

Add typed CredentialSortOrder (#2413)

Leendert de Borstc7f576699014
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 4248bce35..11f273068 100644
--- a/apps/browser-extension/src/entrypoints/popup/pages/items/ItemsList.tsx
+++ b/apps/browser-extension/src/entrypoints/popup/pages/items/ItemsList.tsx
@@ -1,4 +1,5 @@
import { isSameItem, scopedKey } from '@aliasvault/client/database/ItemRef';
+import { CredentialSortOrder } from '@aliasvault/client/database/repositories/SettingsRepository';
import { canHaveSubfolders, getDescendantFolderIds, getFolderPath, getRecursiveItemCount, isItemInFolder, isSharedFolder } from '@aliasvault/client/items/FolderUtils';
import { applySearchFilter, applyTypeFilter, isItemTypeFilter, parseItemFilterType, type ItemFilterType } from '@aliasvault/client/items/ItemFilters';
import { multiManifestRendering } from '@aliasvault/client/sharing/MultiManifestRendering';
@@ -38,7 +39,6 @@ import { useMinDurationLoading } from '@/hooks/useMinDurationLoading';
import type { ItemRef } from '@aliasvault/client/database/ItemRef';
import type { Folder, FolderRef } from '@aliasvault/client/database/repositories/FolderRepository';
-import type { CredentialSortOrder } from '@aliasvault/client/database/repositories/SettingsRepository';
import type { Item, ItemType } from '@aliasvault/models/vault';
const FILTER_STORAGE_KEY = 'items-filter';
@@ -55,9 +55,9 @@ const CURRENT_SITE_SUGGESTION_MIN_ITEMS = 5;
* Sort order options with their translation keys
*/
const SORT_OPTIONS: { value: CredentialSortOrder; labelKey: string }[] = [
- { value: 'OldestFirst', labelKey: 'items.sort.oldestFirst' },
- { value: 'NewestFirst', labelKey: 'items.sort.newestFirst' },
- { value: 'Alphabetical', labelKey: 'items.sort.alphabetical' },
+ { value: CredentialSortOrder.OldestFirst, labelKey: 'items.sort.oldestFirst' },
+ { value: CredentialSortOrder.NewestFirst, labelKey: 'items.sort.newestFirst' },
+ { value: CredentialSortOrder.Alphabetical, labelKey: 'items.sort.alphabetical' },
];
/**
@@ -141,7 +141,7 @@ const ItemsList: React.FC = () => {
const [highlightedItem, setHighlightedItem] = useState<ItemRef | null>(null);
const [recentlyDeletedCount, setRecentlyDeletedCount] = useState(0);
const [folderRefreshKey, setFolderRefreshKey] = useState(0);
- const [sortOrder, setSortOrder] = useState<CredentialSortOrder>('NewestFirst');
+ const [sortOrder, setSortOrder] = useState<CredentialSortOrder>(CredentialSortOrder.NewestFirst);
const [showSortMenu, setShowSortMenu] = useState(false);
const [showFolders, setShowFolders] = useState(true);
const { setIsInitialLoading } = useLoading();
@@ -523,7 +523,7 @@ const ItemsList: React.FC = () => {
const deletedCount = dbContext.sqliteClient?.items.getRecentlyDeletedCount() ?? 0;
setRecentlyDeletedCount(deletedCount);
// Load sort order from settings
- const savedSortOrder = dbContext.sqliteClient?.settings.getCredentialsSortOrder() ?? 'NewestFirst';
+ const savedSortOrder = dbContext.sqliteClient?.settings.getCredentialsSortOrder() ?? CredentialSortOrder.NewestFirst;
setSortOrder(savedSortOrder);
setIsLoading(false);
setIsInitialLoading(false);
@@ -689,15 +689,15 @@ const ItemsList: React.FC = () => {
const sortedItems = useMemo(() => {
const itemsCopy = [...filteredItems];
switch (sortOrder) {
- case 'NewestFirst':
+ case CredentialSortOrder.NewestFirst:
return itemsCopy.sort((a, b) =>
new Date(b.CreatedAt || 0).getTime() - new Date(a.CreatedAt || 0).getTime()
);
- case 'Alphabetical':
+ case CredentialSortOrder.Alphabetical:
return itemsCopy.sort((a, b) =>
(a.Name || '').localeCompare(b.Name || '')
);
- case 'OldestFirst':
+ case CredentialSortOrder.OldestFirst:
default:
return itemsCopy.sort((a, b) =>
new Date(a.CreatedAt || 0).getTime() - new Date(b.CreatedAt || 0).getTime()
diff --git a/apps/mobile-app/app/(tabs)/items/index.tsx b/apps/mobile-app/app/(tabs)/items/index.tsx
index 2ae21d100..88391128b 100644
--- a/apps/mobile-app/app/(tabs)/items/index.tsx
+++ b/apps/mobile-app/app/(tabs)/items/index.tsx
@@ -1,4 +1,5 @@
import { scopedKey, type ItemRef } from '@aliasvault/client/database/ItemRef';
+import { CredentialSortOrder } from '@aliasvault/client/database/repositories/SettingsRepository';
import { getRecursiveItemCount, isSharedFolder } from '@aliasvault/client/items/FolderUtils';
import { applyTypeFilter, isItemTypeFilter, type ItemFilterType } from '@aliasvault/client/items/ItemFilters';
import { getFieldValue, FieldKey, ItemTypes } from '@aliasvault/models/vault';
@@ -43,7 +44,6 @@ import { useDb } from '@/context/DbContext';
import { LocalPreferencesService } from '@/services/LocalPreferencesService';
import type { Folder, FolderRef } from '@aliasvault/client/database/repositories/FolderRepository';
-import type { CredentialSortOrder } from '@aliasvault/client/database/repositories/SettingsRepository';
import type { ItemType } from '@aliasvault/models/vault';
/**
@@ -93,7 +93,7 @@ export default function ItemsScreen(): React.ReactNode {
const [searchQuery, setSearchQuery] = useState('');
const [filterType, setFilterType] = useState<ItemFilterType>('all');
const [showFilterMenu, setShowFilterMenu] = useState(false);
- const [sortOrder, setSortOrder] = useState<CredentialSortOrder>('NewestFirst');
+ const [sortOrder, setSortOrder] = useState<CredentialSortOrder>(CredentialSortOrder.NewestFirst);
const [showSortMenu, setShowSortMenu] = useState(false);
const [showFolderItems, setShowFolderItems] = useState(true);
@@ -278,15 +278,15 @@ export default function ItemsScreen(): React.ReactNode {
const sortedItems = useMemo(() => {
const itemsCopy = [...filteredItems];
switch (sortOrder) {
- case 'NewestFirst':
+ case CredentialSortOrder.NewestFirst:
return itemsCopy.sort((a, b) =>
new Date(b.CreatedAt || 0).getTime() - new Date(a.CreatedAt || 0).getTime()
);
- case 'Alphabetical':
+ case CredentialSortOrder.Alphabetical:
return itemsCopy.sort((a, b) =>
(a.Name || '').localeCompare(b.Name || '')
);
- case 'OldestFirst':
+ case CredentialSortOrder.OldestFirst:
default:
return itemsCopy.sort((a, b) =>
new Date(a.CreatedAt || 0).getTime() - new Date(b.CreatedAt || 0).getTime()
diff --git a/apps/mobile-app/hooks/useItemSort.ts b/apps/mobile-app/hooks/useItemSort.ts
index d77b4b8ec..4b1d6e079 100644
--- a/apps/mobile-app/hooks/useItemSort.ts
+++ b/apps/mobile-app/hooks/useItemSort.ts
@@ -1,15 +1,15 @@
import { useState, useMemo, useCallback } from 'react';
-import type { CredentialSortOrder } from '@aliasvault/client/database/repositories/SettingsRepository';
+import { CredentialSortOrder } from '@aliasvault/client/database/repositories/SettingsRepository';
import type { Item } from '@aliasvault/models/vault';
/**
* Sort order options with their translation keys.
*/
export const SORT_OPTIONS: { value: CredentialSortOrder; labelKey: string }[] = [
- { value: 'OldestFirst', labelKey: 'items.sort.oldestFirst' },
- { value: 'NewestFirst', labelKey: 'items.sort.newestFirst' },
- { value: 'Alphabetical', labelKey: 'items.sort.alphabetical' },
+ { value: CredentialSortOrder.OldestFirst, labelKey: 'items.sort.oldestFirst' },
+ { value: CredentialSortOrder.NewestFirst, labelKey: 'items.sort.newestFirst' },
+ { value: CredentialSortOrder.Alphabetical, labelKey: 'items.sort.alphabetical' },
];
/**
@@ -46,10 +46,10 @@ export interface UseItemSortReturn {
* Hook to manage item sorting state and logic.
* Can be used by both the main items screen and folder view.
*
- * @param initialSortOrder - Optional initial sort order (default: 'NewestFirst')
+ * @param initialSortOrder - Optional initial sort order (default: NewestFirst)
* @returns Sort state and functions
*/
-export function useItemSort(initialSortOrder: CredentialSortOrder = 'NewestFirst'): UseItemSortReturn {
+export function useItemSort(initialSortOrder: CredentialSortOrder = CredentialSortOrder.NewestFirst): UseItemSortReturn {
const [sortOrder, setSortOrder] = useState<CredentialSortOrder>(initialSortOrder);
const [showSortMenu, setShowSortMenu] = useState(false);
@@ -67,15 +67,15 @@ export function useItemSort(initialSortOrder: CredentialSortOrder = 'NewestFirst
const sortItems = useCallback((items: Item[]): Item[] => {
const itemsCopy = [...items];
switch (sortOrder) {
- case 'NewestFirst':
+ case CredentialSortOrder.NewestFirst:
return itemsCopy.sort((a, b) =>
new Date(b.CreatedAt || 0).getTime() - new Date(a.CreatedAt || 0).getTime()
);
- case 'Alphabetical':
+ case CredentialSortOrder.Alphabetical:
return itemsCopy.sort((a, b) =>
(a.Name || '').localeCompare(b.Name || '')
);
- case 'OldestFirst':
+ case CredentialSortOrder.OldestFirst:
default:
return itemsCopy.sort((a, b) =>
new Date(a.CreatedAt || 0).getTime() - new Date(b.CreatedAt || 0).getTime()
@@ -105,15 +105,15 @@ export function useSortedItems<T extends Item>(filteredItems: T[], sortOrder: Cr
return useMemo(() => {
const itemsCopy = [...filteredItems];
switch (sortOrder) {
- case 'NewestFirst':
+ case CredentialSortOrder.NewestFirst:
return itemsCopy.sort((a, b) =>
new Date(b.CreatedAt || 0).getTime() - new Date(a.CreatedAt || 0).getTime()
);
- case 'Alphabetical':
+ case CredentialSortOrder.Alphabetical:
return itemsCopy.sort((a, b) =>
(a.Name || '').localeCompare(b.Name || '')
);
- case 'OldestFirst':
+ case CredentialSortOrder.OldestFirst:
default:
return itemsCopy.sort((a, b) =>
new Date(a.CreatedAt || 0).getTime() - new Date(b.CreatedAt || 0).getTime()
diff --git a/core/client/src/database/repositories/SettingsRepository.ts b/core/client/src/database/repositories/SettingsRepository.ts
index 509d023ce..d6b954542 100644
--- a/core/client/src/database/repositories/SettingsRepository.ts
+++ b/core/client/src/database/repositories/SettingsRepository.ts
@@ -10,9 +10,13 @@ import type { DbOp } from '../DbOp';
import type { PasswordSettings } from '@aliasvault/models/vault';
/**
- * Sort order options for credentials list.
+ * Sort order options for the items list. The values are stored as-is in the synced vault Settings table.
*/
-export type CredentialSortOrder = 'OldestFirst' | 'NewestFirst' | 'Alphabetical';
+export enum CredentialSortOrder {
+ OldestFirst = 'OldestFirst',
+ NewestFirst = 'NewestFirst',
+ Alphabetical = 'Alphabetical',
+}
/**
* Repository for the vault's user preferences: the manifest-scoped key/value rows of the Settings table.
@@ -130,12 +134,8 @@ export class SettingsRepository extends BaseRepository {
* @returns The sort order preference
*/
public *getCredentialsSortOrder(): DbOp<CredentialSortOrder> {
- const value = yield* this.getSetting('CredentialsSortOrder', 'NewestFirst');
- // Validate the value is a valid sort order
- if (value === 'OldestFirst' || value === 'NewestFirst' || value === 'Alphabetical') {
- return value;
- }
- return 'NewestFirst';
+ const value = yield* this.getSetting('CredentialsSortOrder', CredentialSortOrder.NewestFirst);
+ return Object.values(CredentialSortOrder).includes(value as CredentialSortOrder) ? value as CredentialSortOrder : CredentialSortOrder.NewestFirst;
}
/**