highperfocused/grimoire
1
0
Fork 0
mirror of https://github.com/purrgrammer/grimoire.git synced 2026-06-05 02:01:22 +02:00
Code Issues Packages Projects Releases Wiki Activity

refactor: simplify settings service to only used settings

Browse Source 
Removed unused settings that were defined but never consumed:
- RelaySettings (fallbackRelays, discoveryRelays, outbox*, etc.)
- PrivacySettings (shareReadReceipts, blurWalletBalances, etc.)
- DatabaseSettings (maxEventsCached, autoCleanupDays, etc.)
- NotificationSettings (enabled, notifyOnMention, etc.)
- DeveloperSettings (debugMode, showEventIds, logLevel, etc.)
- Most of AppearanceSettings (theme, fontSizeMultiplier, etc.)
- Most of PostSettings (defaultRelayMode, customPostRelays)

Only kept settings that are actually used:
- post.includeClientTag
- appearance.showClientTags

Also simplified useSettings hook to match.

https://claude.ai/code/session_01DiWUxiS5BAzU9mrKvCUuMW
This commit is contained in:
Claude
2026-01-30 13:18:46 +00:00
parent ceea6f82b7
commit 17300b1b7d
2 changed files with 23 additions and 279 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
src/hooks/useSettings.ts
View File

@@ -9,16 +9,6 @@ import { settingsManager, type AppSettings } from "@/services/settings";
export function useSettings() {
const settings = use$(settingsManager.stream$);
const updateSection = useCallback(
<K extends keyof Omit<AppSettings, "__version">>(
section: K,
updates: Partial<AppSettings[K]>,
) => {
settingsManager.updateSection(section, updates);
},
[],
);
const updateSetting = useCallback(
<
S extends keyof Omit<AppSettings, "__version">,
@@ -37,18 +27,9 @@ export function useSettings() {
settingsManager.reset();
}, []);
const resetSection = useCallback(
<K extends keyof Omit<AppSettings, "__version">>(section: K) => {
settingsManager.resetSection(section);
},
[],
);
return {
settings,
updateSection,
updateSetting,
reset,
resetSection,
};
}

283
src/services/settings.ts
View File

@@ -1,6 +1,5 @@
/**
* Global application settings with namespaced structure
* Manages user preferences with localStorage persistence, validation, and migrations
* Global application settings with localStorage persistence
*/
import { BehaviorSubject } from "rxjs";
@@ -15,123 +14,23 @@ import { BehaviorSubject } from "rxjs";
export interface PostSettings {
/** Include Grimoire client tag in published events */
includeClientTag: boolean;
/** Default relay selection preference (user-relays, aggregators, custom) */
defaultRelayMode: "user-relays" | "aggregators" | "custom";
/** Custom relay list for posting (when defaultRelayMode is "custom") */
customPostRelays: string[];
}
/**
* Appearance and theme settings
* Appearance settings
*/
export interface AppearanceSettings {
/** Theme mode (light, dark, or system) */
theme: "light" | "dark" | "system";
/** Show client tags in event UI */
showClientTags: boolean;
/** Font size multiplier (0.8 = 80%, 1.0 = 100%, 1.2 = 120%) */
fontSizeMultiplier: number;
/** Enable UI animations */
animationsEnabled: boolean;
/** Accent color (hue value 0-360) */
accentHue: number;
}
/**
* Relay configuration settings
*/
export interface RelaySettings {
/** Fallback aggregator relays when user has no relay list */
fallbackRelays: string[];
/** Discovery relays for bootstrapping (NIP-05, relay lists, etc.) */
discoveryRelays: string[];
/** Enable NIP-65 outbox model for finding events */
outboxEnabled: boolean;
/** Fallback to aggregators if outbox fails */
outboxFallbackEnabled: boolean;
/** Relay connection timeout in milliseconds */
relayTimeout: number;
/** Maximum concurrent relay connections per query */
maxRelaysPerQuery: number;
/** Automatically connect to inbox relays when viewing DMs */
autoConnectInbox: boolean;
}
/**
* Privacy and security settings
*/
export interface PrivacySettings {
/** Share read receipts (NIP-15) */
shareReadReceipts: boolean;
/** Blur wallet balances in UI */
blurWalletBalances: boolean;
/** Blur sensitive content (marked with content-warning tag) */
blurSensitiveContent: boolean;
/** Warn before opening external links */
warnExternalLinks: boolean;
}
/**
* Local database and caching settings
*/
export interface DatabaseSettings {
/** Maximum events to cache in IndexedDB (0 = unlimited) */
maxEventsCached: number;
/** Auto-cleanup old events after N days (0 = never) */
autoCleanupDays: number;
/** Enable IndexedDB caching */
cacheEnabled: boolean;
/** Cache profile metadata */
cacheProfiles: boolean;
/** Cache relay lists */
cacheRelayLists: boolean;
}
/**
* Notification preferences
*/
export interface NotificationSettings {
/** Enable browser notifications */
enabled: boolean;
/** Notify on mentions */
notifyOnMention: boolean;
/** Notify on zaps received */
notifyOnZap: boolean;
/** Notify on replies */
notifyOnReply: boolean;
/** Play sound on notification */
soundEnabled: boolean;
}
/**
* Developer and debug settings
*/
export interface DeveloperSettings {
/** Enable debug mode */
debugMode: boolean;
/** Show event IDs in UI */
showEventIds: boolean;
/** Console log level */
logLevel: "none" | "error" | "warn" | "info" | "debug";
/** Enable experimental features */
experimentalFeatures: boolean;
/** Show performance metrics */
showPerformanceMetrics: boolean;
}
/**
* Complete application settings structure
* Version 1: Initial namespaced structure
*/
export interface AppSettings {
__version: 1;
post: PostSettings;
appearance: AppearanceSettings;
relay: RelaySettings;
privacy: PrivacySettings;
database: DatabaseSettings;
notifications: NotificationSettings;
developer: DeveloperSettings;
}
// ============================================================================
@@ -140,77 +39,16 @@ export interface AppSettings {
const DEFAULT_POST_SETTINGS: PostSettings = {
includeClientTag: true,
defaultRelayMode: "user-relays",
customPostRelays: [],
};
const DEFAULT_APPEARANCE_SETTINGS: AppearanceSettings = {
theme: "dark",
showClientTags: true,
fontSizeMultiplier: 1.0,
animationsEnabled: true,
accentHue: 280, // Purple
};
const DEFAULT_RELAY_SETTINGS: RelaySettings = {
fallbackRelays: [
"wss://relay.damus.io",
"wss://relay.nostr.band",
"wss://nos.lol",
"wss://relay.primal.net",
],
discoveryRelays: [
"wss://relay.damus.io",
"wss://relay.nostr.band",
"wss://purplepag.es",
],
outboxEnabled: true,
outboxFallbackEnabled: true,
relayTimeout: 5000,
maxRelaysPerQuery: 10,
autoConnectInbox: true,
};
const DEFAULT_PRIVACY_SETTINGS: PrivacySettings = {
shareReadReceipts: false,
blurWalletBalances: false,
blurSensitiveContent: true,
warnExternalLinks: false,
};
const DEFAULT_DATABASE_SETTINGS: DatabaseSettings = {
maxEventsCached: 50000,
autoCleanupDays: 30,
cacheEnabled: true,
cacheProfiles: true,
cacheRelayLists: true,
};
const DEFAULT_NOTIFICATION_SETTINGS: NotificationSettings = {
enabled: false,
notifyOnMention: true,
notifyOnZap: true,
notifyOnReply: true,
soundEnabled: false,
};
const DEFAULT_DEVELOPER_SETTINGS: DeveloperSettings = {
debugMode: false,
showEventIds: false,
logLevel: "warn",
experimentalFeatures: false,
showPerformanceMetrics: false,
};
export const DEFAULT_SETTINGS: AppSettings = {
__version: 1,
post: DEFAULT_POST_SETTINGS,
appearance: DEFAULT_APPEARANCE_SETTINGS,
relay: DEFAULT_RELAY_SETTINGS,
privacy: DEFAULT_PRIVACY_SETTINGS,
database: DEFAULT_DATABASE_SETTINGS,
notifications: DEFAULT_NOTIFICATION_SETTINGS,
developer: DEFAULT_DEVELOPER_SETTINGS,
};
// ============================================================================
@@ -223,49 +61,49 @@ const SETTINGS_STORAGE_KEY = "grimoire-settings-v2";
* Validate settings structure and return valid settings
* Falls back to defaults for invalid sections
*/
function validateSettings(settings: any): AppSettings {
function validateSettings(settings: unknown): AppSettings {
if (!settings || typeof settings !== "object") {
return DEFAULT_SETTINGS;
}
// Ensure all namespaces exist
const s = settings as Record<string, unknown>;
return {
__version: 1,
post: { ...DEFAULT_POST_SETTINGS, ...(settings.post || {}) },
post: {
...DEFAULT_POST_SETTINGS,
...((s.post as object) || {}),
},
appearance: {
...DEFAULT_APPEARANCE_SETTINGS,
...(settings.appearance || {}),
...((s.appearance as object) || {}),
},
relay: { ...DEFAULT_RELAY_SETTINGS, ...(settings.relay || {}) },
privacy: { ...DEFAULT_PRIVACY_SETTINGS, ...(settings.privacy || {}) },
database: { ...DEFAULT_DATABASE_SETTINGS, ...(settings.database || {}) },
notifications: {
...DEFAULT_NOTIFICATION_SETTINGS,
...(settings.notifications || {}),
},
developer: { ...DEFAULT_DEVELOPER_SETTINGS, ...(settings.developer || {}) },
};
}
/**
* Migrate settings from old format to current version
*/
function migrateSettings(stored: any): AppSettings {
// If it's already v2 format, validate and return
if (stored && stored.__version === 1) {
function migrateSettings(stored: unknown): AppSettings {
if (!stored || typeof stored !== "object") {
return DEFAULT_SETTINGS;
}
const s = stored as Record<string, unknown>;
// If it's already current format, validate and return
if (s.__version === 1) {
return validateSettings(stored);
}
// Migrate from v1 (flat structure with only includeClientTag)
// Migrate from old flat structure
const migrated: AppSettings = {
...DEFAULT_SETTINGS,
};
if (stored && typeof stored === "object") {
// Migrate old includeClientTag setting
if ("includeClientTag" in stored) {
migrated.post.includeClientTag = stored.includeClientTag;
}
// Migrate old includeClientTag setting
if ("includeClientTag" in s && typeof s.includeClientTag === "boolean") {
migrated.post.includeClientTag = s.includeClientTag;
}
return migrated;
@@ -316,17 +154,12 @@ function saveSettings(settings: AppSettings): void {
/**
* Global settings manager with reactive updates
* Use settings$ to reactively observe settings changes
* Use getSection() for non-reactive access to a settings section
* Use updateSection() to update an entire section
* Use updateSetting() to update a specific setting within a section
*/
class SettingsManager {
private settings$ = new BehaviorSubject<AppSettings>(loadSettings());
/**
* Observable stream of settings
* Subscribe to get notified of changes
*/
get stream$() {
return this.settings$.asObservable();
@@ -339,18 +172,8 @@ class SettingsManager {
return this.settings$.value;
}
/**
* Get a specific settings section
*/
getSection<K extends keyof Omit<AppSettings, "__version">>(
section: K,
): AppSettings[K] {
return this.settings$.value[section];
}
/**
* Get a specific setting within a section
* @example getSetting("post", "includeClientTag")
*/
getSetting<
S extends keyof Omit<AppSettings, "__version">,
@@ -359,29 +182,8 @@ class SettingsManager {
return this.settings$.value[section][key];
}
/**
* Update an entire settings section
* Automatically persists to localStorage
*/
updateSection<K extends keyof Omit<AppSettings, "__version">>(
section: K,
updates: Partial<AppSettings[K]>,
): void {
const newSettings = {
...this.settings$.value,
[section]: {
...this.settings$.value[section],
...updates,
},
};
this.settings$.next(newSettings);
saveSettings(newSettings);
}
/**
* Update a specific setting within a section
* Automatically persists to localStorage
* @example updateSetting("post", "includeClientTag", true)
*/
updateSetting<
S extends keyof Omit<AppSettings, "__version">,
@@ -405,48 +207,9 @@ class SettingsManager {
this.settings$.next(DEFAULT_SETTINGS);
saveSettings(DEFAULT_SETTINGS);
}
/**
* Reset a specific section to defaults
*/
resetSection<K extends keyof Omit<AppSettings, "__version">>(
section: K,
): void {
const newSettings = {
...this.settings$.value,
[section]: DEFAULT_SETTINGS[section],
};
this.settings$.next(newSettings);
saveSettings(newSettings);
}
/**
* Export settings as JSON string
*/
export(): string {
return JSON.stringify(this.settings$.value, null, 2);
}
/**
* Import settings from JSON string
* Validates and migrates imported settings
*/
import(json: string): boolean {
try {
const parsed = JSON.parse(json);
const validated = validateSettings(parsed);
this.settings$.next(validated);
saveSettings(validated);
return true;
} catch (err) {
console.error("Failed to import settings:", err);
return false;
}
}
}
/**
* Global settings manager instance
* Import this to access settings throughout the app
*/
export const settingsManager = new SettingsManager();